Cisco 4500 Config Guide
Uploaded by
DeepuCisco 4500 Config Guide
Uploaded by
DeepuCatalyst 4500 Series Switch Cisco IOS
Software Configuration Guide
Release IOS-XE 3.1.0 SG
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Customer Order Number: DOC-OL22250=
Text Part Number: OL-22250-01
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL
STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at
www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1005R)
Catalyst 4500 Series Switch Cisco IOS Software Configuration Guide
Copyright © 1999–2009 Cisco Systems, Inc. All rights reserved.
CONTENTS
Preface xxxix
Audience xxxix
Organization xxxix
Notices xlii
OpenSSL/Open SSL Project xlii
License Issues xlii
Conventions xliv
Commands in Task Tables xlv
Related Documentation i-xlv
Hardware Documents i-xlv
Software Documentation i-xlvi
Cisco IOS Documentation i-xlvi
Obtaining Documentation and Submitting a Service Request i-xlvii
CHAPTER 1 Product Overview 1-1
Layer 2 Software Features 1-1
Cisco Discovery Protocol 1-2
Cisco Group Management Protocol (CGMP) server 1-2
EtherChannel Bundles 1-2
Flexible NetFlow 1-2
Internet Group Management Protocol (IGMP) Snooping 1-3
IPv6 Multicast Listen Discovery (MLD) and Multicast Listen Discovery snooping 1-3
Jumbo Frames 1-3
Link Aggregation Control Protocol 1-4
Cisco IOS XE IP Application Services Features in Cisco IOS XE 3.1.0SG 1-4
Link Layer Discovery Protocol 1-4
Multiple Spanning Tree 1-5
Per-VLAN Rapid Spanning Tree 1-5
Quality of Service 1-5
Spanning Tree Protocol 1-6
Stateful Switchover 1-6
SVI Autostate 1-6
Unidirectional Ethernet 1-7
UniDirectional Link Detection 1-7
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 i
Contents
User Based Rate Limiting 1-7
Virtual Switch System Client 1-7
VLANs 1-7
Layer 3 Software Features 1-8
Cisco Express Forwarding 1-9
Enhanced Object Tracking 1-9
GLBP 1-9
Cisco IOS XE IP Application Services Features in Cisco IOS XE 3.1.0SG 1-9
HSRP 1-10
Cisco IOS XE IP Application Services: HSRP Features in Cisco IOS XE 3.1.0SG 1-10
SSO Aware HSRP 1-11
IP Routing Protocols 1-11
BGP 1-11
EIGRP 1-12
OSPF 1-13
RIP 1-13
In Service Software Upgrade 1-14
Multicast Services 1-14
NSF with SSO 1-14
Policy-Based Routing 1-14
Unidirectional Link Routing 1-15
Unicast Reverse Path Forwarding 1-15
VRF-lite 1-15
Virtual Router Redundancy Protocol 1-15
Management Features 1-15
Cisco Call Home 1-16
Cisco Energy Wise 1-16
Cisco IOS IP Service Level Agreement 1-16
Dynamic Host Control Protocol 1-17
Embedded CiscoView 1-17
Embedded Event Manager 1-17
File System Management on Supervisor Engine 7-E 1-17
Forced 10/100 Autonegotiation 1-18
Intelligent Power Management 1-18
MAC Address Notification 1-18
MAC Notify MIB 1-18
Secure Shell 1-18
Simple Network Management Protocol 1-19
SPAN and RSPAN 1-19
XML-PI 1-19
Software Configuration Guide—Release IOS-XE 3.1.0 SG
ii OL-22250-01
Contents
Security Features 1-20
802.1X Identity-Based Network Security 1-20
Dynamic ARP Inspection 1-21
Dynamic Host Configuration Protocol Snooping 1-21
Flood Blocking 1-22
Hardware-Based Control Plane Policing 1-22
IP Source Guard 1-22
Local Authentication, RADIUS, and TACACS+ Authentication 1-22
Network Admission Control 1-23
Network Security with ACLs 1-23
Port Security 1-23
Storm Control 1-24
uRPF Strict Mode 1-24
Utilities 1-24
Layer 2 Traceroute 1-24
Time Domain Reflectometry 1-24
Debugging Features 1-25
Web-based Authentication 1-25
1-25
CHAPTER 2 Command-Line Interfaces 2-1
File Management Commands 2-1
Accessing the Switch CLI 2-2
Accessing the CLI Using the EIA/TIA-232 Console Interface 2-2
Accessing the CLI Through Telnet 2-2
Performing Command-Line Processing 2-3
Performing History Substitution 2-4
About Cisco IOS Command Modes 2-4
Getting a List of Commands and Syntax 2-5
Virtual Console for Standby Supervisor Engine 2-6
ROMMON Command-Line Interface 2-7
CHAPTER 3 Configuring the Switch for the First Time 3-1
Default Switch Configuration 3-1
Configuring DHCP-Based Autoconfiguration 3-2
DHCP-Based Autoconfiguration 3-2
DHCP Client Request Process 3-3
Configuring the DHCP Server 3-4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 iii
Contents
Configuring the TFTP Server 3-4
Configuring the DNS Server 3-5
Configuring the Relay Device 3-5
Obtaining Configuration Files 3-6
Example Configuration 3-7
Configuring the Switch 3-8
Using Configuration Mode to Configure Your Switch 3-9
Verifying the Running Configuration Settings 3-9
Saving the Running Configuration Settings to Your Start-Up File 3-10
Reviewing the Configuration in NVRAM 3-10
Configuring a Default Gateway 3-11
Configuring a Static Route 3-11
Controlling Access to Privileged EXEC Commands 3-13
Setting or Changing a Static enable Password 3-13
Using the enable password and enable secret Commands 3-14
Setting or Changing a Privileged Password 3-14
Controlling Switch Access with TACACS+ 3-15
Understanding TACACS+ 3-15
TACACS+ Operation 3-17
Configuring TACACS+ 3-17
Displaying the TACACS+ Configuration 3-22
Encrypting Passwords 3-22
Configuring Multiple Privilege Levels 3-23
Setting the Privilege Level for a Command 3-23
Changing the Default Privilege Level for Lines 3-23
Logging In to a Privilege Level 3-24
Exiting a Privilege Level 3-24
Displaying the Password, Access Level, and Privilege Level Configuration 3-24
Recovering a Lost Enable Password 3-25
Modifying the Supervisor Engine Startup Configuration 3-25
Understanding the Supervisor Engine Boot Configuration 3-25
Understanding the ROM Monitor 3-26
Configuring the Software Configuration Register 3-26
Modifying the Boot Field and Using the boot Command 3-27
Modifying the Boot Field 3-28
Verifying the Configuration Register Setting 3-29
Specifying the Startup System Image 3-30
Flash Memory Features 3-30
Security Precautions 3-31
Software Configuration Guide—Release IOS-XE 3.1.0 SG
iv OL-22250-01
Contents
Configuring Flash Memory 3-31
Controlling Environment Variables 3-31
Resetting a Switch to Factory Default Settings 3-32
Configuring Crashinfo 3-32
About Crashinfo 3-33
Process Crashinfo File 3-33
Process Core Dump File 3-34
Kernel Crashinfo File 3-34
Configuring Crashinfo 3-35
Default Configuration 3-35
Configuring commands 3-35
show Commands 3-36
Enabling the Generation of the Process Core Dump File 3-38
Saving Crash Files to a Secondary Devices 3-39
Determining the Process that Crashed 3-39
CHAPTER 4 Administering the Switch 4-1
Managing the System Time and Date 4-1
System Clock 4-2
Understanding Network Time Protocol 4-2
Configuring NTP 4-3
Default NTP Configuration 4-4
Configuring NTP Authentication 4-4
Configuring NTP Associations 4-6
Configuring NTP Broadcast Service 4-7
Configuring NTP Access Restrictions 4-8
Configuring the Source IP Address for NTP Packets 4-10
Displaying the NTP Configuration 4-11
Configuring Time and Date Manually 4-11
Setting the System Clock 4-11
Displaying the Time and Date Configuration 4-12
Configuring the Time Zone 4-12
Configuring Summer Time (Daylight Saving Time) 4-13
Configuring a System Name and Prompt 4-14
Configuring a System Name 4-15
Understanding DNS 4-15
Default DNS Configuration 4-16
Setting Up DNS 4-16
Displaying the DNS Configuration 4-17
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 v
Contents
Creating a Banner 4-17
Default Banner Configuration 4-18
Configuring a Message-of-the-Day Login Banner 4-18
Configuring a Login Banner 4-19
Managing the MAC Address Table 4-19
Building the Address Table 4-20
MAC Addresses and VLANs 4-20
Default MAC Address Table Configuration 4-21
Changing the Address Aging Time 4-21
Removing Dynamic Address Entries 4-22
Configuring MAC Change Notification Traps 4-22
Configuring MAC Move Notification Traps 4-24
Configuring MAC Threshold Notification Traps 4-26
Adding and Removing Static Address Entries 4-27
Configuring Unicast MAC Address Filtering 4-28
Displaying Address Table Entries 4-30
Managing the ARP Table 4-30
Configuring Embedded CiscoView Support 4-30
Understanding Embedded CiscoView 4-31
Installing and Configuring Embedded CiscoView 4-31
Displaying Embedded CiscoView Information 4-33
CHAPTER 5 Configuring Supervisor Engine Redundancy Using RPR and SSO 5-1
About Supervisor Engine Redundancy 5-2
Overview 5-2
RPR Operation 5-3
SSO Operation 5-3
About Supervisor Engine Redundancy Synchronization 5-5
RPR Supervisor Engine Configuration Synchronization 5-5
SSO Supervisor Engine Configuration Synchronization 5-6
Supervisor Engine Redundancy Guidelines and Restrictions 5-6
Configuring Supervisor Engine Redundancy 5-7
Configuring Redundancy 5-8
Virtual Console for Standby Supervisor Engine 5-9
Synchronizing the Supervisor Engine Configurations 5-11
Performing a Manual Switchover 5-12
Performing a Software Upgrade 5-13
Manipulating Bootflash on the Standby Supervisor Engine 5-14
Software Configuration Guide—Release IOS-XE 3.1.0 SG
vi OL-22250-01
Contents
CHAPTER 6 Configuring the Cisco IOS XE In Service Software Upgrade Process 6-1
Related Documents 6-2
Prerequisites to Performing ISSU 6-2
About Performing ISSU 6-3
Stateful Switchover 6-3
NSF 6-5
ISSU Process 6-6
Performing an ISSU Upgrade: 2 Methods 6-11
Changeversion Process 6-12
Changeversion: Quick Option (LV to INIT) 6-12
Scheduled Changeversion: “in” and “at” Options 6-12
Changeversion Deployment Scenario 6-13
Aborting an In-Progress Changeversion Procedure 6-13
Guidelines for Performing ISSU 6-13
Compatibility Matrix 6-13
SNMP Support for ISSU 6-14
Compatibility Verification Using Cisco Feature Navigator 6-14
How to Perform the ISSU Process 6-15
Verifying the ISSU Software Installation 6-15
Verifying Redundancy Mode Before Beginning the ISSU Process 6-16
Verifying the ISSU State Before Beginning the ISSU Process 6-17
Loading New Cisco IOS XE Software on the Standby Supervisor Engine 6-18
Switching to the Standby Supervisor Engine 6-21
Stopping the ISSU Rollback Timer (Optional) 6-23
Loading New Cisco IOS XE Software on the New Standby Supervisor Engine 6-24
Using changeversion to Automate an ISSU Upgrade 6-25
Aborting a Software Upgrade During ISSU 6-31
Configuring the Rollback Timer to Safeguard Against Upgrade Issues 6-32
Displaying ISSU Compatibility Matrix Information 6-34
Cisco High Availability Features in Cisco IOS XE 3.1.0 SG 6-35
CHAPTER 7 Configuring Interfaces 7-1
About Interface Configuration 7-2
Using the interface Command 7-2
Configuring a Range of Interfaces 7-4
Defining and Using Interface-Range Macros 7-6
Deploying SFP+ in X2 Ports 7-7
Deploying 10-Gigabit Ethernet or Gigabit Ethernet Ports on WS-X4606-10GE-E 7-7
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 vii
Contents
Port Numbering TwinGig Convertors 7-7
Selecting X2/TwinGig Convertor Mode 7-8
Internal Management Port and Supervisor Engine 7-E 7-10
Limitation and Restrictions on Supervisor Engine 7-E 7-10
Digital Optical Monitoring Transceiver Support 7-10
Configuring Optional Interface Features 7-11
Configuring Ethernet Interface Speed and Duplex Mode 7-11
Speed and Duplex Mode Configuration Guidelines 7-11
Setting the Interface Speed 7-11
Setting the Interface Duplex Mode 7-12
Displaying the Interface Speed and Duplex Mode Configuration 7-13
Adding a Description for an Interface 7-13
Configuring Flow Control 7-14
Configuring Jumbo Frame Support 7-16
Ports and Modules that Support Jumbo Frames 7-16
Jumbo Frame Support 7-17
Configuring MTU Sizes 7-19
Interacting with Baby Giants 7-20
Configuring the Port Debounce Timer 7-20
Configuring auto-MDIX on a Port 7-21
Displaying the Interface auto-MDIX Configuration 7-22
Understanding Online Insertion and Removal 7-23
Monitoring and Maintaining the Interface 7-24
Monitoring Interface and Controller Status 7-24
Clearing and Resetting the Interface 7-25
Shutting Down and Restarting an Interface 7-25
Configuring Interface Link Status and Trunk Status Events 7-26
Configuring Link Status Event Notification for an Interface 7-26
Global Settings 7-26
Configuring a Switch Global Link Status Logging Event 7-27
Result 7-27
Resetting the Interface to the Default Configuration 7-28
CHAPTER 8 Checking Port Status and Connectivity 8-1
Checking Module Status 8-2
Checking Interfaces Status 8-2
Displaying MAC Addresses 8-3
Checking Cable Status Using Time Domain Reflectometer 8-3
Software Configuration Guide—Release IOS-XE 3.1.0 SG
viii OL-22250-01
Contents
Overview 8-4
Running the TDR Test 8-4
TDR Guidelines 8-5
Using Telnet 8-5
Changing the Logout Timer 8-6
Monitoring User Sessions 8-6
Using Ping 8-7
Understanding How Ping Works 8-7
Running Ping 8-8
Using IP Traceroute 8-8
Understanding How IP Traceroute Works 8-9
Running IP Traceroute 8-9
Using Layer 2 Traceroute 8-10
Layer 2 Traceroute Usage Guidelines 8-10
Running Layer 2 Traceroute 8-11
Configuring ICMP 8-12
Enabling ICMP Protocol Unreachable Messages 8-12
Enabling ICMP Redirect Messages 8-13
Enabling ICMP Mask Reply Messages 8-13
CHAPTER 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy 9-1
About NSF with SSO Supervisor Engine Redundancy 9-1
About Cisco IOS NSF-Aware and NSF-Capable Support 9-2
NSF with SSO Supervisor Engine Redundancy Overview 9-3
SSO Operation 9-3
NSF Operation 9-4
Cisco Express Forwarding 9-4
Routing Protocols 9-5
BGP Operation 9-5
OSPF Operation 9-6
EIGRP Operation 9-6
NSF Guidelines and Restrictions 9-7
Configuring NSF with SSO Supervisor Engine Redundancy 9-7
Configuring SSO 9-8
Configuring CEF NSF 9-8
Verifying CEF NSF 9-9
Configuring BGP NSF 9-9
Verifying BGP NSF 9-10
Configuring OSPF NSF 9-11
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 ix
Contents
Verifying OSPF NSF 9-11
Configuring EIGRP NSF 9-12
Verifying EIGRP NSF 9-13
Cisco High Availability Features in Cisco IOS XE 3.1.0 SG 9-13
CHAPTER 10 Environmental Monitoring and Power Management 10-1
About Environmental Monitoring 10-1
Using CLI Commands to Monitor your Environment 10-2
Displaying Environment Conditions 10-2
Emergency Actions 10-3
System Alarms 10-4
Power Management 10-5
Power Management for the Catalyst 4500 Series Switches 10-5
Supported Power Supplies 10-5
Power Management Modes for the Catalyst 4500 Switch 10-7
Selecting a Power Management Mode 10-7
Power Management Limitations in Catalyst 4500 Series Switches 10-8
Available Power for Catalyst 4500 Series Switches Power Supplies 10-12
Special Considerations for the 4200 W AC and 6000 W AC Power Supplies 10-13
Combined Mode Power Resiliency 10-15
Special Considerations for the 1400 W DC Power Supply 10-16
Special Considerations for the 1400 W DC SP Triple Input Power Supply 10-17
Powering Down a Module 10-18
CHAPTER 11 Configuring Power over Ethernet 11-1
About Power over Ethernet 11-1
Hardware Requirements 11-2
Power Management Modes 11-3
Intelligent Power Management 11-4
Configuring Power Consumption for Powered Devices
on an Interface 11-5
Displaying the Operational Status for an Interface 11-6
Displaying the PoE Consumed by a Module 11-7
PoE Policing and Monitoring 11-11
PoE Policing Modes 11-12
Configuring Power Policing on an Interface 11-12
Displaying Power Policing on an Interface 11-13
Configuring Errdisable Recovery 11-14
Software Configuration Guide—Release IOS-XE 3.1.0 SG
x OL-22250-01
Contents
Enhanced Power PoE Support on the E-Series Chassis 11-15
CHAPTER 12 Configuring VLANs, VTP, and VMPS 12-1
VLANs 12-1
About VLANs 12-1
VLAN Configuration Guidelines and Restrictions 12-3
VLAN Ranges 12-3
Configurable Normal-Range VLAN Parameters 12-4
VLAN Default Configuration 12-4
Configuring VLANs 12-5
Configuring VLANs in Global Configuration Mode 12-5
Assigning a Layer 2 LAN Interface to a VLAN 12-7
VLAN Trunking Protocol 12-7
About VTP 12-7
Understanding the VTP Domain 12-8
Understanding VTP Modes 12-8
Understanding VTP Advertisements 12-9
Understanding VTP Versions 12-9
Understanding VTP Pruning 12-11
VTP Configuration Guidelines and Restrictions 12-12
VTP Default Configuration 12-13
Configuring VTP 12-14
Configuring VTP Global Parameters 12-14
Configuring the VTP Mode 12-16
Starting a Takeover 12-19
Displaying VTP Statistics 12-19
Displaying VTP Devices in a Domain 12-20
VLAN Membership Policy Server 12-20
About VMPS 12-21
VMPS Server 12-21
Security Modes for VMPS Server 12-22
Fallback VLAN 12-23
Illegal VMPS Client Requests 12-23
Overview of VMPS Clients 12-23
Understanding Dynamic VLAN Membership 12-23
Default VMPS Client Configuration 12-24
Configuring a Switch as a VMPS Client 12-24
Administering and Monitoring the VMPS 12-28
Troubleshooting Dynamic Port VLAN Membership 12-29
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xi
Contents
Dynamic Port VLAN Membership Configuration Example 12-29
VMPS Database Configuration File Example 12-32
CHAPTER 13 Configuring IP Unnumbered Interface 13-1
Related Documents 13-2
About IP Unnumbered Support 13-2
IP Unnumbered Interface Support with DHCP Server and Relay Agent 13-2
DHCP Option 82 13-3
IP Unnumbered with Connected Host Polling 13-4
Limitations and Restrictions 13-4
Configuring IP Unnumbered Interface Support with DHCP Server 13-5
Configuring IP Unnumbered Interface Support on LAN and VLAN Interfaces 13-5
Configuring IP Unnumbered Interface Support on a Range of Ethernet VLANs 13-6
Configuring IP Unnumbered Interface Support
with Connected Host Polling 13-7
Displaying IP Unnumbered Interface Settings 13-8
Troubleshooting IP Unnumbered 13-9
CHAPTER 14 Configuring Layer 2 Ethernet Interfaces 14-1
About Layer 2 Ethernet Switching 14-1
Layer 2 Ethernet Switching 14-2
Switching Frames Between Segments 14-2
Building the MAC Address Table 14-2
VLAN Trunks 14-3
Encapsulation Types 14-3
Layer 2 Interface Modes 14-4
Default Layer 2 Ethernet Interface Configuration 14-4
Layer 2 Interface Configuration Guidelines and Restrictions 14-5
Configuring Ethernet Interfaces for Layer 2 Switching 14-5
Configuring an Ethernet Interface as a Layer 2 Trunk 14-6
Configuring an Interface as a Layer 2 Access Port 14-8
Clearing Layer 2 Configuration 14-9
CHAPTER 15 Configuring SmartPort Macros 15-1
About SmartPort Macros 15-1
Configuring SmartPort Macros 15-2
Passing Parameters Through the Macro 15-2
Macro Parameter Help 15-3
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xii OL-22250-01
Contents
Default SmartPort Macro Configuration 15-3
cisco-global 15-4
cisco-desktop 15-4
cisco-phone 15-4
cisco-router 15-5
cisco-switch 15-5
SmartPort Macro Configuration Guidelines 15-6
Creating SmartPorts Macros 15-7
Applying SmartPorts Macros 15-8
cisco-global 15-9
cisco-desktop 15-9
cisco-phone 15-10
cisco-switch 15-11
cisco-router 15-11
Displaying SmartPort Macros 15-12
CHAPTER 16 Configuring STP and MST 16-1
Overview of STP 16-1
Understanding the Bridge ID 16-2
Bridge Priority Value 16-2
Extended System ID 16-2
STP MAC Address Allocation 16-3
Bridge Protocol Data Units 16-3
Election of the Root Bridge 16-4
STP Timers 16-4
Creating the STP Topology 16-4
STP Port States 16-5
MAC Address Allocation 16-5
STP and IEEE 802.1Q Trunks 16-6
Per-VLAN Rapid Spanning Tree 16-6
Default STP Configuration 16-6
Configuring STP 16-7
Enabling STP 16-7
Enabling the Extended System ID 16-8
Configuring the Root Bridge 16-9
Configuring a Secondary Root Switch 16-12
Configuring STP Port Priority 16-13
Configuring STP Port Cost 16-15
Configuring the Bridge Priority of a VLAN 16-16
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xiii
Contents
Configuring the Hello Time 16-17
Configuring the Maximum Aging Time for a VLAN 16-18
Configuring the Forward-Delay Time for a VLAN 16-18
Disabling Spanning Tree Protocol 16-19
Enabling Per-VLAN Rapid Spanning Tree 16-20
Specifying the Link Type 16-21
Restarting Protocol Migration 16-21
Overview of MST 16-21
IEEE 802.1s MST 16-22
IEEE 802.1w RSTP 16-23
RSTP Port Roles 16-23
RSTP Port States 16-24
MST-to-SST Interoperability 16-24
Common Spanning Tree 16-25
MST Instances 16-26
MST Configuration Parameters 16-26
MST Regions 16-26
MST Region Overview 16-26
Boundary Ports 16-27
IST Master 16-27
Edge Ports 16-27
Link Type 16-28
Message Age and Hop Count 16-28
MST-to-PVST+ Interoperability 16-28
MST Configuration Restrictions and Guidelines 16-29
Configuring MST 16-29
Enabling MST 16-29
Configuring MST Instance Parameters 16-31
Configuring MST Instance Port Parameters 16-32
Restarting Protocol Migration 16-33
Displaying MST Configurations 16-33
CHAPTER 18 Configuring Optional STP Features 18-1
About Root Guard 18-2
Enabling Root Guard 18-2
About Loop Guard 18-3
Enabling Loop Guard 18-5
About EtherChannel Guard 18-6
Enabling EtherChannel Guard (Optional) 18-6
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xiv OL-22250-01
Contents
About PortFast 18-7
Enabling PortFast 18-7
About BPDU Guard 18-8
Enabling BPDU Guard 18-9
About PortFast BPDU Filtering 18-9
Enabling PortFast BPDU Filtering 18-10
About UplinkFast 18-11
Enabling UplinkFast 18-12
About BackboneFast 18-14
Enabling BackboneFast 18-16
CHAPTER 19 Configuring EtherChannel 19-1
EtherChannel Overview 19-1
Port-Channel Interfaces 19-2
How EtherChannels Are Configured 19-2
EtherChannel Configuration Overview 19-3
Manual EtherChannel Configuration 19-3
PAgP EtherChannel Configuration 19-3
IEEE 802.3ad LACP EtherChannel Configuration 19-4
Load Balancing 19-5
EtherChannel Configuration Guidelines and Restrictions 19-5
Configuring EtherChannel 19-6
Configuring Layer 3 EtherChannels 19-6
Creating Port-Channel Logical Interfaces 19-7
Configuring Physical Interfaces as Layer 3 EtherChannels 19-7
Configuring Layer 2 EtherChannels 19-9
Configuring the LACP System Priority and System ID 19-11
Configuring EtherChannel Load Balancing 19-12
Removing an Interface from an EtherChannel 19-13
Removing an EtherChannel 19-14
Displaying EtherChannel to a Virtual Switch System 19-14
Understanding VSS Client 19-15
Virtual Switch System 19-15
Dual-Active Scenarios 19-15
Dual-Active Detection Using Enhance PAgP 19-15
Displaying EtherChannel Links to VSS 19-17
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xv
Contents
CHAPTER 20 Configuring CDP 20-1
About CDP 20-1
Configuring CDP 20-2
Enabling CDP Globally 20-2
Displaying the CDP Global Configuration 20-2
Enabling CDP on an Interface 20-3
Displaying the CDP Interface Configuration 20-3
Monitoring and Maintaining CDP 20-3
CHAPTER 21 Configuring IGMP Snooping and Filtering 21-1
Overview of IGMP Snooping 21-1
Immediate-Leave Processing 21-3
IGMP Configurable-Leave Timer 21-4
IGMP Snooping Querier 21-4
Explicit Host Tracking 21-4
Configuring IGMP Snooping 21-5
Default IGMP Snooping Configuration 21-5
Enabling IGMP Snooping Globally 21-6
Enabling IGMP Snooping on a VLAN 21-6
Configuring Learning Methods 21-7
Configuring PIM/DVMRP Learning 21-7
Configuring CGMP Learning 21-7
Configuring a Static Connection to a Multicast Router 21-8
Enabling IGMP Immediate-Leave Processing 21-8
Configuring the IGMP Leave Timer 21-9
Configuring IGMP Snooping Querier 21-10
Configuring Explicit Host Tracking 21-11
Configuring a Host Statically 21-11
Suppressing Multicast Flooding 21-12
IGMP Snooping Interface Configuration 21-12
IGMP Snooping Switch Configuration 21-13
Displaying IGMP Snooping Information 21-14
Displaying Querier Information 21-15
Displaying IGMP Host Membership Information 21-15
Displaying Group Information 21-16
Displaying Multicast Router Interfaces 21-17
Displaying MAC Address Multicast Entries 21-18
Displaying IGMP Snooping Information on a VLAN Interface 21-18
Displaying IGMP Snooping Querier Information 21-19
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xvi OL-22250-01
Contents
Configuring IGMP Filtering 21-20
Default IGMP Filtering Configuration 21-20
Configuring IGMP Profiles 21-21
Applying IGMP Profiles 21-22
Setting the Maximum Number of IGMP Groups 21-23
Displaying IGMP Filtering Configuration 21-24
CHAPTER 22 Configuring IPv6 MLD Snooping 22-1
About MLD Snooping 22-1
MLD Messages 22-2
MLD Queries 22-3
Multicast Client Aging Robustness 22-3
Multicast Router Discovery 22-3
MLD Reports 22-4
MLD Done Messages and Immediate-Leave 22-4
Topology Change Notification Processing 22-4
Configuring IPv6 MLD Snooping 22-5
Default MLD Snooping Configuration 22-5
MLD Snooping Configuration Guidelines 22-6
Enabling or Disabling MLD Snooping 22-6
Configuring a Static Multicast Group 22-7
Configuring a Multicast Router Port 22-7
Enabling MLD Immediate Leave 22-8
Configuring MLD Snooping Queries 22-9
Disabling MLD Listener Message Suppression 22-10
Displaying MLD Snooping Information 22-11
CHAPTER 23 Configuring LLDP, and LLDP-MED 23-1
About LLDP and LLDP-MED 23-1
Understanding LLDP 23-1
Understanding LLDP-MED 23-2
Configuring LLDP and LLDP-MED 23-3
Default LLDP Configuration 23-3
Configuring LLDP Characteristics 23-4
Disabling and Enabling LLDP Globally 23-5
Disabling and Enabling LLDP on an Interface 23-6
Configuring LLDP-MED TLVs 23-7
Configuring LLDP Power Negotiation 23-8
Configuring LLDP and Location TLV 23-9
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xvii
Contents
Monitoring and Maintaining LLDP and LLDP-MED 23-10
Cisco IOS Carries Ethernet Features in Cisco IOS XE 3.1.0 SG 23-10
CHAPTER 24 Configuring UDLD 24-1
About UDLD 24-1
Modes of Operation 24-1
Default UDLD Configuration 24-2
Configuring UDLD on the Switch 24-3
Enabling UDLD Globally 24-4
Enabling UDLD on Individual Interfaces 24-4
Disabling UDLD on Non-Fiber-Optic Interfaces 24-5
Configuring the UDLD Probe Message Interval 24-5
Resetting Disabled LAN Interfaces 24-5
CHAPTER 25 Configuring Unidirectional Ethernet 25-1
About Unidirectional Ethernet 25-1
Configuring Unidirectional Ethernet 25-2
CHAPTER 26 Configuring Layer 3 Interfaces 26-1
Overview of Layer 3 Interfaces 26-1
Logical Layer 3 VLAN Interfaces 26-2
Physical Layer 3 Interfaces 26-2
Understanding SVI Autostate Exclude 26-3
Understanding Layer 3 Interface Counters 26-3
Configuration Guidelines 26-4
Configuring Logical Layer 3 VLAN Interfaces 26-5
Configuring VLANs as Layer 3 Interfaces 26-6
Configuring SVI Autostate Exclude 26-6
Configuring IP MTU Sizes 26-8
Configuring Layer 3 Interface Counters 26-9
Configuring Physical Layer 3 Interfaces 26-10
Configuring EIGRP Stub Routing 26-11
Overview 26-11
How to Configure EIGRP Stub Routing 26-12
Dual-Homed Remote Topology 26-14
EIGRP Stub Routing Configuration Task List 26-16
Monitoring and Maintaining EIGRP 26-17
EIGRP Configuration Examples 26-18
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xviii OL-22250-01
Contents
Route Summarization Example 26-18
Route Authentication Example 26-18
Stub Routing Example 26-19
CHAPTER 27 Configuring Cisco Express Forwarding 27-1
About CEF 27-1
Benefits of CEF 27-2
Forwarding Information Base 27-2
Adjacency Tables 27-2
Adjacency Discovery 27-2
Adjacency Resolution 27-3
Adjacency Types That Require Special Handling 27-3
Unresolved Adjacency 27-3
Catalyst 4500 Series Switch Implementation of CEF 27-3
Hardware and Software Switching 27-4
Hardware Switching 27-5
Software Switching 27-5
Load Balancing 27-6
Software Interfaces 27-6
CEF Configuration Restrictions 27-6
Configuring CEF 27-6
Enabling CEF 27-6
Configuring Load Balancing for CEF 27-7
Configuring Per-Destination Load Balancing 27-7
Configuring Load Sharing Hash Function 27-7
Viewing CEF Information 27-8
Monitoring and Maintaining CEF 27-8
Displaying IP Statistics 27-8
CHAPTER 28 Configuring Unicast Reverse Path Forwarding 28-1
In This Chapter 28-1
About Unicast Reverse Path Forwarding 28-2
How Unicast RPF Works 28-2
Implementing Unicast RPF 28-4
Security Policy and Unicast RPF 28-5
Where to Use Unicast RPF 28-5
Routing Table Requirements 28-7
Where Not to Use Unicast RPF 28-7
Unicast RPF with BOOTP and DHCP 28-8
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xix
Contents
Restrictions 28-8
Limitations 28-8
Related Features and Technologies 28-8
Prerequisites to Configuring Unicast RPF 28-9
Unicast RPF Configuration Task List 28-9
Configuring Unicast RPF 28-9
Verifying Unicast RPF 28-10
Monitoring and Maintaining Unicast RPF 28-11
Unicast RPF Configuration Example:
Inbound and Outbound Filters 28-12
CHAPTER 29 Configuring IP Multicast 29-1
Overview of IP Multicast 29-1
IP Multicast Protocols 29-2
Internet Group Management Protocol 29-3
Protocol-Independent Multicast 29-3
Rendezvous Point (RP) 29-4
IGMP Snooping 29-4
IP Multicast on the Catalyst 4500 Series Switch 29-5
CEF, MFIB, and Layer 2 Forwarding 29-5
IP Multicast Tables 29-7
Hardware and Software Forwarding 29-8
Non-Reverse Path Forwarding Traffic 29-9
Multicast Fast Drop 29-10
Multicast Forwarding Information Base 29-11
S/M, 224/4 29-12
Restrictions on using Bidirectional PIM 29-12
Unsupported Feature 29-12
Configuring IP Multicast Routing 29-12
Default Configuration in IP Multicast Routing 29-12
Enabling IP Multicast Routing 29-13
Enabling PIM on an Interface 29-13
Enabling Dense Mode 29-14
Enabling Sparse Mode 29-14
Enabling Sparse-Dense Mode 29-14
Enabling Bidirectional Mode 29-15
Enabling PIM-SSM Mapping 29-16
Configuring a Rendezvous Point 29-16
Configuring Auto-RP 29-16
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xx OL-22250-01
Contents
Configuring a Single Static RP 29-19
Monitoring and Maintaining IP Multicast Routing 29-21
Displaying System and Network Statistics 29-21
Displaying the Multicast Routing Table 29-22
Displaying IP MFIB 29-24
Displaying Bidirectional PIM Information 29-25
Displaying PIM Statistics 29-25
Clearing Tables and Databases 29-26
Configuration Examples 29-26
PIM Dense Mode: Example 29-26
PIM Sparse Mode: Example 29-27
Bidirectional PIM Mode: Example 29-27
Sparse Mode with a Single Static RP: Example 29-27
Sparse Mode with Auto-RP: Example 29-28
CHAPTER 30 Configuring Policy-Based Routing 30-1
Overview of Policy-Based Routing 30-1
About PBR 30-2
Understanding Route-Maps 30-2
Understanding PBR 30-5
Using Policy-Based Routing 30-5
Policy-Based Routing Configuration Task List 30-6
Enabling PBR 30-6
Enabling Local PBR 30-8
Unsupported Commands 30-8
Policy-Based Routing Configuration Examples 30-8
Equal Access 30-8
Differing Next Hops 30-9
Deny ACE 30-9
CHAPTER 31 Configuring VRF-lite 31-1
VRF-lite Overview 31-2
Default VRF-lite Configuration 31-3
VRF-lite Configuration Guidelines 31-4
Configuring VRFs 31-5
Configuring VRF-Aware Services 31-6
User Interface for ARP 31-6
User Interface for PING 31-7
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xxi
Contents
User Interface for SNMP 31-7
User Interface for uRPF 31-7
User Interface for Syslog 31-8
User Interface for Traceroute 31-8
User Interface for FTP and TFTP 31-8
User Interface for Telnet and SSH 31-9
User Interface for NTP 31-9
Configuring Multicast VRFs 31-10
Configuring a VPN Routing Session 31-11
Configuring BGP PE to CE Routing Sessions 31-11
VRF-lite Configuration Example 31-12
Configuring Switch S8 31-14
Configuring Switch S20 31-15
Configuring Switch S11 31-16
Configuring the PE Switch S3 31-16
Displaying VRF-lite Status 31-17
CHAPTER 32 Configuring Flexible NetFlow 32-1
CHAPTER 33 Configuring Quality of Service 33-1
Overview of QoS on the Catalyst 4500 Series Switch 33-1
Prioritization 33-2
QoS Terminology 33-3
Basic QoS Model 33-5
Classification 33-6
Classification Based on QoS ACLs 33-6
Classification Based on Class Maps and Policy Maps 33-7
Policing and Marking 33-8
Queueing and Scheduling 33-8
Active Queue Management 33-9
Sharing Link Bandwidth Among Transmit Queues 33-9
Strict Priority / Low Latency Queueing 33-9
Traffic Shaping 33-9
Packet Modification 33-9
Per Port Per VLAN QoS 33-10
Flow-based QoS 33-10
Configuring QoS 33-11
MQC-based QoS Configuration 33-11
Platform-supported Classification Criteria and QoS Features 33-11
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xxii OL-22250-01
Contents
Platform Hardware Capabilities 33-12
Prerequisites for Applying a QoS Service Policy 33-13
Restrictions for Applying a QoS Service Policy 33-13
Classification 33-13
Classification Statistics 33-13
Configuring a Policy Map 33-14
Attaching a Policy Map to an Interface 33-14
Policing 33-14
How to Implement Policing 33-15
Platform Restrictions 33-16
Marking Network Traffic 33-16
Contents 33-16
Information About Marking Network Traffic 33-16
Marking Action Drivers 33-19
Traffic Marking Procedure Flowchart 33-19
Restrictions for Marking Network Traffic 33-20
Multi-attribute Marking Support 33-20
Hardware Capabilities for Marking 33-21
Configuring the Policy Map Marking Action 33-21
Marking Statistics 33-22
Shaping, Sharing (Bandwidth), Priority Queuing, Queue-limiting and DBL 33-23
Shaping 33-23
Sharing(bandwidth) 33-25
Priority queuing 33-28
Queue-limiting 33-29
Active Queue Management (AQM) via Dynamic Buffer Limiting (DBL) 33-32
Transmit Queue Statistics 33-33
Enabling Per-Port Per-VLAN QoS 33-33
Policy Associations 33-37
Software QoS 33-38
Applying Flow-based QoS Policy 33-39
Examples 33-39
Configuration Guidelines 33-42
Configuring Auto-QoS 33-43
CHAPTER 34 Configuring Voice Interfaces 34-1
About Voice Interfaces 34-1
Cisco IP Phone Voice Traffic 34-2
Cisco IP Phone Data Traffic 34-2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xxiii
Contents
Configuring a Port to Connect to a Cisco 7960 IP Phone 34-3
Configuring Voice Ports for Voice and Data Traffic 34-3
Overriding the CoS Priority of Incoming Frames 34-5
Configuring Power 34-5
CHAPTER 35 Configuring Private VLANs 35-1
Command List 35-1
Private VLANs 35-2
Definition Table 35-4
Private VLANs across Multiple Switches 35-5
Standard Trunk Ports 35-5
Isolated Private VLAN Trunk Ports 35-6
Promiscuous Private VLAN Trunk Ports 35-8
Private-VLAN Interaction with Other Features 35-8
PVLANs and VLAN ACL/QoS 35-9
Private VLANs and Unicast, Broadcast, and Multicast Traffic 35-9
Private VLANs and SVIs 35-10
Per-Virtual-Port Error Disable on Private Vlans 35-10
Configuring PVLANs 35-10
Tasks for Configuring Private VLANs 35-11
Default Private-VLAN Configuration 35-11
PVLAN Configuration Guidelines and Restrictions 35-11
Configuring a VLAN as a PVLAN 35-13
Associating a Secondary VLAN with a Primary VLAN 35-14
Configuring a Layer 2 Interface as a PVLAN Promiscuous Port 35-16
Configuring a Layer 2 Interface as a PVLAN Host Port 35-17
Configuring a Layer 2 Interface as an Isolated PVLAN Trunk Port 35-18
Configuring a Layer 2 Interface as a Promiscuous PVLAN Trunk Port 35-19
Permitting Routing of Secondary VLAN Ingress Traffic 35-21
CHAPTER 36 Configuring 802.1X Port-Based Authentication 36-1
About 802.1X Port-Based Authentication 36-1
Device Roles 36-2
802.1X and Network Access Control 36-3
Authentication Initiation and Message Exchange 36-3
Ports in Authorized and Unauthorized States 36-4
802.1X Host Mode 36-6
Single-Host Mode 36-7
Multiple-Hosts Mode 36-7
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xxiv OL-22250-01
Contents
Multidomain Authentication Mode 36-7
Multiauthentication Mode 36-8
Pre-Authentication Open Access 36-8
Using 802.1X with VLAN Assignment 36-9
Using 802.1X for Guest VLANs 36-10
Usage Guidelines for Using 802.1X Authentication with Guest VLANs 36-10
Usage Guidelines for Using 802.1X Authentication with Guest VLANs on Windows-XP
Hosts 36-11
Using 802.1X with MAC Authentication Bypass 36-11
Feature Interaction 36-12
Using 802.1X with Web-Based Authentication 36-13
Using 802.1X with Inaccessible Authentication Bypass 36-13
Using 802.1X with Unidirectional Controlled Port 36-14
Unidirectional State 36-14
Bidirectional State 36-14
Using 802.1X with Authentication Failed VLAN Assignment 36-14
Usage Guidelines for Using Authentication Failed VLAN Assignment 36-15
Using 802.1X with Port Security 36-16
Using 802.1X Authentication with ACL Assignments and Redirect URLs 36-17
Cisco Secure ACS and AV Pairs for URL-Redirect 36-17
ACLs 36-18
Using 802.1X with RADIUS-Provided Session Timeouts 36-18
Using 802.1X with Voice VLAN Ports 36-19
Using Multiple Domain Authentication and Multiple Authentication 36-20
How 802.1X Fails on a Port 36-21
Supported Topologies 36-21
Configuring 802.1X Port-Based Authentication 36-22
Default 802.1X Configuration 36-23
802.1X Configuration Guidelines 36-24
Enabling 802.1X Authentication 36-24
Configuring Switch-to-RADIUS-Server Communication 36-27
Configuring Multiple Domain Authentication and Multiple Authorization 36-29
Configuring 802.1X Authentication with ACL Assignments and Redirect URLs 36-32
Downloadable ACL 36-32
URL-Redirect 36-34
Configuring a Downloadable Policy 36-37
Configuring 802.1X Authentication with Per-User ACL and Filter-ID ACL 36-38
Per-User ACL and Filter-ID ACL 36-38
Configuring a Per-User ACL and Filter-ID ACL 36-44
Configuring RADIUS-Provided Session Timeouts 36-45
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xxv
Contents
Configuring 802.1X with Guest VLANs 36-46
Configuring 802.1X with MAC Authentication Bypass 36-48
Configuring 802.1X with Inaccessible Authentication Bypass 36-50
Configuring 802.1X with Unidirectional Controlled Port 36-52
Configuring 802.1X with Authentication Failed 36-53
Configuring 802.1X with Voice VLAN 36-54
Configuring 802.1X with VLAN Assignment 36-55
Cisco ACS Configuration for VLAN Assignment 36-56
Enabling Fallback Authentication 36-57
Enabling Periodic Reauthentication 36-61
Enabling Multiple Hosts 36-62
Changing the Quiet Period 36-63
Changing the Switch-to-Client Retransmission Time 36-63
Setting the Switch-to-Client Frame-Retransmission Number 36-64
Manually Reauthenticating a Client Connected to a Port 36-66
Initializing the 802.1X Authentication State 36-66
Removing 802.1X Client Information 36-66
Resetting the 802.1X Configuration to the Default Values 36-66
Displaying 802.1X Statistics and Status 36-67
Displaying Authentication Details 36-67
Determining the Authentication Methods Registered with the Auth Manager 36-67
Displaying the Auth Manager Summary for an Interface 36-67
Displaying the Summary of All Auth Manager Sessions on the Switch 36-68
Displaying a Summary of All Auth Manager Sessions on the Switch Authorized for a Specified
Authentication Method 36-68
Verifying the Auth Manager Session for an Interface 36-68
Displaying MAB Details 36-70
EPM Logging 36-70
-Cisco IOS Security Features in Cisco IOS XE 3.1.0 SG Release 36-71
CHAPTER 37 Configuring Web-Based Authentication 37-1
About Web-Based Authentication 37-1
Device Roles 37-2
Host Detection 37-2
Session Creation 37-3
Authentication Process 37-3
Customization of the Authentication Proxy Web Pages 37-4
Web-based Authentication Interactions with Other Features 37-4
Port Security 37-4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xxvi OL-22250-01
Contents
LAN Port IP 37-4
ACLs 37-5
Context-Based Access Control 37-5
802.1X Authentication 37-5
EtherChannel 37-5
Switchover 37-5
Configuring Web-Based Authentication 37-5
Default Web-Based Authentication Configuration 37-6
Web-Based Authentication Configuration Guidelines and Restrictions 37-6
Web-Based Authentication Configuration Task List 37-7
Configuring the Authentication Rule and Interfaces 37-7
Configuring AAA Authentication 37-8
Configuring Switch-to-RADIUS-Server Communication 37-8
Configuring the HTTP Server 37-10
Customizing the Authentication Proxy Web Pages 37-11
Specifying a Redirection URL for Successful Login 37-12
Configuring the Web-Based Authentication Parameters 37-13
Removing Web-Based Authentication Cache Entries 37-13
Displaying Web-Based Authentication Status 37-13
CHAPTER 38 Configuring Port Security 38-1
Command List 38-1
Port Security 38-3
Secure MAC Addresses 38-3
Maximum Number of Secure MAC Addresses 38-4
Aging Secure MAC Addresses 38-5
Sticky Addresses on a Port 38-5
Violation Actions 38-6
Invalid Packet Handling 38-6
Configuring Port Security on Access Ports 38-7
Configuring Port Security on Access Ports 38-7
Examples 38-10
Example 1: Setting Maximum Number of Secure Addresses 38-11
Example 2: Setting a Violation Mode 38-11
Example 3: Setting the Aging Timer 38-11
Example 4: Setting the Aging Timer Type 38-12
Example 5: Configuring a Secure MAC Address 38-12
Example 6: Configuring Sticky Port Security 38-13
Example 7: Setting a Rate Limit for Bad Packets 38-13
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xxvii
Contents
Example 8: Clearing Dynamic Secure MAC Addresses 38-14
Configuring Port Security on PVLAN Ports 38-14
Configuring Port Security on an Isolated Private VLAN Host Port 38-14
Example of Port Security on an Isolated Private VLAN Host Port 38-16
Configuring Port Security on a Private VLAN Promiscous Port 38-16
Example of Port Security on a Private VLAN Promiscous Port 38-17
Configuring Port Security on Trunk Ports 38-17
Configuring Trunk Port Security 38-17
Examples of Trunk Port Security 38-19
Example 1: Configuring a Maximum Limit of Secure MAC Addresses for all VLANs 38-19
Example 2: Configuring a Maximum Limit of Secure MAC Addresses for Specific VLANs 38-20
Example 3: Configuring Secure MAC Addresses in a VLAN Range 38-20
Trunk Port Security Guidelines and Restrictions 38-21
Port Mode Changes 38-22
Configuring Port Security on Voice Ports 38-22
Configuring Port Security on Voice Ports 38-23
Examples of Voice Port Security 38-25
Example 1: Configuring Maximum MAC Addresses for Voice and Data VLANs 38-25
Example 2: Configuring Sticky MAC Addresses for Voice and Data VLANs 38-26
Voice Port Security Guidelines and Restrictions 38-27
Displaying Port Security Settings 38-27
Examples 38-28
Example 1: Displaying Security Settings for the Entire Switch 38-28
Example 2: Displaying Security Settings for an Interface 38-29
Example 3: Displaying all Secure Addresses for the Entire Switch 38-29
Example 4: Displaying a Maximum Number of MAC Addresses on an Interface 38-30
Example 5: Displaying Security Settings on an Interface for a VLAN Range 38-30
Example 6: Displaying Secured MAC Addresses and Aging Information on an Interface 38-30
Example 7: Displaying Secured MAC Addresses for a VLAN Range on an Interface 38-30
Configuring Port Security with Other Features/Environments 38-31
DHCP and IP Source Guard 38-31
802.1X Authentication 38-32
Configuring Port Security in a Wireless Environment 38-32
Guidelines and Restrictions 38-33
CHAPTER 39 Configuring Control Plane Policing 39-1
About Control Plane Policing 39-2
CoPP Default Configuration 39-3
Configuring CoPP 39-3
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xxviii OL-22250-01
Contents
Configure CoPP for Control Plane Traffic 39-3
Configure CoPP for Data Plane and Management Plane Traffic 39-5
CoPP Configuration Guidelines and Restrictions 39-7
Monitoring CoPP 39-7
CHAPTER 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts 40-1
About DHCP Snooping 40-1
Trusted and Untrusted Sources 40-2
Overview of the DHCP Snooping Database Agent 40-2
Option-82 Data Insertion 40-4
Configuring DHCP Snooping 40-6
Default Configuration for DHCP Snooping 40-7
Enabling DHCP Snooping 40-7
Enabling DHCP Snooping on the Aggregation Switch 40-9
Enabling DHCP Snooping and Option 82 40-10
Enabling DHCP Snooping on Private VLAN 40-11
Configuring DHCP Snooping on Private VLAN 40-12
Configuring DHCP Snooping with an Ethernet Channel Group 40-12
Enabling the DHCP Snooping Database Agent 40-12
Limiting the Rate of Incoming DHCP Packets 40-13
Configuration Examples for the Database Agent 40-15
Example 1: Enabling the Database Agent 40-15
Example 2: Reading Binding Entries from a TFTP File 40-16
Example 3: Adding Information to the DHCP Snooping Database 40-18
Displaying DHCP Snooping Information 40-18
Displaying a Binding Table 40-18
Displaying the DHCP Snooping Configuration 40-19
About IP Source Guard 40-19
Configuring IP Source Guard 40-20
Configuring IP Source Guard on Private VLANs 40-22
Displaying IP Source Guard Information 40-22
Displaying IP Source Binding Information 40-23
CHAPTER 41 Configuring Dynamic ARP Inspection 41-1
About Dynamic ARP Inspection 41-1
ARP Cache Poisoning 41-2
Purpose of Dynamic ARP Inspection 41-2
Interface Trust State, Security Coverage and Network Configuration 41-3
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xxix
Contents
Relative Priority of Static Bindings and DHCP Snooping Entries 41-4
Logging of Dropped Packets 41-4
Rate Limiting of ARP Packets 41-4
Port Channels and Their Behavior 41-5
Configuring Dynamic ARP Inspection 41-5
Configuring Dynamic ARP Inspection in DHCP Environments 41-5
On Switch A 41-7
On Switch B 41-9
Configuring ARP ACLs for Non-DHCP Environments 41-11
Configuring the Log Buffer 41-14
Limiting the Rate of Incoming ARP Packets 41-16
Performing Validation Checks 41-19
CHAPTER 42 Configuring Network Security with ACLs 42-1
About ACLs 42-2
ACL Overview 42-2
Supported Features That Use ACLs 42-3
Router ACLs 42-3
Port ACLs 42-4
VLAN Maps 42-5
Hardware and Software ACL Support 42-5
TCAM Programming and ACLs 42-6
Troubleshooting High CPU Due to ACLs 42-6
Selecting Mode of Capturing Control Packets 42-7
Caveats and Restriction 42-7
Configuration 42-8
Layer 4 Operators in ACLs 42-9
Restrictions for Layer 4 Operations 42-9
Configuration Guidelines for Layer 4 Operations 42-10
How ACL Processing Impacts CPU 42-11
Configuring Unicast MAC Address Filtering 42-12
Configuring Named MAC Extended ACLs 42-12
Configuring EtherType Matching 42-14
Configuring Named IPv6 ACLs 42-15
Applying IPv6 ACLs to a Layer 2 Interface 42-16
Applying IPv6 ACLs to a Layer 3 Interface 42-16
Configuring VLAN Maps 42-17
VLAN Map Configuration Guidelines 42-18
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xxx OL-22250-01
Contents
Creating and Deleting VLAN Maps 42-19
Examples of ACLs and VLAN Maps 42-19
Applying a VLAN Map to a VLAN 42-21
Using VLAN Maps in Your Network 42-22
Denying Access to a Server on Another VLAN 42-23
Displaying VLAN Access Map Information 42-24
Using VLAN Maps with Router ACLs 42-25
Guidelines for Using Router ACLs and VLAN Maps on the Same VLAN 42-25
Examples of Router ACLs and VLAN Maps Applied to VLANs 42-25
ACLs and Switched Packets 42-25
ACLs and Routed Packets 42-26
Configuring PACLs 42-27
Creating a PACL 42-27
PACL Configuration Guidelines 42-28
Configuring IPv6, IP, and MAC ACLs on a Layer 2 Interface 42-28
Using PACL with Access-Group Mode 42-29
Configuring Access-group Mode on Layer 2 Interface 42-30
Applying ACLs to a Layer 2 Interface 42-30
Displaying an ACL Configuration on a Layer 2 Interface 42-31
Using PACL with VLAN Maps and Router ACLs 42-31
CHAPTER 43 Support for IPv6 43-1
Finding Feature Information 43-1
About IPv6 43-1
IPv6 Addressing and Basic Connectivity 43-2
DHCP 43-3
Security 43-3
QoS 43-3
Management 43-4
Multicast 43-4
Static Routes 43-4
First-Hop Redundancy Protocols 43-5
Unicast Routing 43-5
RIP 43-5
OSPF 43-5
EIGRP 43-6
Multiprotocol BGP 43-6
Tunneling 43-6
IPv6 Default States 43-7
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xxxi
Contents
CHAPTER 44 Port Unicast and Multicast Flood Blocking 44-1
About Flood Blocking 44-1
Configuring Port Blocking 44-1
Blocking Flooded Traffic on an Interface 44-2
Resuming Normal Forwarding on a Port 44-3
CHAPTER 45 Configuring Storm Control 45-1
About Storm Control 45-1
Hardware-based Storm Control Implementation 45-2
Software-based Storm Control Implementation 45-2
Enabling Broadcast Storm Control 45-3
Enabling Multicast Storm Control 45-4
Disabling Broadcast Storm Control 45-5
Disabling Multicast Storm Control 45-6
Displaying Storm Control 45-6
CHAPTER 46 Configuring SPAN and RSPAN 46-1
About SPAN and RSPAN 46-2
SPAN and RSPAN Concepts and Terminology 46-3
SPAN Session 46-3
Traffic Types 46-3
Source Port 46-4
Destination Port 46-5
VLAN-Based SPAN 46-5
SPAN Traffic 46-6
SPAN and RSPAN Session Limits 46-6
Default SPAN and RSPAN Configuration 46-6
Configuring SPAN 46-7
SPAN Configuration Guidelines and Restrictions 46-7
Configuring SPAN Sources 46-8
Configuring SPAN Destinations 46-9
Monitoring Source VLANs on a Trunk Interface 46-9
Configuration Scenario 46-10
Verifying a SPAN Configuration 46-10
CPU Port Sniffing 46-10
Encapsulation Configuration 46-12
Ingress Packets 46-12
Access List Filtering 46-13
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xxxii OL-22250-01
Contents
ACL Configuration Guidelines 46-13
Configuring Access List Filtering 46-14
Packet Type Filtering 46-14
Configuration Example 46-15
Configuring RSPAN 46-16
RSPAN Configuration Guidelines 46-16
Creating an RSPAN Session 46-17
Creating an RSPAN Destination Session 46-18
Creating an RSPAN Destination Session and Enabling Ingress Traffic 46-19
Removing Ports from an RSPAN Session 46-21
Specifying VLANs to Monitor 46-22
Specifying VLANs to Filter 46-23
Displaying SPAN and RSPAN Status 46-24
CHAPTER 47 Configuring System Message Logging 47-1
About System Message Logging 47-1
Configuring System Message Logging 47-2
System Log Message Format 47-2
Default System Message Logging Configuration 47-3
Disabling Message Logging 47-4
Setting the Message Display Destination Device 47-5
Synchronizing Log Messages 47-6
Enabling and Disabling Timestamps on Log Messages 47-7
Enabling and Disabling Sequence Numbers in Log Messages (Optional) 47-7
Defining the Message Severity Level (Optional) 47-8
Limiting Syslog Messages Sent to the History Table and to SNMP (Optional) 47-9
Configuring UNIX Syslog Servers 47-10
Logging Messages to a UNIX Syslog Daemon 47-10
Configuring the UNIX System Logging Facility 47-11
Displaying the Logging Configuration 47-12
CHAPTER 48 Configuring Onboard Failure Logging (OBFL) 48-1
Prerequisites for OBFL 48-1
Restrictions for OBFL 48-2
Information About OBFL 48-2
Overview of OBFL 48-2
Information about Data Collected by OBFL 48-2
OBFL Data Overview 48-2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xxxiii
Contents
Temperature 48-3
Operational Uptime 48-4
Interrupts 48-7
Message Logging 48-8
Default Settings for OBFL 48-9
Enabling OBFL 48-9
Configuration Examples for OBFL 48-10
Enabling OBFL Message Logging: Example 48-10
OBFL Message Log: Example 48-10
OBFL Component Uptime Report: Example 48-11
OBFL Report for a Specific Time: Example 48-11
CHAPTER 49 Configuring SNMP 49-1
About SNMP 49-1
SNMP Versions 49-2
SNMP Manager Functions 49-3
SNMP Agent Functions 49-4
SNMP Community Strings 49-4
Using SNMP to Access MIB Variables 49-4
SNMP Notifications 49-5
Configuring SNMP 49-5
Default SNMP Configuration 49-5
SNMP Configuration Guidelines 49-6
Disabling the SNMP Agent 49-7
Configuring Community Strings 49-7
Configuring SNMP Groups and Users 49-9
Configuring SNMP Notifications 49-11
Setting the Agent Contact and Location Information 49-15
Limiting TFTP Servers Used Through SNMP 49-15
SNMP Examples 49-16
Displaying SNMP Status 49-17
CHAPTER 50 Configuring Cisco IOS IP SLAs Operations 50-1
Command Table 50-2
About Cisco IOS IP SLAs 50-2
Using Cisco IOS IP SLAs to Measure Network Performance 50-3
IP SLAs Responder and IP SLAs Control Protocol 50-4
Response Time Computation for IP SLAs 50-5
IP SLAs Operation Scheduling 50-6
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xxxiv OL-22250-01
Contents
IP SLAs Operation Threshold Monitoring 50-6
Configuring IP SLAs Operations 50-7
Default Configuration 50-7
Configuration Guidelines 50-7
Configuring the IP SLAs Responder 50-8
Analyzing IP Service Levels by Using the UDP Jitter Operation 50-9
Analyzing IP Service Levels by Using the ICMP Echo Operation 50-11
Monitoring IP SLAs Operations 50-13
Cisco IOS XE IP SLAs Features in Cisco IOS XE 3.1.0 SG 50-14
CHAPTER 51 Configuring RMON 51-1
About RMON 51-1
Configuring RMON 51-3
Default RMON Configuration 51-3
Configuring RMON Alarms and Events 51-3
Configuring RMON Collection on an Interface 51-5
Displaying RMON Status 51-6
CHAPTER 52 Configuring Call Home 52-1
About Call Home 52-1
Obtaining Smart Call Home 52-2
Configuring Call Home 52-3
Configuring Contact Information 52-4
Configuring Destination Profiles 52-5
Copying a Destination Profile 52-6
Subscribing to Alert Groups 52-6
Configuring Periodic Notification 52-8
Configuring Message Severity Threshold 52-8
Configuring Syslog Pattern Matching 52-9
Configuring General E-Mail Options 52-9
Enabling Call Home 52-10
Disabling Call Home 52-10
Testing Call Home Communications 52-10
Sending a Call Home Test Message Manually 52-11
Sending a Call Home Alert Group Message Manually 52-11
Sending a Request for an Analysis and Report 52-12
Sending the Output of a Command 52-13
Configuring and Enabling Smart Call Home 52-13
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xxxv
Contents
Displaying Call Home Configuration Information 52-14
Default Settings 52-18
Alert Group Trigger Events and Commands 52-18
Message Contents 52-21
Sample Syslog Alert Notification in Long-Text Format 52-25
Sample Syslog Alert Notification in XML Format 52-34
CHAPTER 53 Performing Diagnostics 53-1
Configuring Online Diagnostics 53-1
Configuring On-Demand Online Diagnostics 53-1
Scheduling Online Diagnostics 53-2
Performing Diagnostics 53-2
Starting and Stopping Online Diagnostic Tests 53-3
Displaying Online Diagnostic Tests and Test Results 53-4
Line card Online Diagnostics 53-7
Troubleshooting with Online Diagnostics 53-7
Power-On Self-Test Diagnostics 53-9
Overview 53-9
Sample POST Results 53-10
Power-On Self-Test Results for Supervisor Engine V-10GE 53-14
POST on the Active Supervisor Engine 53-14
Sample POST Results on an Active Supervisor Engine 53-15
POST on a Standby Supervisor Engine 53-17
Sample Display of the POST on a Standby Supervisor Engine 53-17
Troubleshooting the Test Failures 53-20
CHAPTER 54 ROM Monitor 54-1
Entering the ROM Monitor 54-1
ROM Monitor Commands 54-2
Command Descriptions 54-2
Configuration Register 54-3
Debug Commands 54-4
Exiting the ROM Monitor 54-5
Digital Signing 54-6
CHAPTER 55 Configuring MIB Support 55-1
Determining MIB Support for Cisco IOS Releases 55-1
Using Cisco IOS MIB Tools 55-2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xxxvi OL-22250-01
Contents
Downloading and Compiling MIBs 55-2
Considerations for Working with MIBs 55-2
Downloading MIBs 55-3
Compiling MIBs 55-4
Enabling SNMP Support 55-4
Acronyms and Abbreviations A-1
INDEX
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xxxvii
Contents
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xxxviii OL-22250-01
Preface
This preface describes who should read this document, how it is organized, and its conventions. The
preface also tells you how to obtain Cisco documents, as well as how to obtain technical assistance.
Audience
This guide is for experienced network administrators who are responsible for configuring and
maintaining Catalyst 4500 series switches.
Organization
This guide is organized into the following chapters:
Chapter Title Description
Chapter 1 Product Overview Presents an overview of the Cisco IOS software for
the Catalyst 4500 series switches.
Chapter 2 Command-Line Interfaces Describes how to use the CLI.
Chapter 3 Configuring the Switch for the Describes how to perform a baseline configuration
First Time of the switch.
Chapter 4 Administering the Switch Describes how to administer the switch.
Chapter 6 Configuring the Cisco IOS XE In Describes how to configure ISSU on the switch.
Service Software Upgrade Process
Chapter 7 Configuring Interfaces Describes how to configure non-layer-specific
features on Fast Ethernet, Gigabit Ethernet, and
10-Gigabit Ethernet interfaces.
Chapter 8 Checking Port Status and Describes how to check module and interface status.
Connectivity
Chapter 5 Configuring Supervisor Engine Describes how to configure RPR and SSO on the
Redundancy Using RPR and SSO Catalyst 4507R and 4510R switches.
Chapter 9 Configuring Cisco NSF with SSO Describes how to configure supervisor engine
Supervisor Engine Redundancy redundancy using Cisco nonstop forwarding (NSF)
with stateful switchover (SSO).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xxxix
Preface
Chapter Title Description
Chapter 10 Environmental Monitoring and Describes how to configure power management and
Power Management environmental monitoring features.
Chapter 11 Configuring Power over Ethernet Describes how to configure Power over Ethernet
(PoE).
Chapter 12 Configuring VLANs, VTP, Describes how to configure VLANs, VTP, and
and VMPS VMPS.
Chapter 13 Configuring IP Unnumbered Describes how to configure IP Unnumbered
Interface support.
Chapter 14 Configuring Layer 2 Ethernet Describes how to configure interfaces to support
Interfaces Layer 2 features, including VLAN trunks.
Chapter 15 Configuring SmartPort Macros Describes how to configure SmartPort macros.
Chapter 16 Configuring STP and MST Describes how to configure the Spanning Tree
Protocol (STP) and the Multiple Spanning Tree
(MST) protocol and explains how they work.
Chapter 18 Configuring Optional STP Describes how to configure the spanning-tree
Features PortFast, UplinkFast, BackboneFast, and other STP
features
Chapter 19 Configuring EtherChannel Describes how to configure Layer 2 and Layer 3
EtherChannel port bundles.
Chapter 20 Configuring CDP Describes how to configure the Cisco Discovery
Protocol (CDP).
Chapter 21 Configuring IGMP Snooping and Describes how to configure Internet Group
Filtering Management Protocol (IGMP) snooping.
Chapter 22 Configuring IPv6 MLD Snooping Describes how to configure IPv6 MLD Snooping.
Chapter 23 Configuring LLDP, and Describes how to configure Link Layer Discovery
LLDP-MED Protocol (LLDP).
Chapter 24 Configuring UDLD Describes how to configure the UniDirectional Link
Detection (UDLD) protocol.
Chapter 25 Configuring Unidirectional Describes how to configure Unidirectional
Ethernet Ethernet.
Chapter 26 Configuring Layer 3 Interfaces Describes how to configure interfaces to support
Layer 3 features.
Chapter 27 Configuring Cisco Express Describes how to configure Cisco Express
Forwarding Forwarding (CEF) for IP unicast traffic.
Chapter 28 Configuring Unicast Reverse Path Describes how to configure Unicast Reverse Path
Forwarding Forwarding.
Chapter 29 Configuring IP Multicast Describes how to configure IP Multicast Multilayer
Switching (MMLS).
Chapter 30 Configuring Policy-Based Describes how to configure policy-based routing.
Routing
Chapter 31 Configuring VRF-lite Describes how to configure multiple VPN
routing/forwarding (multi-VRF) instances in
customer edge (CE) devices.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xl OL-22250-01
Preface
Chapter Title Description
Chapter 32 Configuring Flexible NetFlow Describes how to configure Flexible NetFlow.
Chapter 33 Configuring Quality of Service Describes how to configure quality of service
(QoS).
Chapter 34 Configuring Voice Interfaces Describes how to configure voice interfaces.
Chapter 35 Configuring Private VLANs Describes how to set up and modify private VLANs.
Chapter 36 Configuring 802.1X Port-Based Describes how to conf.igure 802.1X port-based
Authentication authentication
Chapter 37 Configuring Web-Based Describes how to configure web-based
Authentication authentication.
Chapter 38 Configuring Port Security Describes how to configure port security and trunk
port security.
Chapter 39 Configuring Control Plane Describes how to protect your Catalyst 4500 series
Policing switch using control plane policing (CoPP).
Chapter 40 Configuring DHCP Snooping, IP Describes how to configure DHCP snooping and IP
Source Guard, and IPSG for Static Source Guard.
Hosts
Chapter 41 Configuring Dynamic ARP Describes how to configure Dynamic ARP
Inspection Inspection.
Chapter 42 Configuring Network Security Describes how to configure ACLS, VACLs, and
with ACLs MACLs.
Chapter 43 Support for IPv6 Describes the IPv6 support on the switch.
Chapter 44 Port Unicast and Multicast Flood Describes how to configure unicast flood blocking.
Blocking
Chapter 45 Configuring Storm Control Describes how to configure storm control
suppression.
Chapter 46 Configuring SPAN and RSPAN Describes how to configure the Switched Port
Analyzer (SPAN).
Chapter 47 Configuring System Message Describes how to configure system message
Logging logging.
Chapter 48 Configuring Onboard Failure Describes how to configure OBFL.
Logging (OBFL)
Chapter 49 Configuring SNMP Describes how to configure the Simple Network
Management Protocol (SNMP).
Chapter 50 Configuring Cisco IOS IP SLAs Describes how to configure Cisco IOS IP SLA
Operations operations.
Chapter 51 Configuring RMON Describes how to configure Remote Network
Monitoring (RMON).
Chapter 52 Configuring Call Home Describes how to configure Call Home.
Chapter 53 Performing Diagnostics Describes vaious types of diagnostics on the
Catalyst 4500 series switch.
Chapter 54 ROM Monitor Describes the ROM Monitor.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xli
Preface
Chapter Title Description
Chapter 55 Configuring MIB Support Describes how to configure configure SNMP and
MIB support.
Appendix A Acronyms and Abbreviations Defines acronyms and abbreviations used in this
book.
Notices
The following notices pertain to this software license.
OpenSSL/Open SSL Project
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit
(http://www.openssl.org/).
This product includes cryptographic software written by Eric Young ([email protected]).
This product includes software written by Tim Hudson ([email protected]).
License Issues
The OpenSSL toolkit stays under a dual license, i.e. both the conditions of the OpenSSL License and the
original SSLeay license apply to the toolkit. See below for the actual license texts. Actually both licenses
are BSD-style Open Source licenses. In case of any license issues related to OpenSSL please contact
[email protected].
OpenSSL License:
Copyright © 1998-2007 The OpenSSL Project. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided
that the following conditions are met:
1. Redistributions of source code must retain the copyright notice, this list of conditions and the
following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and
the following disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following
acknowledgment: “This product includes software developed by the OpenSSL Project for use in the
OpenSSL Toolkit (http://www.openssl.org/)”.
4. The names “OpenSSL Toolkit” and “OpenSSL Project” must not be used to endorse or promote
products derived from this software without prior written permission. For written permission, please
contact [email protected].
5. Products derived from this software may not be called “OpenSSL” nor may “OpenSSL” appear in
their names without prior written permission of the OpenSSL Project.
6. Redistributions of any form whatsoever must retain the following acknowledgment:
“This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit
(http://www.openssl.org/)”.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xlii OL-22250-01
Preface
THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT “AS IS”' AND ANY EXPRESSED OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
NO EVENT SHALL THE OpenSSL PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.
This product includes cryptographic software written by Eric Young ([email protected]). This product
includes software written by Tim Hudson ([email protected]).
Original SSLeay License:
Copyright © 1995-1998 Eric Young ([email protected]). All rights reserved.
This package is an SSL implementation written by Eric Young ([email protected]).
The implementation was written so as to conform with Netscapes SSL.
This library is free for commercial and non-commercial use as long as the following conditions are
adhered to. The following conditions apply to all code found in this distribution, be it the RC4, RSA,
lhash, DES, etc., code; not just the SSL code. The SSL documentation included with this distribution is
covered by the same copyright terms except that the holder is Tim Hudson ([email protected]).
Copyright remains Eric Young’s, and as such any Copyright notices in the code are not to be removed.
If this package is used in a product, Eric Young should be given attribution as the author of the parts of
the library used. This can be in the form of a textual message at program startup or in documentation
(online or textual) provided with the package.
Redistribution and use in source and binary forms, with or without modification, are permitted provided
that the following conditions are met:
1. Redistributions of source code must retain the copyright notice, this list of conditions and the
following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
the following disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following
acknowledgement:
“This product includes cryptographic software written by Eric Young ([email protected])”.
The word ‘cryptographic’ can be left out if the routines from the library being used are not
cryptography-related.
4. If you include any Windows specific code (or a derivative thereof) from the apps directory
(application code) you must include an acknowledgement: “This product includes software written
by Tim Hudson ([email protected])”.
THIS SOFTWARE IS PROVIDED BY ERIC YOUNG “AS IS” AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xliii
Preface
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The license and distribution terms for any publicly available version or derivative of this code cannot be
changed. i.e. this code cannot simply be copied and put under another distribution license [including the
GNU Public License].
Conventions
This document uses the following typographical conventions:
Convention Description
boldface font Commands, command options, and keywords are in boldface.
italic font Command arguments for which you supply values are in italics.
[ ] Command elements in square brackets are optional.
{x|y|z} Alternative keywords in command lines are grouped in braces and separated by
vertical bars.
[x|y|z] Optional alternative keywords are grouped in brackets and separated by vertical
bars.
string A nonquoted set of characters. Do not use quotation marks around the string
because the string will include the quotation marks.
screen font System displays are in screen font.
boldface screen Information you must enter verbatim is in boldface screen font.
font
italic screen font Arguments for which you supply values are in italic screen font.
This pointer highlights an important line of text in an example.
^ Represents the key labeled Control—for example, the key combination ^D in a
screen display means hold down the Control key while you press the D key.
< > Nonprinting characters such as passwords are in angle brackets.
Notes use the following conventions:
Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the
publication.
Cautions use the following conventions:
Caution Means reader be careful. In this situation, you might do something that could result in equipment
damage or loss of data.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xliv OL-22250-01
Preface
Related Documentation
Commands in Task Tables
Commands listed in task tables show only the relevant information for completing the task and not all
available options for the command. For a complete description of a command, refer to the command in
the Catalyst 4500 Series Switch Cisco IOS Command Reference.
Related Documentation
Refer to the following documents for additional Catalyst 4500 series information:
• Catalyst 4500 Series Switch Documentation Home
http://www.cisco.com/en/US/products/hw/switches/ps4324/tsd_products_support_series_home.ht
mll
Hardware Documents
Installation guides and notes including specifications and relevant safety information are available at the
following URLs:
• Catalyst 4500 Series Switches Installation Guide
http://www.cisco.com/en/US/docs/switches/lan/catalyst4500/hardware/installation/guide/78-14409
-08/4500inst.html
• Catalyst 4500 E-series Switches Installation Guide
http://www.cisco.com/en/US/docs/switches/lan/catalyst4500/hardware/catalyst4500e/installation/g
uide/Eseries.html
• For information about individual switching modules and supervisors, refer to the Catalyst 4500
Series Module Installation Guide at:
http://www.cisco.com/en/US/docs/switches/lan/catalyst4500/hardware/configuration/notes/OL_25
315.html
• Regulatory Compliance and Safety Information for the Catalyst 4500 Series Switches
http://www.cisco.com/en/US/docs/switches/lan/catalyst4500/hardware/regulatory/compliance/78_
13233.html
• Installation notes for specific supervisor engines or for accessory hardware are available at:
http://www.cisco.com/en/US/products/hw/switches/ps4324/prod_installation_guides_list.html
Software Documentation
Software release notes, configuration guides, command references, and system message guides are
available at the following URLs:
• Catalyst 4500 release notes are available at:
http://www.cisco.com/en/US/products/hw/switches/ps4324/prod_release_notes_list.html
Software documents for the Catalyst 4500 Classic and Catalyst 4500 E-Series are available at the
following URLs:
• Catalyst 4500 Series Software Configuration Guide
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 xlv
Preface
Obtaining Documentation and Submitting a Service Request
http://www.cisco.com/en/US/products/hw/switches/ps4324/products_installation_and_configurati
on_guides_list.html
• Catalyst 4500 Series Software Command Reference
http://www.cisco.com/en/US/products/hw/switches/ps4324/prod_command_reference_list.html
• Catalyst 4500 Series Software System Message Guide
http://www.cisco.com/en/US/products/hw/switches/ps4324/products_system_message_guides_list
.html
Cisco IOS Documentation
Platform- independent Cisco IOS documentation may also apply to the Catalyst 4500 and 4900 switches.
These documents are available at the following URLs:
• Cisco IOS configuration guides, Release 12.x
http://www.cisco.com/en/US/products/ps6350/products_installation_and_configuration_guides_list.html
• Cisco IOS command references, Release 12.x
http://www.cisco.com/en/US/products/ps6350/prod_command_reference_list.html
You can also use the Command Lookup Tool at:
http://tools.cisco.com/Support/CLILookup/cltSearchAction.do
• Cisco IOS system messages, version 12.x
http://www.cisco.com/en/US/products/ps6350/products_system_message_guides_list.html
You can also use the Error Message Decoder tool at:
http://www.cisco.com/pcgi-bin/Support/Errordecoder/index.cgi
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional
information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and
revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed
and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free
service and Cisco currently supports RSS Version 2.0.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
xlvi OL-22250-01
CH A P T E R 1
Product Overview
This chapter provides an overview of Catalyst 4500 series switches and includes the following major
sections:
• Layer 2 Software Features, page 1-1
• Layer 3 Software Features, page 1-8
• Management Features, page 1-15
• Security Features, page 1-20
Note For complete syntax and usage information for the switch commands used in this chapter, first look at
the Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products//hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Series Switch Command Reference, it will be found in
the larger Cisco IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference
and related publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Layer 2 Software Features
The following subsections describe the key Layer 2 switching software features on the
Catalyst 4500 series switch:
• Cisco Discovery Protocol, page 1-2
• Cisco Group Management Protocol (CGMP) server, page 1-2
• EtherChannel Bundles, page 1-2
• Flexible NetFlow, page 1-2
• Internet Group Management Protocol (IGMP) Snooping, page 1-3
• IPv6 Multicast Listen Discovery (MLD) and Multicast Listen Discovery snooping, page 1-3
• Jumbo Frames, page 1-3
• Link Aggregation Control Protocol, page 1-4
• Link Layer Discovery Protocol, page 1-4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-1
Chapter 1 Product Overview
Layer 2 Software Features
• Multiple Spanning Tree, page 1-5
• Per-VLAN Rapid Spanning Tree, page 1-5
• Quality of Service, page 1-5
• Spanning Tree Protocol, page 1-6
• Stateful Switchover, page 1-6
• SVI Autostate, page 1-6
• Unidirectional Ethernet, page 1-7
• VLANs, page 1-7
• User Based Rate Limiting, page 1-7
• Virtual Switch System Client, page 1-7
• VLANs, page 1-7
Cisco Discovery Protocol
The Cisco Discovery Protocol (CDP) is a device-discovery protocol that is both media- and
protocol-independent. CDP is available on all Cisco products, including routers, switches, bridges, and
access servers. Using CDP, a device can advertise its existence to other devices and receive information
about other devices on the same LAN. CDP enables Cisco switches and routers to exchange information,
such as their MAC addresses, IP addresses, and outgoing interfaces. CDP runs over the data-link layer
only, allowing two systems that support different network-layer protocols to learn about each other. Each
device configured for CDP sends periodic messages to a multicast address. Each device advertises at
least one address at which it can receive Simple Network Management Protocol (SNMP) messages.
For information on configuring CDP, see Chapter 20, “Configuring CDP.”
Cisco Group Management Protocol (CGMP) server
CGMP server manages multicast traffic. Multicast traffic is forwarded only to ports with attached hosts
that request the multicast traffic.
EtherChannel Bundles
EtherChannel port bundles allow you to create high-bandwidth connections between two switches by
grouping multiple ports into a single logical transmission path.
For information on configuring EtherChannel, see Chapter 19, “Configuring EtherChannel.”
Flexible NetFlow
Flow is defined as unique set of key fields attributes, which might include fields of packet, packet routing
attributes, and input and output interface information. A NetFlow feature defines a flow as a sequence
of packets that have the same values for the feature key fields. Flexible Netflow (FNF) allows a flow
record that specifies various flow attributes to be collected and optionally exported. Netflow collection
supports IP, IPv6 and Layer 2 traffic.
For information on configuring Flexible NetFlow, see Chapter 32, “Configuring Flexible NetFlow.”
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-2 OL-22250-01
Chapter 1 Product Overview
Layer 2 Software Features
Internet Group Management Protocol (IGMP) Snooping
IGMP snooping manages multicast traffic. The switch software examines IP multicast packets and
forwards packets based on their content. Multicast traffic is forwarded only to ports with attached
hosts that request multicast traffic.
Support for IGMPv3 provides constrained flooding of multicast traffic in the presence of IGMPv3
hosts or routers. IGMPv3 snooping listens to IGMPv3 query and membership report messages to
maintain host-to-multicast group associations. It enables a switch to propagate multicast data only
to ports that need it. IGMPv3 snooping is fully interoperable with IGMPv1 and IGMPv2.
Explicit Host Tracking (EHT) is an extension to IGMPv3 snooping. EHT enables immediate leave
operations on a per-port basis. EHT can be used to track per host membership information or to
gather statistics about all IGMPv3 group members.
The IGMP Snooping Querier is a Layer 2 feature required to support IGMP snooping in a VLAN
where PIM and IGMP are not configured because the multicast traffic does not require routing.
With SSO support, Stateful IGMP Snooping propagates the IGMP data learned by the active
supervisor engine to the redundant supervisor engine so that when a switchover occurs, the newly
active supervisor engine is aware of the multicast group membership, which alleviates a disruption
to multicast traffic during a switchover.
For information on configuring IGMP snooping, see Chapter 21, “Configuring IGMP Snooping and
Filtering.”
IPv6 Multicast Listen Discovery (MLD) and Multicast Listen Discovery snooping
MLD is a protocol used by IPv6 multicast devices to discover the presence of multicast listeners
(nodes that want to receive IPv6 multicast packets) on its directly attached links and to discover
which multicast packets are of interest to neighboring nodes. MLD snooping is supported in two
different versions: MLD v1 and MLD v2. Network switches use MLD snooping to limit the flood
of multicast traffic, causing IPv6 multicast data to be selectively forwarded to a list of ports that want
to receive the data, instead of being flooded to all ports in a VLAN. This lessens the load on devices
in the network, minimizing unnecessary bandwidth on links, enabling efficient distribution of IPv6
multicast data.
For information on configuring multicast services, see Chapter 22, “Configuring IPv6 MLD
Snooping.”
Jumbo Frames
The jumbo frames feature allows the switch to forward packets as large as 9216 bytes (larger than the
IEEE Ethernet MTU), rather than declare those frames “oversize” and discard them. This feature is
typically used for large data transfers. The jumbo frames feature can be configured on a per-port basis
on Layer 2 and Layer 3 interfaces.
The feature is supported only on the following hardware:
• WS-X4306-GB: All ports
• WS-X4232-GB-RJ: Ports 1-2
• WS-X4418-GB: Ports 1-2
• WS-X4412-2GB-TX: Ports 13-14
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-3
Chapter 1 Product Overview
Layer 2 Software Features
• WS-4648-RJ45V-E
• WS-X4648+RJ45V+E
• WS-X4706-10GE linecards
• supervisor engine uplink ports
For information on Jumbo Frames, see Chapter 7, “Configuring Interfaces.”
Link Aggregation Control Protocol
LACP supports the automatic creation of EtherChannels by exchanging LACP packets between LAN
ports. LACP packets are exchanged only between ports in passive and active modes. The protocol
"learns" the capabilities of LAN port groups dynamically and informs the other LAN ports. After LACP
identifies correctly matched Ethernet links, it facilitates grouping the links into an EtherChannel. Then
the EtherChannel is added to the spanning tree as a single bridge port.
Cisco IOS XE IP Application Services Features in Cisco IOS XE 3.1.0SG
This section lists the IP Application Services software features that are supported in Cisco IOS XE
3.1.0SG. Links to the feature documentation are included.
Feature guides may contain information about more than one feature. To find information about a
specific feature within a feature guide, see the Feature Information table at the end of the guide.
Feature guides document features that are supported on many different software releases and platforms.
Your Cisco software release or platform may not support all the features documented in a feature guide.
See the Feature Information table at the end of the feature guide for information about which features in
that guide are supported in your software release. Use Cisco Feature Navigator to find information about
platform support and Cisco software image support. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
IEEE 802.3ad Link Aggregation (LACP)
http://www.cisco.com/en/US/docs/ios/cether/configuration/guide/ce_lnkbndl.html
Link Aggregation Control Protocol (LACP) (802.3ad) for Gigabit Interfaces
http://www.cisco.com/en/US/docs/ios/ios_xe/cether/configuration/guide/ce_lnkbndl_xe.html l
Link Layer Discovery Protocol
To support non-Cisco devices and to allow for interoperability between other devices, the switch
supports the IEEE 802.1AB LLDP. Link Layer Discovery Protocol (LLDP) is a neighbor discovery
protocol that is used for network devices to advertise information about themselves to other devices on
the network. This protocol runs over the data-link layer, which allows two systems running different
network layer protocols to learn about each other.
LLDP supports a set of attributes that it uses to discover neighbor devices. These attributes contain type,
length, and value descriptions and are referred to as TLVs. LLDP supported devices can use TLVs to receive
and send information to their neighbors. Details such as configuration information, device capabilities,
and device identity can be advertised using this protocol.
For information on configuring LLDP, see Chapter 23, “Configuring LLDP, and LLDP-MED.”
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-4 OL-22250-01
Chapter 1 Product Overview
Layer 2 Software Features
Multiple Spanning Tree
IEEE 802.1s Multiple Spanning Tree (MST) allows for multiple spanning tree instances within a single
802.1Q or Inter-Switch Link (ISL) VLAN trunk. MST extends the IEEE 802.1w Rapid Spanning Tree
(RST) algorithm to multiple spanning trees. This extension provides both rapid convergence and load
balancing within a VLAN environment.
MST allows you to build multiple spanning trees over trunks. You can group and associate VLANs to
spanning tree instances. Each instance can have a topology independent of other spanning tree instances.
This new architecture provides multiple forwarding paths for data traffic and enables load balancing.
Network fault tolerance is improved because a failure in one instance (forwarding path) does not affect
other instances (forwarding paths).
For information on configuring MST, see Chapter 16, “Configuring STP and MST.”
Per-VLAN Rapid Spanning Tree
Per-VLAN Rapid Spanning Tree (PVRST+) is the implementation of 802.1w on a per-VLAN basis. It is
the same as PVST+ with respect to STP mode and runs RSTP protocol based on 802.1w.
For information on configuring PVRST+, see Chapter 16, “Configuring STP and MST.”
Quality of Service
The quality of service (QoS) feature prevents congestion by selecting network traffic and prioritizing it
according to its relative importance. Implementing QoS in your network makes network performance
more predictable and bandwidth use more effective.
The Catalyst 4500 series switch supports the following QoS features:
• Classification and marking
• Ingress and egress policing, including per-port per-VLAN policing
• Sharing and shaping
Catalyst 4500 series switch supports trusted boundary, which uses the Cisco Discovery Protocol (CDP)
to detect the presence of a Cisco IP phone (such as the Cisco IP Phone 7910, 7935, 7940, and 7960) on
a switch port. If the telephone is not detected, the trusted boundary feature disables the trusted setting
on the switch port and prevents misuse of a high-priority queue.
The Catalyst 4500 series switch also supports QoS Automation (Auto QoS), which simplifies the
deployment of existing QoS features through automatic configuration.
Cisco Modular QoS command-line-interface
Cisco Modular QoS CLI (MQC) is the framework that implements Cisco IOS software QoS. MQC
allows the user to define a traffic class, create a traffic policy (containing the QoS feature to be applied
to the traffic class), and attach the traffic policy to an interface. MQC is a cross-Cisco baseline that
provides a consistent syntax and behavior of QoS features across multiple product families. MQC
enables rapid deployment of new features and technology innovations and facilitates the management of
network performance with respect to bandwidth, delay, jitter, and packet loss, enhancing the
performance of mission-critical business applications. The rich and advanced QoS features that are
supported as part of the Supervisor Engine 7-E are enabled using Cisco MQC.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-5
Chapter 1 Product Overview
Layer 2 Software Features
The Two-Rate Three-Color Policing feature (also termed Hierarchical QoS) limits the input or output
transmission rate of a class of traffic based on user-defined criteria and marks or colors packets by setting
the applicable differentiated services code point (DSCP) values. This feature is often configured on the
interfaces at the edge of a network to limit the rate of traffic entering or leaving the network. Using this
feature, traffic that conforms to user-defined criteria can be sent through the interfaces, while traffic that
exceeds or violates these criteria is sent out with a decreased priority setting or even dropped.
For information on QoS and Auto QoS, see Chapter 33, “Configuring Quality of Service.”
Spanning Tree Protocol
The Spanning Tree Protocol (STP) allows you to create fault-tolerant internetworks that ensure an active,
loop-free data path between all nodes in the network. STP uses an algorithm to calculate the best
loop-free path throughout a switched network.
For information on configuring STP, see Chapter 16, “Configuring STP and MST.”
The Catalyst 4500 series switch supports the following STP enhancements:
• Spanning tree PortFast—PortFast allows a port with a directly attached host to transition to the
forwarding state directly, bypassing the listening and learning states.
• Spanning tree UplinkFast—UplinkFast provides fast convergence after a spanning-tree topology
change and achieves load balancing between redundant links using uplink groups. Uplink groups
provide an alternate path in case the currently forwarding link fails. UplinkFast is designed to
decrease spanning-tree convergence time for switches that experience a direct link failure.
• Spanning tree BackboneFast—BackboneFast reduces the time needed for the spanning tree to
converge after a topology change caused by an indirect link failure. BackboneFast decreases
spanning-tree convergence time for any switch that experiences an indirect link failure.
• Spanning tree root guard—Root guard forces a port to become a designated port so that no switch
on the other end of the link can become a root switch.
For information on the STP enhancements, see Chapter 18, “Configuring Optional STP Features.”
Stateful Switchover
Stateful switchover (SSO) enables you to propagate configuration and state information from the active
to the redundant supervisor engine so that sub-second interruptions in Layer 2 traffic occur when the
active supervisor engine switches over to the redundant supervisor engine.
For information about SSO, see Chapter 9, “Configuring Cisco NSF with SSO Supervisor Engine
Redundancy.”
SVI Autostate
When an SVI has multiple ports on a VLAN, normally the SVI will go down when all the ports in the
VLAN go down. You can design your network so that some ports are not counted in the calculation of
SVI “going up or down.” SVI Autostate provides a knob to mark a port so that it is not counted in the
SVI “going up and down” calculation and applies to all VLANs that are enabled on that port.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-6 OL-22250-01
Chapter 1 Product Overview
Layer 2 Software Features
Unidirectional Ethernet
Note Unidirectional Ethernet is not supported on either Supervisor Engine 6-E or a Catalyst 4900M chassis.
Unidirectional Ethernet uses only one strand of fiber for either transmitting or receiving one-way traffic
for the Gigaport, instead of two strands of fiber for a full-duplex Gigaport Ethernet.
For information about Unidirectional Ethernet, see Chapter 25, “Configuring Unidirectional Ethernet.”
UniDirectional Link Detection
The UniDirectional Link Detection (UDLD) protocol allows devices connected through fiber-optic or
copper Ethernet cables to monitor the physical configuration of the cables and detect a unidirectional
link.
For information about UDLD, see Chapter 24, “Configuring UDLD.”
User Based Rate Limiting
User Based Rate Limiting (UBRL) enables you to adopt microflow policing to dynamically learn traffic
flows and rate limit each unique flow to an individual rate. UBRL is available only on the Supervisor
Engine V-10GE with the built-in NetFlow support.
For information about UBRL, see the “Flow-based QoS” section on page 33-10.
Virtual Switch System Client
Catalyst 4500 series switches support enhanced PAgP. If a Catalyst 4500 series switch is connected to a
Catalyst 6500 series Virtual Switch System (VSS) via a PAgP EtherChannel, the Catalyst 4500 series
switch will automatically serve as a VSS client, using enhanced PAgP on this EtherChannel for
dual-active detection. This VSS client feature has no impact on the performance of Catalyst 4500 series
switches and does not require any user configuration.
For information on VSS, see Chapter 19, “Configuring EtherChannel.”
VLANs
A VLAN configures switches and routers according to logical, rather than physical, topologies. Using
VLANs, you can combine any collection of LAN segments within an internetwork into an autonomous
user group, such that the segments appear as a single LAN in the network. VLANs logically segment the
network into different broadcast domains so that packets are switched only between ports within the
VLAN. Typically, a VLAN corresponds to a particular subnet, although not necessarily.
For more information about VLANs, VTP, and Dynamic VLAN Membership, see Chapter 12,
“Configuring VLANs, VTP, and VMPS.”
The following VLAN-related features also are supported:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-7
Chapter 1 Product Overview
Layer 3 Software Features
• VLAN Trunking Protocol (VTP)—VTP maintains VLAN naming consistency and connectivity
between all devices in the VTP management domain. You can have redundancy in a domain by using
multiple VTP servers, through which you can maintain and modify the global VLAN information.
Only a few VTP servers are required in a large network.
• Private VLANs—Private VLANs are sets of ports that have the features of normal VLANs and also
provide some Layer 2 isolation from other ports on the switch.
For information about private VLANs, see Chapter 35, “Configuring Private VLANs.”
• Private VLAN Trunk Ports—Private VLAN trunk ports allow a secondary port on a private VLAN
to carry multiple secondary VLANs.
• Private VLAN Promiscuous Trunk Ports—Private VLAN promiscuous trunk extends the
promiscuous port to a 802.1Q trunk port, carrying multiple primary VLANs (hence multiple
subnets). Private VLAN promiscuous trunk is typically used to offer different services or content
on different primary VLANs to isolated subscribers. Secondary VLANs can not be carried over the
private VLAN promiscuous trunk.
• Dynamic VLAN Membership—Dynamic VLAN Membership allows you to assign switch ports to
VLANs dynamically, based on the source Media Access Control (MAC) address of the device
connected to the port. When you move a host from a port on one switch in the network to a port on
another switch in the network, that switch dynamically assigns the new port to the proper VLAN for
that host. With the VMPS Client feature, you can convert a dynamic access port to a VMPS client.
VMPS clients can use VQP queries to communicate with the VMPS server to obtain a VLAN
assignment for the port based on the MAC address of the host attached to that port.
Layer 3 Software Features
A Layer 3 switch is a high-performance switch that has been optimized for a campus LAN or an intranet,
and it provides both wirespeed Ethernet routing and switching services. Layer 3 switching improves
network performance with two software functions: route processing and intelligent network services.
Compared to conventional software-based switches, Layer 3 switches process more packets faster by
using application-specific integrated circuit (ASIC) hardware instead of microprocessor-based engines.
The following sections describe the key Layer 3 switching software features on the Catalyst 4500 series
switch:
• Cisco Express Forwarding, page 1-9
• Enhanced Object Tracking, page 1-9
• GLBP, page 1-9
• HSRP, page 1-10
• IP Routing Protocols, page 1-11
• In Service Software Upgrade, page 1-14
• Multicast Services, page 1-14
• NSF with SSO, page 1-14
• Policy-Based Routing, page 1-14
• Unidirectional Link Routing, page 1-15
• Unicast Reverse Path Forwarding, page 1-15
• VRF-lite, page 1-15
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-8 OL-22250-01
Chapter 1 Product Overview
Layer 3 Software Features
• Virtual Router Redundancy Protocol, page 1-15
Cisco Express Forwarding
Cisco Express Forwarding (CEF) is an advanced Layer 3 IP-switching technology. CEF optimizes
network performance and scalability in networks with large and dynamic traffic patterns, such as the
Internet, and on networks that use intensive web-based applications or interactive sessions. Although
you can use CEF in any part of a network, it is designed for high-performance, highly resilient Layer 3
IP-backbone switching.
For information on configuring CEF, see Chapter 27, “Configuring Cisco Express Forwarding.”
Enhanced Object Tracking
Before the introduction of the Enhanced Object Tracking feature, the Hot Standby Router Protocol
(HSRP) had a simple tracking mechanism that allowed you to track the interface line-protocol state only.
If the line-protocol state of the interface went down, the HSRP priority of the router was reduced,
allowing another HSRP router with a higher priority to become active.
The Enhanced Object Tracking (EOT) feature separates the tracking mechanism from HSRP and creates
a separate standalone tracking process that can be used by other Cisco IOS processes as well as HSRP.
This feature allows tracking of other objects in addition to the interface line-protocol state.
A client process, such as HSRP, Virtual Router Redundancy Protocol (VRRP), or Gateway Load
Balancing Protocol (GLBP), can now register its interest in tracking objects and then be notified when
the tracked object changes state.
For details on EOT, refer to this URL:
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_eot.html
GLBP
The Gateway Load Balancing Protocol (GLBP) feature provides automatic router backup for IP hosts
configured with a single default gateway on a LAN. Multiple first hop routers on the LAN combine to
offer a single virtual first hop IP router while sharing the IP packet forwarding load. GLBP devices share
packet-forwarding responsibilities, optimizing resource usage, thereby reducing costs. Other routers on
the LAN may act as redundant GLBP routers that will become active if any of the existing forwarding
routers fail. This improves the resiliency of the network and reduces administrative burden.
For details on GLBP, refer to this URL:
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_glbp_ps6350_TSD_Products_
Configuration_Guide_Chapter.html
Cisco IOS XE IP Application Services Features in Cisco IOS XE 3.1.0SG
This section list the IP Application Services software features that are supported in Cisco IOS XE
3.1.0SG. Links to the feature documentation are included.
Feature guides may contain information about more than one feature. To find information about a
specific feature within a feature guide, see the Feature Information table at the end of the guide.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-9
Chapter 1 Product Overview
Layer 3 Software Features
Feature guides document features that are supported on many different software releases and platforms.
Your Cisco software release or platform may not support all the features documented in a feature guide.
See the Feature Information table at the end of the feature guide for information about which features in
that guide are supported in your software release. Use Cisco Feature Navigator to find information about
platform support and Cisco software image support. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Gateway Load Balancing Protocol (GLBP), GLBP MD5 Authentication
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_glbp.html
HSRP
The Hot Standby Router Protocol (HSRP) provides high network availability by routing IP traffic from
hosts on Ethernet networks without relying on the availability of any single Layer 3 switch. This feature
is particularly useful for hosts that do not support a router discovery protocol and do not have the
functionality to switch to a new router when their selected router reloads or loses power.
For information on configuring HSRP, refer to the following URL:
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_hsrp_ps6350_TSD_Products_
Configuration_Guide_Chapter.html
Cisco IOS XE IP Application Services: HSRP Features in Cisco IOS XE 3.1.0SG
This section lists the IP Application Services:HSRP software features that are supported in Cisco IOS
XE 3.1.0SG. Links to the feature documentation are included.
Feature guides may contain information about more than one feature. To find information about a
specific feature within a feature guide, see the Feature Information table at the end of the guide.
Feature guides document features that are supported on many different software releases and platforms.
Your Cisco software release or platform may not support all the features documented in a feature guide.
See the Feature Information table at the end of the feature guide for information about which features in
that guide are supported in your software release. Use Cisco Feature Navigator to find information about
platform support and Cisco software image support. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
HSRP—Hot Standby Router Protocol
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_hsrp.html
HSRP MD5 Authentication
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_hsrp.html
HSRP Support for ICMP Redirects
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_hsrp.html
IP Precedence Accounting
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_ipserv.html
ISSU—HSRP
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_hsrp.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-10 OL-22250-01
Chapter 1 Product Overview
Layer 3 Software Features
SSO—HSRP
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_hsrp.html
SSO Aware HSRP
SSO Aware HSRP offers continuous data packet forwarding during a supervisor engine switchover
without a path change to the standby HSRP router. During supervisor engine switchover, NSF with SSO
continues forwarding data packets along known routes using the HSRP virtual IP address. When both
supervisor engines fail on the active HSRP router, the standby HSRP router takes over as the active
HSRP router. SSO Aware HSRP extends the reliability and availability offered by NSF with SSO to
Layer 3 aggregation with redundant chassis.
IP Routing Protocols
The following routing protocols are supported on the Catalyst 4500 series switch:
• BGP, page 1-11
• EIGRP, page 1-12
• OSPF, page 1-13
• RIP, page 1-13
BGP
The Border Gateway Protocol (BGP) is an exterior gateway protocol that allows you to set up an
interdomain routing system to automatically guarantee the loop-free exchange of routing information
between autonomous systems. In BGP, each route consists of a network number, a list of autonomous
systems that information has passed through (called the autonomous system path), and a list of other path
attributes.
The Catalyst 4500 series switch supports BGP version 4, including classless interdomain routing
(CIDR). CIDR lets you reduce the size of your routing tables by creating aggregate routes, resulting in
supernets. CIDR eliminates the concept of network classes within BGP and supports the advertising of
IP prefixes. CIDR routes can be carried by OSPF, EIGRP, and RIP.
BGP Route-Map Continue
The BGP Route-Map Continue feature introduces the continue clause to the BGP route-map
configuration. The continue clause provides more programmable policy configuration and route
filtering. It introduces the capability to execute additional entries in a route map after an entry is executed
with successful match and set clauses. Continue clauses allow configuring and organizing more modular
policy definitions to reduce the number of policy configurations that are repeated within the same route
map.
For details on BGP, refer to this URL:
http://www.cisco.com/en/US/docs/ios/12_4t/ip_route/configuration/guide/t_brbbas.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-11
Chapter 1 Product Overview
Layer 3 Software Features
EIGRP
The Enhanced Interior Gateway Routing Protocol (EIGRP) is a version of IGRP that combines the
advantages of link-state protocols with distance-vector protocols. EIGRP incorporates the Diffusing
Update Algorithm (DUAL). EIGRP includes fast convergence, variable-length subnet masks, partially
bounded updates, and multiple network-layer support. When a network topology change occurs, EIGRP
checks its topology table for a suitable new route to the destination. If such a route exists in the table,
EIGRP updates the routing table instantly. You can use the fast convergence and partial updates that
EIGRP provides to route Internetwork Packet Exchange (IPX) packets.
EIGRP saves bandwidth by sending routing updates only when routing information changes. The
updates contain information only about the link that changed, not the entire routing table. EIGRP also
takes into consideration the available bandwidth when determining the rate at which it transmits updates.
Note Layer 3 switching does not support the Next Hop Resolution Protocol (NHRP).
Note Customers can configure Enhanced Interior Gateway Routing Protocol (EIGRP) to route IPv6 prefixes.
EIGRP configuration and protocol behavior for both IPv4 and IPv6 prefixes are similar, providing
operational familiarity and continuity. EIGRP support for IPv6 will enable customers to use their
existing EIGRP knowledge and processes, allowing them to deploy an IPv6 network at a low cost.
For details on EIGRP, refer to this URL:
http://www.cisco.com/en/US/products/ps6630/products_ios_protocol_option_home.html
Cisco IOS XE IP Routing: EIGRP Features in Cisco IOS XE 3.1.0SG
This section lists the IP Routing: EIGRP software features that are supported in Cisco IOS XE 3.1.0SG.
Links to the feature documentation are included.
Feature guides may contain information about more than one feature. To find information about a
specific feature within a feature guide, see the Feature Information table at the end of the guide.
Feature guides document features that are supported on many different software releases and platforms.
Your Cisco software release or platform may not support all the features documented in a feature guide.
See the Feature Information table at the end of the feature guide for information about which features in
that guide are supported in your software release. Use Cisco Feature Navigator to find information about
platform support and Cisco software image support. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Enhanced IGRP (EIGRP)
http://www.cisco.com/en/US/docs/ios/iproute_eigrp/configuration/guide/ire_cfg_eigrp.html
EIGRP Stub Routing
http://www.cisco.com/en/US/docs/ios/iproute_eigrp/configuration/guide/ire_cfg_eigrp.html
EIGRP Support for Route Map Filtering
http://www.cisco.com/en/US/docs/ios/iproute_eigrp/configuration/guide/ire_sup_route.html
IP Enhanced IGRP Route Authentication
http://www.cisco.com/en/US/docs/ios/iproute_eigrp/configuration/guide/ire_cfg_eigrp.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-12 OL-22250-01
Chapter 1 Product Overview
Layer 3 Software Features
NSF Awareness - EIGRP
http://www.cisco.com/en/US/docs/ios/iproute_eigrp/configuration/guide/ire_nsf.html
OSPF
The Open Shortest Path First (OSPF) protocol is a standards-based IP routing protocol designed to
overcome the limitations of RIP. Because OSPF is a link-state routing protocol, it sends link-state
advertisements (LSAs) to all other routers within the same hierarchical area. Information on the attached
interfaces and their metrics is used in OSPF LSAs. As routers accumulate link-state information, they
use the shortest path first (SPF) algorithm to calculate the shortest path to each node. Additional OSPF
features include equal-cost multipath routing and routing based on the upper-layer type of service (ToS)
requests.
OSPF employs the concept of an area, which is a group of contiguous OSPF networks and hosts. OSPF
areas are logical subdivisions of OSPF autonomous systems in which the internal topology is hidden
from routers outside the area. Areas allow an additional level of hierarchy different from that provided
by IP network classes, and they can be used to aggregate routing information and mask the details of a
network. These features make OSPF particularly scalable for large networks.
For details on OSPF, refer to this URL:
http://www.cisco.com/en/US/tech/tk365/tk480/tsd_technology_support_sub-protocol_home.html
Cisco IOS XE IP Routing: OSPF Features in Cisco IOS XE 3.1.0SG
This section lists the IP Routing: OSPF software features that are supported in Cisco IOS XE 3.1.0SG.
Links to the feature documentation are included.
Feature guides may contain information about more than one feature. To find information about a
specific feature within a feature guide, see the Feature Information table at the end of the guide.
Feature guides document features that are supported on many different software releases and platforms.
Your Cisco software release or platform may not support all the features documented in a feature guide.
See the Feature Information table at the end of the feature guide for information about which features in
that guide are supported in your software release. Use Cisco Feature Navigator to find information about
platform support and Cisco software image support. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
RIP
The Routing Information Protocol (RIP) is a distance-vector, intradomain routing protocol. RIP works
well in small, homogeneous networks. In large, complex internetworks it has many limitations, such as
a maximum hop count of 15, lack of support for variable-length subnet masks (VLSMs), inefficient use
of bandwidth, and slow convergence. RIP II does support VLSMs.
For details on RIP, refer to this URL:
http://www.cisco.com/en/US/tech/tk365/tk554/tsd_technology_support_sub-protocol_home.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-13
Chapter 1 Product Overview
Layer 3 Software Features
In Service Software Upgrade
SSO requires the same version of IOS on both the active and standby supervisor engines. Because of
version mismatch during an upgrade or downgrade of the Cisco IOS software, a Catalyst 4500 series
switch is forced into operating in RPR mode. In this mode, after the switchover, you can observe
link-flaps and a disruption in service. This issue is solved by the In Service Software Upgrade (ISSU)
feature that enables you to operate in SSO/NSF mode while performing software upgrade or downgrade.
In Service Softare Upgrade (ISSU) allows an upgrade or downgrade of the Catalyst IOS XE images at
different release levels on both the active and standby supervisor engines by utilizing the Version
Transformation Framework between the stateful components running on each supervisor engine.
For details, refer to Chapter 6, “Configuring the Cisco IOS XE In Service Software Upgrade Process.”
Multicast Services
Multicast services save bandwidth by forcing the network to replicate packets only when necessary and
by allowing hosts to join and leave groups dynamically. The Catalyst 4500 series switch supports
Protocol Independent Multicast (PIM), which is a protocol-independent because it can leverage
whichever unicast routing protocol is used to populate the unicast routing table, including EIGRP, OSPF,
BGP, or static route. PIM also uses a unicast routing table to perform the Reverse Path Forwarding (RPF)
check function instead of building a completely independent multicast routing table.
For information on configuring multicast services, see Chapter 29, “Configuring IP Multicast.”
For information on PIM-SSM mapping, see the URL:
http://www.cisco.com/en/US/docs/ios/12_3t/12_3t2/feature/guide/gtssmma.html#wp1171997
NSF with SSO
Non-Stop Forwarding with Stateful Switchover (NSF/SSO) offers continuous data packet forwarding in
a Layer 3 routing environment during supervisor engine switchover. NSF extends the reliability and
availability offered by the SSO feature to Layer 3 networks. During supervisor engine switchover,
NSF/SSO continues forwarding data packets along known routes while the routing protocol information
is recovered and validated, avoiding unnecessary route flaps and network instability. With NSF/SSO, IP
phone calls do not drop. NSF/SSO is supported for OSPF, BGP, EIGRP, and Cisco Express Forwarding
(CEF). NSF/SSO is typically deployed in the most critical parts of an enterprise or service provider
network, such as Layer 3 aggregation/core or a resilient Layer 3 wiring closet design. It is an essential
component of single chassis deployment for critical applications. NSF/SSO is available for all shipping
supervisor engines on redundant chassis.
For information on NSF with SSO, see Chapter 9, “Configuring Cisco NSF with SSO Supervisor Engine
Redundancy.”
Policy-Based Routing
Traditional IP forwarding decisions are based purely on the destination IP address of the packet being
forwarded. Policy Based Routing (PBR) enables forwarding based upon other information associated
with a packet, such as the source interface, IP source address, Layer 4 ports, and so on. This feature
allows network managers more flexibility in how they configure and design their networks.
For more information on policy-based routing, see Chapter 30, “Configuring Policy-Based Routing.”
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-14 OL-22250-01
Chapter 1 Product Overview
Management Features
Unidirectional Link Routing
Unidirectional link routing (UDLR) provides a way to forward multicast packets over a physical
unidirectional interface (such as a satellite link of high bandwidth) to stub networks that have a back
channel.
For information on configuring unidirectional link routing, refer to the chapter “Configuring
Unidirectional Link Routing” in the Cisco IP and IP Routing Configuration Guide.
Unicast Reverse Path Forwarding
The Unicast Reverse Path Forwarding (Unicast RPF) feature helps to mitigate problems that are caused
by the introduction of malformed or forged (spoofed) IP source addresses into a network by discarding
IP packets that lack a verifiable IP source address.
For information on URPF, see Chapter 28, “Configuring Unicast Reverse Path Forwarding.”
VRF-lite
VPN routing and forwarding (VRF-lite) is an extension of IP routing that provides multiple routing
instances. Along with BGP, it enables the creation of a Layer 3 VPN service by keeping separate IP
routing and forwarding tables for each VPN customer. VRF-lite uses input interfaces to distinguish
routes for different VPNs. It forms virtual packet-forwarding tables by associating one or more Layer 3
interfaces with each VRF, allowing the creation of multiple Layer 3 VPNs on a single switch. Interfaces
in a VRF could be either physical, such as an Ethernet port, or logical, such as a VLAN switch virtual
interface (SVI). However, interfaces cannot belong to more than one VRF at any time.
For information on VRF-lite, see Chapter 31, “Configuring VRF-lite.”
Virtual Router Redundancy Protocol
Virtual Router Redundancy Protocol (VRRP) is a standard based first-hop redundancy protocol. With
VRRP, a group of routers function as one virtual router by sharing one virtual IP address and one virtual
MAC address. The master router performs packet forwarding, while the backup routers stay idle. VRRP
is typically used in the multivendor first-hop gateway redundancy deployment.
For details on VRRP, refer to this URL:
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_vrrp_ps6441_TSD_Products_
Configuration_Guide_Chapter.html
The folllowing link is to the VRRP features supported in Cisco IOS XE 3.1.0SG:
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_vrrp.html
Management Features
The Catalyst 4500 series switch offers network management and control through the CLI or through
alternative access methods, such as SNMP. The switch software supports these network management
features:
• Cisco Call Home, page 1-16
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-15
Chapter 1 Product Overview
Management Features
• Cisco Energy Wise, page 1-16
• MAC Address Notification, page 1-18
• Dynamic Host Control Protocol, page 1-17
• Embedded CiscoView, page 1-17
• Embedded Event Manager, page 1-17
• File System Management on Supervisor Engine 7-E, page 1-17
• Forced 10/100 Autonegotiation, page 1-18
• Intelligent Power Management, page 1-18
• MAC Address Notification, page 1-18
• MAC Notify MIB, page 1-18
• Secure Shell, page 1-18
• Simple Network Management Protocol, page 1-19
• SPAN and RSPAN, page 1-19
• XML-PI, page 1-19
Cisco Call Home
Call Home provides e-mail-based and web-based notification of critical system events. A versatile range
of message formats are available for optimal compatibility with pager services, standard e-mail, or
XML-based automated parsing applications. Common uses of this feature may include direct paging of
a network support engineer, e-mail notification to a Network Operations Center, XML delivery to a
support website, and utilization of Cisco Smart Call Home services for direct case generation with the
Cisco Systems Technical Assistance Center (TAC).
The Call Home feature can deliver alert messages containing information on configuration, diagnostics,
environmental conditions, inventory, and syslog events.
For more information on Call Home, see Chapter 52, “Configuring Call Home.”
Cisco Energy Wise
Cisco EnergyWise is an energy-management technology added onto Cisco switching solutions to help
you measure, report, and reduce energy consumption across your entire infrastructure. With
EnergyWise’s management interface, network management applications can communicate with
endpoints and each other, using the network as the unifying fabric.
Refer to the following link for more details:
http://www.cisco.com/en/US/docs/switches/lan/energywise/phase2/ios/configuration/guide/ew_v2.html
Cisco IOS IP Service Level Agreement
Cisco IOS IP Service Level Agreements (SLAs) allows Cisco customers to analyze IP service levels for
IP applications and services by using active traffic monitoring—the generation of traffic in a continuous,
reliable, and predictable manner—for measuring network performance. With Cisco IOS IP SLAs,
service provider customers can measure and provide service level agreements, and enterprise customers
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-16 OL-22250-01
Chapter 1 Product Overview
Management Features
can verify service levels, verify outsourced service level agreements, and understand network
performance. Cisco IOS IP SLAs can perform network assessments, verify quality of service (QoS), ease
the deployment of new services, and assist with network troubleshooting.
For more information on IP SLA, see Chapter 50, “Configuring Cisco IOS IP SLAs Operations.”
Dynamic Host Control Protocol
The Catalyst 4500 series switch uses DHCP in the following ways:
• Dynamic Host Control Protocol server—The Cisco IOS DHCP server feature is a full DHCP server
implementation that assigns and manages IP addresses from specified address pools within the
router to DHCP clients. If the Cisco IOS DHCP server cannot satisfy a DHCP request from its own
database, it can forward the request to one or more secondary DHCP servers defined by the network
administrator.
• Dynamic Host Control Protocol autoconfiguration—With this feature your switch (the DHCP client)
is automatically configured at startup with IP address information and a configuration file.
For DHCP server configuration information, refer to the chapter, “Configuring DHCP,” in the Cisco
IOS IP and IP Routing Configuration Guide at the following URL:
http://www.cisco.com/en/US/docs/ios/ipaddr/configuration/guide/iad_dhcp_rdmp_ps6350_TSD_P
roducts_Configuration_Guide_Chapter.html
Embedded CiscoView
A web-based toos to configure the Catalyst 4500 series switch. Embedded CiscoView is a device
management application that can be embedded on the switch flash and provides dynamic status,
monitoring, and configuration information for your switch.
For more information on Embedded CiscoView, see Chapter 4, “Administering the Switch.”
Embedded Event Manager
Embedded Event Manager (EEM) is a distributed and customized approach to event detection and
recovery offered directly in a Cisco IOS device. EEM offers the ability to monitor events and take
informational, corrective, or any desired EEM action when the monitored events occur or when a
threshold is reached. An EEM policy is an entity that defines an event and the actions to be taken when
that event occurs.
For information on EEM, see the URL:
http://www.cisco.com/en/US/products/ps6815/products_ios_protocol_group_home.html
File System Management on Supervisor Engine 7-E
The format command for IOS XE 3.1.0 SG has changed slightly compared to the classic IOS format
because the later does not support ext2 format.
For USB flash under IOS XE 3.1.0 SG, there are 3 optional formats, i.e. FAT16, FAT32 and EXT2:
Switch# format usb0: ?
FAT16 FAT16 filesystem type
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-17
Chapter 1 Product Overview
Management Features
FAT32 FAT32 filesystem type
ext2 ext2 filesystem type
For SD card under IOS XE 3.1.0 SG, the default format is FAT16:
Switch# format slaveusb0: ?
FAT16 FAT16 filesystem type
FAT32 FAT32 filesystem type
ext2 ext2 filesystem type
Forced 10/100 Autonegotiation
This feature allows you to configure a port to limit the speed at which it will autonegotiate to a speed
lower than the physically maximum speed. This method of reducing the throughput incurs much less
overhead than using an ACL.
Intelligent Power Management
Working with powered devices (PDs) from Cisco, this feature uses power negotiation to refine the power
consumption of an 802.3af-compliant PD beyond the granularity of power consumption provided by the
802.3af class. Power negotiation also enables the backward compatibility of newer PDs with older
modules that do not support either 802.3af or high-power levels as required by IEEE standard.
For more information on Intelligent Power Management, see the “Intelligent Power Management”
section in Chapter 11, “Configuring Power over Ethernet.”
MAC Address Notification
MAC address notification monitors the MAC addresses that are learned by, aged out or removed from
the Catalyst 4500 series switch. Notifications are sent out or retrieved via the
CISCO-MAC-NOTIFICATION MIB. It is typically used by a central network management application
to collect such MAC address notification events for host moves. User configurable MAC table
utilization thresholds can be defined to notify any potential DoS or man-in-the-middle attack.
For information on MAC Address Notification, see Chapter 4, “Administering the Switch.”
MAC Notify MIB
The MAC Notify MIB feature monitors network performance, utilization, and security conditions
enabling a network administrator to track the MAC addresses that are learned or removed on the switch
forwarding the Ethernet frames.
Secure Shell
Secure Shell (SSH) is a program that enables you to log into another computer over a network, to execute
commands remotely, and to move files from one machine to another. The switch may not initiate SSH
connections: SSH will be limited to providing a remote login session to the switch and will only function
as a server.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-18 OL-22250-01
Chapter 1 Product Overview
Management Features
Simple Network Management Protocol
Simple Network Management Protocol (SNMP) facilitates the exchange of management information
between network devices. The Catalyst 4500 series switch supports these SNMP types and
enhancements:
• SNMP—A full Internet standard
• SNMP v2—Community-based administrative framework for version 2 of SNMP
• SNMP v3—Security framework with three levels: noAuthNoPriv, authNoPriv, and authPriv
(available only on a crypto image, like cat4000-i5k91s-mz)
• SNMP trap message enhancements—Additional information with certain SNMP trap messages,
including spanning-tree topology change notifications and configuration change notifications
For more information on SNMP, see Chapter 49, “Configuring SNMP.”
SPAN and RSPAN
Switched Port Analyzer (SPAN) allows you to monitor traffic on any port for analysis by a network
analyzer or Remote Monitoring (RMON) probe. You also can do the following:
• Configure ACLs on SPAN sessions.
• Allow incoming traffic on SPAN destination ports to be switched normally.
• Explicitly configure the encapsulation type of packets that are spanned out of a destination port.
• Restrict ingress sniffing depending on whether the packet is unicast, multicast, or broadcast, and
depending on whether the packet is valid.
• Mirror packets sent to or from the CPU out of a SPAN destination port for troubleshooting purposes.
For information on SPAN, see Chapter 46, “Configuring SPAN and RSPAN.”
Remote SPAN (RSPAN) is an extension of SPAN, where source ports and destination ports are
distributed across multiple switches, allowing remote monitoring of multiple switches across the
network. The traffic for each RSPAN session is carried over a user-specified RSPAN VLAN that is
dedicated for that RSPAN session on all participating switches.
For information on RSPAN, see Chapter 46, “Configuring SPAN and RSPAN.”
XML-PI
eXtensible Markup Language Programmatic Interface (XML-PI) Release 1.0 leverages the Network
Configuration Protocol (NETCONF). It provides new data models that collect running configurations
and show command output down to the keyword level without requiring the technologies or external
XML-to-command line interface (CLI) gateways. XML-PI allows you to develop XML-based network
management applications to control any number of network devices simultaneously.
Refer to the following link for more details:
http://www.cisco.com/en/US/docs/ios/netmgmt/configuration/guide/nm_xmlpi_v1.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-19
Chapter 1 Product Overview
Security Features
Security Features
The Catalyst 4500 series switch offers network management and control through the CLI or through
alternative access methods, such as SNMP. The switch software supports these security features:
• 802.1X Identity-Based Network Security, page 1-20
• Dynamic ARP Inspection, page 1-21
• Dynamic Host Configuration Protocol Snooping, page 1-21
• Flood Blocking, page 1-22
• Hardware-Based Control Plane Policing, page 1-22
• IP Source Guard, page 1-22
• Local Authentication, RADIUS, and TACACS+ Authentication, page 1-22
• Network Admission Control, page 1-23
• Network Security with ACLs, page 1-23
• Port Security, page 1-23
• Storm Control, page 1-24
• uRPF Strict Mode, page 1-24
• Utilities, page 1-24
• Web-based Authentication, page 1-25
802.1X Identity-Based Network Security
This security feature consists of the following:
• 802.1X protocol—Provides a means for a host that is connected to a switch port to be authenticated
before it is given access to the switch services.
• 802.1X with VLAN assignment—Enables you to enable non-802.1X-capable hosts to access
networks that use 802.1X authentication.
• 802.1X RADIUS accounting—Enables you to track the usage of network devices.
• 802.1X authentication for Guest VLANs—Enables you to use VLAN assignment to limit network
access for certain users.
• 802.1X with MAC Authentication Bypass—Provides network access to agentless devices without
802.1X supplicant capabilities, such as printers. Upon detecting a new MAC address on a switch
port, the Catalyst 4500 series switch will proxy an 802.1X authentication request based on the
device’s MAC address.
• 802.1X with Inaccessible Authentication Bypass—Applies when the AAA servers are unreachable
or nonresponsive. In this situation, 802.1X user authentication typically fails with the port closed,
and the user is denied access. Inaccessible Authentication Bypass provides a configurable
alternative on the Catalyst 4500 series switch to grant a critical port network access in a locally
specified VLAN.
• 802.1X with Unidirectional Controlled Port—Allows the Wake-on-LAN (WoL) magic packets to
reach a workstation attached to an unauthorized 802.1X switch port. Unidirectional Controlled Port
is typically used to send operating systems or software updates from a central server to workstations
at night.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-20 OL-22250-01
Chapter 1 Product Overview
Security Features
• 802.1X Authentication Failed Open Assignment—Enables you to configure a switch to handle the
case when a device fails to authenticate itself correctly through 802.1X (for example, not providing
the correct password).
• 802.1X with Port Security—Enables port security on an 802.1X port in either single- or
multiple-host mode. When you enable port security and 802.1X on a port, 802.1X authenticates the
port, and port security manages the number of MAC addresses allowed on that port, including that
of the client.
• 802.1X Authentication with ACL Assignment—Downloads per-host policies such as ACLs and
redirect URLs to the switch from the RADIUS server during 802.1X or MAB authentication of the
host.
• 802.1X Authentication with Per-User ACL and Filter-ID ACL—Allows ACL policy enforcement
using a third-party AAA server.
• 802.1X with RADIUS-Provided Session Timeouts—Enables you to specify whether a switch uses
a locally configured or a RADIUS-provided reauthentication timeout.
• 802.1X with Voice VLAN—Enables you to use 802.1X security on a port while enabling it to be
used by both Cisco IP phones and devices with 802.1X supplicant support.
• 802.1X Convergence—Provides consistency between the switching business units in 802.1X
configuration and implementation.
• Multi-Domain Authentication—Allows both a data device and a voice device, such as an IP phone
(Cisco or non-Cisco), to authenticate on the same switch port, which is divided into a data domain
and a voice domain.
For more information on 802.1X identity-based network security, see Chapter 36, “Configuring 802.1X
Port-Based Authentication.”
Dynamic ARP Inspection
Dynamic ARP Inspection (DAI) intercepts all ARP requests, replies on untrusted ports, and verifies each
intercepted packet for valid IP to MAC bindings. Dynamic ARP Inspection helps to prevent attacks on
a network by not relaying invalid ARP replies out to other ports in the same VLAN. Denied ARP packets
are logged by the switch for auditing.
For more information on dynamic ARP inspection, see Chapter 41, “Configuring Dynamic ARP
Inspection.”
Dynamic Host Configuration Protocol Snooping
Dynamic Host Configuration Protocol (DHCP) Snooping is a security feature that is a component of a
DHCP server. DHCP snooping provides security by intercepting untrusted DHCP messages and by
building and maintaining a DHCP snooping binding table. An untrusted message is a message that is
received from outside the network or firewall that can cause traffic attacks within your network.
DHCP snooping acts like a firewall between untrusted hosts and DHCP servers. It also provides a way
to differentiate between untrusted interfaces connected to the end-user and trusted interfaces connected
to the DHCP server or another switch.
With SSO support, DHCP Snooping propagates the DHCP-snooped data from the active supervisor
engine to the redundant supervisor engine so that when a switchover occurs, the newly active supervisor
engine is aware of the DHCP data that was already snooped, and the security benefits continue
uninterrupted.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-21
Chapter 1 Product Overview
Security Features
For DHCP server configuration information, refer to the chapter, “Configuring DHCP,” in the Cisco IOS
IP and IP Routing Configuration Guide at the following URL:
http://www.cisco.com/en/US/docs/ios/ipaddr/configuration/guide/iad_dhcp_rdmp_ps6350_TSD_Produ
cts_Configuration_Guide_Chapter.html
For information on configuring DHCP snooping, see Chapter 40, “Configuring DHCP Snooping, IP
Source Guard, and IPSG for Static Hosts.”
Flood Blocking
Flood blocking enables users to disable the flooding of unicast and multicast packets on a per-port basis.
Occasionally, unknown unicast or multicast traffic from an unprotected port is flooded to a protected port
because a MAC address has timed out or has not been learned by the switch.
For information on flood blocking, see Chapter 44, “Port Unicast and Multicast Flood Blocking.”
Hardware-Based Control Plane Policing
Control Plane Policing provides a unified solution to limit the rate of CPU bound control plane traffic in
hardware. It enables users to install system wide control plane ACLs to protect the CPU by limiting rates
or filtering out malicious DoS attacks. Control plane policing ensures the network stability, availability
and packet forwarding, and prevents network outages such as loss of protocol updates despite an attack
or heavy load on the switch. Hardware-based control plane policing is available on Supervisor Engine
7-E, supporting various Layer 2 and Layer 3 control protocols, such as CDP, EAPOL, STP, DTP, VTP,
ICMP, CGMP, IGMP, DHCP, RIPv2, OSPF, PIM, TELNET, SNMP, HTTP, and packets destined to
224.0.0.* multicast link local addresses. Predefined system policies or user-configurable policies can be
applied to those control protocols.
For information on control plane policing, see Chapter 39, “Configuring Control Plane Policing.”
IP Source Guard
Similar to DHCP snooping, this feature is enabled on an untrusted 12 port that is configured for DHCP
snooping. Initially all IP traffic on the port is blocked except for the DHCP packets, which are captured
by the DHCP snooping process. When a client receives a valid IP address from the DHCP server, a
PVACL is installed on the port, which restricts the client IP traffic only to clients with assigned IP
addresses, so any IP traffic with source IP addresses other than those assigned by the DHCP server will
be filtered out. This filtering prevents a malicious host from attacking a network by hijacking neighbor
host's IP address.
For information on configuring IP Source Guard, see Chapter 40, “Configuring DHCP Snooping, IP
Source Guard, and IPSG for Static Hosts.”
Local Authentication, RADIUS, and TACACS+ Authentication
Local Authentication, Remote Authentication Dial-In User Service (RADIUS), and Terminal Access
Controller Access Control System Plus (TACACS+) authentication methods control access to the switch.
For additional information, refer to the following URL:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-22 OL-22250-01
Chapter 1 Product Overview
Security Features
http://www.cisco.com/en/US/docs/ios/sec_user_services/configuration/guide/sec_cfg_authentifcn_ps635
0_TSD_Products_Configuration_Guide_Chapter.html
Network Admission Control
Network Admission Control consists of two features:
• NAC Layer 2 IP validation
NAC Layer 2 IP is an integral part of Cisco Network Admission Control. It offers the first line of
defense for infected hosts (PCs and other devices attached to a LAN port) attempting to connect to
the corporate network. NAC Layer 2 IP on the Cisco Catalyst 4500 series switch performs posture
validation at the Layer 2 edge of the network for non-802.1x-enabled host devices. Host device
posture validation includes antivirus state and OS patch levels. Depending on the corporate access
policy and host device posture, a host may be unconditionally admitted, admitted with restricted
access, or quarantined to prevent the spread of viruses across the network.
For more information on Layer 2 IP validation, see the URL:
http://www.cisco.com/en/US/docs/net_mgmt/cisco_secure_access_control_server_for_windows/4.
1/configuration/guide/nac_conf.html
• NAC Layer 2 802.1X authentication
The Cisco Catalyst 4500 series switch extends NAC support to 802.1x-enabled devices. Like NAC
Layer 2 IP, the NAC Layer 2 802.1x feature determines the level of network access based on
endpoint information.
For more information on 802.1X identity-based network security, see Chapter 36, “Configuring
802.1X Port-Based Authentication.”
Network Security with ACLs
An access control list (ACL) filters network traffic by controlling whether routed packets are forwarded
or blocked at the router interfaces. The Catalyst 4500 series switch examines each packet to determine
whether to forward or drop the packet based on the criteria you specified within the access lists.
MAC access control lists (MACLs) and VLAN access control lists (VACLs) are supported. VACLs are
also known as VLAN maps in Cisco IOS.
The following security features are supported:
• MAC address filtering, which enables you to block unicast traffic for a MAC address on a VLAN
interface.
• Port ACLs, which enable you to apply ACLs to Layer 2 interfaces on a switch for inbound traffic.
For information on ACLs, MACLs, VLAN maps, MAC address filtering, and Port ACLs, see
Chapter 42, “Configuring Network Security with ACLs.”
Port Security
Port security restricts traffic on a port based upon the MAC address of the workstation that accesses the
port. Trunk port security extends this feature to trunks, including private VLAN isolated trunks, on a
per-VLAN basis.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-23
Chapter 1 Product Overview
Security Features
Sticky port security extends port security by saving the dynamically learned MAC addresses in the
running configuration to survive port link down and switch reset. It enables a network administrator to
restrict the MAC addresses allowed or the maximum number of MAC addresses on each port.
Voice VLAN sticky port security further extends the sticky port security to the Voice-over-IP
deployment. Voice VLAN sticky port security locks a port and blocks access from a station with a MAC
address different from the IP phone and the workstation behind the IP phone.
For information on port security, see Chapter 38, “Configuring Port Security.”
Storm Control
Broadcast suppression is used to prevent LANs from being disrupted by a broadcast storm on one or
more switch ports. A LAN broadcast storm occurs when broadcast packets flood the LAN, creating
excessive traffic and degrading network performance. Errors in the protocol-stack implementation or in
the network configuration can cause a broadcast storm. Multicast and broadcast suppression measures
how much broadcast traffic is passing through a port and compares the broadcast traffic with some
configurable threshold value within a specific time interval. If the amount of broadcast traffic reaches
the threshold during this interval, broadcast frames are dropped, and optionally the port is shut down.
For information on configuring broadcast suppression, see Chapter 45, “Configuring Storm Control.”
uRPF Strict Mode
The uRPF feature mitigates problems caused by the introduction of malformed or forged (spoofed) IP
source addresses into a network by discarding IP packets that lack a verifiable IP source address. uRPF
deflects denial-of-service (DoS) and distributed denial-of-service (DDoS) attacks by forwarding only
packets that have source addresses that are valid and consistent with the IP routing table. This helps to
protect the network of the customer, the ISP, and the rest of the Internet. When using uRPF in strict mode,
the packet must be received on the interface that the router would use to forward the return packet. uRPF
strict mode is supported for both IPv4 and IPv6 prefixes.
For information on configuring broadcast suppression, see Chapter 28, “Configuring Unicast Reverse
Path Forwarding”.
Utilities
The following untilities are supported on the Catalyst 4500 series switch.
Layer 2 Traceroute
Layer 2 traceroute allows the switch to identify the physical path that a packet takes from a source device
to a destination device. Layer 2 traceroute supports only unicast source and destination MAC addresses.
For information about Layer 2 Traceroute, see Chapter 8, “Checking Port Status and Connectivity.”
Time Domain Reflectometry
Time Domain Reflectometry (TDR) is a technology used for diagnosing the state and reliability of
cables. TDR can detect open, shorted, or terminated cable states. The calculation of the distance to the
failure point is also supported.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-24 OL-22250-01
Chapter 1 Product Overview
Security Features
For information about TDR, see Chapter 8, “Checking Port Status and Connectivity.”
Debugging Features
The Catalyst 4500 series switch has several commands to help you debug your initial setup. These
commands are included in the following command groups:
• platform
• debug platform
For more information, refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference.
Web-based Authentication
The web-based authentication feature, known as Web Authentication Proxy, enables you to authenticate
end users on host systems that do not run the IEEE 802.1X supplicant. When you initiate an HTTP
session, this feature intercepts ingress HTTP packets from the host and sends an HTML login page to
your. You key in the credentials, which the web-based authentication feature sends to the AAA server
for authentication. If authentication succeeds, web-based authentication sends a Login-Successful
HTML page to the host and applies the access policies returned by the AAA server.
For information on configuring web-based authentication, see Chapter 37, “Configuring Web-Based
Authentication.”
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 1-25
Chapter 1 Product Overview
Security Features
Software Configuration Guide—Release IOS-XE 3.1.0 SG
1-26 OL-22250-01
CH A P T E R 2
Command-Line Interfaces
This chapter describes the CLIs you use to configure the Catalyst 4500 series switch. This chapter
includes the following major sections:
• File Management Commands, page 2-1
• Accessing the Switch CLI, page 2-2
• Performing Command-Line Processing, page 2-3
• Performing History Substitution, page 2-4
• About Cisco IOS Command Modes, page 2-4
• Getting a List of Commands and Syntax, page 2-5
• ROMMON Command-Line Interface, page 2-7
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
File Management Commands
The following file management commands are supported on Supervisor Engine 7-E:
• verify <filename>
• rename <old_name> <new_name>
• delete <filename>
• copy <source_flename> ,target_filename>
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 2-1
Chapter 2 Command-Line Interfaces
Accessing the Switch CLI
Accessing the Switch CLI
The following sections describe how to access the switch CLI:
• Accessing the CLI Using the EIA/TIA-232 Console Interface, page 2-2
• Accessing the CLI Through Telnet, page 2-2
Accessing the CLI Using the EIA/TIA-232 Console Interface
Note EIA/TIA-232 was known as recommended standard 232 (RS-232) before its acceptance as a standard by
the Electronic Industries Alliance (EIA) and Telecommunications Industry Association (TIA).
Perform the initial switch configuration over a connection to the EIA/TIA-232 console interface. Refer
to the Catalyst 4500 Series Switch Module Installation Guide for console interface cable connection
procedures.
To access the switch through the console interface, perform this task:
Command Purpose
Step 1 Switch> enable From the user EXEC prompt (>), enter enable to change
to enable mode (also known as privileged mode or
privileged EXEC mode).
Step 2 Password: password At the password prompt, enter the system password. The
prompt (#) appears, indicating that you have accessed the
Switch#
CLI in enabled mode.
Step 3 Switch# quit When you are finished executing the task command, exit
the session.
After accessing the switch through the EIA/TIA-232 interface, you see this display:
Press Return for Console prompt
Switch> enable
Password:< >
Switch#
Accessing the CLI Through Telnet
Note Before you make a Telnet connection to the switch, you must set the IP address for the switch. See the
“Configuring Physical Layer 3 Interfaces” section on page 26-10.
The switch supports up to eight simultaneous Telnet sessions. Telnet sessions disconnect automatically
after remaining idle for the period specified by the exec-timeout command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
2-2 OL-22250-01
Chapter 2 Command-Line Interfaces
Performing Command-Line Processing
To make a Telnet connection to the switch, perform this task:
Command Purpose
Step 1 telnet {hostname | ip_addr} From the remote host, enter the telnet command and the
name or IP address of the switch you want to access.
Step 2 Password: password At the prompt, enter the password for the CLI. If no
password has been configured, press Return.
Switch#
Step 3 Enter the necessary commands to complete your desired
tasks.
Step 4 Switch# quit When finished, exit the Telnet session.
This example shows how to open a Telnet session to the switch:
unix_host% telnet Switch_1
Trying 172.20.52.40...
Connected to 172.20.52.40.
Escape character is '^]'.
User Access Verification
Password:< >
Switch_1> enable
Password:
Switch_1#
Performing Command-Line Processing
Switch commands are not case sensitive. You can abbreviate commands and parameters if the
abbreviations contain enough letters to be different from any other currently available commands or
parameters.
You can scroll through the last 20 commands stored in the history buffer and enter or edit a command at
the prompt. Table 2-1 lists the keyboard shortcuts for entering and editing switch commands.
Table 2-1 Keyboard Shortcuts
Keystrokes Result
Press Ctrl-B or Moves the cursor back one character.
press the Left Arrow key1
Press Ctrl-F or Moves the cursor forward one character.
press the Right Arrow key1
Press Ctrl-A Moves the cursor to the beginning of the command line.
Press Ctrl-E Moves the cursor to the end of the command line.
Press Esc-B Moves the cursor back one word.
Press Esc-F Moves the cursor forward one word.
1. The Arrow keys function only on ANSI-compatible terminals, such as VT100s.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 2-3
Chapter 2 Command-Line Interfaces
Performing History Substitution
Performing History Substitution
The history buffer stores the last 20 command lines you entered. History substitution enables you to
access these command lines without retyping them. Table 2-2 lists the history substitution commands.
Table 2-2 History Substitution Commands
Command Purpose
1
Ctrl-P or the Up Arrow key Recalls commands in the history buffer, beginning with
the most recent command. Repeat the key sequence to
recall older commands successively.
Ctrl-N or the Down Arrow key1 Returns to more recent commands in the history buffer
after commands have been recalled with Ctrl-P or the
Up Arrow key. Repeat the key sequence to recall more
recent commands.
Switch# show history Lists the last several commands you have entered in
EXEC mode.
1. The Arrow keys function only on ANSI-compatible terminals such as VT100s.
About Cisco IOS Command Modes
Note For complete information about Cisco IOS command modes, refer to the Cisco IOS Configuration
Fundamentals Configuration Guide and the Cisco IOS Configuration Fundamentals Command
Reference at the following URLs:
http://www.cisco.com/en/US/docs/ios/12_2/configfun/configuration/guide/ffun_c.html
http://www.cisco.com/en/US/docs/ios/fundamentals/command/reference/cf_book.html
The Cisco IOS user interface has many different modes: user EXEC, privileged EXEC (enable), global
configuration, interface, subinterface, and protocol-specific. The commands available to you depend on
which mode you are in. To get a list of the commands in a given mode, enter a question mark (?) at the
system prompt. See the “Getting a List of Commands and Syntax” section on page 2-5 for more
information.
When you start a session on the switch, you begin in user mode, also called user EXEC mode. Only a
small subset of commands are available in EXEC mode. To have access to all commands, you must enter
privileged EXEC mode, also called enable mode. To access the privileged EXEC mode, you must enter
a password. When you are in the privileged EXEC mode, you can enter any EXEC command or access
global configuration mode. Most EXEC commands are one-time commands, such as show commands,
which display the current configuration status, and clear commands, which reset counters or interfaces.
The EXEC commands are not saved when the switch is rebooted.
The configuration modes allow you to make changes to the running configuration. If you save the
configuration, these commands are stored when you reboot the switch. You must start in global
configuration mode. From global configuration mode, you can enter interface configuration mode,
subinterface configuration mode, and a variety of protocol-specific modes.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
2-4 OL-22250-01
Chapter 2 Command-Line Interfaces
Getting a List of Commands and Syntax
You would use a separate mode called ROMMON when the switch cannot boot up properly. For example,
the switch might enter ROMMON mode if it does not find a valid system image when it is booting, or if
its configuration file is corrupted. For more information, see the “ROMMON Command-Line Interface”
section on page 2-7.
Table 2-3 lists and describes frequently used Cisco IOS modes.
Table 2-3 Frequently Used Cisco IOS Command Modes
Mode What You Use It For How to Access Prompt
User EXEC To connect to remote devices, Log in. Switch>
change terminal settings on a
temporary basis, perform basic
tests, and display system
information.
Privileged EXEC (enable) To set operating parameters. The From user EXEC mode, enter the Switch#
privileged command set includes enable command and the enable
the commands in user EXEC password (if a password has been
mode, as well as the configure configured).
command. Use the configure
command to access the other
command modes.
Global configuration To configure features that affect From privileged EXEC mode, Switch(config)#
the system as a whole, such as the enter the configure terminal
system time or switch name. command.
Interface configuration To enable or modify the operation From global configuration mode, Switch(config-if)#
of a 10-Gigabit Ethernet, Gigabit enter the interface type location
Ethernet, or Fast Ethernet interface command.
with interface commands.
Console configuration To configure the console interface; From global configuration mode, Switch(config-line)#
from the directly connected enter the line console 0 command.
console or the virtual terminal;
used with Telnet.
The Cisco IOS command interpreter, called the EXEC, interprets and runs the commands you enter. You
can abbreviate commands and keywords by entering just enough characters to make the command unique
from other commands. For example, you can abbreviate the show command to sh and the configure
terminal command to config t.
When you type exit, the switch backs out one level. To exit configuration mode completely and return
to privileged EXEC mode, press Ctrl-Z.
Getting a List of Commands and Syntax
In any command mode, you can get a list of available commands by entering a question mark (?).
Switch> ?
To obtain a list of commands that begin with a particular character sequence, enter those characters
followed by the question mark (?). Do not include a space before the question mark. This form of help
is called word help, because it completes a word for you.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 2-5
Chapter 2 Command-Line Interfaces
Getting a List of Commands and Syntax
To list keywords or arguments, enter a question mark in place of a keyword or argument. Include a space
before the question mark. This form of help is called command syntax help, because it reminds you
which keywords or arguments are applicable based on the command, keywords, and arguments you have
already entered.
Switch# configure ?
memory Configure from NV memory
network Configure from a TFTP network host
overwrite-network Overwrite NV memory from TFTP network host
terminal Configure from the terminal
<cr>
To redisplay a command you previously entered, press the Up Arrow key or Ctrl-P. You can continue
to press the Up Arrow key to see the last 20 commands you entered.
Tip If you are having trouble entering a command, check the system prompt and enter the question mark (?)
for a list of available commands. You might be in the wrong command mode or using incorrect syntax.
Type exit to return to the previous mode. Press Ctrl-Z or enter the end command in any mode to
immediately return to privileged EXEC mode.
Virtual Console for Standby Supervisor Engine
Catalyst 4500 series switches can be configured with 2 supervisor engines to provide redundancy. When
the switch is powered, one of the supervisor engines becomes active and remains active until a
switchover occurs. The other supervisor engine remains in standby mode.
Each supervisor engine has its own console port. Access to the standby supervisor engine is possible
only through the console port of the standby supervisor engine. Therefore, you must connect to the
standby console to access, monitor or debug the standby supervisor.
Virtual Console for Standby Supervisor Engine enables you to access the standby console from the active
supervisor engine without requiring a physical connection to the standby console. It uses IPC over
EOBC to communicate with the standby supervisor engine and thus emulate the standby console on the
active supervisor engine. Only one active standby console session is active at any time.
The virtual console for standby supervisor engine enables users who are logged onto the active
supervisor engine to remotely execute show commands on the standby supervisor engine and view the
results on the active supervisor engine. Virtual console is available only from the active supervisor
engine.
You can access the standby virtual console from the active supervisor engine with the attach module,
session module, or remote login commands on the active supervisor engine. You must be in privilege
EXEC mode (level 15) to run these commands to access the standby console.
Once you enter the standby virtual console, the terminal prompt automatically changes to
"<hostname>-standby-console#", where hostname is the configured name of the switch. The prompt is
restored back to the original prompt when you exit the virtual console.
You exit the virtual console with the exit or quit commands. When the inactivity period of the terminal
on the active supervisor engine where you logged in exceeds the configured idle time, you are
automatically logged out of the terminal on the active supervisor engine. In such a case, the virtual
console session is also terminated. Virtual console session is also automatically terminated when the
standby is rebooted. After the standby boots up, you need to create another virtual console session.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
2-6 OL-22250-01
Chapter 2 Command-Line Interfaces
ROMMON Command-Line Interface
To log in to the standby supervisor engine using a virtual console, do the following:
Switch# session module 2
Connecting to standby virtual console
Type "exit" or "quit" to end this session
Switch-standby-console# exit
If the standby console is not enabled, the following message appears:
Switch-standby-console#
Standby console disabled.
Valid commands are: exit, logout
Virtual session into the standby console is N/A with RPR:
Switch# session module 2
IPC server port name IFConsoleServer:2 not registered on standby.
Secondary cannot be accessed by virtual console
Note The standby virtual console provides the standard features that are available from the supervisor console
such as command history, command completion, command help and partial command keywords.
The following limitations apply to the standby virtual console:
• All commands on the virtual console run to completion. It does not provide the auto-more feature;
it behaves as if the terminal length 0 command has been executed. It is also noninteractive.
Therefore, a running command cannot be interrupted or aborted by any key sequence on the active
supervisor engine. If a command produces considerable output, the virtual console displays it on the
supervisor screen.
• The virtual console is noninteractive. Because the virtual console does not detect the interactive
nature of a command, any command that requires user interaction causes the virtual console to wait
until the RPC timer aborts the command.
The virtual console timer is set to 60 seconds. The virtual console returns to its prompt after 60
seconds. During this time, you cannot abort the command from the keyboard. You must wait for the
timer to expire before you continue.
• You cannot use virtual console to view debug and syslog messages that are being displayed on the
standby supervisor engine. The virtual console only displays the output of commands that are
executed from the virtual console. Other information that is displayed on the real standby console
does not appear on the virtual console.
ROMMON Command-Line Interface
ROMMON is a ROM-based program that is involved at power-up or reset, or when a fatal exception error
occurs. The switch enters ROMMON mode if the switch does not find a valid software image, if the
NVRAM configuration is corrupted, or if the configuration register is set to enter ROMMON mode.
From the ROMMON mode, you can load a software image manually from flash memory, from a network
server file, or from bootflash.
You can also enter ROMMON mode by restarting the switch and pressing Ctrl-C during the first five
seconds of startup.
Note Ctrl-C is always enabled for 60 seconds after you reboot the switch, even if Ctrl-C is configured to be
off in the configuration register settings.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 2-7
Chapter 2 Command-Line Interfaces
ROMMON Command-Line Interface
When you enter ROMMON mode, the prompt changes to rommon 1>. Use the ? command to see the
available ROMMON commands.
For more information about the ROMMON commands, refer to the Catalyst 4500 Series Switch Cisco
IOS Command Reference.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
2-8 OL-22250-01
CH A P T E R 3
Configuring the Switch for the First Time
This chapter describes how to initially configure a Catalyst 4500 series switch.
The information presented here supplements the administration information and procedures in this
publication: Cisco IOS Configuration Fundamentals Command Reference, Release 12.2SR, at this URL:
http://www.cisco.com/en/US/docs/ios/12_2/configfun/command/reference/frfabout.html
This chapter includes the following major sections:
• Default Switch Configuration, page 3-1
• Configuring DHCP-Based Autoconfiguration, page 3-2
• Configuring the Switch, page 3-8
• Controlling Access to Privileged EXEC Commands, page 3-13
• Recovering a Lost Enable Password, page 3-25
• Modifying the Supervisor Engine Startup Configuration, page 3-25
• Resetting a Switch to Factory Default Settings, page 3-32
• Configuring Crashinfo, page 3-32
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Default Switch Configuration
This section describes the default configurations for the Catalyst 4500 series switch. Table 3-1 shows the
default configuration settings for each feature.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-1
Chapter 3 Configuring the Switch for the First Time
Configuring DHCP-Based Autoconfiguration
Table 3-1 Default Switch Configuration
Feature Default Settings
Administrative connection Normal mode
Global switch information No default value for system name, system contact, and location
System clock No value for system clock time
Passwords No passwords are configured for normal mode or enable mode
(press the Return key)
Switch prompt Switch>
Interfaces Enabled, with speed and flow control autonegotiated, and without
IP addresses
Configuring DHCP-Based Autoconfiguration
These sections describe how to configure DHCP-based autoconfiguration:
• DHCP-Based Autoconfiguration, page 3-2
• DHCP Client Request Process, page 3-3
• Configuring the DHCP Server, page 3-4
• Configuring the TFTP Server, page 3-4
• Configuring the DNS Server, page 3-5
• Configuring the Relay Device, page 3-5
• Obtaining Configuration Files, page 3-6
• Example Configuration, page 3-7
If your DHCP server is a Cisco device, or if you are configuring the switch as a DHCP server, refer to
the “IP Addressing and Services” section in the Cisco IOS IP and IP Routing Configuration Guide for
Cisco IOS Release 12.1 for additional information about configuring DHCP.
DHCP-Based Autoconfiguration
Note Starting with Release 12.2(20)EW, you can enable DHCP AutoConfiguration by entering the write erase
command. This command clears the startup-config in NVRAM. In images prior to Release 12.2(20)EW,
this command will not enable autoconfiguration.
DHCP provides configuration information to Internet hosts and internetworking devices. This protocol
consists of two components: one component for delivering configuration parameters from a DHCP
server to a device and another component that is a mechanism for allocating network addresses to
devices. DHCP is built on a client-server model, in which designated DHCP servers allocate network
addresses and deliver configuration parameters to dynamically configured devices. The switch can act
as both a DHCP client and a DHCP server.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-2 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Configuring DHCP-Based Autoconfiguration
With DHCP-based autoconfiguration, no DHCP client-side configuration is needed on your switch
because your switch (the DHCP client) is automatically configured at startup with IP address
information and a configuration file. However, you need to configure the DHCP server or the DHCP
server feature on your switch for various lease options associated with IP addresses. If you are using
DHCP to relay the configuration file location on the network, you might also need to configure a Trivial
File Transfer Protocol (TFTP) server and a Domain Name System (DNS) server.
DHCP-based autoconfiguration replaces the BOOTP client functionality on your switch.
DHCP Client Request Process
At startup the switch automatically requests configuration information from a DHCP server if a
configuration file is not present on the switch.
Figure 3-1 shows the sequence of messages that are exchanged between the DHCP client and the DHCP
server.
Figure 3-1 DHCP Client and Server Message Exchange
DHCPDISCOVER (broadcast)
Switch A DHCPOFFER (unicast) DHCP server
DHCPREQUEST (broadcast)
DHCPACK (unicast)
51807
The client, Switch A, broadcasts a DHCPDISCOVER message to locate a DHCP server. The DHCP
server offers configuration parameters (such as an IP address, subnet mask, gateway IP address, DNS IP
address, lease for the IP address, and so forth) to the client in a DHCPOFFER unicast message.
In a DHCPREQUEST broadcast message, the client returns a formal request for the offered
configuration information to the DHCP server. The formal request is broadcast so that all other DHCP
servers that received the DHCPDISCOVER broadcast message from the client can reclaim the IP
addresses that they offered to the client.
The DHCP server confirms that the IP address has been allocated to the client by returning a DHCPACK
unicast message to the client. With this message, the client and server are bound, and the client uses the
configuration information that it received from the server. The amount of information the switch receives
depends on how you configure the DHCP server. For more information, see the “Configuring the DHCP
Server” section on page 3-4.
If the configuration parameters sent to the client in the DHCPOFFER unicast message are invalid (if
configuration error exists), the client returns a DHCPDECLINE broadcast message to the DHCP server.
The DHCP server sends the client a DHCPNAK denial broadcast message, which means that the offered
configuration parameters have not been assigned, that an error has occurred during the negotiation of the
parameters, or that the client has been slow in responding to the DHCPOFFER message. (The DHCP
server might have assigned the parameters to another client.)
A DHCP client might receive offers from multiple DHCP servers and can accept any of them; however,
the client usually accepts the first offer it receives. The offer from the DHCP server is not a guarantee
that the IP address will be allocated to the client; however, the server usually reserves the address until
the client has had a chance to formally request the address.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-3
Chapter 3 Configuring the Switch for the First Time
Configuring DHCP-Based Autoconfiguration
Configuring the DHCP Server
A switch can act as both the DHCP client and the DHCP server. By default, the Cisco IOS DHCP server
and relay agent features are enabled on your switch.
You should configure the DHCP server, or the DHCP server feature running on your switch, with
reserved leases that are bound to each switch by the switch hardware address.
If you want the switch to receive IP address information, you must configure the DHCP server with these
lease options:
• IP address of the client (required)
• Subnet mask of the client (required)
• DNS server IP address (optional)
• Router IP address (required)
Note The router IP address is the default gateway address for the switch.
If you want the switch to receive the configuration file from a TFTP server, you must configure the
DHCP server with these lease options:
• TFTP server name or IP address (required)
• Boot filename (the name of the configuration file that the client needs) (recommended)
• Host name (optional)
Depending on the settings of the DHCP server or the DHCP server feature running on your switch, the
switch can receive IP address information, the configuration file, or both.
If you do not configure the DHCP server, or the DHCP server feature running on your switch, with the
lease options described earlier, the switch replies to client requests with only those parameters that are
configured. If the IP address and subnet mask are not in the reply, the switch is not configured. If the
router IP address or TFTP server name (or IP address) are not found, the switch might send broadcast,
instead of unicast, TFTP requests. Unavailability of other lease options does not impact
autoconfiguration.
The DHCP server, or the DHCP server feature running on your switch, can be on the same LAN or on a
different LAN than the switch. If the DHCP server is running on a different LAN, you should configure
a DHCP relay, which forwards broadcast traffic between two directly connected LANs. A router does
not forward broadcast packets, but it forwards packets based on the destination IP address in the received
packet. For more information on relay devices, see the “Configuring the Relay Device” section on
page 3-5.
Configuring the TFTP Server
Based on the DHCP server configuration, the switch attempts to download one or more configuration
files from the TFTP server. If you configured the DHCP server to respond to the switch with all the
options required for IP connectivity to the TFTP server, and if you configured the DHCP server with a
TFTP server name, address, and configuration filename, the switch attempts to download the specified
configuration file from the specified TFTP server.
If you did not specify the configuration filename or the TFTP server name, or if the configuration file
could not be downloaded, the switch attempts to download a configuration file using various
combinations of filenames and TFTP server addresses. The files include the specified configuration
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-4 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Configuring DHCP-Based Autoconfiguration
filename (if any) and the following files: network-confg, cisconet.cfg, hostname.confg, or hostname.cfg,
where hostname is the current hostname of the switch and router-confg and ciscortr.cfg. The TFTP
server addresses used include the specified TFTP server address (if any) and the broadcast address
(255.255.255.255).
For the switch to successfully download a configuration file, the TFTP server must contain one or more
configuration files in its base directory. The files can include the following:
• The configuration file named in the DHCP reply (the actual switch configuration file).
• The network-confg or the cisconet.cfg file (known as the default configuration files).
• The router-confg or the ciscortr.cfg file. (These files contain commands common to all switches.
Normally, if the DHCP and TFTP servers are properly configured, these files are not accessed.)
If you specify the TFTP server name in the DHCP server-lease database, you must also configure the
TFTP server name-to-IP-address mapping in the DNS-server database.
If the TFTP server you plan to use is on a different LAN from the switch, or if you plan to access it with
the switch through the broadcast address (which occurs if the DHCP server response does not contain
all the required information described earlier), you must configure a relay to forward the TFTP packets
to the TFTP server. For more information, see the “Configuring the Relay Device” section on page 3-5.
The preferred solution is to configure either the DHCP server or the DHCP server feature running on
your switch with all the required information.
Configuring the DNS Server
The DHCP server, or the DHCP server feature running on your switch, uses the DNS server to resolve
the TFTP server name to an IP address. You must configure the TFTP server name-to-IP address map
on the DNS server. The TFTP server contains the configuration files for the switch.
You can configure the IP addresses of the DNS servers in the lease database of the DHCP server where
the DHCP replies will retrieve them. You can enter up to two DNS server IP addresses in the lease
database.
The DNS server can be on the same or on a different LAN as the switch. If it is on a different LAN, the
switch must be able to access it through a router.
Configuring the Relay Device
You must configure a relay device to forward received broadcast packets to the destination host
whenever a switch sends broadcast packets to which a host on a different LAN must respond. Examples
of such broadcast packets are DHCP, DNS, and in some cases, TFTP packets.
If the relay device is a Cisco router, enable IP routing (ip routing global configuration command), and
configure helper addresses (ip helper-address interface configuration command). For example, in
Figure 3-2, configure the router interfaces as follows:
On interface 10.0.0.2:
router(config-if)# ip helper-address 20.0.0.2
router(config-if)# ip helper-address 20.0.0.3
router(config-if)# ip helper-address 20.0.0.4
On interface 20.0.0.1:
router(config-if)# ip helper-address 10.0.0.1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-5
Chapter 3 Configuring the Switch for the First Time
Configuring DHCP-Based Autoconfiguration
Figure 3-2 Relay Device Used in Autoconfiguration
Switch Cisco router
(DHCP client) (Relay)
10.0.0.2
10.0.0.1 20.0.0.1
20.0.0.2 20.0.0.3 20.0.0.4
49068
DHCP server TFTP server DNS server
Obtaining Configuration Files
Depending on the availability of the IP address and the configuration filename in the DHCP reserved
lease, the switch obtains its configuration information in these ways:
• The IP address and the configuration filename are reserved for the switch and provided in the DHCP
reply (one-file read method).
The switch receives its IP address, subnet mask, TFTP server address, and the configuration
filename from either the DHCP server or the DHCP server feature running on your switch. The
switch sends a unicast message to the TFTP server to retrieve the named configuration file from the
base directory of the server, and upon receipt, completes its boot-up process.
• The IP address and the configuration filename is reserved for the switch, but the TFTP server
address is not provided in the DHCP reply (one-file read method).
The switch receives its IP address, subnet mask, and the configuration filename from either the
DHCP server or the DHCP server feature running on your switch. The switch sends a broadcast
message to a TFTP server to retrieve the named configuration file from the base directory of the
server, and upon receipt, completes its boot-up process.
• Only the IP address is reserved for the switch and provided in the DHCP reply. The configuration
filename is not provided (two-file read method).
The switch receives its IP address, subnet mask, and the TFTP server address from either the DHCP
server or the DHCP server feature running on your switch. The switch sends a unicast message to
the TFTP server to retrieve the network-confg or cisconet.cfg default configuration file. (If the
network-confg file cannot be read, the switch reads the cisconet.cfg file.)
The default configuration file contains the host names-to-IP-address mapping for the switch. The
switch fills its host table with the information in the file and obtains its host name. If the host name
is not found in the file, the switch uses the host name in the DHCP reply. If the host name is not
specified in the DHCP reply, the switch uses the default Switch as its host name.
After obtaining its host name from the default configuration file or the DHCP reply, the switch reads
the configuration file that has the same name as its host name (hostname-confg or hostname.cfg,
depending on whether or not the network-confg file or the cisconet.cfg file was read earlier) from
the TFTP server. If the cisconet.cfg file is read, the filename of the host is truncated to eight
characters.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-6 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Configuring DHCP-Based Autoconfiguration
If the switch cannot read the network-confg, cisconet.cfg, or the hostname file, it reads the
router-confg file. If the switch cannot read the router-confg file, it reads the ciscortr.cfg file.
Note The switch broadcasts TFTP server requests provided that one of these conditions is met: the TFTP
server is not obtained from the DHCP replies; all attempts to read the configuration file through unicast
transmissions fail; or the TFTP server name cannot be resolved to an IP address.
Example Configuration
Figure 3-3 shows a network example for retrieving IP information using DHCP-based autoconfiguration.
Figure 3-3 DHCP-Based Autoconfiguration Network Example
Switch 1 Switch 2 Switch 3 Switch 4
00e0.9f1e.2001 00e0.9f1e.2002 00e0.9f1e.2003 00e0.9f1e.2004
Cisco router
10.0.0.10
10.0.0.1 10.0.0.2 10.0.0.3
49066
DHCP server DNS server TFTP server
(maritsu)
Table 3-2 shows the configuration of the reserved leases on either the DHCP server or the DHCP server
feature running on your switch.
Table 3-2 DHCP Server Configuration
Switch 1 Switch 2 Switch 3 Switch 4
Binding key 00e0.9f1e.2001 00e0.9f1e.2002 00e0.9f1e.2003 00e0.9f1e.2004
(hardware address)
IP address 10.0.0.21 10.0.0.22 10.0.0.23 10.0.0.24
Subnet mask 255.255.255.0 255.255.255.0 255.255.255.0 255.255.255.0
Router address 10.0.0.10 10.0.0.10 10.0.0.10 10.0.0.10
DNS server address 10.0.0.2 10.0.0.2 10.0.0.2 10.0.0.2
TFTP server name maritsu or 10.0.0.3 maritsu or 10.0.0.3 maritsu or 10.0.0.3 maritsu or 10.0.0.3
Boot filename switch1-confg switch2-confg switch3-confg switch4-confg
(configuration file)
(optional)
Host name (optional) switch1 switch2 switch3 switch4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-7
Chapter 3 Configuring the Switch for the First Time
Configuring the Switch
DNS Server Configuration
The DNS server maps the TFTP server name maritsu to IP address 10.0.0.3.
TFTP Server Configuration (on UNIX)
The TFTP server base directory is set to /tftpserver/work/. This directory contains the network-confg file
used in the two-file read method. This file contains the host name that you plan to assign to the switch
based on its IP address. The base directory also contains a configuration file for each switch
(switch1-confg, switch2-confg, and so forth) as shown in the following display:
prompt> cd /tftpserver/work/
prompt> ls
network-confg
switch1-confg
switch2-confg
switch3-confg
switch4-confg
prompt> cat network-confg
ip host switch1 10.0.0.21
ip host switch2 10.0.0.22
ip host switch3 10.0.0.23
ip host switch4 10.0.0.24
DHCP Client Configuration
No configuration file is present on Switch 1 through Switch 4.
Configuration Explanation
In Figure 3-3, Switch 1 reads its configuration file as follows:
• Switch 1 obtains its IP address 10.0.0.21 from the DHCP server.
• If no configuration filename is given in the DHCP server reply, Switch 1 reads the network-confg
file from the base directory of the TFTP server.
• Switch 1 adds the contents of the network-confg file to its host table.
• Switch 1 reads its host table by indexing its IP address 10.0.0.21 to its host name (switch1).
• Switch 1 reads the configuration file that corresponds to its host name; for example, it reads
switch1-confg from the TFTP server.
Switches 2 through 4 retrieve their configuration files and IP addresses in the same way.
Configuring the Switch
The following sections describe how to configure your switch:
• Using Configuration Mode to Configure Your Switch, page 3-9
• Verifying the Running Configuration Settings, page 3-9
• Saving the Running Configuration Settings to Your Start-Up File, page 3-10
• Reviewing the Configuration in NVRAM, page 3-10
• Configuring a Default Gateway, page 3-11
• Configuring a Static Route, page 3-11
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-8 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Configuring the Switch
Using Configuration Mode to Configure Your Switch
To configure your switch from configuration mode, perform this procedure:
Step 1 Connect a console terminal to the console interface of your supervisor engine.
Step 2 After a few seconds, you will see the user EXEC prompt (Switch>). Now, you may want to enter
privileged EXEC mode, also known as enable mode. Type enable to enter enable mode:
Switch> enable
Note You must be in enable mode to make configuration changes.
The prompt will change to the enable prompt (#):
Switch#
Step 3 At the enable prompt (#), enter the configure terminal command to enter global configuration mode:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)#
Step 4 At the global configuration mode prompt, enter the interface type slot/interface command to enter
interface configuration mode:
Switch(config)# interface fastethernet 5/1
Switch(config-if)#
Step 5 In either of these configuration modes, enter changes to the switch configuration.
Step 6 Enter the end command to exit configuration mode.
Step 7 Save your settings. (See the “Saving the Running Configuration Settings to Your Start-Up File” section
on page 3-10.)
Your switch is now minimally configured and can boot with the configuration you entered. To see a list
of the configuration commands, enter ? at the prompt or press the help key in configuration mode.
Verifying the Running Configuration Settings
To verify the configuration settings you entered or the changes you made, enter the show
running-config command at the enable prompt (#), as shown in this example:
Switch# show running-config
Building configuration...
Current configuration:
!
version 12.0
service timestamps debug uptime
service timestamps log uptime
no service password-encryption
!
hostname Switch
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-9
Chapter 3 Configuring the Switch for the First Time
Configuring the Switch
<...output truncated...>
!
line con 0
transport input none
line vty 0 4
exec-timeout 0 0
password lab
login
transport input lat pad dsipcon mop telnet rlogin udptn nasi
!
end
Switch#
Saving the Running Configuration Settings to Your Start-Up File
Caution This command saves the configuration settings that you created in configuration mode. If you fail to do
this step, your configuration will be lost the next time you reload the system.
To store the configuration, changes to the configuration, or changes to the startup configuration in
NVRAM, enter the copy running-config startup-config command at the enable prompt (#), as follows:
Switch# copy running-config startup-config
Reviewing the Configuration in NVRAM
To display information stored in NVRAM, enter the show startup-config EXEC command.
The following example shows a typical system configuration:
Switch# show startup-config
Using 1579 out of 491500 bytes, uncompressed size = 7372 bytes
Uncompressed configuration from 1579 bytes to 7372 bytes
!
version 12.1
no service pad
service timestamps debug uptime
service timestamps log uptime
no service password-encryption
service compress-config
!
hostname Switch
!
!
ip subnet-zero
!
!
!
!
interface GigabitEthernet1/1
no snmp trap link-status
!
interface GigabitEthernet1/2
no snmp trap link-status
!--More--
<...output truncated...>
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-10 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Configuring the Switch
!
line con 0
exec-timeout 0 0
transport input none
line vty 0 4
exec-timeout 0 0
password lab
login
transport input lat pad dsipcon mop telnet rlogin udptn nasi
!
end
Switch#
Configuring a Default Gateway
Note The switch uses the default gateway only when it is not configured with a routing protocol.
Configure a default gateway to send data to subnets other than its own when the switch is not configured
with a routing protocol. The default gateway must be the IP address of an interface on a router that is
directly connected to the switch.
To configure a default gateway, perform this task:
Command Purpose
Step 1 Switch(config)# ip default-gateway IP-address Configures a default gateway.
Step 2 Switch# show ip route Verifies that the default gateway is correctly displayed in
the IP routing table.
This example shows how to configure a default gateway and how to verify the configuration:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# ip default-gateway 172.20.52.35
Switch(config)# end
3d17h: %SYS-5-CONFIG_I: Configured from console by console
Switch# show ip route
Default gateway is 172.20.52.35
Host Gateway Last Use Total Uses Interface
ICMP redirect cache is empty
Switch#
Configuring a Static Route
If your Telnet station or SNMP network management workstation is on a different network from your
switch and a routing protocol has not been configured, you might need to add a static routing table entry
for the network where your end station is located.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-11
Chapter 3 Configuring the Switch for the First Time
Configuring the Switch
To configure a static route, perform this task:
Command Purpose
Step 1 Switch(config)# ip route dest_IP_address mask Configures a static route to the remote network.
{forwarding_IP | vlan vlan_ID}
Step 2 Switch# show running-config Verifies that the static route is displayed correctly.
This example shows how to use the ip route command to configure a static route to a workstation at IP
address 171.10.5.10 on the switch with a subnet mask and IP address 172.20.3.35 of the forwarding
router:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# ip route 171.10.5.10 255.255.255.255 172.20.3.35
Switch(config)# end
Switch#
This example shows how to use the show running-config command to confirm the configuration of the
static route:
Switch# show running-config
Building configuration...
.
<...output truncated...>
.
ip default-gateway 172.20.52.35
ip classless
ip route 171.10.5.10 255.255.255.255 172.20.3.35
no ip http server
!
line con 0
transport input none
line vty 0 4
exec-timeout 0 0
password lab
login
transport input lat pad dsipcon mop telnet rlogin udptn nasi
!
end
Switch#
This example shows how to use the ip route command to configure the static route IP address 171.20.5.3
with subnet mask and connected over VLAN 1 to a workstation on the switch:
Switch# configure terminal
Switch(config)# ip route 171.20.5.3 255.255.255.255 vlan 1
Switch(config)# end
Switch#
This example shows how to use the show running-config command to confirm the configuration of the
static route:
Switch# show running-config
Building configuration...
.
<...output truncated...>
.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-12 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
ip default-gateway 172.20.52.35
ip classless
ip route 171.20.5.3 255.255.255.255 Vlan1
no ip http server
!
!
x25 host z
!
line con 0
transport input none
line vty 0 4
exec-timeout 0 0
password lab
login
transport input lat pad dsipcon mop telnet rlogin udptn nasi
!
end
Switch#
Controlling Access to Privileged EXEC Commands
The procedures in these sections let you control access to the system configuration file and privileged
EXEC commands:
• Setting or Changing a Static enable Password, page 3-13
• Using the enable password and enable secret Commands, page 3-14
• Setting or Changing a Privileged Password, page 3-14
• Encrypting Passwords, page 3-22
• Encrypting Passwords, page 3-22
• Configuring Multiple Privilege Levels, page 3-23
Setting or Changing a Static enable Password
To set or change a static password that controls access to the enable mode, perform this task:
Command Purpose
Switch(config)# enable password password Sets a new password or changes an existing
password for the privileged EXEC mode.
This example shows how to configure an enable password as “lab” at the privileged EXEC mode:
Switch# configure terminal
Switch(config)# enable password lab
Switch(config)#
For instructions on how to display the password or access level configuration, see the “Displaying the
Password, Access Level, and Privilege Level Configuration” section on page 3-24.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-13
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
Using the enable password and enable secret Commands
To provide an additional layer of security, particularly for passwords that cross the network or that are
stored on a TFTP server, you can use either the enable password or enable secret command. Both
commands configure an encrypted password that you must enter to access the enable mode (the default)
or any other privilege level that you specify.
We recommend that you use the enable secret command.
If you configure the enable secret command, it takes precedence over the enable password command;
the two commands cannot be in effect simultaneously.
To configure the switch to require an enable password, perform either one of these tasks:
Command Purpose
Switch(config)# enable password [level Establishes a password for the privileged EXEC
level] {password | encryption-type mode.
encrypted-password}
Switch(config)# enable secret [level Specifies a secret password that will be saved using
level] {password | encryption-type a nonreversible encryption method. (If
encrypted-password}
enable password and enable secret commands are
both set, users must enter the enable secret
password.)
When you enter either of these password commands with the level option, you define a password for a
specific privilege level. After you specify the level and set a password, give the password only to users
who need to have access at this level. Use the privilege level configuration command to specify
commands accessible at various levels.
If you enable the service password-encryption command, the password you enter is encrypted. When
you display the password with the more system:running-config command, the password displays the
password in encrypted form.
If you specify an encryption type, you must provide an encrypted password—an encrypted password you
copy from another Catalyst 4500 series switch configuration.
Note You cannot recover a lost encrypted password. You must clear NVRAM and set a new password. See
the “Recovering a Lost Enable Password” section on page 3-25 for more information.
For information on how to display the password or access level configuration, see the “Displaying the
Password, Access Level, and Privilege Level Configuration” section on page 3-24.
Setting or Changing a Privileged Password
To set or change a privileged password, perform this task:
Command Purpose
Switch(config-line)# password password Sets a new password or changes an existing
password for the privileged level.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-14 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
For information on how to display the password or access level configuration, see the “Displaying the
Password, Access Level, and Privilege Level Configuration” section on page 3-24.
Controlling Switch Access with TACACS+
This section describes how to enable and configure TACACS+, which provides detailed accounting
information and flexible administrative control over authentication and authorization processes.
TACACS+ is facilitated through authentication, authorization, accounting (AAA) and can be enabled
only through AAA commands.
Note For complete syntax and usage information for the commands used in this section, see the Cisco IOS
Security Command Reference, Release 12.2.
This section contains this configuration information:
• Understanding TACACS+, page 3-15
• TACACS+ Operation, page 3-17
• Configuring TACACS+, page 3-17
• Displaying the TACACS+ Configuration, page 3-22
Understanding TACACS+
TACACS+ is a security application that provides centralized validation of users attempting to gain
access to your switch. TACACS+ services are maintained in a database on a TACACS+ daemon
typically running on a UNIX or Windows NT workstation. You should have access to and should
configure a TACACS+ server before configuring TACACS+ features on your switch.
TACACS+ provides for separate and modular AAA facilities. TACACS+ allows for a single access
control server (the TACACS+ daemon) to provide each service—authentication, authorization, and
accounting—independently. Each service can be locked into its own database to take advantage of other
services available on that server or on the network, depending on the capabilities of the daemon.
The goal of TACACS+ is to provide a method for managing multiple network access points from a single
management service. Your switch can be a network access server along with other Cisco routers and
access servers. A network access server provides connections to a single user, to a network or
subnetwork, and to interconnected networks as shown in Figure 3-4.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-15
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
Figure 3-4 Typical TACACS+ Network Configuration
UNIX workstation
(TACACS+ Catalyst 6500
server 1) series switch
171.20.10.7
UNIX workstation
(TACACS+
server 2)
171.20.10.8
Configure the switches with the
TACACS+ server addresses.
Set an authentication key
(also configure the same key on
the TACACS+ servers).
Enable AAA.
101230
Create a login authentication method list.
Apply the list to the terminal lines.
Create an authorization and accounting
Workstations method list as required. Workstations
TACACS+ administered through the AAA security services can provide these services:
• Authentication—Provides complete control of authentication through login and password dialog,
challenge and response, and messaging support.
The authentication facility can conduct a dialog with the user (such as, after a username and
password are provided, to challenge a user with several questions such as home address, mother’s
maiden name, service type, and social security number). The TACACS+ authentication service can
also send messages to user screens. For example, a message could notify users that their passwords
must be changed because of the company’s password aging policy.
• Authorization—Provides strict control over user capabilities for the duration of the user’s session,
including but not limited to setting autocommands, access control, session duration, or protocol
support. You can also enforce restrictions on the commands a user can execute with the TACACS+
authorization feature.
• Accounting—Collects and sends information used for billing, auditing, and reporting to the
TACACS+ daemon. Network managers can use the accounting facility to track user activity for a
security audit or to provide information for user billing. Accounting records include user identities,
start and stop times, executed commands (such as PPP), number of packets, and number of bytes.
The TACACS+ protocol provides authentication between the switch and the TACACS+ daemon, and it
ensures confidentiality because all protocol exchanges between the switch and the TACACS+ daemon
are encrypted.
You need a system running the TACACS+ daemon software to use TACACS+ on your switch.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-16 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
TACACS+ Operation
When a user attempts a simple ASCII login by authenticating to a switch using TACACS+, this process
occurs:
1. When the connection is established, the switch contacts the TACACS+ daemon to obtain a username
prompt, which is then displayed to the user. The user enters a username, and the switch then contacts
the TACACS+ daemon to obtain a password prompt. The switch displays the password prompt to
the user, the user enters a password, and the password is then sent to the TACACS+ daemon.
TACACS+ allows a conversation between the daemon and the user until the daemon receives enough
information to authenticate the user. The daemon prompts for a username and password
combination, but can include other items such as the user’s mother’s maiden name.
2. The switch eventually receives one of these responses from the TACACS+ daemon:
• ACCEPT—The user is authenticated and service can begin. If the switch is configured to
require authorization, authorization begins at this time.
• REJECT—The user is not authenticated. The user can be denied access or is prompted to retry
the login sequence, depending on the TACACS+ daemon.
• ERROR—An error occurred at some time during authentication with the daemon or in the
network connection between the daemon and the switch. If an ERROR response is received, the
switch typically tries to use an alternative method for authenticating the user.
• CONTINUE—The user is prompted for additional authentication information.
After authentication, the user undergoes an additional authorization phase if authorization has been
enabled on the switch. Users must first successfully complete TACACS+ authentication before
proceeding to TACACS+ authorization.
3. If TACACS+ authorization is required, the TACACS+ daemon is again contacted, and it returns an
ACCEPT or REJECT authorization response. If an ACCEPT response is returned, the response
contains data in the form of attributes that direct the EXEC or NETWORK session for that user and
the services that the user can access:
• Telnet, Secure Shell (SSH), rlogin, or privileged EXEC services
• Connection parameters, including the host or client IP address, access list, and user timeouts
Configuring TACACS+
This section describes how to configure your switch to support TACACS+. At a minimum, you must
identify the host or hosts maintaining the TACACS+ daemon and define the method lists for TACACS+
authentication. You can optionally define method lists for TACACS+ authorization and accounting. A
method list defines the sequence and methods used to authenticate, to authorize, or to keep accounts on
a user. You can use method lists to designate one or more security protocols, ensuring a backup system
if the initial method fails. The software uses the first method listed to authenticate, to authorize, or to
keep accounts on users; if that method does not respond, the software selects the next method in the list.
This process continues until there is successful communication with a listed method or the method list
is exhausted.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-17
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
This section contains this configuration information:
• Default TACACS+ Configuration, page 3-18
• Identifying the TACACS+ Server Host and Setting the Authentication Key, page 3-18
• Configuring TACACS+ Login Authentication, page 3-19
• Configuring TACACS+ Authorization for Privileged EXEC Access and Network Services,
page 3-21
• Starting TACACS+ Accounting, page 3-21
Default TACACS+ Configuration
TACACS+ and AAA are disabled by default.
To prevent a lapse in security, you cannot configure TACACS+ through a network management
application. When enabled, TACACS+ can authenticate users accessing the switch through the CLI.
Note Although TACACS+ configuration is performed through the CLI, the TACACS+ server authenticates
HTTP connections that have been configured with a privilege level of 15.
Identifying the TACACS+ Server Host and Setting the Authentication Key
You can configure the switch to use a single server or AAA server groups in order to group existing
server hosts for authentication. You can group servers to select a subset of the configured server hosts
and use them for a particular service. The server group is used with a global server-host list and contains
the list of IP addresses of the selected server hosts.
Beginning in privileged EXEC mode, follow these steps to identify the IP host or host maintaining
TACACS+ server and optionally set the encryption key:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 tacacs-server host hostname [port Identifies the IP host or hosts maintaining a TACACS+ server. Enter this
integer] [timeout integer] [key command multiple times to create a list of preferred hosts. The software
string]
searches for hosts in the order in which you specify them.
• For hostname, specify the name or IP address of the host.
• (Optional) For port integer, specify a server port number. The default
is port 49. The range is 1 to 65535.
• (Optional) For timeout integer, specify a time in seconds the switch
waits for a response from the daemon before it times out and declares
an error. The default is 5 seconds. The range is 1 to 1000 seconds.
• (Optional) For key string, specify the encryption key for encrypting
and decrypting all traffic between the switch and the TACACS+
daemon. You must configure the same key on the TACACS+ daemon
for encryption to succeed.
Step 3 aaa new-model Enables AAA.
Step 4 aaa group server tacacs+ group-name (Optional) Defines the AAA server-group with a group name.
This command puts the switch in a server group subconfiguration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-18 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
Command Purpose
Step 5 server ip-address (Optional) Associates a particular TACACS+ server with the defined
server group. Repeat this step for each TACACS+ server in the AAA
server group.
Each server in the group must be previously defined in Step 2.
Step 6 end Returns to privileged EXEC mode.
Step 7 show tacacs Verifies your entries.
Step 8 copy running-config startup-config (Optional) Saves your entries in the configuration file.
To remove the specified TACACS+ server name or address, use the no tacacs-server host hostname
global configuration command. To remove a server group from the configuration list, use the no aaa
group server tacacs+ group-name global configuration command. To remove the IP address of a
TACACS+ server, use the no server ip-address server group subconfiguration command.
Configuring TACACS+ Login Authentication
To configure AAA authentication, define a named list of authentication methods and then apply that list
to various ports. The method list defines the types of authentication you intend to perform and the
sequence in which you intend to perform them; you must apply the list to a specific port before you can
perform any of the defined authentication methods. The only exception is the default method list (which,
by coincidence, is named default). The default method list is automatically applied to all ports except
those that have a named method list explicitly defined. A defined method list overrides the default
method list.
A method list describes the sequence and authentication methods that must be queried to authenticate a
user. You can designate one or more security protocols for authentication, ensuring a backup system for
authentication in case the initial method fails. The software uses the first method listed to authenticate
users; if that method fails to respond, the software selects the next authentication method in the method
list. This process continues until there is successful communication with a listed authentication method
or until all defined methods are exhausted. If authentication fails at any point in this cycle—meaning that
the security server or local username database responds by denying the user access—the authentication
process stops, and no other authentication methods are attempted.
Beginning in privileged EXEC mode, follow these steps to configure login authentication:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 aaa new-model Enables AAA.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-19
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
Command Purpose
Step 3 aaa authentication login {default | Creates a login authentication method list.
list-name} method1 [method2...]
• To create a default list that is used when a named list is not specified
in the login authentication command, use the default keyword
followed by the methods that you plan to use in default situations. The
default method list is automatically applied to all ports.
• For list-name, specify a character string to name the list you are
creating.
• For method1..., specify the actual method the authentication
algorithm tries. The additional methods of authentication are used
only if the previous method returns an error, not if it fails.
Select one of these methods:
• enable—Use the enable password for authentication. Before you can
use this authentication method, you must define an enable password
by using the enable password global configuration command.
• group tacacs+—Uses TACACS+ authentication. Before you can use
this authentication method, you must configure the TACACS+
server. For more information, see the “Identifying the TACACS+
Server Host and Setting the Authentication Key” section on
page 3-18.
• line—Use the line password for authentication. Before you can use
this authentication method, you must define a line password. Use the
password password line configuration command.
• local—Use the local username database for authentication. You must
enter username information in the database. Use the username
password global configuration command.
• local-case—Use a case-sensitive local username database for
authentication. You must enter username information in the database
by using the username name password global configuration
command.
• none—Do not use any authentication for login.
Step 4 line [console | tty | vty] line-number Enters line configuration mode, and configure the lines to which you want
[ending-line-number] to apply the authentication list.
Step 5 login authentication { default | Applies the authentication list to a line or set of lines.
list-name}
• If you specify default, use the default list created with the aaa
authentication login command.
• For list-name, specify the list created with the aaa authentication
login command.
Step 6 end Returns to privileged EXEC mode.
Step 7 show running-config Verifies your entries.
Step 8 copy running-config startup-config (Optional) Saves your entries in the configuration file.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-20 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
To disable AAA, use the no aaa new-model global configuration command. To disable AAA
authentication, use the no aaa authentication login {default | list-name} method1 [method2...] global
configuration command. To either disable TACACS+ authentication for logins or to return to the default
value, use the no login authentication {default | list-name} line configuration command.
Configuring TACACS+ Authorization for Privileged EXEC Access and Network Services
AAA authorization limits the services available to a user. When AAA authorization is enabled, the
switch uses information retrieved from the user’s profile, which is located either in the local user
database or on the security server, to configure the user’s session. The user is granted access to a
requested service only if the information in the user profile allows it.
You can use the aaa authorization global configuration command with the tacacs+ keyword to set
parameters that restrict a user’s network access to privileged EXEC mode.
The aaa authorization exec tacacs+ local command sets these authorization parameters:
• Use TACACS+ for privileged EXEC access authorization if authentication was performed by using
TACACS+.
• Use the local database if authentication was not performed by using TACACS+.
Note Authorization is bypassed for authenticated users who log in through the CLI even if authorization has
been configured.
Beginning in privileged EXEC mode, follow these steps to specify TACACS+ authorization for
privileged EXEC access and network services:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 aaa authorization network tacacs+ Configures the switch for user TACACS+ authorization for all
network-related service requests.
Step 3 aaa authorization exec tacacs+ Configures the switch for user TACACS+ authorization if the user has
privileged EXEC access.
The exec keyword might return user profile information (such as
autocommand information).
Step 4 end Returns to privileged EXEC mode.
Step 5 show running-config Verifies your entries.
Step 6 copy running-config startup-config (Optional) Saves your entries in the configuration file.
To disable authorization, use the no aaa authorization {network | exec} method1 global configuration
command.
Starting TACACS+ Accounting
The AAA accounting feature tracks the services that users are accessing and the amount of network
resources that they are consuming. When AAA accounting is enabled, the switch reports user activity to
the TACACS+ security server in the form of accounting records. Each accounting record contains
accounting attribute-value (AV) pairs and is stored on the security server. This data can then be analyzed
for network management, client billing, or auditing.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-21
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
Beginning in privileged EXEC mode, follow these steps to enable TACACS+ accounting for each Cisco
IOS privilege level and for network services:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 aaa accounting network start-stop Enables TACACS+ accounting for all network-related service requests.
tacacs+
Step 3 aaa accounting exec start-stop Enables TACACS+ accounting to send a start-record accounting notice
tacacs+ at the beginning of a privileged EXEC process and a stop-record at the
end.
Step 4 end Returns to privileged EXEC mode.
Step 5 show running-config Verifies your entries.
Step 6 copy running-config startup-config (Optional) Saves your entries in the configuration file.
To disable accounting, use the no aaa accounting {network | exec} {start-stop} method1... global
configuration command.
Displaying the TACACS+ Configuration
To display TACACS+ server statistics, use the show tacacs privileged EXEC command.
Encrypting Passwords
Because protocol analyzers can examine packets (and read passwords), you can increase access security
by configuring the Cisco IOS software to encrypt passwords. Encryption prevents the password from
being readable in the configuration file.
To configure the Cisco IOS software to encrypt passwords, perform this task:
Command Purpose
Switch(config)# service password-encryption Encrypts a password.
Encryption occurs when the current configuration is written or when a password is configured. Password
encryption is applied to all passwords, including authentication key passwords, the privileged command
password, console and virtual terminal line access passwords, and Border Gateway Protocol (BGP)
neighbor passwords. The service password-encryption command keeps unauthorized individuals from
viewing your password in your configuration file.
Caution The service password-encryption command does not provide a high level of network security. If you
use this command, you should also take additional network security measures.
Although you cannot recover a lost encrypted password (that is, you cannot get the original password
back), you can regain control of the switch after having lost or forgotten the encrypted password. See
the “Recovering a Lost Enable Password” section on page 3-25 for more information.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-22 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
For information on how to display the password or access level configuration, see the “Displaying the
Password, Access Level, and Privilege Level Configuration” section on page 3-24.
Configuring Multiple Privilege Levels
By default, Cisco IOS software has two modes of password security: user EXEC mode and privileged
EXEC mode. You can configure up to 16 hierarchical levels of commands for each mode. By configuring
multiple passwords, you can allow different sets of users to have access to specified commands.
For example, if you want many users to have access to the clear line command, you can assign it level 2
security and distribute the level 2 password fairly widely. If you want more restricted access to the
configure command, you can assign it level 3 security and distribute that password to fewer users.
The procedures in the following sections describe how to configure additional levels of security:
• Setting the Privilege Level for a Command, page 3-23
• Changing the Default Privilege Level for Lines, page 3-23
• Logging In to a Privilege Level, page 3-24
• Exiting a Privilege Level, page 3-24
• Displaying the Password, Access Level, and Privilege Level Configuration, page 3-24
Setting the Privilege Level for a Command
To set the privilege level for a command, perform this task:
Command Purpose
Step 1 Switch(config)# privilege mode level level Sets the privilege level for a command.
command
Step 2 Switch(config)# enable password level level Specifies the enable password for a privilege level.
[encryption-type] password
For information on how to display the password or access level configuration, see the “Displaying the
Password, Access Level, and Privilege Level Configuration” section on page 3-24.
Changing the Default Privilege Level for Lines
To change the default privilege level for a given line or a group of lines, perform this task:
Command Purpose
Switch(config-line)# privilege level level Changes the default privilege level for the line.
For information on how to display the password or access level configuration, see the “Displaying the
Password, Access Level, and Privilege Level Configuration” section on page 3-24.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-23
Chapter 3 Configuring the Switch for the First Time
Controlling Access to Privileged EXEC Commands
Logging In to a Privilege Level
To log in at a specified privilege level, perform this task:
Command Purpose
Switch# enable level Logs in to a specified privilege level.
Exiting a Privilege Level
To exit to a specified privilege level, perform this task:
Command Purpose
Switch# disable level Exits to a specified privilege level.
Displaying the Password, Access Level, and Privilege Level Configuration
To display detailed password information, perform this task:
Command Purpose
Step 1 Switch# show running-config Displays the password and access level configuration.
Step 2 Switch# show privilege Shows the privilege level configuration.
This example shows how to display the password and access level configuration:
Switch# show running-config
Building configuration...
Current configuration:
!
version 12.0
service timestamps debug datetime localtime
service timestamps log datetime localtime
no service password-encryption
!
hostname Switch
!
boot system flash sup-bootflash
enable password lab
!
<...output truncated...>
This example shows how to display the privilege level configuration:
Switch# show privilege
Current privilege level is 15
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-24 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Recovering a Lost Enable Password
Recovering a Lost Enable Password
Note For more information on the configuration register which is preconfigured in NVRAM, see “Configuring
the Software Configuration Register” section on page 3-26.
To recover a lost enable password, follow these steps:
Step 1 Connect to the console interface.
Step 2 Stop the boot sequence and enter ROM monitor by pressing Ctrl-C during the first 5 seconds of bootup.
Step 3 Configure the switch to boot-up without reading the configuration memory (NVRAM).
Step 4 Reboot the system.
Step 5 Access enable mode (this can be done without a password if a password has not been configured).
Step 6 View or change the password, or erase the configuration.
Step 7 Reconfigure the switch to boot-up and read the NVRAM as it normally does.
Step 8 Reboot the system.
Modifying the Supervisor Engine Startup Configuration
These sections describe how the startup configuration on the supervisor engine works and how to modify
the BOOT variable and the configuration register:
• Understanding the Supervisor Engine Boot Configuration, page 3-25
• Configuring the Software Configuration Register, page 3-26
• Specifying the Startup System Image, page 3-30
• Controlling Environment Variables, page 3-31
Understanding the Supervisor Engine Boot Configuration
The supervisor engine boot process involves two software images: ROM monitor and supervisor engine
software. When the switch is booted or reset, the ROMMON code is executed. Depending on the
NVRAM configuration, the supervisor engine either stays in ROMMON mode or loads the supervisor
engine software.
Two user-configurable parameters determine how the switch boots: the configuration register and the
BOOT environment variable. The configuration register is described in the “Modifying the Boot Field
and Using the boot Command” section on page 3-27. The BOOT environment variable is described in
the “Specifying the Startup System Image” section on page 3-30.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-25
Chapter 3 Configuring the Switch for the First Time
Modifying the Supervisor Engine Startup Configuration
Understanding the ROM Monitor
The ROM monitor (ROMMON) is invoked at switch bootup, reset, or when a fatal exception occurs. The
switch enters ROMMON mode if the switch does not find a valid software image, if the NVRAM
configuration is corrupted, or if the configuration register is set to enter ROMMON mode. From
ROMMON mode, you can manually load a software image from bootflash or a flash disk, or you can
boot up from the management interface. ROMMON mode loads a primary image from which you can
configure a secondary image to boot up from a specified source either locally or through the network
using the BOOTLDR environment variable. This variable is described in the “Switch#” section on
page 3-32.
You can also enter ROMMON mode by restarting the switch and then pressing Ctrl-C during the first
five seconds of startup.
Note Ctrl-C is always enabled for five seconds after you reboot the switch, regardless of whether the
configuration-register setting has Ctrl-C disabled.
The ROM monitor has these features:
• Power-on confidence test
• Hardware initialization
• Boot capability (manual bootup and autoboot)
• File system (read-only while in ROMMON)
Configuring the Software Configuration Register
The switch uses a 16-bit software configuration register, which allows you to set specific system
parameters. Settings for the software configuration register are preconfigured in NVRAM.
Here are some reasons why you might want to change the software configuration register settings:
• To select a boot source and default boot filename
• To control broadcast addresses
• To set the console terminal baud rate
• To load operating software from flash memory
• To recover a lost password
• To manually boot the system using the boot command at the bootstrap program prompt
• To force an automatic bootup from the system bootstrap software (boot image) or from a default
system image in onboard flash memory, and read any boot system commands that are stored in the
configuration file in NVRAM
Caution To avoid possibly halting the Catalyst 4500 series switch switch, remember that valid configuration
register settings might be combinations of settings and not just the individual settings listed in Table 3-3.
For example, the factory default value of 0x2101 is a combination of settings.
Table 3-3 lists the meaning of each of the software configuration memory bits. Table 3-4 defines the boot
field.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-26 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Modifying the Supervisor Engine Startup Configuration
Table 3-3 Software Configuration Register Bits
Bit Number1 Hexadecimal Meaning
00 to 03 0x0000 to 0x000F Boot field (see Table 3-4)
04 0x0010 Unused
05 0x0020 Bit two of console line speed
06 0x0040 Causes system software to ignore NVRAM contents
07 0x0080 OEM2 bit enabled
08 0x0100 Unused
09 0x0200 Unused
10 0x0400 IP broadcast with all zeros
11 to 12 0x0800 to 0x1000 Bits one and zero of Console line speed (default is 9600 baud)
13 0x2000 Loads ROM monitor after netboot fails
14 0x4000 IP broadcasts do not have network numbers
1. The factory default value for the configuration register is 0x2101. This value is a combination of the following: binary bit 13,
bit 8 = 0x0100 and binary bits 00 through 03 = 0x0001. (See Table 3-4.)
2. OEM = original equipment manufacturer.
Table 3-4 Explanation of Boot Field (Configuration Register Bits 00 to 03)
Boot Field Meaning
00 Stays at the system bootstrap prompt (does not autoboot).
01 Boots the first file in onboard flash memory.
02 to 0F Autoboots using image(s) specified by the BOOT environment variable. If more than one
image is specified, the switch attempts to boot the first image specified in the BOOT
variable. As long as the switch can successfully boot from this image, the same image will
be used on a reboot. If the switch fails to boot from the image specified in the BOOT
variable, the switch will try to boot from the next image listed in the BOOT variable. If the
end of the BOOT variable is reached without the switch booting successfully, the switch
attempts the boot from the beginning of the BOOT variable. The autoboot continues until
the switch successfully boots from one of the images specified in the BOOT variable.
Modifying the Boot Field and Using the boot Command
The configuration register boot field determines whether the switch loads an operating system image
and, if so, where it obtains this system image. The following sections describe how to use and set the
configuration register boot field and the procedures you must perform to modify the configuration
register boot field. In ROMMON, you can use the confreg command to modify the configuration register
and change boot settings.
Bits 0 through 3 of the software configuration register contain the boot field.
Note The factory default configuration register setting for systems and spares is 0x2101. However, the
recommended value is 0x0102.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-27
Chapter 3 Configuring the Switch for the First Time
Modifying the Supervisor Engine Startup Configuration
When the boot field is set to either 00 or 01 (0-0-0-0 or 0-0-0-1), the system ignores any boot instructions
in the system configuration file and the following occurs:
• When the boot field is set to 00, you must boot up the operating system manually by issuing the boot
command at the system bootstrap or ROMMON prompt.
• When the boot field is set to 01, the system boots the first image in the bootflash single in-line
memory module (SIMM).
• When the entire boot field equals a value between 0-0-1-0 and 1-1-1-1, the switch loads the system
image specified by boot system commands in the startup configuration file.
Caution If you set bootfield to a value between 0-0-1-0 and 1-1-1-1, you must specify a value in the boot system
command, else the switch cannot boot up and will remain in ROMMON.
You can enter the boot command only or enter the command and include additional boot instructions,
such as the name of a file stored in flash memory, or a file that you specify for booting from a network
server. If you use the boot command without specifying a file or any other boot instructions, the system
boots from the default flash image (the first image in onboard flash memory). Otherwise, you can
instruct the system to boot up from a specific flash image (using the boot system flash filename
command).
You can also use the boot command to boot up images stored in the compact flash cards located in slot 0
on the supervisor engine.
Modifying the Boot Field
Modify the boot field from the software configuration register.
To modify the software configuration register boot field, perform this task:
Command Purpose
Step 1 Switch# show version Determines the current configuration register setting.
Step 2 Switch# configure terminal Enters configuration mode, and specify the terminal
option.
Step 3 Switch(config)# config-register value Modifies the existing configuration register setting to
reflect the way you want the switch to load a system
image.
Step 4 Switch(config)# end Exits configuration mode.
Step 5 Switch# reload Reboots the switch to make your changes take effect.
To modify the configuration register while the switch is running Cisco IOS software, follow these steps:
Step 1 Enter the enable command and your password to enter privileged level, as follows:
Switch> enable
Password:
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-28 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Modifying the Supervisor Engine Startup Configuration
Step 2 Enter the configure terminal command at the EXEC mode prompt (#), as follows:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)#
Step 3 Configure the configuration register to 0x102 as follows:
Switch(config)# config-register 0x102
Set the contents of the configuration register by specifying the value command variable, where value is
a hexadecimal number preceded by 0x (see Table 3-3 on page 3-27).
Step 4 Enter the end command to exit configuration mode. The new value settings are saved to memory;
however, the new settings do not take effect until the system is rebooted.
Step 5 Enter the show version EXEC command to display the configuration register value currently in effect;
it will be used at the next reload. The value is displayed on the last line of the screen display, as shown
in this sample output:
Configuration register is 0x141 (will be 0x102 at next reload)
Step 6 Save your settings.
See the “Saving the Running Configuration Settings to Your Start-Up File” section on page 3-10. Note
that configuration register changes take effect only after the system reloads, such as when you enter a
reload command from the console.
Step 7 Reboot the system. The new configuration register value takes effect with the next system boot up.
Verifying the Configuration Register Setting
Enter the show version EXEC command to verify the current configuration register setting. In
ROMMON mode, enter the show version command to verify the configuration register setting.
To verify the configuration register setting for the switch, perform this task:
Command Purpose
Switch# show version Displays the configuration register setting.
In this example, the show version command indicates that the current configuration register is set so that
the switch does not automatically load an operating system image. Instead, it enters ROMMON mode
and waits for you to enter ROM monitor commands.
Switch# show version
Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3 Switch Software
(cat4500e-UNIVERSAL-M), Version 03.01.00.SG RELEASE SOFTWARE (fc4)
Technical Support: http://www.cisco.com/techsupport
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Fri 10-Sep-10 03:32 by prod_rel_team
...
Image text-base: 0x1009E914, data-base: 0x13B71550
ROM: 15.0(1r)SG(0.326)
Jawa Revision 7, Snowtrooper Revision 0x0.0x15
Switch uptime is 4 minutes
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-29
Chapter 3 Configuring the Switch for the First Time
Modifying the Supervisor Engine Startup Configuration
System returned to ROM by reload
System image file is
"tftp://172.25.60.31/auto/gsg-sw/interim/speedy/cco/cat4500e-universal.SPA.03.01.00."
Last reload reason: Reload command
License Information for 'WS-X45-SUP7-E'
License Level: entservices Type: Permanent
Next reboot license Level: entservices
cisco WS-C4503-E (MPC8572) processor (revision 8) with 786516K/16384K bytes of memory.
Processor board ID SPE134600QA
MPC8572 CPU at 1.5GHz, Supervisor 7
Last reset from Reload
1 Virtual Ethernet interface
96 Gigabit Ethernet interfaces
4 Ten Gigabit Ethernet interfaces
511K bytes of non-volatile configuration memory.
Configuration register is 0x40
1
Specifying the Startup System Image
You can enter multiple boot commands in the startup configuration file or in the BOOT environment
variable to provide backup methods for loading a system image.
The BOOT environment variable is also described in the “Specify the Startup System Image in the
Configuration File” section in the “Loading and Maintaining System Images and Microcode” chapter of
the Cisco IOS Configuration Fundamentals Configuration Guide.
Use the following sections to configure your switch to boot from flash memory. flash memory can be
either single in-line memory modules (SIMMs) or flash disks. Check the appropriate hardware
installation and maintenance guide for information about types of flash memory.
Flash Memory Features
Flash memory allows you to do the following:
• Remotely load multiple system software images through TFTP or RCP transfers (one transfer for
each file loaded)
• Boot a switch manually or automatically from a system software image stored in flash memory (you
can also boot directly from ROM)
• Copy the system image to flash memory using TFTP
• Boot the system from flash memory either automatically or manually
• Copy the flash memory image to a network server using TFTP or RCP
For more information on Flash Memory, see this URL:
http://www.cisco.com/en/US/docs/switches/lan/catalyst4500/hardware/configuration/notes/OL_2788.h
tml
1.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-30 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Modifying the Supervisor Engine Startup Configuration
Security Precautions
Note the following security precaution when loading from flash memory:
Caution You can only change the system image stored in flash memory from privileged EXEC level on the
console terminal.
Configuring Flash Memory
To configure your switch to boot from flash memory, perform the following procedure. (Refer to the
appropriate hardware installation and maintenance publication for complete instructions on installing
the hardware.)
Step 1 Copy a system image to flash memory using TFTP or other protocols. Refer to the “Cisco IOS File
Management” and “Loading and Maintaining System Images” chapters in the Cisco IOS Configuration
Fundamentals Configuration Guide, Release 12.2, at the following URL:
http://www.cisco.com/en/US/docs/ios/fundamentals/configuration/guide/12_2sr/cf_12_2sr_book.html
Step 2 Configure the system to boot automatically from the desired file in flash memory.
You might need to change the configuration register value. See the “Modifying the Boot Field and Using
the boot Command” section on page 3-27, for more information on modifying the configuration register.
Step 3 Save your configurations.
Step 4 Power cycle and reboot your system to verify that all is working as expected.
Controlling Environment Variables
Although the ROM monitor controls environment variables, you can create, modify, or view them with
certain commands. To create or modify the BOOT and BOOTLDR variables, use the boot system and
boot bootldr global configuration commands, respectively. Refer to the “Specify the Startup System
Image in the Configuration File” section in the “Loading and Maintaining System Images and
Microcode” chapter of the Configuration Fundamentals Configuration Guide for details on setting the
BOOT environment variable.
Note When you use the boot system and boot bootldr global configuration commands, you affect only the
running configuration. To save the configuration for future use, you must save the environment variable
settings to your startup configuration, which places the information under ROM monitor control. Enter
the copy system:running-config nvram:startup-config command to save the environment variables
from your running configuration to your startup configuration.
You can view the contents of the BOOT and BOOTLDR variables using the show bootvar command.
This command displays the settings for these variables as they exist in the startup configuration and in
the running configuration if a running configuration setting differs from a startup configuration setting.
This example shows how to check the BOOT and BOOTLDR variables on the switch:
Switch# show bootvar
BOOTLDR variable = bootflash:cat4000-is-mz,1;
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-31
Chapter 3 Configuring the Switch for the First Time
Resetting a Switch to Factory Default Settings
Configuration register is 0x0
Switch#
Resetting a Switch to Factory Default Settings
Manufacturing and repair centers can use the erase /all non-default command to do the following:
• Clear the non-volatile configurations and states of the local supervisor engine (NVRAM and
flashes).
• Set the factory default parameters on the Catalyst 4500 series switch before it is ready to ship to a
customer.
For example, entering this command can generate the following output:
Switch# erase /all non-default
Erase and format operation will destroy all data in non-volatile storage. Continue?
[confirm]
Formatting bootflash: ...
Format of bootflash complete
Erasing nvram:
Erasing cat4000_flash:
Clearing crashinfo:data
Clearing the last power failure timestamp
Clearing all ROMMON variables
Setting default ROMMON variables:
ConfigReg=0x2101
PS1=rommon ! >
EnableAutoConfig=1
Setting vtp mode to transparent
%WARNING! Please reboot the system for the changes to take effect
Switch#
00:01:48: %SYS-7-NV_BLOCK_INIT: Initialized the geometry of nvram
Switch#
If the Catalyst 4500 series switch is accessible to a TFTP server, you can copy an image to the bootflash
memory with the TFTP command:
Switch# copy tftp://192.20.3.123/tftpboot/abc/cat4500-entservices-mz.bin bootflash:
When the copying is completed, you can reboot the just-copied Catalyst 4500 series switch image to the
image stored in the bootflash memory with the reload command:
Switch# reload
System configuration has been modified. Save? [yes/no]: no
Proceed with reload? [confirm]
00:06:17: %SYS-5-RELOAD: Reload requested by console. Reload Reason: Reload Command.
To see details about the default parameters set by the erase /all non-default command, see the usage
guidelines for the erase command in the Catalyst 4500 Series Switch Cisco IOS Command Reference.
Configuring Crashinfo
The crashinfo file is a collection of useful debugging information related to a process that has crashed.
A system might have numerous processes running, and occasionally, one or more of them may crash
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-32 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Configuring Crashinfo
because of a software defect. The crashinfo file not only contain a snapshot of the process’s state infor-
mation of the process state at crash time, but it also contains a snapshot of the system's state informa-
tion (such as the state of system resources). The information in the crashinfo file helps to identify a
crash’s possible root cause.
This section contains the following subsections:
• About Crashinfo, page 3-33
• Configuring Crashinfo, page 3-35
About Crashinfo
This subsection describes the three types of crashinfo files (process crashinfo, process core dump, and
kernel crashinfo).
The following topics are discussed:
• Process Crashinfo File, page 3-33
• Process Core Dump File, page 3-34
• Kernel Crashinfo File, page 3-34
Process Crashinfo File
The naming convention of the crashinfo filename is
crashinfo_<process_name>_YYYYMMDD-HHMMSS-UTC
By default, this process crashinfo file is always generated for a process crash.
Although the file’s contents are in readable text format, some parts of the file can only be decoded by a
specific Cisco debugging tool. For nearly all process crashes, this file is required for root cause analysis.
This file contains the following information:
• Software exception that cause the crash
• Identity summary of the process
• Register values at the time of crash
• Stack dump of each of the threads of the process
• Files that are opened and used at the time of crash
• Command line as the process was launched
• Environment variables and resource limits
• Memory addresses where executable code are loaded
• Status of memory usage and CPU usage for each of the threads
• Application specific debugging information
• System boot log message
• System up time and CPU usage
• List of kernel loadable modules in the system
• System devices and their status
• List of mounted filesystems
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-33
Chapter 3 Configuring the Switch for the First Time
Configuring Crashinfo
• System memory total, free, and usage information
• Information on memory zones and slabs, and their status
• Virtual memory usage
• Resources maintained by the kernel
• List of program identifiers, called TRACEKEYs
Process Core Dump File
The naming convention for the core dump file name is
fullcore_<process_name>_YYYYMMDD-HHMMSS-UTC
By default, this file is not generated for a process crash. It can be enabled with the exception CLI
command.
The file is of compressed binary type and can only be decoded by a specific Cisco debugging tool. The
uncompressed file of this type is basically a coredump, which is a copy of memory pages that are used
by the process that crashed. You should provide the coredump file, if available, as part of debugging
information for root cause analysis.
By default, compression is enabled. We do not recommend that you enable coredump to obtain an
uncompressed coredump because it requires a considerable storage space and time to save to the storage
device. Enabling the uncompressed crash data generation is better suited for those systems with faster
and larger storage capacity.
Kernel Crashinfo File
The filename of the kernel crashinfo file is koops.dat.
By default, the kernel crashinfo dump is enabled and cannot be disabled. The kernel crashinfo, also
known Kernel OOPS (KOOPS), represents a defect in the kernel software code (a detected undesirable
hardware condition). The term OOPS is an interjection made after a mistake.
Although the file’s contents are in readable text format, some parts of this file can only be decoded by
a trained engineer. For nearly all kernel crashes, this file is required for root cause analysis.
This file contains the following information:
• Exception summary
• CPU information
• List of kernel loadable modules
• Register values at the time of kernel oops event taken place
• Task that was running at the time of oops event
• List of code blocks executed leading up to the oops event
• A number of code instructions
• Time the oops event taken place
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-34 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Configuring Crashinfo
Configuring Crashinfo
The crashinfo is configured with default values. It is not necessary to configure the crashinfo because
the default values are designed to be optimal. The configuration may require customization to account
for system configuration, storage availability, and capacity.
Topics include:
• Default Configuration, page 3-35
• Configuring commands, page 3-35
• show Commands, page 3-36
• Enabling the Generation of the Process Core Dump File, page 3-38
• Saving Crash Files to a Secondary Devices, page 3-39
• Determining the Process that Crashed, page 3-39
Default Configuration
By default, the crash files are saved in crashinfo: partition, which cannot be changed. Two additional
storage devices can be configured to save the crash files.
Using the crashinfo configuration commands, you can set the maximum number of files stored in each
of the storage devices. This allows you to use the storage device wisely, saving the crash files, and
increasing their manageability. By default, you can save up to 10 crashinfo files and up to 10 coredump
files. Recall that the generation of the process core dump file is disabled by default. When the maximum
number of files has been achieved and a new crash file is created, one or more of the oldest files, among
the process crashinfo and core dump files, are deleted to create space for the new crash file.
The file named last_crashinfo possesses the file name of the latest crash file. View this file when it is
hard to locate the latest crash file because multiple crash files exist on multiple storage devices.
Configuring commands
The following commands define the number of crashinfo files or coredump files respectively to be
retained on each of the storage partition such as crashinfo:. Depending on the size of the storage
partition, you might not be able to retain the configured number of files. Also, when a new crash file is
created, and if there is insufficient space to store the new crash file, the oldest crash files are deleted
until enough storage space is available for the new crash file.
Command Purpose
Switch# exception crashinfo maximum-files ? Sets the maximum number of process crashinfo
<1-20> A value between 1-20 files to be retained.
The initial default values is 10.
Switch# exception coredump maximum-files ? Sets the maximum number of process core dump
<1-20> A value between 1-20 files to be retained.
The initial default values are 10.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-35
Chapter 3 Configuring the Switch for the First Time
Configuring Crashinfo
The following command is used to configure the list of storage devices to be searched for space defined
by the system when space is required to store newly created crash files. The first device is always the
crashinfo: partition and cannot be changed. For example, if a second device is configured and there is
insufficient space to store the new crash files, the system attempts to save these new crash files on the
second device rather than deleting files from the crashinfo: partition.
Command Purpose
Switch# exception dump device ? Sets the second and third storage devices that are
second Second search device to store checked for available storage space for saving
crashinfo
third Third search device to store
the new crash files.
crashinfo crashinfo: is the default device and cannot be
changed,
The following command enables the generation of coredump crash data. The coredump data is a binary
data, and it is compressed by default.
Command Purpose
Switch# exception coredump Enables the generation of compressed process
core dump file.
The default is not to generate compressed
process core dump file.
The following command directs the system to generate uncompressed coredump crash data. Typically,
you should not generate uncompressed coredump data because the file can very large (on the order of
1-2 Gigabytes), and storage sapce for the crash file will be insufficient.
Command Purpose
Switch# exception coredump uncompress Enables the generation of the uncompressed
process core dump file.
Note An uncompressed coredump file can be
very large.
The default is to generate compressed process
core dump file.
show Commands
Use the following command to display the current configuration of the crashinfo:
Switch# show exception information
Exception configuration information
Coredump file - disabled,compressed
Maximum number of files
Core - 10 file(s)
Process crashinfo - 10 file(s)
Configured storage devices
1 - crashinfo:
2 - not assigned
3 - not assigned
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-36 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Configuring Crashinfo
Dump protocol - not configured
Use the following command to determine the file name of latest crash file:
Switch# more crashinfo:last_crashinfo
crashinfo:crashinfo_iosd_20100803-073408-UTC
Use the following command to view the contents of a process crashinfo file:
Switch# more crashinfo:crashinfo_iosd_20100803-073408-UTC
====== signr 5
======= Process
PID=11773 PPPID=1 PGRP=11773
Time: User=7794 System=724
======= current - pid 11773
====== Registers
nip = 0x0C3CC798 msr = 0x0002D000 r3* = 0x00002DFD ctr = 0x0CF05040
lnk = 0x0CF05050 xer = 0x20000000 ccr = 0x42002444
trp = 0x00000C00 dar = 0x143CDC68 isr = 0x00000000 res = 0x00000000
R0 0x000000FA R1 0x7B37D090 R2 0x4804D780 R3 0x00000000
R4 0x00002DFD R5 0x00000005 R6 0x143CDC68 R7 0x00000000
R8 0x00000000 R9 0x00002DFD R10 0x7B37CEA8 R11 0x0CF05040
R12 0x22002448 R13 0x14FF4008 R14 0x10B50F44 R15 0x00000000
R16 0x00000000 R17 0x14CB665C R18 0x13E70000 R19 0x14CB0000
R20 0x14FF0000 R21 0x00000001 R22 0x891753A1 R23 0x891752A0
R24 0x15AB30D8 R25 0x00000000 R26 0x00000000 R27 0x143CDC68
R28 0x000007CA R29 0x7B37D0E0 R30 0x143D10C4 R31 0x7820B3D4
--More-
//output omitted//
Use the following command to view the contents of kernel crash information
Switch# more crashinfo:koops.dat
NOVAOOPS:
<4>CRASHINFO_OOPS:
<4>Oops: Machine check, sig: 7 [#1]
<4>SMP NR_CPUS=2 Cisco Systems K10 (Callista)
<4>Modules linked in: gsbu64atomic mtsmod(P) aipcmod(P) vsi uld_timer cpumem tun bridge
pds crashinfo bpa_mem
<4>NIP: c0022cc0 LR: c00230e8 CTR: c00230b0
<4>REGS: c04c4f50 TRAP: 0202 Tainted: P (2.6.24.4.28.13.k10)
<4>MSR: 00021000 <ME> CR: 24084422 XER: 20000000
<4>TASK = ea088150[13355] 'iosd' THREAD: ea738000 CPU: 0
<6>GPR00: 00000001 ea739c60 ea088150 0000001a ea4c0460 00000000 00000000 00000000
<6>GPR08: c0fec000 c04d0000 fcfd3000 fcfd3060 24084482 1423ebb8 00000000 10121d28
<6>GPR16: 100d0000 ea739db8 c03f61a0 c03fb098 ea088318 c04c0000 ea739f50 ea088530
<6>GPR24: 418004fc ea739e88 00029000 00021000 c04c8eb0 0000005a 0000005a e9b80fa0
<4>NIP [c0022cc0] cisco_tatooine_mask_irq_internal+0x10/0x40
<4>LR [c00230e8] cisco_tatooine_mask_and_ack_irq+0x38/0x60
<4>Call Trace:
<4>[ea739c60] [c00f3004] proc_destroy_inode+0x24/0x40 (unreliable)
<4>[ea739c80] [c0073e0c] free_irq+0x14c/0x170
<4>[ea739ca0] [c0075ee0] irq_proc_release+0x50/0x170
<4>[ea739cc0] [c00f3570] proc_reg_release+0x70/0xd0
<4>[ea739ce0] [c00ab28c] __fput+0xbc/0x1b0
<4>[ea739d00] [c00a777c] filp_close+0x6c/0xd0
<4>[ea739d20] [c004506c] put_files_struct+0x10c/0x120
<4>[ea739d40] [c00468f8] do_exit+0x198/0x7a0
<4>[ea739d90] [c0046f38] do_group_exit+0x38/0x90
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-37
Chapter 3 Configuring the Switch for the First Time
Configuring Crashinfo
<4>[ea739db0] [c0053cc8] get_signal_to_deliver+0x3a8/0x610
<4>[ea739e80] [c0010d68] do_signal+0x48/0x2f0
<4>[ea739f40] [c0018a64] do_user_signal+0x74/0xc4
<4>Instruction dump:
<4>38000001 7c00e830 7d400378 5400043e 7c0004ac b00b0100 4bffffac 00000000
<4>3d20c04d 81498eac 396a0060 7c0004ac <812a0060> 0c090000 4c00012c 3800fffe
TIMESTAMP:
730956298.010309
READFLAG:
1
Use the following command to list the current crash files on the system:
Switch# show exception files
Exception crashinfo files
Most Recent Crashinfo file:
crashinfo:crashinfo_iosd_20100803-073408-UTC
Files in crashinfo:
crashinfo_iosd_20100803-064137-UTC
crashinfo_iosd_20100803-073408-UTC
Enabling the Generation of the Process Core Dump File
If there might be insufficient storage space, you might want to reduce the number of process core dump
files. To do that you must first enable the generation of the process core dump file by performing the
following task:
Command Purpose
Step 1 Switch# config terminal Enters global configuration mode.
Step 2 Switch(config)# exception coredump Generates the process core dump file.
Step 3 Switch(config)# exception coredump maximum-files Limits the number of process core dump files to x.
x
Step 4 Switch(config)# end Returns to global configuration mode.
Step 5 Switch# show exception information (optional) Verifies the configuration.
This example shows how to generate the process core dump file, limit the number of process core dump
files to 2, and to verify the configuration:
Switch# config t
Switch (config)# exception coredump
Switch (config)# exception coredump maximum files 2
Switch (config)# end
Switch# show exception information
Exception configuration information
Coredump file - enabled,compressed
Maximum number of files
Core - 2 file(s)
Process crashinfo - 10 file(s)
Configured storage devices
1 - crashinfo:
2 - not assigned
3 - not assigned
Dump protocol - not configured
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-38 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Configuring Crashinfo
Saving Crash Files to a Secondary Devices
Assume that the system has an installed USB storage device and you want to save the crash files to the
USB storage instead of deleting the old crash files from the default storage crashinfo: partition. The
system starts saving the crash files to either installed and configured USB, when either the maximum
number of files had been reached or there is in sufficient space on the crashinfo: partition.
To configure to save a crash file in a secondary device, perform the following task:
Command Purpose
Step 1 Switch# config terminal Enters global configuration mode.
Step 2 Switch(config)# exception dump second device x Configures x as the storage devices to be searched for
needed storage space.
Step 3 Switch(config)# end Returns to global configuration mode.
Step 4 Switch# show exception information (optional) Verifies the configuration.
Note A portion of the output should indicate that the
secondary device has been configured.
Configured storage devices
1 - crashinfo:
2 - usb0:
3 - not assigned
This example shows how to configure the USB to be searched for needed storage space and to verify
the configuration>
Switch# config t
Switch(config)# exception dump second device usb0:
Switch# show exception information
Exception configuration information
Coredump file - disabled,compressed
Maximum number of files
Core - 10 file(s)
Process crashinfo - 10 file(s)
Configured storage devices
1 - crashinfo:
2 - usb0:
3 - not assigned
Dump protocol - not configured
Determining the Process that Crashed
Your system might have rebooted after a critical process had crashed. If so, you might want to deter-
mine the location of the latest crash file, the process that crashed, and the likely root cause. Cisco TAC
requires the available crash files for root cause analysis. If the crash is due to some side-effects of
another process that crashed earlier, the latest crash file may not contain the actual root cause informa-
tion. We recommend that you provide Cisco TAC all the crash files that are generated around crash
time.
To determine the process that crashed, perform this task:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-39
Chapter 3 Configuring the Switch for the First Time
Configuring Crashinfo
Command Purpose
Step 1 Switch# show exception information Displays the configuration to determine where the crash
files are saved.
Step 2 Switch# more crashinfo:last_crashinfo Locates the latest crashinfo file.
Step 3 Switch# more Displays the contents of the process crashinfo file.
crashinfo:crashinfo_yyyymmdd-hhmmss-UTC
Step 4 Switch(config)# more crashinfo:koops.dat Displays the contents of the kernel crashinfo file to
determine whether the kernel had crashed.
Step 5 Switch# copy crashinfo: tftp: Copies a crash file to a TFTP server. When Cisco TAC
Source filename [}? requests a specific crash file for root cause analysis, you
Address or name of remote host []? remote_host
Destination filename []?
can copy the file to a TFTP server from the switch.
crashinfo_yyyymmdd-hhmmss-UTC
The following examples show how to use these commands:
Switch# show exception information
Exception configuration information
Coredump file - disabled,compressed
Maximum number of files
Core - 10 file(s)
Process crashinfo - 10 file(s)
Configured storage devices
1 - crashinfo:
2 - not assigned
3 - not assigned
Dump protocol - not configured
Switch# more crashinfo:last_crashinfo
crashinfo:crashinfo_iosd_20100803-073408-UTC
Switch# more crashinfo:crashinfo_iosd_20100803-073408-UTC
====== signr 5
======= Process
PID=11773 PPPID=1 PGRP=11773
Time: User=7794 System=724
======= current - pid 11773
====== Registers
nip = 0x0C3CC798 msr = 0x0002D000 r3* = 0x00002DFD ctr = 0x0CF05040
lnk = 0x0CF05050 xer = 0x20000000 ccr = 0x42002444
trp = 0x00000C00 dar = 0x143CDC68 isr = 0x00000000 res = 0x00000000
R0 0x000000FA R1 0x7B37D090 R2 0x4804D780 R3 0x00000000
R4 0x00002DFD R5 0x00000005 R6 0x143CDC68 R7 0x00000000
R8 0x00000000 R9 0x00002DFD R10 0x7B37CEA8 R11 0x0CF05040
R12 0x22002448 R13 0x14FF4008 R14 0x10B50F44 R15 0x00000000
R16 0x00000000 R17 0x14CB665C R18 0x13E70000 R19 0x14CB0000
R20 0x14FF0000 R21 0x00000001 R22 0x891753A1 R23 0x891752A0
R24 0x15AB30D8 R25 0x00000000 R26 0x00000000 R27 0x143CDC68
R28 0x000007CA R29 0x7B37D0E0 R30 0x143D10C4 R31 0x7820B3D4
--More-
//output omitted//
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-40 OL-22250-01
Chapter 3 Configuring the Switch for the First Time
Configuring Crashinfo
Switch# more crashinfo:koops.dat
NOVAOOPS:
<4>CRASHINFO_OOPS:
<4>Oops: Machine check, sig: 7 [#1]
<4>SMP NR_CPUS=2 Cisco Systems K10 (Callista)
<4>Modules linked in: gsbu64atomic mtsmod(P) aipcmod(P) vsi uld_timer cpumem tun bridge
pds crashinfo bpa_mem
<4>NIP: c0022cc0 LR: c00230e8 CTR: c00230b0
<4>REGS: c04c4f50 TRAP: 0202 Tainted: P (2.6.24.4.28.13.k10)
<4>MSR: 00021000 <ME> CR: 24084422 XER: 20000000
<4>TASK = ea088150[13355] 'iosd' THREAD: ea738000 CPU: 0
<6>GPR00: 00000001 ea739c60 ea088150 0000001a ea4c0460 00000000 00000000 00000000
<6>GPR08: c0fec000 c04d0000 fcfd3000 fcfd3060 24084482 1423ebb8 00000000 10121d28
<6>GPR16: 100d0000 ea739db8 c03f61a0 c03fb098 ea088318 c04c0000 ea739f50 ea088530
<6>GPR24: 418004fc ea739e88 00029000 00021000 c04c8eb0 0000005a 0000005a e9b80fa0
<4>NIP [c0022cc0] cisco_tatooine_mask_irq_internal+0x10/0x40
<4>LR [c00230e8] cisco_tatooine_mask_and_ack_irq+0x38/0x60
<4>Call Trace:
<4>[ea739c60] [c00f3004] proc_destroy_inode+0x24/0x40 (unreliable)
<4>[ea739c80] [c0073e0c] free_irq+0x14c/0x170
<4>[ea739ca0] [c0075ee0] irq_proc_release+0x50/0x170
<4>[ea739cc0] [c00f3570] proc_reg_release+0x70/0xd0
<4>[ea739ce0] [c00ab28c] __fput+0xbc/0x1b0
<4>[ea739d00] [c00a777c] filp_close+0x6c/0xd0
<4>[ea739d20] [c004506c] put_files_struct+0x10c/0x120
<4>[ea739d40] [c00468f8] do_exit+0x198/0x7a0
<4>[ea739d90] [c0046f38] do_group_exit+0x38/0x90
<4>[ea739db0] [c0053cc8] get_signal_to_deliver+0x3a8/0x610
<4>[ea739e80] [c0010d68] do_signal+0x48/0x2f0
<4>[ea739f40] [c0018a64] do_user_signal+0x74/0xc4
<4>Instruction dump:
<4>38000001 7c00e830 7d400378 5400043e 7c0004ac b00b0100 4bffffac 00000000
<4>3d20c04d 81498eac 396a0060 7c0004ac <812a0060> 0c090000 4c00012c 3800fffe
TIMESTAMP:
730956298.010309
READFLAG:
Switch# copy crashinfo: tftp:
Source filename [}?
Address or name of remote host []? 10.5.224.2
Destination filename []? /users/user/crashinfo_iosd_20100803-073408-UTC
!!!!!!
790676 bytes copied in 37.420 secs (21130 bytes/sec)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 3-41
Chapter 3 Configuring the Switch for the First Time
Configuring Crashinfo
Software Configuration Guide—Release IOS-XE 3.1.0 SG
3-42 OL-22250-01
CH A P T E R 4
Administering the Switch
This chapter describes how to perform one-time operations to administer the Catalyst 4500 Series
switch.
This chapter also describes how to install and configure the Embedded CiscoView network management
system to provide a graphical representation of a Catalyst 4500 series switch and to provide a GUI-based
management and configuration interface.
This chapter includes the following major sections:
• Managing the System Time and Date, page 4-1
• Configuring a System Name and Prompt, page 4-14
• Creating a Banner, page 4-17
• Managing the MAC Address Table, page 4-19
• Managing the ARP Table, page 4-30
• Configuring Embedded CiscoView Support, page 4-30
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it will be found in the larger
Cisco IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Managing the System Time and Date
You can configure the system time and date on your switch manually or automatically by using Network
Time Protocol (NTP).
These sections contain this configuration information:
• System Clock, page 4-2
• Understanding Network Time Protocol, page 4-2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-1
Chapter 4 Administering the Switch
Managing the System Time and Date
• Configuring NTP, page 4-3
• Configuring Time and Date Manually, page 4-11
System Clock
The core of the time service is the system clock, which monitors the date and time. This clock starts when
the system starts.
The system clock can provide time to these services:
• User show commands
• Logging and debugging messages
The system clock keeps track of time internally based on Universal Time Coordinated (UTC), also
known as Greenwich Mean Time (GMT). You can configure information about the local time zone and
summer time (daylight saving time) so that the time is correct for the local time zone.
The system clock keeps track of whether the time is authoritative or not (whether it has been set by a
time source considered to be authoritative). If it is not authoritative, the time is available only for display
purposes and is not redistributed. For configuration information, see the “Configuring Time and Date
Manually” section on page 4-11.
Understanding Network Time Protocol
The NTP is designed to synchronize a network of devices. NTP runs over User Datagram Protocol
(UDP), which runs over IP. NTP is documented in RFC 1305.
An NTP network usually gets its time from an authoritative time source, such as a radio clock or an
atomic clock attached to a time server. NTP then distributes this time across the network. NTP is
extremely efficient; no more than one packet per minute is necessary to synchronize two devices to
within a millisecond of one another.
NTP uses the concept of a stratum to describe how many NTP hops away a device is from an
authoritative time source. A stratum 1 time server has a radio or atomic clock directly attached, a
stratum 2 time server receives its time through NTP from a stratum 1 time server, and so on. A device
running NTP automatically chooses as its time source the device with the lowest stratum number with
which it communicates through NTP. This strategy effectively builds a self-organizing tree of NTP
speakers.
NTP avoids synchronizing to a device whose time might not have been synchronized. NTP also
compares the time reported by several devices and does not synchronize to a device whose time is
significantly different than the others, even if its stratum is lower.
The communications between devices running NTP (known as associations) are usually statically
configured; each device is given the IP address of all devices with which it should associate. Accurate
timekeeping is possible by exchanging NTP messages between each pair of devices with an association.
However, in a LAN environment, NTP can be configured to use IP broadcast messages instead. This
alternative reduces configuration complexity because each device can simply be configured to send or
receive broadcast messages; however, information flow is one-way only.
The time kept on a device is a critical resource; you should use the security features of NTP to avoid the
accidental or malicious setting of an incorrect time. Two mechanisms are available: an access list-based
restriction scheme and an encrypted authentication mechanism.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-2 OL-22250-01
Chapter 4 Administering the Switch
Managing the System Time and Date
Cisco’s implementation of NTP does not support stratum 1 service; it is not possible to connect to a radio
or atomic clock. We recommend that the time service for your network be derived from the public NTP
servers available on the IP Internet.
Figure 4-1 shows a typical network example using NTP. Switch A is the NTP master, with Switches B,
C, and D configured in NTP server mode, in server association with Switch A. Switch E is configured
as an NTP peer to the upstream and downstream switches, Switch B and Switch F, respectively.
Figure 4-1 Typical NTP Network Configuration
Switch A
Local
workgroup
servers
Switch B Switch C Switch D
Switch E
Workstations
Switch F
101349
Workstations
If the network is isolated from the Internet, Cisco’s implementation of NTP allows a device to act as if
it is synchronized through NTP, when it is not. Other devices then synchronize to that device through
NTP.
NTP time overrides the time set by any other method.
Several manufacturers include NTP software for their host systems, and a public version for systems
running UNIX and its various derivatives is also available. This software allows host systems to be
synchronized as well.
Configuring NTP
These sections contain this configuration information:
• Default NTP Configuration, page 4-4
• Configuring NTP Authentication, page 4-4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-3
Chapter 4 Administering the Switch
Managing the System Time and Date
• Configuring NTP Associations, page 4-6
• Configuring NTP Broadcast Service, page 4-7
• Configuring NTP Access Restrictions, page 4-8
• Configuring the Source IP Address for NTP Packets, page 4-10
• Displaying the NTP Configuration, page 4-11
Default NTP Configuration
Table 4-1 shows the default NTP configuration.
Table 4-1 Default NTP Configuration
Feature Default Setting
NTP authentication Disabled. No authentication key is specified.
NTP peer or server associations None configured.
NTP broadcast service Disabled; no interface sends or receives NTP broadcast packets.
NTP access restrictions No access control is specified.
NTP packet source IP address The source address is set by the outgoing interface.
NTP is enabled on all interfaces by default. All interfaces receive NTP packets.
Configuring NTP Authentication
This procedure must be coordinated with the administrator of the NTP server; the information you
configure in this procedure must be matched by the servers used by the switch to synchronize its time to
the NTP server.
To authenticate the associations (communications between devices running NTP that provide for
accurate timekeeping) with other devices for security purposes, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 ntp authenticate Enables the NTP authentication feature, which is disabled by
default.
Step 3 ntp authentication-key number md5 value Defines the authentication keys. By default, none are defined.
• For number, specify a key number. The range is 1 to
4294967295.
• md5 specifies that message authentication support is provided
by using the message digest algorithm 5 (MD5).
• For value, enter an arbitrary string of up to eight characters for
the key.
The switch does not synchronize to a device unless both have one
of these authentication keys, and the key number is specified by the
ntp trusted-key key-number command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-4 OL-22250-01
Chapter 4 Administering the Switch
Managing the System Time and Date
Command Purpose
Step 4 ntp trusted-key key-number Specifies one or more key numbers (defined in Step 3) that a peer
NTP device must provide in its NTP packets for this switch to
synchronize to it.
By default, no trusted keys are defined.
For key-number, specify the key defined in Step 3.
This command provides protection against accidentally
synchronizing the switch to a device that is not trusted.
Step 5 end Returns to privileged EXEC mode.
Step 6 show running-config Verifies your entries.
Step 7 copy running-config startup-config (Optional) Saves your entries in the configuration file.
To disable NTP authentication, use the no ntp authenticate global configuration command. To remove
an authentication key, use the no ntp authentication-key number global configuration command. To
disable authentication of the identity of a device, use the no ntp trusted-key key-number global
configuration command.
This example shows how to configure the switch to synchronize only to devices providing authentication
key 42 in the device’s NTP packets:
Switch# configure terminal
Switch(config)# ntp authenticate
Switch(config)# ntp authentication-key 42 md5 aNiceKey
Switch(config)# ntp trusted-key 42
Switch(config)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-5
Chapter 4 Administering the Switch
Managing the System Time and Date
Configuring NTP Associations
An NTP association can be a peer association (this switch can either synchronize to the other device or
allow the other device to synchronize to it), or it can be a server association (meaning that only this
switch synchronizes to the other device, and not the other way around).
To form an NTP association with another device, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 ntp peer ip-address [version number] Configures the switch system clock to synchronize a peer or to be
[key keyid] [source interface] synchronized by a peer (peer association).
[prefer]
or or
ntp server ip-address [version
number] [key keyid] [source Configures the switch system clock to be synchronized by a time server
interface] [prefer] (server association).
No peer or server associations are defined by default.
• For ip-address in a peer association, specify either the IP address of
the peer providing, or being provided, the clock synchronization. For
a server association, specify the IP address of the time server
providing the clock synchronization.
• (Optional) For number, specify the NTP version number. The range
is 1 to 3. By default, Version 3 is selected.
• (Optional) For keyid, enter the authentication key defined with the
ntp authentication-key global configuration command.
• (Optional) For interface, specify the interface from which to pick the
IP source address. By default, the source IP address is taken from the
outgoing interface.
• (Optional) Enter the prefer keyword to make this peer or server the
preferred one that provides synchronization. This keyword reduces
switching back and forth between peers and servers.
Step 3 end Returns to privileged EXEC mode.
Step 4 show running-config Verifies your entries.
Step 5 copy running-config startup-config (Optional) Saves your entries in the configuration file.
You need to configure only one end of an association; the other device can automatically establish the
association. If you are using the default NTP version (Version 3) and NTP synchronization does not
occur, try using NTP Version 2. Many NTP servers on the Internet run Version 2.
To remove a peer or server association, use the no ntp peer ip-address or the no ntp server ip-address
global configuration command.
This example shows how to configure the switch to synchronize its system clock with the clock of the
peer at IP address 172.16.22.44 using NTP Version 2:
Switch# configure terminal
Switch(config)# ntp server 172.16.22.44 version 2
Switch(config)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-6 OL-22250-01
Chapter 4 Administering the Switch
Managing the System Time and Date
Configuring NTP Broadcast Service
The communications between devices running NTP (known as associations) are usually statically
configured; each device is given the IP addresses of all devices with which it should form associations.
Accurate timekeeping is possible by exchanging NTP messages between each pair of devices with an
association. However, in a LAN environment, NTP can be configured to use IP broadcast messages
instead. This alternative reduces configuration complexity because each device can simply be
configured to send or receive broadcast messages. However, the information flow is one-way only.
The switch can send or receive NTP broadcast packets on an interface-by-interface basis if there is an
NTP broadcast server, such as a router, broadcasting time information on the network. The switch can
send NTP broadcast packets to a peer so that the peer can synchronize to it. The switch can also receive
NTP broadcast packets to synchronize its own clock. This section provides procedures for both sending
and receiving NTP broadcast packets.
To configure the switch to send NTP broadcast packets to peers so that they can synchronize their clock
to the switch, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 interface interface-id Specifies the interface to send NTP broadcast packets, and enter
interface configuration mode.
Step 3 ntp broadcast [version number] [key Enables the interface to send NTP broadcast packets to a peer.
keyid] [destination-address]
By default, this feature is disabled on all interfaces.
• (Optional) For number, specify the NTP version number. The
range is 1 to 3. If you do not specify a version, Version 3 is used.
• (Optional) For keyid, specify the authentication key to use when
sending packets to the peer.
• (Optional) For destination-address, specify the IP address of the
peer that is synchronizing its clock to this switch.
Step 4 end Returns to privileged EXEC mode.
Step 5 show running-config Verifies your entries.
Step 6 copy running-config startup-config (Optional) Saves your entries in the configuration file.
To disable the interface from sending NTP broadcast packets, use the no ntp broadcast interface
configuration command.
This example shows how to configure a port to send NTP Version 2 packets:
Switch# configure terminal
Switch(config)# interface gigabitethernet0/1
Switch(config-if)# ntp broadcast version 2
Switch(config-if)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-7
Chapter 4 Administering the Switch
Managing the System Time and Date
To configure the switch to receive NTP broadcast packets from connected peers, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 interface interface-id Specifies the interface to receive NTP broadcast packets, and enter
interface configuration mode.
Step 3 ntp broadcast client Enables the interface to receive NTP broadcast packets.
By default, no interfaces receive NTP broadcast packets.
Step 4 exit Returns to global configuration mode.
Step 5 ntp broadcastdelay microseconds (Optional) Changes the estimated round-trip delay between the switch and
the NTP broadcast server.
The default is 3000 microseconds; the range is 1 to 999999.
Step 6 end Returns to privileged EXEC mode.
Step 7 show running-config Verifies your entries.
Step 8 copy running-config startup-config (Optional) Saves your entries in the configuration file.
To disable an interface from receiving NTP broadcast packets, use the no ntp broadcast client interface
configuration command. To change the estimated round-trip delay to the default, use the
no ntp broadcastdelay global configuration command.
This example shows how to configure a port to receive NTP broadcast packets:
Switch# configure terminal
Switch(config)# interface gigabitethernet0/1
Switch(config-if)# ntp broadcast client
Switch(config-if)# end
Switch#
Configuring NTP Access Restrictions
You can control NTP access on two levels as described in these sections:
• Creating an Access Group and Assigning a Basic IP Access List, page 4-9
• Disabling NTP Services on a Specific Interface, page 4-10
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-8 OL-22250-01
Chapter 4 Administering the Switch
Managing the System Time and Date
Creating an Access Group and Assigning a Basic IP Access List
To control access to NTP services by using access lists, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 ntp access-group {query-only | Creates an access group, and apply a basic IP access list.
serve-only | serve | peer}
access-list-number The keywords have these meanings:
• query-only—Allows only NTP control queries.
• serve-only—Allows only time requests.
• serve—Allows time requests and NTP control queries, but does not
allow the switch to synchronize to the remote device.
• peer—Allows time requests and NTP control queries and allows the
switch to synchronize to the remote device.
For access-list-number, enter a standard IP access list number from 1
to 99.
Step 3 access-list access-list-number Creates the access list.
permit source [source-wildcard]
• For access-list-number, enter the number specified in Step 2.
• Enter the permit keyword to permit access if the conditions are
matched.
• For source, enter the IP address of the device that is permitted access
to the switch.
• (Optional) For source-wildcard, enter the wildcard bits to be applied
to the source.
Note When creating an access list, remember that, by default, the end
of the access list contains an implicit deny statement for
everything if it did not find a match before reaching the end.
Step 4 end Returns to privileged EXEC mode.
Step 5 show running-config Verifies your entries.
Step 6 copy running-config startup-config (Optional) Saves your entries in the configuration file.
The access group keywords are scanned in this order, from least restrictive to most restrictive:
1. peer—Allows time requests and NTP control queries and allows the switch to synchronize itself to
a device whose address passes the access list criteria.
2. serve—Allows time requests and NTP control queries, but does not allow the switch to synchronize
itself to a device whose address passes the access list criteria.
3. serve-only—Allows only time requests from a device whose address passes the access list criteria.
4. query-only—Allows only NTP control queries from a device whose address passes the access list
criteria.
If the source IP address matches the access lists for more than one access type, the first type is granted.
If no access groups are specified, all access types are granted to all devices. If any access groups are
specified, only the specified access types are granted.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-9
Chapter 4 Administering the Switch
Managing the System Time and Date
To remove access control to the switch NTP services, use the
no ntp access-group {query-only | serve-only | serve | peer} global configuration command.
This example shows how to configure the switch to allow itself to synchronize to a peer from access
list 99. However, the switch restricts access to allow only time requests from access list 42:
Switch# configure terminal
Switch(config)# ntp access-group peer 99
Switch(config)# ntp access-group serve-only 42
Switch(config)# access-list 99 permit 172.20.130.5
Switch(config)# access list 42 permit 172.20.130.6
Switch(config)# end
Switch#
Disabling NTP Services on a Specific Interface
NTP services are enabled on all interfaces by default.
To disable NTP packets from being received on an interface, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 interface interface-id Enters interface configuration mode, and specify the interface to disable.
Step 3 ntp disable Disables NTP packets from being received on the interface.
By default, all interfaces receive NTP packets.
To reenable receipt of NTP packets on an interface, use the
no ntp disable interface configuration command.
Step 4 end Returns to privileged EXEC mode.
Step 5 show running-config Verifies your entries.
Step 6 copy running-config startup-config (Optional) Saves your entries in the configuration file.
Configuring the Source IP Address for NTP Packets
When the switch sends an NTP packet, the source IP address is normally set to the address of the
interface through which the NTP packet is sent. Use the ntp source global configuration command when
you want to use a particular source IP address for all NTP packets. The address is taken from the
specified interface. This command is useful if the address on an interface cannot be used as the
destination for reply packets.
To configure a specific interface from which the IP source address is to be taken, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 ntp source type number Specifies the interface type and number from which the IP source address
is taken.
By default, the source address is set by the outgoing interface.
Step 3 end Returns to privileged EXEC mode.
Step 4 show running-config Verifies your entries.
Step 5 copy running-config startup-config (Optional) Saves your entries in the configuration file.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-10 OL-22250-01
Chapter 4 Administering the Switch
Managing the System Time and Date
The specified interface is used for the source address for all packets sent to all destinations. If a source
address is to be used for a specific association, use the source keyword in the ntp peer or ntp server
global configuration command as described in the “Configuring NTP Associations” section on page 4-6.
Displaying the NTP Configuration
You can use two privileged EXEC commands to display NTP information:
• show ntp associations [detail]
• show ntp status
For detailed information about the fields in these displays, see the
Cisco IOS Configuration Fundamentals Command Reference, Release 12.3.
Configuring Time and Date Manually
If no other source of time is available, you can manually configure the time and date after the system is
restarted. The time remains accurate until the next system restart. We recommend that you use manual
configuration only as a last resort. If you have an outside source to which the switch can synchronize,
you do not need to manually set the system clock.
These sections contain this configuration information:
• Setting the System Clock, page 4-11
• Displaying the Time and Date Configuration, page 4-12
• Configuring the Time Zone, page 4-12
• Configuring Summer Time (Daylight Saving Time), page 4-13
Setting the System Clock
If you have an outside source on the network that provides time services, such as an NTP server, you do
not need to manually set the system clock.
To set the system clock, perform this task:
Command Purpose
Step 1 clock set hh:mm:ss day month year Manually sets the system clock using one of these formats.
or
clock set hh:mm:ss month day year • For hh:mm:ss, specify the time in hours (24-hour format), minutes,
and seconds. The time specified is relative to the configured time
zone.
• For day, specify the day by date in the month.
• For month, specify the month by name.
• For year, specify the year (no abbreviation).
This example shows how to manually set the system clock to 1:32 p.m. on July 23, 2001:
Switch# clock set 13:32:00 23 July 2001
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-11
Chapter 4 Administering the Switch
Managing the System Time and Date
Displaying the Time and Date Configuration
To display the time and date configuration, use the show clock [detail] privileged EXEC command.
The system clock keeps an authoritative flag that shows whether the time is authoritative (believed to be
accurate). If the system clock has been set by a timing source such as NTP, the flag is set. If the time is
not authoritative, it is used only for display purposes. Until the clock is authoritative and the
authoritative flag is set, the flag prevents peers from synchronizing to the clock when the peers’ time is
invalid.
The symbol that precedes the show clock display has the following meaning:
• Asterix(*)—Time is not authoritative.
• Blank—Time is authoritative.
• Period(.)—Time is authoritative, but NTP is not synchronized.
Configuring the Time Zone
To manually configure the time zone, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 clock timezone zone hours-offset Sets the time zone.
[minutes-offset]
To set the time to UTC, use the no clock timezone global configuration
command.
The switch keeps internal time in universal time coordinated (UTC), so
this command is used only for display purposes and when the time is
manually set.
• For zone, enter the name of the time zone to be displayed when
standard time is in effect. The default is UTC.
• For hours-offset, enter the hours offset from UTC.
• (Optional) For minutes-offset, enter the minutes offset from UTC.
Step 3 end Returns to privileged EXEC mode.
Step 4 show running-config Verifies your entries.
Step 5 copy running-config startup-config (Optional) Saves your entries in the configuration file.
The minutes-offset variable in the clock timezone global configuration command is available for those
cases where a local time zone is a percentage of an hour different from UTC. For example, the time zone
for some sections of Atlantic Canada (AST) is UTC-3.5, where the 3 means 3 hours and .5 means 50
percent. In this case, the necessary command is clock timezone AST -3 30.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-12 OL-22250-01
Chapter 4 Administering the Switch
Managing the System Time and Date
Configuring Summer Time (Daylight Saving Time)
To configure summer time (daylight saving time) in areas where it starts and ends on a particular day of
the week each year, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 clock summer-time zone recurring Configures summer time to start and end on the specified days every year.
[week day month hh:mm week day
month hh:mm [offset]] Summer time is disabled by default. If you specify clock summer-time
zone recurring without parameters, the summer time rules default to the
United States rules.
• For zone, specify the name of the time zone (for example, PDT) to be
displayed when summer time is in effect.
• (Optional) For week, specify the week of the month (1 to 5 or last).
• (Optional) For day, specify the day of the week (Sunday, Monday...).
• (Optional) For month, specify the month (January, February...).
• (Optional) For hh:mm, specify the time (24-hour format) in hours and
minutes.
• (Optional) For offset, specify the number of minutes to add during
summer time. The default is 60.
Step 3 end Returns to privileged EXEC mode.
Step 4 show running-config Verifies your entries.
Step 5 copy running-config startup-config (Optional) Saves your entries in the configuration file.
The first part of the clock summer-time global configuration command specifies when summer time
begins, and the second part specifies when it ends. All times are relative to the local time zone. The start
time is relative to standard time. The end time is relative to summer time. If the starting month is after
the ending month, the system assumes that you are in the southern hemisphere.
This example shows how to specify that summer time starts on the first Sunday in April at 02:00 and
ends on the last Sunday in October at 02:00:
Switch# configure terminal
Switch(config)# clock summer-time PDT recurring 1 Sunday April 2:00 last Sunday October
2:00
Switch(config)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-13
Chapter 4 Administering the Switch
Configuring a System Name and Prompt
If summer time in your area does not follow a recurring pattern (configure the exact date and time of the
next summer time events), perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 clock summer-time zone date [month Configures summer time to start on the first date and end on the second
date year hh:mm month date year date.
hh:mm [offset]]
or To disable summer time, use the no clock summer-time global
clock summer-time zone date [date configuration command.
month year hh:mm date month year
hh:mm [offset]] Summer time is disabled by default.
• For zone, specify the name of the time zone (for example, PDT) to be
displayed when summer time is in effect.
• (Optional) For week, specify the week of the month (1 to 5 or last).
• (Optional) For day, specify the day of the week (Sunday, Monday...).
• (Optional) For month, specify the month (January, February...).
• (Optional) For hh:mm, specify the time (24-hour format) in hours and
minutes.
• (Optional) For offset, specify the number of minutes to add during
summer time. The default is 60.
Step 3 end Returns to privileged EXEC mode.
Step 4 show running-config Verifies your entries.
Step 5 copy running-config startup-config (Optional) Saves your entries in the configuration file.
The first part of the clock summer-time global configuration command specifies when summer time
begins, and the second part specifies when it ends. All times are relative to the local time zone. The start
time is relative to standard time. The end time is relative to summer time. If the starting month is after
the ending month, the system assumes that you are in the southern hemisphere.
To disable summer time, use the no clock summer-time global configuration command.
This example shows how to set summer time to start on October 12, 2000, at 02:00, and end on April
26, 2001, at 02:00:
Switch# configure terminal
Switch(config)# clock summer-time pdt date 12 October 2000 2:00 26 April 2001 2:00
Switch#
Configuring a System Name and Prompt
You configure the system name on the switch to identify it. By default, the system name and prompt are
Switch.
If you have not configured a system prompt, the first 20 characters of the system name are used as the
system prompt. A greater-than symbol [>] is appended. The prompt is updated whenever the system
name changes.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-14 OL-22250-01
Chapter 4 Administering the Switch
Configuring a System Name and Prompt
For complete syntax and usage information for the commands used in this section, see the Cisco IOS
Configuration Fundamentals Command Reference, Release 12.3 and the Cisco IOS IP Command
Reference, Volume 2 of 3: Routing Protocols, Release 12.3.
These sections contain this configuration information:
• Configuring a System Name, page 4-15
• Understanding DNS, page 4-15
Configuring a System Name
To manually configure a system name, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 hostname name Manually configures a system name.
The default setting is switch.
The name must follow the rules for ARPANET hostnames. They must start
with a letter, end with a letter or digit, and have as interior characters only
letters, digits, and hyphens. Names can be up to 63 characters.
To return to the default hostname, use the no hostname global
configuration command.
Step 3 end Returns to privileged EXEC mode.
Step 4 show running-config Verifies your entries.
Step 5 copy running-config (Optional) Saves your entries in the configuration file.
startup-config
When you set the system name, it is also used as the system prompt.
Understanding DNS
The DNS protocol controls the Domain Name System (DNS), a distributed database with which you can
map hostnames to IP addresses. When you configure DNS on your switch, you can substitute the
hostname for the IP address with all IP commands, such as ping, telnet, connect, and related Telnet
support operations.
IP defines a hierarchical naming scheme that allows a device to be identified by its location or domain.
Domain names are pieced together with periods (.) as the delimiting characters. For example, Cisco
Systems is a commercial organization that IP identifies by a com domain name, so its domain name is
cisco.com. A specific device in this domain, for example, the File Transfer Protocol (FTP) system is
identified as ftp.cisco.com.
To keep track of domain names, IP has defined the concept of a domain name server, which holds a cache
(or database) of names mapped to IP addresses. To map domain names to IP addresses, you must first
identify the hostnames, specify the name server that is present on your network, and enable the DNS.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-15
Chapter 4 Administering the Switch
Configuring a System Name and Prompt
These sections contain this configuration information:
• Default DNS Configuration, page 4-16
• Setting Up DNS, page 4-16
• Displaying the DNS Configuration, page 4-17
Default DNS Configuration
Table 4-2 shows the default DNS configuration.
Table 4-2 Default DNS Configuration
Feature Default Setting
DNS enable state Enabled.
DNS default domain name None configured.
DNS servers No name server addresses are configured.
Setting Up DNS
To set up your switch to use the DNS, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 ip domain-name name Defines a default domain name that the software uses to complete unqualified
hostnames (names without a dotted-decimal domain name).
To remove a domain name, use the no ip domain-name name global
configuration command.
Do not include the initial period that separates an unqualified name from the
domain name.
At boot time, no domain name is configured; however, if the switch
configuration comes from a BOOTP or Dynamic Host Configuration Protocol
(DHCP) server, then the default domain name might be set by the BOOTP or
DHCP server (if the servers were configured with this information).
Step 3 ip name-server Specifies the address of one or more name servers to use for name and address
server-address1 resolution.
[server-address2 ...
server-address6] To remove a name server address, use the no ip name-server server-address
global configuration command.
You can specify up to six name servers. Separate each server address with a
space. The first server specified is the primary server. The switch sends DNS
queries to the primary server first. If that query fails, the backup servers are
queried.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-16 OL-22250-01
Chapter 4 Administering the Switch
Creating a Banner
Command Purpose
Step 4 ip domain-lookup (Optional) Enables DNS-based hostname-to-address translation on your switch.
This feature is enabled by default.
To disable DNS on the switch, use the no ip domain-lookup global
configuration command.
If your network devices require connectivity with devices in networks for which
you do not control name assignment, you can dynamically assign device names
that uniquely identify your devices by using the global Internet naming scheme
(DNS).
Step 5 end Returns to privileged EXEC mode.
Step 6 show running-config Verifies your entries.
Step 7 copy running-config (Optional) Saves your entries in the configuration file.
startup-config
If you use the switch IP address as its hostname, the IP address is used and no DNS query occurs. If you
configure a hostname that contains no periods (.), a period followed by the default domain name is
appended to the hostname before the DNS query is made to map the name to an IP address. The default
domain name is the value set by the ip domain-name global configuration command. If there is a
period (.) in the hostname, the Cisco IOS software looks up the IP address without appending any default
domain name to the hostname.
Displaying the DNS Configuration
To display the DNS configuration information, use the show running-config privileged EXEC
command.
Creating a Banner
You can configure a message-of-the-day (MOTD) and a login banner. The MOTD banner displays on
all connected terminals at login and is useful for sending messages that affect all network users (such as
impending system shutdowns).
The login banner also displays on all connected terminals. It appears after the MOTD banner and before
the login prompts.
Note For complete syntax and usage information for the commands used in this section, see the Cisco IOS
Configuration Fundamentals Command Reference, Release 12.3.
These sections contain this configuration information:
• Default Banner Configuration, page 4-18
• Configuring a Message-of-the-Day Login Banner, page 4-18
• Configuring a Login Banner, page 4-19
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-17
Chapter 4 Administering the Switch
Creating a Banner
Default Banner Configuration
The MOTD and login banners are not configured.
Configuring a Message-of-the-Day Login Banner
You can create a single or multiline message banner that appears on the screen when someone logs in to
the switch.
To configure a MOTD login banner, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 banner motd c message c Specifies the message of the day.
To delete the MOTD banner, use the no banner motd global
configuration command.
For c, enter the delimiting character of your choice, for example, a
pound sign (#), and press the Return key. The delimiting character
signifies the beginning and end of the banner text. Characters after the
ending delimiter are discarded.
For message, enter a banner message up to 255 characters. You cannot
use the delimiting character in the message.
Step 3 end Returns to privileged EXEC mode.
Step 4 show running-config Verifies your entries.
Step 5 copy running-config startup-config (Optional) Saves your entries in the configuration file.
This example shows how to configure a MOTD banner for the switch by using the pound sign (#) symbol
as the beginning and ending delimiter:
Switch(config)# banner motd #
This is a secure site. Only authorized users are allowed.
For access, contact technical support.
#
Switch(config)#
This example shows the banner that appears from the previous configuration:
Unix> telnet 172.2.5.4
Trying 172.2.5.4...
Connected to 172.2.5.4.
Escape character is '^]'.
This is a secure site. Only authorized users are allowed.
For access, contact technical support.
User Access Verification
Password:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-18 OL-22250-01
Chapter 4 Administering the Switch
Managing the MAC Address Table
Configuring a Login Banner
You can configure a login banner to be displayed on all connected terminals. This banner appears after
the MOTD banner and before the login prompt.
To configure a login banner, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 banner login c message c Specifies the login message.
To delete the login banner, use the no banner login global configuration
command.
For c, enter the delimiting character of your choice, for example, a pound
sign (#), and press the Return key. The delimiting character signifies the
beginning and end of the banner text. Characters after the ending delimiter
are discarded.
For message, enter a login message up to 255 characters. You cannot use the
delimiting character in the message.
Step 3 end Returns to privileged EXEC mode.
Step 4 show running-config Verifies your entries.
Step 5 copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to configure a login banner for the switch by using the dollar sign ($) symbol
as the beginning and ending delimiter:
Switch# configuration terminal
Switch(config)# banner login $
Access for authorized users only. Please enter your username and password.
$
Switch(config)# end
Switch#
Managing the MAC Address Table
The MAC address table contains address information that the switch uses to forward traffic between
ports. All MAC addresses in the address table are associated with one or more ports. The address table
includes these types of addresses:
• Dynamic address—A source MAC address that the switch learns and then ages when it is not in use.
• Static address—A manually entered unicast address that does not age and that is not lost when the
switch resets.
The address table lists the destination MAC address, the associated VLAN ID, and port number
associated with the address and the type (static or dynamic).
Note For complete syntax and usage information for the commands used in this section, see the command
reference for this release.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-19
Chapter 4 Administering the Switch
Managing the MAC Address Table
These sections contain this configuration information:
• Building the Address Table, page 4-20
• MAC Addresses and VLANs, page 4-20
• Default MAC Address Table Configuration, page 4-21
• Changing the Address Aging Time, page 4-21
• Removing Dynamic Address Entries, page 4-22
• Configuring MAC Change Notification Traps, page 4-22
• Configuring MAC Move Notification Traps, page 4-24
• Configuring MAC Threshold Notification Traps, page 4-26
• Adding and Removing Static Address Entries, page 4-27
• Configuring Unicast MAC Address Filtering, page 4-28
• Displaying Address Table Entries, page 4-30
Building the Address Table
With multiple MAC addresses supported on all ports, you can connect any port on the switch to
individual workstations, repeaters, switches, routers, or other network devices. The switch provides
dynamic addressing by learning the source address of packets it receives on each port and adding the
address and its associated port number to the address table. As stations are added or removed from the
network, the switch updates the address table, adding new dynamic addresses and aging out those that
are not in use.
The aging interval is globally configured. However, the switch maintains an address table for each
VLAN, and STP can accelerate the aging interval on a per-VLAN basis.
The switch sends packets between any combination of ports, based on the destination address of the
received packet. Using the MAC address table, the switch forwards the packet only to the port associated
with the destination address. If the destination address is on the port that sent the packet, the packet is
filtered and not forwarded. The switch always uses the store-and-forward method: complete packets are
stored and checked for errors before transmission.
MAC Addresses and VLANs
All addresses are associated with a VLAN. An address can exist in more than one VLAN and have
different destinations in each. Unicast addresses, for example, could be forwarded to port 1 in VLAN 1
and ports 9, 10, and 1 in VLAN 5.
Each VLAN maintains its own logical address table. A known address in one VLAN is unknown in
another until it is learned or statically associated with a port in the other VLAN.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-20 OL-22250-01
Chapter 4 Administering the Switch
Managing the MAC Address Table
When private VLANs are configured, address learning depends on the type of MAC address:
• Dynamic MAC addresses learned in one VLAN of a private VLAN are replicated in the associated
VLANs. For example, a MAC address learned in a private-VLAN secondary VLAN is replicated in
the primary VLAN.
• Static MAC addresses configured in a primary or secondary VLAN are not replicated in the
associated VLANs. When you configure a static MAC address in a private VLAN primary or
secondary VLAN, you should also configure the same static MAC address in all associated VLANs.
For more information about private VLANs, see Chapter 35, “Configuring Private VLANs.”
Default MAC Address Table Configuration
Table 4-3 shows the default MAC address table configuration.
Table 4-3 Default MAC Address Table Configuration
Feature Default Setting
Aging time 300 seconds
Dynamic addresses Automatically learned
Static addresses None configured
Changing the Address Aging Time
Dynamic addresses are source MAC addresses that the switch learns and then ages when they are not in
use. You can change the aging time setting for all VLANs or for a specified VLAN.
Setting too short an aging time can cause addresses to be prematurely removed from the table. Then
when the switch receives a packet for an unknown destination, it floods the packet to all ports in the same
VLAN as the receiving port. This unnecessary flooding can impact performance. Setting too long an
aging time can cause the address table to be filled with unused addresses, which prevents new addresses
from being learned. Flooding results, which can impact switch performance.
To configure the dynamic address table aging time, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 mac address-table aging-time [0 | Sets the length of time that a dynamic entry remains in the MAC
10-1000000] [vlan vlan-id] address table after the entry is used or updated.
To return to the default value, use the no mac address-table
aging-time global configuration command.
The range is 10 to 1000000 seconds. The default is 300. You can also
enter 0, which disables aging. Static address entries are never aged
or removed from the table.
For vlan-id, valid IDs are 1 to 4094.
Step 3 end Returns to privileged EXEC mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-21
Chapter 4 Administering the Switch
Managing the MAC Address Table
Command Purpose
Step 4 show mac address-table aging-time Verifies your entries.
Step 5 copy running-config startup-config (Optional) Saves your entries in the configuration file.
Removing Dynamic Address Entries
To remove all dynamic entries, use the clear mac address-table dynamic command in EXEC mode.
You can also remove a specific MAC address (clear mac address-table dynamic address
mac-address), remove all addresses on the specified physical port or port channel
(clear mac address-table dynamic interface interface-id), or remove all addresses on a specified
VLAN (clear mac address-table dynamic vlan vlan-id).
To verify that dynamic entries have been removed, use the show mac address-table dynamic privileged
EXEC command.
Configuring MAC Change Notification Traps
MAC change notification enables you to track users on a network by storing the MAC change activity
on the switch. Whenever the switch learns or removes a MAC address, an SNMP notification can be
generated and sent to the network management system. If you have many users entering and exiting the
network, you can set a trap interval time to bundle the notification traps and reduce network traffic. The
MAC notification history table stores the MAC address activity for each hardware port for which the
trap is enabled. MAC address notifications are generated for dynamic and static MAC addresses; events
are not generated for self addresses or multicast addresses.
To send MAC change notification traps to an NMS host, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 snmp-server host host-addr [traps|informs] {version Specifies the recipient of the trap message.
{1|2c|3}} [auth | noauth | priv] community-string
[udp-port port] [notification-type] • For host-addr, specify the name or address of the
NMS.
• Specify traps (the default) to send SNMP traps
to the host. Specify informs to send SNMP
informs to the host.
• Specify the SNMP version to support. Version 1,
the default, is not available with informs.
• For community-string, specify the string to send
with the notification operation. Though you can
set this string by using the snmp-server host
command, we recommend that you define this
string by using the snmp-server community
command before using the snmp-server host
command.
• For notification-type, use the mac-notification
keyword.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-22 OL-22250-01
Chapter 4 Administering the Switch
Managing the MAC Address Table
Command Purpose
Step 3 snmp-server enable traps mac-notification change Enables the switch to send MAC change traps to the
NMS.
To disable the switch from sending MAC change
notification traps, use the
no snmp-server enable traps mac-notification
change global configuration command.
Step 4 mac address-table notification change Enables the MAC address change notification
feature.
Step 5 mac address-table notification change Enters the trap interval time and the history table
[interval value] | [history-size value] size.
• (Optional) For interval value, specify the
notification trap interval in seconds between
each set of traps that are generated to the NMS.
The range is 0 to 2147483647 seconds; the
default is 1 second.
• (Optional) For history-size value, specify the
maximum number of entries in the MAC
notification history table. The range is 0 to 500;
the default is 1.
To disable the MAC change notification feature, use
the no mac address-table notification change
global configuration command.
Step 6 interface interface-id Enters interface configuration mode, and specify the
interface on which to enable the SNMP MAC change
notification trap.
Step 7 snmp trap mac-notification change {added | removed} Enables the MAC change notification trap.
• Enable the MAC change notification trap
whenever a MAC address is added on this
interface.
• Enable the MAC change notification trap
whenever a MAC address is removed from this
interface.
To disable the MAC change notification traps on a
specific interface, use the no snmp trap
mac-notification change {added | removed}
interface configuration command.
Step 8 end Returns to privileged EXEC mode.
Step 9 show mac address-table notification change interface Verifies your entries.
show running-config
Step 10 copy running-config startup-config (Optional) Saves your entries in the configuration
file.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-23
Chapter 4 Administering the Switch
Managing the MAC Address Table
This example shows how to specify 172.69.59.93 as the network management system, enable the switch
to send MAC change notification traps to the network management system, enable the MAC change
notification feature, set the interval time to 60 seconds, set the history-size to 100 entries, and enable
traps whenever a MAC address is added on the specified port:
Switch# configure terminal
Switch(config)# snmp-server host 172.69.59.93 private mac-notification
Switch(config)# snmp-server enable traps mac-notification change
Switch(config)# mac address-table notification change
Switch(config)# mac address-table notification change interval 60
Switch(config)# mac address-table notification change history-size 100
Switch(config)# interface fastethernet0/2
Switch(config-if)# snmp trap mac-notification change added
Switch(config-if)# end
Switch# show mac address-table notification change interface
MAC Notification Feature is Enabled on the switch
MAC Notification Flags For All Ethernet Interfaces :
----------------------------------------------------
Interface MAC Added Trap MAC Removed Trap
--------- -------------- ----------------
GigabitEthernet1/1 Enabled Enabled
GigabitEthernet1/2 Enabled Enabled
GigabitEthernet1/3 Enabled Enabled
GigabitEthernet1/4 Enabled Enabled
GigabitEthernet1/5 Enabled Enabled
GigabitEthernet1/6 Enabled Enabled
GigabitEthernet1/7 Enabled Enabled
GigabitEthernet1/8 Enabled Enabled
GigabitEthernet1/9 Enabled Enabled
GigabitEthernet1/10 Enabled Enabled
GigabitEthernet1/11 Enabled Enabled
GigabitEthernet1/12 Enabled Enabled
Switch#
Configuring MAC Move Notification Traps
When you configure MAC move notification, an SNMP notification is generated and sent to the network
management system whenever a MAC address moves from one port to another within the same VLAN.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-24 OL-22250-01
Chapter 4 Administering the Switch
Managing the MAC Address Table
To configure MAC move notification, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 snmp-server host host-addr [traps|informs] {version Specifies the recipient of the trap message.
{1|2c|3}} [auth | noauth | priv] community-string
[udp-port port] [notification-type] • For host-addr, specify the name or address of the
NMS.
• Specify traps (the default) to send SNMP traps
to the host. Specify informs to send SNMP
informs to the host.
• Specify the SNMP version to support. Version 1,
the default, is not available with informs.
• For community-string, specify the string to send
with the notification operation. Though you can
set this string by using the snmp-server host
command, we recommend that you define this
string by using the snmp-server community
command before using the snmp-server host
command.
• For notification-type, use the mac-notification
keyword.
Step 3 snmp-server enable traps mac-notification move Enables the switch to send MAC move notification
traps to the NMS.
To disable the switch from sending MAC
notification traps, use the
no snmp-server enable traps mac-notification
move global configuration command.
Step 4 mac address-table notification mac-move Enables the MAC-move notification feature.
To disable this feature, use the
no mac-address-table notification mac-move
global configuration command.
Step 5 end Returns to privileged EXEC mode.
Step 6 show mac address-table notification mac-move Displays the MAC-move notification status.
show running-config
Step 7 copy running-config startup-config (Optional) Saves your entries in the configuration
file.
This example shows how to specify 172.69.59.93 as the network management system, enable the switch
to send MAC move notification traps to the NMS, enable the MAC move notification feature, and enable
traps whenever a MAC address moves from one port to another:
Switch# configure terminal
Switch(config)# snmp-server host 171.69.59.93 private mac-notification
Switch(config)# snmp-server enable traps mac-notification move
Switch(config)# mac address-table notification mac-move
Switch(config)# end
Switch# show mac address-table notification mac-move
MAC Move Notification: Enabled
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-25
Chapter 4 Administering the Switch
Managing the MAC Address Table
Configuring MAC Threshold Notification Traps
When you configure MAC threshold notification, an SNMP notification is generated and sent to the
network management system when a MAC address table (MAT) threshold limit is reached or exceeded.
To configure MAC address threshold notification, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 snmp-server host host-addr [traps|informs] {version Specifies the recipient of the trap message.
{1|2c|3}} [auth | noauth | priv] community-string
[udp-port port] [notification-type] • For host-addr, specify the name or address of the
NMS.
• Specify traps (the default) to send SNMP traps
to the host. Specify informs to send SNMP
informs to the host.
• Specify the SNMP version to support. Version 1,
the default, is not available with informs.
• For community-string, specify the string to send
with the notification operation. Though you can
set this string by using the snmp-server host
command, we recommend that you define this
string by using the snmp-server community
command before using the snmp-server host
command.
• For notification-type, use the mac-notification
keyword.
Step 3 snmp-server enable traps mac-notification threshold Enables the switch to send MAC threshold
notification traps to the NMS.
To disable the switch from sending MAC threshold
notification traps, use the
no snmp-server enable traps mac-notification
threshold global configuration command.
Step 4 mac address-table notification threshold Enables the MAC address threshold notification
feature.
To disable this feature, use the
no address-table notification threshold global
configuration command.
Step 5 mac address-table notification threshold Enters the threshold value for the MAT usage
[limit percentage] | [interval time] monitoring.
• (Optional) For limit percentage, specify the
percentage of the MAT utilization; valid values
are from 1 to 100 percent. Default is 50 per cent.
• (Optional) For interval time, specify the time
between notifications; valid values are greater
than or equal to 120 seconds. Default is 120
seconds.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-26 OL-22250-01
Chapter 4 Administering the Switch
Managing the MAC Address Table
Command Purpose
Step 6 end Returns to privileged EXEC mode.
Step 7 show mac address-table notification threshold Displays the MAT utilization threshold notification
show running-config status.
Step 8 copy running-config startup-config (Optional) Saves your entries in the configuration
file.
This example shows how to specify 172.69.59.93 as the network management system, enable the MAC
threshold notification feature, enable the switch to send MAC threshold notification traps to the NMS,
set the interval to 123 seconds, and set the limit to 78 per cent:
Switch# configure terminal
Switch(config)# snmp-server host 171.69.59.93 private mac-notification
Switch(config)# snmp-server enable traps mac-notification threshold
Switch(config)# mac address-table notification threshold
Switch(config)# mac address-table notification threshold interval 123
Switch(config)# mac address-table notification threshold limit 78
Switch(config)# end
Switch# show mac-address-table notification threshold
Status limit Interval
-------------+-----------+-------------
enabled 78 123
Switch#
Adding and Removing Static Address Entries
A static address has these characteristics:
• It is manually entered in the address table and must be manually removed.
• It can be a unicast or multicast address.
• It does not age and is retained when the switch restarts.
You can add and remove static addresses and define the forwarding behavior for them. The forwarding
behavior defines how a port that receives a packet forwards it to another port for transmission. Because
all ports are associated with at least one VLAN, the switch acquires the VLAN ID for the address from
the ports that you specify. You can specify a different list of destination ports for each source port.
A packet with a static address that arrives on a VLAN where it has not been statically entered is flooded
to all ports and not learned.
You add a static address to the address table by specifying the destination MAC unicast address and the
VLAN from which it is received. Packets received with this destination address are forwarded to the
interface specified with the interface-id option.
When you configure a static MAC address in a private-VLAN primary or secondary VLAN, you should
also configure the same static MAC address in all associated VLANs. Static MAC addresses configured
in a private-VLAN primary or secondary VLAN are not replicated in the associated VLAN. For more
information about private VLANs, see Chapter 35, “Configuring Private VLANs.”
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-27
Chapter 4 Administering the Switch
Managing the MAC Address Table
To add a static address, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 mac address-table static mac-addr Adds a static address to the MAC address table.
vlan vlan-id interface interface-id
• For mac-addr, specify the destination MAC unicast address to add to
the address table. Packets with this destination address received in the
specified VLAN are forwarded to the specified interface.
• For vlan-id, specify the VLAN for which the packet with the
specified MAC address is received. Valid VLAN IDs are 1 to 4094.
• For interface-id, specify the interface to which the received packet is
forwarded. Valid interfaces include physical ports or port channels.
You can specify static multicast addresses for multiple interface IDs.
However, you cannot assign static unicast MAC address to multiple
interfaces with the same MAC address and VLAN ID.
To remove static entries from the address table, use the
no mac address-table static mac-addr vlan vlan-id [interface
interface-id] global configuration command.
Step 3 end Returns to privileged EXEC mode.
Step 4 show mac address-table static Verifies your entries.
Step 5 copy running-config startup-config (Optional) Saves your entries in the configuration file.
This example shows how to add the static address c2f3.220a.12f4 to the MAC address table. When a
packet is received in VLAN 4 with this MAC address as its destination address, the packet is forwarded
to the specified port:
Switch# configure terminal
Switch(config)# mac address-table static c2f3.220a.12f4 vlan 4 interface
gigabitethernet0/1
Switch(config)# end
Switch#
Configuring Unicast MAC Address Filtering
Note Unicast MAC Address Filtering is not supported on Supervisor Engine 6-E.
When unicast MAC address filtering is enabled, the switch drops packets with specific source or
destination MAC addresses. This feature is disabled by default and only supports unicast static
addresses.
Follow these guidelines when using this feature:
• Multicast MAC addresses, broadcast MAC addresses, and router MAC addresses are not supported.
If you specify one of these addresses when entering the mac address-table static mac-addr vlan
vlan-id drop global configuration command, one of these messages appears:
% Only unicast addresses can be configured to be dropped
% CPU destined address cannot be configured as drop address
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-28 OL-22250-01
Chapter 4 Administering the Switch
Managing the MAC Address Table
• Packets that are forwarded to the CPU are also not supported.
• If you add a unicast MAC address as a static address and configure unicast MAC address filtering,
the switch either adds the MAC address as a static address or drops packets with that MAC address,
depending on which command was entered last. The second command that you entered overrides
the first command.
For example, if you enter the mac address-table static mac-addr vlan vlan-id interface global
configuration command followed by the mac address-table static mac-addr vlan vlan-id drop
command, the switch drops packets with the specified MAC address as a source or destination.
If you enter the mac address-table static mac-addr vlan vlan-id drop global configuration
command followed by the mac address-table static mac-addr vlan vlan-id interface command, the
switch adds the MAC address as a static address.
You enable unicast MAC address filtering and configure the switch to drop packets with a specific
address by specifying the source or destination unicast MAC address and the VLAN from which it is
received.
To configure the switch to drop a source or destination unicast static address, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 mac address-table static mac-addr Enables unicast MAC address filtering and configure the switch to drop a
vlan vlan-id drop packet with the specified source or destination unicast static address.
• For mac-addr, specify a source or destination unicast MAC address.
Packets with this MAC address are dropped.
• For vlan-id, specify the VLAN for which the packet with the
specified MAC address is received. Valid VLAN IDs are 1 to 4094.
To disable unicast MAC address filtering, use the no mac address-table
static mac-addr vlan vlan-id global configuration command.
Step 3 end Returns to privileged EXEC mode.
Step 4 show mac address-table static Verifies your entries.
Step 5 copy running-config startup-config (Optional) Saves your entries in the configuration file.
This example shows how to enable unicast MAC address filtering and to configure the switch to drop
packets that have a source or destination address of c2f3.220a.12f4. When a packet is received in
VLAN 4 with this MAC address as its source or destination, the packet is dropped:
Switch# configure terminal
Switch(config)# mac a ddress-table static c2f3.220a.12f4 vlan 4 drop
Switch(config)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-29
Chapter 4 Administering the Switch
Managing the ARP Table
Displaying Address Table Entries
You can display the MAC address table by using one or more of the privileged EXEC commands
described in Table 4-4:
Table 4-4 Commands for Displaying the MAC Address Table
Command Description
show ip igmp snooping groups Displays the Layer 2 multicast entries for all VLANs or the specified VLAN.
show mac address-table address Displays MAC address table information for the specified MAC address.
show mac address-table aging-time Displays the aging time in all VLANs or the specified VLAN.
show mac address-table count Displays the number of addresses present in all VLANs or the specified VLAN.
show mac address-table dynamic Displays only dynamic MAC address table entries.
show mac address-table interface Displays the MAC address table information for the specified interface.
show mac address-table notification Displays the MAC notification parameters and history table.
show mac address-table static Displays only static MAC address table entries.
show mac address-table vlan Displays the MAC address table information for the specified VLAN.
Managing the ARP Table
To communicate with a device (over Ethernet, for example), the software first must learn the 48-bit
MAC address or the local data link address of that device. The process of learning the local data link
address from an IP address is called address resolution.
The Address Resolution Protocol (ARP) associates a host IP address with the corresponding media or
MAC addresses and the VLAN ID. Using an IP address, ARP finds the associated MAC address. When
a MAC address is found, the IP-MAC address association is stored in an ARP cache for rapid retrieval.
Then the IP datagram is encapsulated in a link-layer frame and sent over the network. Encapsulation of
IP datagrams and ARP requests and replies on IEEE 802 networks other than Ethernet is specified by
the Subnetwork Access Protocol (SNAP). By default, standard Ethernet-style ARP encapsulation
(represented by the arpa keyword) is enabled on the IP interface.
ARP entries added manually to the table do not age and must be manually removed.
For CLI procedures, see the Cisco IOS Release 12.3 documentation on Cisco.com.
Configuring Embedded CiscoView Support
The Catalyst 4500 series switch supports CiscoView web-based administration through the Catalyst
Web Interface (CWI) tool. CiscoView is a device management application that can be embedded on the
switch flash and provides dynamic status, monitoring, and configuration information for your switch.
CiscoView displays a physical view of your switch chassis with color-coded modules and ports and
monitoring capabilities that display the switch status, performance, and other statistics. Configuration
capabilities allow comprehensive changes to devices, if the required security privileges have been
granted. The configuration and monitoring capabilities for the Catalyst 4500 series of switches mirror
those available in CiscoView in all server-based CiscoWorks solutions, including CiscoWorks LAN
Management Solution (LMS) and CiscoWorks Routed WAN Management Solution (RWAN).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-30 OL-22250-01
Chapter 4 Administering the Switch
Configuring Embedded CiscoView Support
These sections describe the Embedded CiscoView support available with
Cisco IOS Release 12.1(20)EW and later releases:
• Understanding Embedded CiscoView, page 4-31
• Installing and Configuring Embedded CiscoView, page 4-31
• Displaying Embedded CiscoView Information, page 4-33
Understanding Embedded CiscoView
The Embedded CiscoView network management system is a web-based interface that uses HTTP and
SNMP to provide a graphical representation of the switch and to provide a GUI-based management and
configuration interface.
Installing and Configuring Embedded CiscoView
To install and configure Embedded CiscoView, perform this task:
Command Purpose
Step 1 Switch# dir device_name Displays the contents of the device.
If you are installing Embedded CiscoView for the first
time, or if the CiscoView directory is empty, skip to
Step 5.
Step 2 Switch# delete device_name:cv/* Removes existing files from the CiscoView directory.
Step 3 Switch# squeeze device_name: Recovers the space in the file system.
Step 4 Switch# copy tftp bootflash Copies the tar file to bootflash.
Step 5 Switch# archive tar /xtract tftp:// Extracts the CiscoView files from the tar file on the
ip address of tftp server/ciscoview.tar TFTP server to the CiscoView directory.
device_name:cv
Step 6 Switch# dir device_name: Displays the contents of the device.
In a redundant configuration, repeat Step 1 through
Step 6 for the file system on the redundant supervisor
engine.
Step 7 Switch# configure terminal Enters global configuration mode.
Step 8 Switch(config)# ip http server Enables the HTTP web server.
Step 9 Switch(config)# snmp-server community string ro Configures the SNMP password for read-only operation.
Step 10 Switch(config)# snmp-server community string rw Configures the SNMP password for read/write operation.
Note The default password for accessing the switch web page is the enable-level password of the switch.
The following example shows how to install and configure Embedded CiscoView on your switch:
Switch# dir
Directory of bootflash:/
Directory of bootflash:/
1 -rw- 9572396 Dec 30 2002 01:05:01 +00:00 cat4000-i9k2s-mz.121-19.EW
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-31
Chapter 4 Administering the Switch
Configuring Embedded CiscoView Support
2 -rw- 9604192 Jan 3 2003 07:46:49 +00:00 cat4000-i5k2s-mz.121-19.EW
3 -rw- 1985024 Jan 21 2003 03:31:20 +00:00 Cat4000IOS.v4-0.tar
4 -rw- 1910127 Jan 23 2003 04:23:39 +00:00 cv/Cat4000IOS-4.0.sgz
5 -rw- 7258 Jan 23 2003 04:23:46 +00:00 cv/Cat4000IOS-4.0_ace.html
6 -rw- 405 Jan 23 2003 04:23:46 +00:00 cv/Cat4000IOS-4.0_error.html
7 -rw- 2738 Jan 23 2003 04:23:46 +00:00 cv/Cat4000IOS-4.0_install.html
8 -rw- 20450 Jan 23 2003 04:23:46 +00:00 cv/Cat4000IOS-4.0_jks.jar
9 -rw- 20743 Jan 23 2003 04:23:46 +00:00 cv/Cat4000IOS-4.0_nos.jar
10 -rw- 12383 Jan 23 2003 04:23:46 +00:00 cv/applet.html
11 -rw- 529 Jan 23 2003 04:23:46 +00:00 cv/cisco.x509
12 -rw- 2523 Jan 23 2003 04:23:46 +00:00 cv/identitydb.obj
13 -rw- 1173 Mar 19 2003 05:50:26 +00:00 post-2003.03.19.05.50.07-passed.txt
32578556 bytes total (38199688 bytes free)
Switch#
Switch# del cv/*
Delete filename [cv/*]?
Delete bootflash:cv/Cat4000IOS-4.0.sgz? [confirm]y
Delete bootflash:cv/Cat4000IOS-4.0_ace.html? [confirm]y
Delete bootflash:cv/Cat4000IOS-4.0_error.html? [confirm]y
Delete bootflash:cv/Cat4000IOS-4.0_install.html? [confirm]y
Delete bootflash:cv/Cat4000IOS-4.0_jks.jar? [confirm]y
Delete bootflash:cv/Cat4000IOS-4.0_nos.jar? [confirm]y
Delete bootflash:cv/applet.html? [confirm]y
Delete bootflash:cv/cisco.x509? [confirm]y
Delete bootflash:cv/identitydb.obj? [confirm]y
Switch#
Switch# squeeze bootflash:
All deleted files will be removed. Continue? [confirm]y
Squeeze operation may take a while. Continue? [confirm]y
Squeeze of bootflash complete
Switch#
Switch# copy tftp bootflash
Address or name of remote host []? 10.5.5.5
Source filename []? Cat4000IOS.v5-1.tar
Destination filename [Cat4000IOS.v5-1.tar]?
Accessing tftp://10.5.5.5/Cat4000IOS.v5-1.tar...
Loading Cat4000IOS.v5-1.tar from 10.5.5.5 (via FastEthernet2/1):
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
[OK - 2031616 bytes]
2031616 bytes copied in 11.388 secs (178400 bytes/sec)
Switch#
Switch# dir
Directory of bootflash:/
Directory of bootflash:/
1 -rw- 9572396 Dec 30 2002 01:05:01 +00:00 cat4000-i9k2s-mz.121-19.EW
2 -rw- 9604192 Jan 3 2003 07:46:49 +00:00 cat4000-i5k2s-mz.121-19.EW
3 -rw- 1985024 Jan 21 2003 03:31:20 +00:00 Cat4000IOS.v4-0.tar
4 -rw- 1173 Mar 19 2003 05:50:26 +00:00 post-2003.03.19.05.50.07-passed.txt
5 -rw- 2031616 Mar 26 2003 05:33:12 +00:00 Cat4000IOS.v5-1.tar
32578556 bytes total (38199688 bytes free)
Switch#
Switch# archive tar /xtract Cat4000IOS.v5-1.tar /cv
extracting Cat4000IOS-5.1.sgz (1956591 bytes)
extracting Cat4000IOS-5.1_ace.html (7263 bytes)
extracting Cat4000IOS-5.1_error.html (410 bytes)
extracting Cat4000IOS-5.1_install.html (2743 bytes)
extracting Cat4000IOS-5.1_jks.jar (20450 bytes)
extracting Cat4000IOS-5.1_nos.jar (20782 bytes)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-32 OL-22250-01
Chapter 4 Administering the Switch
Configuring Embedded CiscoView Support
extracting applet.html (12388 bytes)
extracting cisco.x509 (529 bytes)
extracting identitydb.obj (2523 bytes)
Switch#
Switch# dir
Directory of bootflash:/
1 -rw- 9572396 Dec 30 2002 01:05:01 +00:00 cat4000-i9k2s-mz.121-19.EW
2 -rw- 9604192 Jan 3 2003 07:46:49 +00:00 cat4000-i5k2s-mz.121-19.EW
3 -rw- 1985024 Jan 21 2003 03:31:20 +00:00 Cat4000IOS.v4-0.tar
4 -rw- 1173 Mar 19 2003 05:50:26 +00:00 post-2003.03.19.05.50.07-passed.txt
5 -rw- 2031616 Mar 26 2003 05:33:12 +00:00 Cat4000IOS.v5-1.tar
6 -rw- 1956591 Mar 26 2003 05:36:11 +00:00 cv/Cat4000IOS-5.1.sgz
7 -rw- 7263 Mar 26 2003 05:36:19 +00:00 cv/Cat4000IOS-5.1_ace.html
8 -rw- 410 Mar 26 2003 05:36:19 +00:00 cv/Cat4000IOS-5.1_error.html
9 -rw- 2743 Mar 26 2003 05:36:19 +00:00 cv/Cat4000IOS-5.1_install.html
10 -rw- 20450 Mar 26 2003 05:36:19 +00:00 cv/Cat4000IOS-5.1_jks.jar
11 -rw- 20782 Mar 26 2003 05:36:19 +00:00 cv/Cat4000IOS-5.1_nos.jar
12 -rw- 12388 Mar 26 2003 05:36:19 +00:00 cv/applet.html
13 -rw- 529 Mar 26 2003 05:36:19 +00:00 cv/cisco.x509
14 -rw- 2523 Mar 26 2003 05:36:19 +00:00 cv/identitydb.obj
32578556 bytes total (7358284 bytes free)
Switch#
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# ip http server
Switch(config)# snmp-server community public ro
Switch(config)# snmp-server community public rw
Switch(config)# exit
Switch# wr
Building configuration...
Compressed configuration from 2735 bytes to 1169 bytes[OK]
Switch# show ciscoview ?
package ADP Package Details
version ADP version
| Output modifiers
<
For more information about web access to the switch, refer to the “Using the Cisco Web Browser”
chapter in the Cisco IOS Configuration Fundamentals Configuration Guide at this URL:
http://www.cisco.com/en/US/docs/ios/fundamentals/configuration/guide/12_4t/cf_12_4t_book.html
Displaying Embedded CiscoView Information
To display the Embedded CiscoView information, enter the following commands:
Command Purpose
Switch# show ciscoview package Displays information about the Embedded CiscoView files.
Switch# show ciscoview version Displays the Embedded CiscoView version.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 4-33
Chapter 4 Administering the Switch
Configuring Embedded CiscoView Support
The following example shows how to display the Embedded CiscoView file and version information:
Switch# show ciscoview package
File source:
CVFILE SIZE(in bytes)
------------------------------------------------
Cat4000IOS-5.1.sgz 1956591
Cat4000IOS-5.1_ace.html 7263
Cat4000IOS-5.1_error.html 410
Cat4000IOS-5.1_install.html 2743
Cat4000IOS-5.1_jks.jar 20450
Cat4000IOS-5.1_nos.jar 20782
applet.html 12388
cisco.x509 529
identitydb.obj 2523
Switch# show ciscoview version
Engine Version: 5.3.4 ADP Device: Cat4000IOS ADP Version: 5.1 ADK: 49
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
4-34 OL-22250-01
CH A P T E R 5
Configuring Supervisor Engine Redundancy Using
RPR and SSO
Catalyst 4500 series switches allow a standby supervisor engine to take over if the active supervisor
engine fails. In software, supervisor engine redundancy is enabled by running the redundant supervisor
engine in route processor redundancy (RPR) or stateful switchover (SSO) operating mode.
Note The minimum ROMMON requirement for running SSO and RPR on Supervisor Engine 7-E is
15.0(1r)SG1.
This chapter describes how to configure supervisor engine redundancy on the Catalyst 4507R and
Catalyst 4510R switches.
Note For information on Cisco nonstop forwarding (NSF) with SSO, see Chapter 9, “Configuring Cisco NSF
with SSO Supervisor Engine Redundancy.”
This chapter contains these major sections:
• About Supervisor Engine Redundancy, page 5-2
• About Supervisor Engine Redundancy Synchronization, page 5-5
• Supervisor Engine Redundancy Guidelines and Restrictions, page 5-6
• Configuring Supervisor Engine Redundancy, page 5-7
• Performing a Manual Switchover, page 5-12
• Performing a Software Upgrade, page 5-13
• Manipulating Bootflash on the Standby Supervisor Engine, page 5-14
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 5-1
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
About Supervisor Engine Redundancy
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Supervisor Engine Redundancy
These sections describe supervisor engine redundancy:
• Overview, page 5-2
• RPR Operation, page 5-3
• SSO Operation, page 5-3
Overview
With supervisor engine redundancy enabled, if the active supervisor engine fails or if a manual
switchover is performed, the standby supervisor engine becomes the “new” active supervisor engine.
The standby supervisor engine has been automatically initialized with the startup configuration of the
active supervisor engine, shortening the switchover time (30 seconds or longer in RPR mode, depending
on the configuration; subsecond in SSO mode).
In addition to the reduced switchover time, supervisor engine redundancy supports the following:
• Online insertion and removal (OIR) of the supervisor engine.
Supervisor engine redundancy allows OIR of the redundant supervisor engine for maintenance.
When the redundant supervisor engine is inserted, the active supervisor engine detects its presence,
and the redundant supervisor engine boots into a partially-initialized state in RPR mode and a
fully-initialized state in SSO mode.
• Software upgrade. (See the “Performing a Software Upgrade” section on page 5-13.)
To minimize down time during software changes on the supervisor engine, load the new image on
the standby supervisor engine, and conduct a switchover.
When power is first applied to a switch, the supervisor engine that boots first becomes the active
supervisor engine and remains active until a switchover occurs.
A switchover will occur when one or more of the following events take place:
• The active supervisor engine fails (due to either hardware or software function) or is removed.
• A user forces a switchover.
• A user reloads the active supervisor engine.
Table 5-1 provides information about chassis and supervisor engine support for redundancy.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
5-2 OL-22250-01
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
About Supervisor Engine Redundancy
Table 5-1 Chassis and Supervisor Support
Switch Supported Supported Supervisor Engines
WS-C4507R-E Supervisor Engine 7-E (WS-X45-SUP7-E)
WS-C4510R-E Supervisor Engine 7-E (WS-X45-SUP7-E)
WS-C4507R+E Supervisor Engine 7-E (WS-X45-SUP7-E)
WS-C4510R+E Supervisor Engine 7-E (WS-X45-SUP7-E)
RPR Operation
RPR is supported in Cisco IOS-XE Release 3.1.0 SG and later releases. When a standby supervisor
engine runs in RPR mode, it starts up in a partially-initialized state and is synchronized with the
persistent configuration of the active supervisor engine.
Note Persistent configuration includes the following components: startup-config, boot variables,
config-register, and VLAN database.
The standby supervisor engine pauses the startup sequence after basic system initialization, and in the
event that the active supervisor engine fails, the standby supervisor engine becomes the new active
supervisor engine.
In a supervisor engine switchover, traffic is disrupted because in the RPR mode all of the physical ports
restart since there is no state maintained between supervisor engines relating to module types and
statuses. Upon switchover, when the standby supervisor engine completes its initialization, it will read
hardware information directly from the module and become the active supervisor engine.
SSO Operation
SSO is supported in Cisco IOS-XE Release 3.1.0 SG and later releases. When a standby supervisor
engine runs in SSO mode, the standby supervisor engine starts up in a fully-initialized state and
synchronizes with the persistent configuration and the running configuration of the active supervisor
engine. It subsequently maintains the state on the protocols listed below, and all changes in hardware
and software states for features that support stateful switchover are kept in synchronization.
Consequently, it offers zero interruption to Layer 2 sessions in a redundant supervisor engine
configuration.
Because the standby supervisor engine recognizes the hardware link status of every link, ports that were
active before the switchover will remain active, including the uplink ports. However, because uplink
ports are physically on the supervisor engine, they will be disconnected if the supervisor engine is
removed.
If the active supervisor engine fails, the standby supervisor engine become active. This newly active
supervisor engine uses existing Layer 2 switching information to continue forwarding traffic. Layer 3
forwarding will be delayed until the routing tables have been repopulated in the newly active supervisor
engine.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 5-3
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
About Supervisor Engine Redundancy
SSO supports stateful switchover of the following Layer 2 features.
Note SSO is not supported if the IOS-XE software is running in the LAN Base mode.
The state of these features is preserved between both the active and standby supervisor engines:
• 802.3
• 802.3u
• 802.3x (Flow Control)
• 802.3ab (GE)
• 802.3z (Gigabit Ethernet including CWDM)
• 802.3ad (LACP)
• 802.1p (Layer 2 QoS)
• 802.1q
• 802.1X (Authentication)
• 802.1D (Spanning Tree Protocol)
• 802.3af (Inline power)
• PAgP
• VTP
• Dynamic ARP Inspection
• DHCP snooping
• IP source guard
• IGMP snooping (versions 1 and 2)
• DTP (802.1q and ISL)
• MST
• PVST+
• Rapid-PVST
• PortFast/UplinkFast/BackboneFast
• BPDU guard and filtering
• Voice VLAN
• Port security
• Unicast MAC filtering
• ACL (VACLS, PACLS, RACLS)
• QOS (DBL)
• Multicast storm control/broadcast storm control
SSO is compatible with the following list of features. However, the protocol database for these features
is not synchronized between the standby and active supervisor engines:
• 802.1Q tunneling with Layer 2 Protocol Tunneling (L2PT)
• Baby giants
Software Configuration Guide—Release IOS-XE 3.1.0 SG
5-4 OL-22250-01
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
About Supervisor Engine Redundancy Synchronization
• Jumbo frame support
• CDP
• Flood blocking
• UDLD
• SPAN/RSPAN
• NetFlow
The following features are learned on the standby supervisor engine if the SSO feature is enabled:
• All Layer 3 protocols on Catalyst 4500 series switches (Switch Virtual Interfaces)
About Supervisor Engine Redundancy Synchronization
During normal operation, the persistent configuration (RPR and SSO) and the running configuration
(SSO only) are synchronized by default between the two supervisor engines. In a switchover, the new
active supervisor engine uses the current configuration.
Note You cannot enter CLI commands on the standby supervisor engine console.
These sections describe supervisor engine redundancy synchronization:
• RPR Supervisor Engine Configuration Synchronization, page 5-5
• SSO Supervisor Engine Configuration Synchronization, page 5-6
RPR Supervisor Engine Configuration Synchronization
Because the standby supervisor engine is only partially initialized in RPR mode, it interacts with the
active supervisor engine only to receive configuration changes at startup and upon saving the
configuration changes.
When a standby supervisor engine is running in RPR mode, the following events trigger synchronization
of the configuration information:
• When the standby supervisor engine boots, the auto-sync command synchronizes the persistent
configuration. This command is enabled by default. For details, refer to “Synchronizing the
Supervisor Engine Configurations” section on page 5-11.
• When the active supervisor engine detects the standby supervisor engine, the configuration
information is synchronized from the active supervisor engine to the standby supervisor engine. This
synchronization overwrites any existing startup configuration file on the standby supervisor engine.
• When you make changes to the configuration, you must use the write command to save and
synchronize the startup configuration to the standby supervisor engine.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 5-5
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Supervisor Engine Redundancy Guidelines and Restrictions
SSO Supervisor Engine Configuration Synchronization
When a standby supervisor engine runs in SSO mode, the following events trigger synchronization of
the configuration information:
• When the active supervisor detects the standby supervisor engine, synchronization of the persistent
and running configuration takes place, allowing the standby supervisor engine to arrive at a
fully-initiated state.
• When real-time changes occur, the active supervisor engine synchronizes the running-config and
(or) the persistent configuration (if necessary) with the standby supervisor engine.
• When you change the configuration, you must use the write command to allow the active supervisor
engine to save and synchronize the startup configuration to the standby supervisor engine.
Supervisor Engine Redundancy Guidelines and Restrictions
The following guidelines and restrictions apply to supervisor engine redundancy:
• If SSO mode cannot be established between the active and standby supervisor engines because of
an incompatibility in the configuration file, a mismatched command list (MCL) is generated at the
active supervisor engine and a reload into RPR mode is forced for the standby supervisor engine.
Subsequent attempts to establish SSO, after removing the offending configuration and rebooting the
standby supervisor engine with the exact same image, might cause the
C4K_REDUNDANCY-2-IOS_VERSION_CHECK_FAIL and
ISSU-3-PEER_IMAGE_INCOMPATIBLE messages to appear because the peer image is listed as
incompatible. If the configuration problem can be corrected, you can clear the peer image from the
incompatible list with the redundancy config-sync ignore mismatched-commands EXEC
command while the peer is in a standby cold (RPR) state. This action allows the standy supervisor
engine to boot in standby hot (SSO) state when it reloads.
Here are the steps:
Step 1 Clear the offending configuration (that caused an MCL) while the standby supervisor engine is in
standby cold (RPR) state.
Step 2 Enter the redundancy config-sync ignore mismatched-commands EXEC command at the active
standby supervisor engine.
Step 3 Perform write memory.
Step 4 Reload the standy supervisor engine with the redundancy reload peer command.
• RPR and SSO requires Cisco IOS-XE Release 3.1.0 SG and later releases.
• SSO is not supported if the IOS-XE software is running in the LAN Base mode.
• WS-C4507R-E, WS-C4510R-E, WS-C4507R+E, and WS-C4510R+E are the only Catalyst 4500
series switches that support Supervisor Engine 7-E redundancy.
• SSO requires both supervisor engines in the chassis to have the same components ( model and
memory), and to use the same Cisco IOS XE software image.
• When you use WS-X45-SUP7-E in RPR or SSO mode, only the first two uplinks on each supervisor
engine are available. The second two uplinks are unavailable.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
5-6 OL-22250-01
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Configuring Supervisor Engine Redundancy
• The active and standby supervisor engines in the chassis must be in slots 3 and 4 for 7-slot chassis
and slot 5 and 6 for 10-slot chassis.
• Each supervisor engine in the chassis must have its own flash device and console port connections
to operate the switch on its own.
• Each supervisor engine must have a unique console connection. Do not connect a Y cable to the
console ports.
• Supervisor engine redundancy does not provide supervisor engine load balancing.
• The Cisco Express Forwarding (CEF) table is cleared on a switchover. As a result, routed traffic is
interrupted until route tables reconverge. This reconvergence time is minimal because the SSO
feature reduces the supervisor engine redundancy switchover time from 30+ seconds to subsecond,
so Layer 3 also has a faster failover time if the switch is configured for SSO.
• Static IP routes are maintained across a switchover because they are configured from entries in the
configuration file.
• Information about Layer 3 dynamic states that is maintained on the active supervisor engine is not
synchronized to the standby supervisor engine and is lost on switchover.
• If configuration changes on a redundant swtich are made through SNMP set operations, the changes
are not synchronized to the standby supervisor engine even in SSO mode. You might experience
unexpected behavior.
• After you configure the switch through SNMP in SSO mode, copy the running-config file to the
startup-config file on the active supervisor engine to trigger synchronization of the startup-config
file to the standby supervisor engine. Then, reload the standby supervisor engine so that the new
configuration is applied on the standby supervisor engine.
• You cannot perform configuration changes during the startup (bulk) synchronization. If you attempt
to make configuration changes during this process, the following message is generated:
Config mode locked out till standby initializes
• If configuration changes occur at the same time as a supervisor engine switchover, these
configuration changes are lost.
• If you remove a line card from a redundant switch and initiate an SSO switchover, then reinsert the
line card, and all interfaces are shutdown. The rest of the original line card configuration is
preserved.
This situation only occurs if a switch had reached SSO before you removed the line card.
Configuring Supervisor Engine Redundancy
These sections describe how to configure supervisor engine redundancy:
• Configuring Redundancy, page 5-8
• Virtual Console for Standby Supervisor Engine, page 5-9
• Synchronizing the Supervisor Engine Configurations, page 5-11
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 5-7
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Configuring Supervisor Engine Redundancy
Configuring Redundancy
Note IOS XE software can be booted at three different levels (Enterprise Services, IP Base, and LAN Base),
based on the licenses available on the supervisor engine. If you are booting the image in LAN Base
mode, only RPR redundancy mode is available.
To configure redundancy, perform this task:
Command Purpose
Step 1 Switch(config)# redundancy Enters redundancy configuration mode.
Step 2 Switch(config-red)# mode {sso | rpr} Configures SSO or RPR. When this command is entered,
the standby supervisor engine is reloaded and begins to
work in SSO or RPR mode.
Step 3 Switch# show running-config Verifies that SSO or RPR is configured.
Step 4 Switch# show redundancy Displays the redundancy information (counter, state, and
[clients | counters | history | states] so on) for the active and standby supervisor engines.
This example shows how to configure the system for SSO and display the redundancy facility
information:
Switch> enable
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# redundancy
Switch(config-red)# mode sso
Switch(config-red)# end
Switch# show redundancy
Redundant System Information :
------------------------------
Available system uptime = 10 minutes Switchovers system experienced = 0
Standby failures = 1
Last switchover reason = none
Hardware Mode = Duplex
Configured Redundancy Mode = Stateful Switchover
Operating Redundancy Mode = Stateful Switchover
Maintenance Mode = Disabled
Communications = Up
Current Processor Information :
------------------------------
Active Location = slot 3
Current Software state = ACTIVE
Uptime in current state = 9 minutes
Image Version = Cisco IOS Software, Catalyst 4500 L3 Switch Software
(cat4500e-UNIVERSALK9-M), Version 15.0(100)XO(1.42), INTERIM SOFTWARE Copyright (c)
1986-2010 by Cisco Systems, Inc.
Compiled Sun 01-Aug-10 04:12 by gsbuprod
Configuration register = 0x920
Peer Processor Information :
------------------------------
Standby Location = slot 4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
5-8 OL-22250-01
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Configuring Supervisor Engine Redundancy
Current Software state = STANDBY HOT
Uptime in current state = 0 minute
Image Version = Cisco IOS Software, Catalyst 4500 L3 Switch Software
(cat4500e-UNIVERSALK9-M), Version 15.0(100)XO(1.42), INTERIM SOFTWARE Copyright (c)
1986-2010 by Cisco Systems, Inc.
Compiled Sun 01-Aug-10 04:12 by gsbuprod
Configuration register = 0x920
This example shows how to display redundancy facility state information:
Switch# show redundancy states
my state = 13 -ACTIVE
peer state = 8 -STANDBY HOT
Mode = Duplex
Unit = Primary
Unit ID = 3
Redundancy Mode (Operational) = Stateful Switchover
Redundancy Mode (Configured) = Stateful Switchover
Redundancy State = Stateful Switchover
Manual Swact = enabled
Communications = Up
client count = 64
client_notification_TMR = 240000 milliseconds
keep_alive TMR = 9000 milliseconds
keep_alive count = 1
keep_alive threshold = 18
RF debug mask = 0
This example shows how to change the system configuration from RPR to SSO mode:
Switch(config)# redundancy
Switch(config-red)# mode
Switch(config-red)# mode sso
Changing to sso mode will reset the standby. Do you want to continue?[confirm]
Switch(config-red)# end
Switch#
*Aug 1 13:11:16: %C4K_REDUNDANCY-3-COMMUNICATION: Communication with the peer Supervisor
has been lost
*Aug 1 13:11:16: %C4K_REDUNDANCY-3-SIMPLEX_MODE: The peer Supervisor has been lost
This example shows how to change the system configuration from SSO to RPR mode:
Switch(config)# redundancy
Switch(config-red)# mode rpr
Changing to rpr mode will reset the standby. Do you want to continue?[confirm]
Switch(config-red)# end
*Aug 1 13:11:16: %C4K_REDUNDANCY-3-COMMUNICATION: Communication with the peer Supervisor
has been lost
*Aug 1 13:11:16: %C4K_REDUNDANCY-3-SIMPLEX_MODE: The peer Supervisor has been lost
Virtual Console for Standby Supervisor Engine
Catalyst 4500 series switches can be configured with 2 supervisor engines to provide redundancy. When
the switch is powered, one of the supervisor engines becomes active and remains active until a
switchover occurs. The other supervisor engine remains in standby mode.
Each supervisor engine has its own console port. Access to the standby supervisor engine is possible
only through the console port of the standby supervisor engine. Therefore, you must connect to the
standby console to access, monitor or debug the standby supervisor.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 5-9
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Configuring Supervisor Engine Redundancy
Virtual Console for Standby Supervisor Engine enables you to access the standby console from the active
supervisor engine without requiring a physical connection to the standby console. It uses IPC over
EOBC to communicate with the standby supervisor engine and thus emulate the standby console on the
active supervisor engine. Only one standby console session is active at any time.
The Virtual Console for Standby Supervisor Engine allows users who are logged onto the active
supervisor engine to remotely execute show commands on the standby supervisor engine and view the
results on the active supervisor engine. Virtual Console is available only from the active supervisor
engine.
You can access the standby virtual console from the active supervisor engine with the attach module,
session module, or remote login commands on the active supervisor engine. You must be in privilege
EXEC mode (level 15) to run these commands to access the standby console.
Once you enter the standby virtual console, the terminal prompt automatically changes to
hostname-standby-console where hostname is the configured name of the switch. The prompt is restored
back to the original prompt when you exit the virtual console.
You exit the virtual console with the exit or quit commands. When the inactivity period of the terminal
on the active supervisor engine where you logged in exceeds the configured idle time, you are
automatically logged out of the terminal on the active supervisor engine. In such a case, the virtual
console session is also terminated. Virtual console session is also automatically terminated when the
standby is rebooted. After the standby boots up, you need to create another virtual console session.
To log in to the standby supervisor engine using a virtual console, do the following:
Switch# session module 4
Connecting to standby virtual console
Type "exit" or "quit" to end this session
Switch-standby-console# exit
Switch#
If the standby console is not enabled, the following message appears:
Switch-standby-console#
Standby console disabled.
Valid commands are: exit, logout
Note The standby virtual console provides the standard features that are available from the supervisor console
such as command history, command completion, command help and partial command keywords.
The following limitations apply to the standby virtual console:
• All commands on the virtual console run to completion. It does not provide the auto-more feature;
it behaves as if the terminal length 0 command has been executed. It is also non-interactive.
Therefore, a running command cannot be interrupted or aborted by any key sequence on the active
supervisor engine. If a command produces considerable output, the virtual console displays it on the
supervisor engine screen.
• The virtual console is non-interactive. Because the virtual console does not detect the interactive
nature of a command, any command that requires user interaction causes the virtual console to wait
until the RPC timer aborts the command.
The virtual console timer is set to 60 seconds. The virtual console returns to its prompt after 60
seconds. During this time, you cannot abort the command from the key board. You must wait for
the timer to expire before you continue.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
5-10 OL-22250-01
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Configuring Supervisor Engine Redundancy
• You cannot use virtual console to view debug and syslog messages that are being displayed on the
standby supervisor engine. The virtual console only displays the output of commands that are
executed from the virtual console. Other information that is displayed on the real standby console
does not appear on the virtual console.
Synchronizing the Supervisor Engine Configurations
To manually synchronize the configurations used by the two supervisor engines, perform this task on the
active supervisor engine:
Command Purpose
Step 1 Switch(config)# redundancy Enters redundancy configuration mode.
Step 2 Switch(config-red)# main-cpu Enters main-cpu configuration submode.
Step 3 Switch(config-r-mc)# auto-sync {startup-config | Synchronizes the configuration elements.
config-register | bootvar | standard}
Step 4 Switch(config-r-mc)# end Returns to privileged EXEC mode.
Step 5 Switch# copy running-config startup-config Synchronizes the running configuration in dynamic
random-access memory (DRAM) to the startup
configuration file in NVRAM.
Note This step is not required to synchronize the
running configuration file in (DRAM).
Note Configuration changes made to the active supervisor engine through SNMP are not synchronized to the
redundant supervisor engine. For information on how to handle this situation, see the “Supervisor Engine
Redundancy Guidelines and Restrictions” section on page 5-6.
Note The auto-sync command controls the synchronization of the config-reg, bootvar, and startup/private
configuration files only. The calendar and VLAN database files are always synchronized when they
change. In SSO mode, the running-config is always synchronized.
This example shows how to reenable the default automatic synchronization feature using the auto-sync
standard command to synchronize the startup-config and config-register configuration of the active
supervisor engine with the standby supervisor engine. Updates for the boot variables are automatic and
cannot be disabled.
Switch(config)# redundancy
Switch(config-red)# main-cpu
Switch(config-r-mc)# auto-sync standard
Switch(config-r-mc)# end
Switch# copy running-config startup-config
Note To manually synchronize individual elements of the standard auto-sync configuration, disable the default
automatic synchronization feature.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 5-11
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Performing a Manual Switchover
Note When you configure the auto-sync standard, the individual sync options such as no auto-sync
startup-config are ignored.
This example shows how to disable default automatic synchronization and allow only automatic
synchronization of the config-registers of the active supervisor engine to the standby supervisor engine,
while disallowing synchronization of the startup configuration:
Switch(config)# redundancy
Switch(config-red)# main-cpu
Switch(config-r-mc)# no auto-sync standard
Switch(config-r-mc)# auto-sync config-register
Switch(config-r-mc)# end
Performing a Manual Switchover
This section describes how to perform a manual switchover (from the active supervisor engine to the
standby supervisor engine) for test purposes. We recommend that you perform a manual switchover prior
to deploying SSO in your production environment.
Note This discussion assumes that SSO has been configured as the redundant mode.
To perform a manual switchover, perform this task on the active supervisor engine:
Command Purpose
Step 1 Switch# show redundancy Verifies that the peer state is in the standby hot state.
See the example of the show redundancy states
command on page 6-10.
Step 2 Switch# redundancy force-switchover Launches switchover from the active supervisor engine
to the standby supervisor engine.
Be aware of these usage guidelines:
• force a switchover, the redundant supervisor engine must be in a standby hot (SSO) or standby cold
(RPR) state. You can verify the state with the show redundancy command. If the state is not standby
hot or standby cold, the redundancy force-switchover command will not execute.
• Use the redundancy force-switchover command, rather than the reload command, to initiate a
switchover. The redundancy force-switchover command will first check that the redundant
supervisor engine is in the correct state. If you issue the reload command and the status is not
standby hot or standby cold, the reload command will reset the current supervisor engine and the
peer supervisor may not be able to take over because it was not in a terminsal state (standby hot or
cold).
After a normal switchover, you might want to make the supervisor engine in a lower slot number of the
chassis the active supervisor engine. Use the show module command to see which slot contains the
active supervisor engine, and force another switchover if necessary.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
5-12 OL-22250-01
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Performing a Software Upgrade
Performing a Software Upgrade
This is useful only if IOS -XE software is running in LAN Base mode. For Enterprise Services or IP Base
mode, use ISSU to upgrade software for both RPR and SSO redundant mode.
The software upgrade procedure supported by supervisor engine redundancy allows you to reload the
Cisco IOS software image on the redundant supervisor engine, and once complete, reload the active
supervisor engine once.
To perform a software upgrade, perform this task:
Command Purpose
Step 1 Switch# copy source_device:source_filename Copies the new Cisco IOS-XE software image to
slot0:target_filename bootflash on the supervisor engine.
Or:
Switch# copy source_device:source_filename
bootflash:target_filename
Step 2 Switch# copy source_device:source_filename Copies the new image to a device on the standby
slaveslot0:target_filename supervisor engine (such as slavebootflash and slaveslot0).
Or:
Switch# copy source_device:source_filename
slavebootflash:target_filename
Step 3 Switch# config terminal Configures the supervisor engines to boot the new image.
Switch(config)# config-register 0x2
Switch(config)# boot system flash
device:file_name
If your system was configured to autoboot an earlier
image, issue the following command string to boot the
new image instead:
no boot system flash device:old_file_name
Step 4 Switch(config)# redundancy Enters redundancy configuration mode.
Step 5 Switch(config-red)# main-cpu Enters main-cpu configuration submode.
Step 6 Switch(config-r-mc)# auto-syn standard Synchronizes the configuration elements.
Step 7 Switch(config-r-mc)# end Returns to privileged EXEC mode.
Step 8 Switch# copy running-config start-config Saves the configuration.
Step 9 Switch# redundancy reload peer Reloads the standby supervisor engine and brings it back
online (using the new release of the Cisco IOS-XE
software).
Step 10 Switch# redundancy force-switchover Conducts a manual switchover to the standby supervisor
engine. The standby supervisor engine becomes the new
active supervisor engine using the new Cisco IOS-XE
software image.
The old active supervisor engine reboots with the new
image and becomes the standby supervisor engine.
This example shows how to perform a software upgrade:
Switch# config terminal
Switch(config)# config-register 0x2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 5-13
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Manipulating Bootflash on the Standby Supervisor Engine
Switch(config)# boot system flash
bootflash0:cat4500e-universalk9.SSA.03.01.00.150.1.XO.bin
Switch(config)# redundancy
Switch(config-red)# main-cpu
Switch(config-r-mc)# auto-syn standard
Switch(config-r-mc)# end
Switch# copy running-config start-config
Switch# redundancy reload peer
Switch# redundancy force-switchover
Switch#
This example illustrates how to verify that the running configuration on the active supervisor engine has
successfully synchronized with the redundant supervisor engine:
Switch# config terminal
Switch(config)# redundancy
Switch(config-red)# main-cpu
Switch(config-r-mc)# auto-sync standard
4d01h: %C4K_REDUNDANCY-5-CONFIGSYNC: The bootvar has been successfully synchronized to the
standby supervisor
4d01h: %C4K_REDUNDANCY-5-CONFIGSYNC: The config-reg has been successfully synchronized to
the standby supervisor
4d01h: %C4K_REDUNDANCY-5-CONFIGSYNC: The startup-config has been successfully synchronized
to the standby supervisor
4d01h: %C4K_REDUNDANCY-5-CONFIGSYNC: The private-config has been successfully synchronized
to the standby supervisor
The example above shows that the boot variable, the config-register, and the startup configuration from
the active supervisor engine have successfully synchronized to the redundant supervisor engine.
Manipulating Bootflash on the Standby Supervisor Engine
Note The console port on the standby supervisor engine is not available.
To manipulate the standby supervisor engine bootflash, perform one or more of the following tasks:
Command Purpose
Switch# dir slaveslot0:target_filename Lists the contents of the slot0: device on the standby
supervisor engine.
or
Switch# dir slavebootflash:target_filename Lists the contents of the bootflash: device on the standby
supervisor engine.
Switch# delete slaveslot0:target_filename Deletes specific files from the slot0: device on the standby
supervisor engine.
or
Switch# delete slave bootflash:target_filename Deletes specific files from the bootflash: device on the
standby supervisor engine.
Switch# squeeze slaveslot0: Squeezes the slot0: device on the standby supervisor engine.
or
Switch# squeeze slavebootflash: Squeezes the bootflash: device on the standby supervisor
engine.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
5-14 OL-22250-01
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Manipulating Bootflash on the Standby Supervisor Engine
Command Purpose
Switch# format slaveslot0: Formats the slot0: device on the standby supervisor engine.
or Formats the bootflash: device on the standby supervisor
Switch# format slavebootflash: engine.
Switch# copy source_device:source_filename Copies a file from the active supervisor engine to the slot0:
slaveslot0:target_filename device on the standby supervisor engine.
or Copies a file to the bootflash: device on a standby supervisor
Switch# copy source_device:source_filename engine.
slavebootflash:target_filename
Note Source could be the active supervisor engine or a
TFTP server.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 5-15
Chapter 5 Configuring Supervisor Engine Redundancy Using RPR and SSO
Manipulating Bootflash on the Standby Supervisor Engine
Software Configuration Guide—Release IOS-XE 3.1.0 SG
5-16 OL-22250-01
CH A P T E R 6
Configuring the Cisco IOS XE In Service Software
Upgrade Process
Note ISSU is available in Cisco IOS XE 3.1.0.SG and later releases.
Operating on redundant systems, the In Service Software Upgrade (ISSU) process allows Cisco IOS XE
software to be updated or otherwise modified while packet forwarding continues. In most networks,
planned software upgrades are a significant cause of downtime. ISSU allows Cisco IOS XE software to
be upgraded while packet forwarding continues. This increases network availability and reduces
downtime caused by planned software upgrades. This document provides information about ISSU
concepts and describes the steps taken to perform ISSU in a system.
Topics include:
• Prerequisites to Performing ISSU, page 6-2
• About Performing ISSU, page 6-3
• How to Perform the ISSU Process, page 6-15
• Cisco High Availability Features in Cisco IOS XE 3.1.0 SG, page 6-35
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Cisco IOS Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-1
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
Prerequisites to Performing ISSU
Related Documents
Related Topic Document Title
Performing ISSU Cisco IOS Software: Guide to Performing In Service Software
Upgrades
Information about Cisco Nonstop Forwarding Cisco Nonstop Forwarding
http://www.cisco.com/en/US/docs/ios/12_2s/feature/guide/fsnsf20s.
html
Information about Stateful Switchover Stateful Switchover
http://www.cisco.com/en/US/docs/ios/12_0s/feature/guide/sso120s.
html
Prerequisites to Performing ISSU
Before performing ISSU, you must meet these prerequisites:
• The type of the existing and target image must match. You cannot upgrade from a Universal Lite
image to a Universal image (and vice versa) without experiencing several minutes of traffic loss. The
same restriction applies between crypto and non-crypto images.
• The active and the standby supervisor engines must have the same supervisor engine hardware (same
model, same memory, and so on).
• The new and old Cisco IOS XE software images must be loaded into the file systems (bootflash, SD
card, or USB) of both the active and the standby supervisor engines before you begin the ISSU
process.
The old software image should be available either in bootflash, SD card, or USB and the system
should have been booted from one of these locations because the boot variable must be changed
before the ISSU process starts.
Note auto-boot must be enabled for ISSU to succeed.
• Stateful Switchover (SSO) must be configured and the standby supervisor engine should be in
STANDBY HOT state.
These commands indicate whether SSO is enabled: show module, show running-config,
show redundancy state.
If you do not have SSO enabled, see the Stateful Switchover document for further information on
how to enable and configure SSO.
• Nonstop Forwarding (NSF) must be configured and working properly. If you do not have NSF
enabled, see the Cisco Nonstop Forwarding document for further information on how to enable and
configure NSF.
• Before you perform ISSU, ensure that the file system for both the active and the standby supervisor
engines contains the new ISSU-compatible IOS XE software. The current Cisco IOS XE version
running in the system must also support ISSU.
You can enter various commands on the Catalyst 4500 series switch to determine supervisor engine
versioning and Cisco IOS XE software compatibility. Alternatively, you can use the ISSU
application on Cisco Feature Navigator to determine this.
Software Configuration Guide—IOS-XE 3.1.0 SG
6-2 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
• If you enter the no ip routing command, ISSU falls back from SSO to RPR mode, resulting in traffic
loss.
• Autoboot is turned on and the current booted image matches the one specified in the BOOT
environmental variable. For details on how to configure and verify these, please refer to "Modifying
the Boot Field and Using the boot Command, page 3-27.
• If you enter the no ip routing command, ISSU falls back from SSO to RPR mode, resulting in traffic
loss.
About Performing ISSU
Note Do not make any hardware changes while performing ISSU.
Before you perform ISSU, you should understand the following concepts:
• Stateful Switchover, page 6-3
• NSF, page 6-5
• ISSU Process, page 6-6
• Performing an ISSU Upgrade: 2 Methods, page 6-11
• Changeversion Process, page 6-12
• Guidelines for Performing ISSU, page 6-13
• Compatibility Matrix, page 6-13
• SNMP Support for ISSU, page 6-14
• Compatibility Verification Using Cisco Feature Navigator, page 6-14
Stateful Switchover
Development of the SSO feature is an incremental step within an overall program to improve the
availability of networks constructed with Cisco IOS XE switches.
In specific Cisco networking devices that support dual supervisor engines, SSO takes advantage of
supervisor engine redundancy to increase network availability. SSO achieves this by establishing one of
the supervisor engines as the active processor while the other supervisor engine is designated as the
standby processor. Following an initial synchronization between the two supervisor engines, SSO
dynamically synchronizes supervisor engine state information between them in real-time.
A switchover from the active to the standby supervisor engine occurs when the active supervisor engine
fails or is removed from the networking device.
Cisco NSF is used with SSO. Cisco NSF allows the forwarding of data packets to continue along known
routes while the routing protocol information is being restored following a switchover. With Cisco NSF,
peer networking devices do not experience routing flaps, which reduce loss of service outages for
customers.
Figure 6-1 illustrates how SSO is typically deployed in service provider networks. In this example,
Cisco NSF with SSO is enabled at the access layer (edge) of the service provider network. A fault at this
point could result in loss of service for enterprise customers requiring access to the service provider
network.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-3
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
For Cisco NSF protocols that require neighboring devices to participate in Cisco NSF, Cisco NSF-aware
software images must be installed on those neighboring distribution layer devices. Depending on your
objectives, you may decide to deploy Cisco NSF and SSO features at the core layer of your network.
Doing this can help reduce the time required to restore network capacity and service for certain failures,
which leads to additional availability.
Figure 6-1 Cisco NSF with SSO Network Deployment: Service Provider Networks
Service Cisco NSF with SSO
provider features may provide
core some benefit, but usually
layer not required
Service provider Good position for
distribution NSF-aware
layer routers
Service Primary deployment
provider position for Cisco NSF
access layer with SSO capable-routers
Customers
72134
Additional levels of availability may be gained by deploying Cisco NSF with SSO at other points in the
network where a single point of failure exists. Figure 6-2 illustrates an optional deployment strategy that
applies Cisco NSF with SSO at the enterprise network access layer. In this example, each access point
in the enterprise network represents another single point of failure in the network design. In the event of
a switchover or a planned software upgrade, enterprise customer sessions would continue uninterrupted
through the network in this example.
Software Configuration Guide—IOS-XE 3.1.0 SG
6-4 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
Figure 6-2 Cisco NSF with SSO Network Deployment: Enterprise Networks
Service Cisco NSF with SSO
provider features may provide
core some benefit, but usually
layer not required
Service provider Good position for
distribution NSF-aware
layer routers
Service Primary deployment
provider position for Cisco NSF
access layer with SSO-capable routers
Secondary deployment
Enterprise position for Cisco NSF
access with SSO-capable
layer or -aware routers
Enterprise Good position for
distribution NSF-aware
layer routers
Enterprise SSO may provide
core some benefit
72064
layer
For further information on SSO, see the Stateful Switchover document.
NSF
Cisco NSF works with the SSO feature in Cisco IOS XE software. SSO is a prerequisite of Cisco NSF.
NSF works with SSO to minimize the amount of time a network is unavailable to its users following a
switchover. The main objective of Cisco NSF is to continue forwarding IP packets following a supervisor
engine switchover.
Usually, when a networking device restarts, all routing peers of that device detect that the device went
down and then came back up. This transition results in what is called a routing flap, which could spread
across multiple routing domains. Routing flaps caused by routing restarts create routing instabilities,
which are detrimental to the overall network performance. Cisco NSF helps to suppress routing flaps in
SSO-enabled devices, thus reducing network instability.
Cisco NSF allows for the forwarding of data packets to continue along known routes while the routing
protocol information is being restored following a switchover. With Cisco NSF, peer networking devices
do not experience routing flaps. Data traffic is forwarded while the standby supervisor engine assumes
control from the failed active supervisor engine during a switchover. The ability of physical links to
remain up through a switchover and to be kept current with the Forwarding Information Base (FIB) on
the active supervisor engine is key to Cisco NSF operation.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-5
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
ISSU Process
The ISSU process allows you to perform a Cisco IOS XE software upgrade or downgrade while the
system continues to forward packets. (For an illustration of the commands used during the ISSU process,
refer to Figure 6-8.) Cisco IOS XE ISSU takes advantage of the Cisco IOS XE high availability
infrastructure—Cisco NSF with SSO and hardware redundancy—and eliminates downtime associated
with software upgrades by allowing changes while the system remains in service (see Figure 6-3).
SSO and NSF mode support configuration and runtime state synchronization from the active to the
standby supervisor engine. For this process, the IOS XE software image on both the active and the
standby supervisor engines must be the same. When images on active and standby supervisor engines
are different, ISSU allows the two supervisor engines to be kept in synchronization even when these two
versions of Cisco IOS XE support different sets of features and commands.
Figure 6-3 High Availability Features and Hardware Redundancy in the ISSU Process
Control
plane
Active Standby Management
Supervisor NSF/SSO Supervisor plane
Engine Engine
Line cards
Data
plane
180230
Software Configuration Guide—IOS-XE 3.1.0 SG
6-6 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
An ISSU-capable switch consists of two supervisor engines (active and standby) and 200 or more
linecards. Before initiating the ISSU process, copy the Cisco IOS XE software into the file systems of
both supervisor engines (see Figure 6-4).
Note In the following figure, Cisco IOS XE 3.x.y SG represents the current version of Cisco IOS XE 3.z.y SG
represents the image you are migrating to.
Figure 6-4 Copy New Version of Cisco IOS XE Software on Both Supervisor Engines
Copy new version
of Cisco IOS XE
on active and standby
Supervisor Engines
Cisco IOS XE Cisco IOS XE
3.x.y.SG 3.x.y.SG
Cisco IOS XE Cisco IOS XE
3.z.y.SG 3.z.y.SG
Active NSF/SSO Standby
Supervisor Supervisor
Engine Engine
Line cards
208664
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-7
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
After you have copied the Cisco IOS XE software to both file systems, load the new version of
Cisco IOS XE software onto the standby supervisor engine (see Figure 6-5).
Note Without the ISSU feature, SSO/NSF cannot function between the active and standby supervisor engines
when they are running different versions of the Cisco IOS XE image.
Figure 6-5 Load New Version of Cisco IOS XE Software on the Standby Supervisor Engine
Load new version
of Cisco IOS XE
on standby
Cisco IOS XE Cisco IOS XE
3.x.y.SG 3.z.y.SG
Cisco IOS XE
3.z.y.SG
Active NSF/SSO Standby
Supervisor Supervisor
Engine Engine
Line cards
207610
Software Configuration Guide—IOS-XE 3.1.0 SG
6-8 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
After a switchover (NSF/SSO, not RPR), the standby supervisor engine takes over as the new active
supervisor engine (see Figure 6-6).
Figure 6-6 Switch Over to Standby Supervisor Engine
Run new version
of Cisco IOS XE
the new active
Cisco IOS XE Cisco IOS XE
3.x.y.SG 3.z.y.SG
New
Old Active
Active NSF/SSO Supervisor
Supervisor Switchover Engine
Engine
Line cards
208665
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-9
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
The former active supervisor engine is loaded with an old Cisco IOS XE image so that if the new active
supervisor engine experiences problems, you can abort and conduct a switchover to the former active,
which is already running the old software image. Next, the former active supervisor engine is loaded
with the new version of Cisco IOS XE software and becomes the new standby supervisor engine (see
Figure 6-7).
Figure 6-7 Load New Standby Supervisor Engine with New Cisco IOS XE Software
Standby is reset and
reloaded with
new software
Cisco IOS XE Cisco IOS XE
3.z.y.SG 3.z.y.SG
Standby Active
NSF/SSO
Supervisor Supervisor
Engine Engine
Line cards
208666
Software Configuration Guide—IOS-XE 3.1.0 SG
6-10 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
Figure 6-8 shows the steps during the ISSU process.
Figure 6-8 Steps During the ISSU Process
1
Standby
Old
Active Loadversion
Old
5
Active 2
New Standby
New
Standby Abortversion
New Active
Abortversion Old
Switchover
4 3
Commitversion Runversion
Active Active
New New
Standby Standby
Old Old
*Acceptversion
180235
Commitversion
Commitversion * This command is optional.
Note Accept version stops the rollback timer.
Performing an ISSU Upgrade: 2 Methods
There are two ways to perform an ISSU upgrade: manually, with four commands; or automatically, with
one command.
The normal ISSU upgrade process involves issuing four separate ISSU exec commands
(issu loadversion, issu runversion, issu acceptversion, issue commitversion) along with additional
show command invocations to evaluate the success of each command before proceeding. Although the
ISSU process is complicated, you should not expect disruption of service. The use of multiple ISSU
commands dictates an additional level of care to ensure no service disruption. However, in some
scenarios, this upgrade procedure might be cumbersome and of minimal value. A typical example is
during a network upgrade that involves performing an ISSU upgrade on a large number of Catalyst 4500
switches. In these cases, we recommend that you first perform the normal (four command) ISSU upgrade
procedure on one switch (possibly in a lab environment) to verify successful upgrade. Then, use a single
issu changeversion command to perform an automatic ISSU on the rest of the Catalyst 4500 switches
in the network.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-11
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
Changeversion Process
The issu changeversion command launches a single-step complete ISSU upgrade cycle. It performs the
logic for all four of the standard commands (issu loadversion, issu runversion, issu acceptversion, and
issu commitversion) without user intervention, streamlining the upgrade through a single CLI step.
Additionally, issu changeversion allows the upgrade process to be scheduled for a future time. This
enables you to stage a number of systems to perform upgrades sequentially when a potential disruption
would be least harmful.
After the standby supervisor engine initializes and the system reaches a terminal state (RPR/SSO), the
upgrade process is complete and the BOOT variable is permanently written with the new IOS XE
software image. Hence, a reset on any RP will keep the system booting the new software image. Console
and syslog messages will be generated to notify anyone monitoring the upgrade that the state transition
has occurred.
Similar to the normal ISSU upgrade procedure, the in-progress upgrade procedure initiated by the
issu changeversion command can be aborted with the issu abortversion command. If the system
detects any problems or detects an unhealthy system during an upgrade, the upgrade might be
automatically aborted.
When the issu runversion command is entered during the four step manual upgrade process, if any
incompatible ISSU clients exist, the upgrade process reports them and their side effects, and allows the
user to abort the upgrade. While performing a single-step upgrade process, when the process reaches the
runversion state, it will either automatically continue with the upgrade provided the base clients are
compatible, or automatically abort because of client incompatibility. If the user wants to continue the
upgrade procedure in RPR mode, the user must use the normal ISSU command set and specify the force
option when entering the issu loadversion command.
Changeversion: Quick Option (LV to INIT)
The issu changeversion command provides an optional quick command option that can reduce the time
required to perform the automatic ISSU upgrade. When the quick command option is applied, the ISSU
upgrade state transition differs from that described previously. With this option, the software logic up
the loadversion stage remains the same as previously described, and the logic that performs runversion
and commitversion is combined. This logic skips the step in the upgrade procedure that loads the old
software version on the new standby (old active) supervisor, reducing the time required for the automatic
ISSU upgrade by about a third.
Scheduled Changeversion: “in” and “at” Options
issu changeversion provides in and at command options that enable you to schedule a future automatic
ISSU upgrade.
The at command option schedules an automatic ISSU upgrade to begin at a specific time. This option
specifies an exact time (hh:mm, 24 hour format) in the next 24 hours at which the upgrade will occur.
The in command option schedules an automatic ISSU upgrade to begin after a certain amount of time
has elapsed. This option specifies the number of hours and minutes (hh:mm format) that must elapse
before an upgrade will occur, with a maximum value of 99:59.
Software Configuration Guide—IOS-XE 3.1.0 SG
6-12 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
Changeversion Deployment Scenario
The typical issu changeversion command usage scenario is for experienced users with a large installed
base. These users typically validate a new image using a topology and configuration similar to their
production network. The validation process should be done using both the existing multi-command
process and the new issu changeversion command process. Once users certify an IOS XE software
image and want to roll it out broadly, they can use the single command process to perform an efficient
upgrade of their network.
Aborting an In-Progress Changeversion Procedure
The issu changeversion command functionality is designed to perform an ISSU software upgrade
without user intervention. However, status messages are displayed to the console as the upgrade
transitions through the various states. If any anomalies are noticed during the automatic upgrade,
perhaps with peers or other parts of the network, you can use the issu abortversion command to
manually abort the upgrade at any point in the process prior to the commitversion operation.
Guidelines for Performing ISSU
Be aware of the following guidelines while performing the ISSU process:
• Even with ISSU, it is recommended that upgrades be performed during a maintenance window.
• The new features should not be enabled (if they require change of configuration) during the ISSU
process.
Note Enabling them will cause the system to enter RPR mode because commands are only supported
on the new version.
• In a downgrade scenario, if any feature is not available in the downgrade revision of the
Cisco IOS XE software handle, that feature should be disabled prior to initiating the ISSU process.
Compatibility Matrix
ISSU requires additional information to determine compatibility between software versions. Therefore,
a compatibility matrix is defined that contains information about other IOS XE software image with
respect to the one in question.
This compatibility matrix represents the compatibility of two software versions, one running on the
active and the other on the standby supervisor engine, and to allow the system to determine the highest
operating mode it can achieve. Incompatible versions will not be able to progress to SSO operational
mode.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-13
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
About Performing ISSU
The compatibility matrix represents the compatibility relationship a Cisco IOS XE software image has
with all of the other Cisco IOS XE software versions within the designated support window (for example,
all of those software versions the IOS XE software image “knows” about) and is populated and released
with every IOS XE software image. The matrix stores compatibility information between its own release
and prior releases. It is always the newest release that contains the latest information about compatibility
with existing releases in the field. The compatibility matrix is available within the Cisco IOS XE
software image and on Cisco.com so that users can determine in advance whether an upgrade can be done
using the ISSU process.
You can perform the ISSU process when the old and new Cisco IOS XE software are compatible. The
compatibility matrix information stores the compatibility among releases as follows:
• Compatible—The base-level system infrastructure and all optional HA-aware subsystems are
compatible. An in-service upgrade or downgrade between these versions will succeed with minimal
service impact. The matrix entry designates the images to be compatible (C).
• Base-level compatible—One or more of the optional HA-aware subsystems is not compatible. An
in-service upgrade or downgrade between these versions will succeed; however, some subsystems
will not be able to maintain state always during the transition from the old to the new version of
Cisco IOS XE. The matrix entry designates the images to be base-level compatible (B).
• Incompatible—A core set of system infrastructure exists in Cisco IOS XE that must be able to
interoperate in a stateful manner for SSO to function correctly. If any of these required features or
subsystems is not interoperable, then the two versions of the Cisco IOS XE software image are
declared to be incompatible. An in-service upgrade or downgrade between these versions is not
possible. The matrix entry designates the images to be incompatible (I). The system operates in RPR
mode during the upgrade process when the versions of Cisco IOS XE at the active and standby
supervisor engines are incompatible.
• Cisco IOS XE determines the compatibility between the active and the standby IOS XE software
dynamically during STANDBY boot up. The matrix is represented by “x”.
To display the compatibility matrix data between two software versions on a given system, enter the
show issu comp-matrix stored command.
Note This command is useful only for verification purposes because it is available only after the ISSU process
has started. You might want to check the compatibility matrix prior to starting ISSU. Use the Feature
Navigator to obtain the needed information
http://tools.cisco.com/ITDIT/CFN/jsp/index.jsp
SNMP Support for ISSU
SNMP for SSO provides a mechanism for synchronizing the SNMP configurations and the MIBs that
support SSO from the active supervisor engine to the standby supervisor engine.
Compatibility Verification Using Cisco Feature Navigator
The ISSU application on Cisco Feature Navigator allows you to:
• Select a specific software bundle.
• Identify which software images are compatible with the selected software image.
Software Configuration Guide—IOS-XE 3.1.0 SG
6-14 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
• Compare two IOS XE software images and understand the compatibility level of the software
images (that is, compatible, base-level compatible, and incompatible), or dynamically determined.
• Compare two software images and see the client compatibility for each ISSU client.
• Provide links to release notes for the software image.
How to Perform the ISSU Process
Unlike SSO, which is a mode of operation for the device and a prerequisite for performing ISSU, the
ISSU process is a series of steps performed while the switch is in operation. The steps result in an
upgrade to new or modified Cisco IOS XE software, and have a minimal impact to traffic.
Note For an illustration of the process flow for ISSU, refer to Figure 6-8 on page 6-11.
This section includes the following topics:
• Verifying the ISSU Software Installation, page 6-15
• Loading New Cisco IOS XE Software on the Standby Supervisor Engine, page 6-18 (required)
• Switching to the Standby Supervisor Engine, page 6-21 (required)
• Stopping the ISSU Rollback Timer (Optional), page 6-23 (optional)
• Loading New Cisco IOS XE Software on the New Standby Supervisor Engine, page 6-24 (required)
• Using changeversion to Automate an ISSU Upgrade, page 6-25
• Aborting a Software Upgrade During ISSU, page 6-31
• Configuring the Rollback Timer to Safeguard Against Upgrade Issues, page 6-32
• Displaying ISSU Compatibility Matrix Information, page 6-34
Verifying the ISSU Software Installation
During the ISSU process, there are five valid states: disabled, init, load version, run version, and system
reset. Use the show issu state command to obtain the current ISSU state:
• Disabled state—The state for the standby supervisor engine while this engine is resetting.
• Init state—The initial state for two supervisor engines, one active and one standby, before the ISSU
process is started. It is also the final state after the ISSU process completes.
• Load version (LV) state—The standby supervisor engine is loaded with the new version of Cisco
IOS XE software.
• Run version (RV) state—The issu runversion command forces the switchover of the supervisor
engines. The newly active supervisor engine runs the new Cisco IOS XE software image.
• While running ISSU, if both supervisor engines are reset due to power outage, for example, the ISSU
context is lost and returns to the init state. Both supervisor engines return to the old software.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-15
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
You can verify the ISSU software upgrade by entering show commands to provide information on the
state of the during the ISSU process:
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# show issu state [detail] Displays the state of the during the ISSU process.
Step 3 Switch# show redundancy Displays current or historical status, mode, and related
redundancy information about the device.
This example shows how to display the state and the current status of the supervisor engine during the
ISSU process:
Switch> enable
Switch# show issu state
Switch# show redundancy
Verifying Redundancy Mode Before Beginning the ISSU Process
Before you begin the ISSU process, verify the redundancy mode for the system and be sure to configure
NSF and SSO.
The following example displays verification that the system is in SSO mode, that slot 3 is the active
supervisor engine, and that slot 4 is the standby supervisor engine. Both supervisor engines are running
the same Cisco IOS XE software release.
Switch# show redundancy states
my state = 13 -ACTIVE
peer state = 8 -STANDBY HOT
Mode = Duplex
Unit = Primary
Unit ID = 5
Redundancy Mode (Operational) = Stateful Switchover
Redundancy Mode (Configured) = Stateful Switchover
Redundancy State = Stateful Switchover
Manual Swact = enabled
Communications = Up
client count = 64
client_notification_TMR = 240000 milliseconds
keep_alive TMR = 9000 milliseconds
keep_alive count = 1
keep_alive threshold = 18
RF debug mask = 0
Switch# show redundancy
Redundant System Information :
------------------------------
Available system uptime = 12 minutes
Switchovers system experienced = 0
Standby failures = 0
Last switchover reason = none
Software Configuration Guide—IOS-XE 3.1.0 SG
6-16 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Hardware Mode = Duplex
Configured Redundancy Mode = Stateful Switchover
Operating Redundancy Mode = Stateful Switchover
Maintenance Mode = Disabled
Communications = Up
Current Processor Information :
------------------------------
Active Location = slot 5
Current Software state = ACTIVE
Uptime in current state = 9 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Peer Processor Information :
------------------------------
Standby Location = slot 6
Current Software state = STANDBY HOT
Uptime in current state = 2 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Verifying the ISSU State Before Beginning the ISSU Process
Ensure that the active and standby supervisor engines are up and in ISSU Init state and that both
supervisor engines are running the same current image.
The following example displays the ISSU state before the process begins:
Switch# show issu state detail
Slot = 5
RP State = Active
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:old_image
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Slot = 6
RP State = Standby
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:old_image
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
The new version of the Cisco IOS XE software must be present on both of the supervisor engines. The
directory information displayed for each of the supervisor engines shows that the new version is present.
Switch# dir bootflash:
Directory of bootflash:/
5 -rw- 129923402 Aug 6 2010 09:32:33 +00:00 old_image
6 -rw- 127724184 Aug 6 2010 09:34:07 +00:00 new_image
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-17
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
61341696 bytes total (1111388 bytes free)
Switch# dir slavebootflash:
Directory of slavebootflash:/
4 -rw- 129923402 Aug 6 2006 09:40:10 +00:00 old_image
5 -rw- 127724184 Aug 6 2006 09:42:13 +00:00 new_image
61341696 bytes total (1116224 bytes free)
Loading New Cisco IOS XE Software on the Standby Supervisor Engine
This task describes how to use ISSU to load a new version of Cisco IOS XE software to the standby
supervisor engine.
Prerequisites
• Ensure that the new version of Cisco IOS XE software image is already present in the file system of
both the active and standby supervisor engines. Also ensure that appropriate boot parameters
(BOOT string and config-register) are set for the active and standby supervisor engines.
Note The switch must boot with the BOOT string setting before the ISSU procedure is attempted.
Note auto-boot must be enabled for ISSU to succeed.
• Optionally, perform additional tests and commands to determine the current state of peers and
interfaces for later comparison.
• Ensure the system (both active and standby supervisor engines) is in SSO redundancy mode. If the
system is in RPR mode, you can still upgrade the system using the ISSU CLI commands, but the
system will experience extended packet loss during the upgrade.'
Refer to the Stateful Switchover document for more details on how to configure SSO mode on
supervisor engines.
• For ISSU to function, the IOS XE file names on the active and standby supervisor engines must
match.
Software Configuration Guide—IOS-XE 3.1.0 SG
6-18 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Perform the following steps at the active supervisor engine:
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# issu loadversion [active-slot] Starts the ISSU process and (optionally) overrides the
active-image-new [standby-slot] automatic rollback when the new Cisco IOS XE software
standby-image-new [forced]
version is detected to be incompatible.
It may take several minutes after entering the issu
loadversion command for Cisco IOS XE software to load
onto the standby supervisor engine and for the standby
supervisor engine to transition to SSO mode. This causes
the standby supervisor engine to reload with the new
software image.
If you use the forced option, the standby supervisor engine
is booted with the new software image. After the software
image is loaded on the standby supervisor engine, if the
software image is incompatible, the system is forced to the
RPR mode. Otherwise the system will continue in the SSO
mode.
Step 3 Switch# show issu state [detail] Displays the state of ISSU during the ISSU process. At this
point in the ISSU process, use this command to check that
the standby supervisor engine is loaded and is in SSO mode.
It may take several minutes after entering the
issu loadversion command for Cisco IOS XE software to
load onto the standby supervisor engine and the standby
supervisor engine to transition to SSO mode. If you enter
the show issu state command too quickly, you may not see
the information you need.
Step 4 Switch# show redundancy [states] Displays redundancy facility state information.
This example shows how to start the ISSU process, boot the standby supervisor engine in the Standby
Hot state, and load the standby supervisor engine slot (6) with the new IOS XE software image:
Switch> enable
Switch# issu loadversion 5 bootflash:new_image 6 slavebootflash:new_image
%issu loadversion executed successfully, Standby is being reloaded
Switch# show issu state detail
Slot = 5
RP State = Active
ISSU State = Load Version
Operating Mode = Stateful Switchover
Current Image = bootflash:old_image
Pre-ISSU (Original) Image = bootflash:old_image
Post-ISSU (Targeted) Image = bootflash:new_image
Slot = 6
RP State = Standby
ISSU State = Load Version
Operating Mode = Stateful Switchover
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-19
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Current Image = bootflash:new_image
Pre-ISSU (Original) Image = bootflash:old_image
Post-ISSU (Targeted) Image = bootflash:new_image
Switch# show redundancy states
my state = 13 -ACTIVE
peer state = 8 -STANDBY HOT
Mode = Duplex
Unit = Primary
Unit ID = 5
Redundancy Mode (Operational) = Stateful Switchover
Redundancy Mode (Configured) = Stateful Switchover
Redundancy State = Stateful Switchover
Manual Swact = enabled
Communications = Up
client count = 64
client_notification_TMR = 240000 milliseconds
keep_alive TMR = 9000 milliseconds
keep_alive count = 1
keep_alive threshold = 18
RF debug mask = 0
The following example shows how the forced option places the system in RPR mode:
Switch> enable
Switch# issu loadversion 5 bootflash:new_image 6 slavebootflash:new_image forced
%issu loadversion executed successfully, Standby is being reloaded
Switch# show issu state detail
Slot = 5
RP State = Active
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:old_image
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Slot = 6
RP State = Standby
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:old_image
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
The following example shows the redundancy mode as RPR:
Switch# show redundancy states
my state = 13 -ACTIVE
peer state = 4 -STANDBY COLD
Mode = Duplex
Unit = Primary
Unit ID = 3
Redundancy Mode (Operational) = RPR
Redundancy Mode (Configured) = Stateful Switchover
Redundancy State = RPR
Manual Swact = enabled
Communications = Up
Software Configuration Guide—IOS-XE 3.1.0 SG
6-20 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
client count = 64
client_notification_TMR = 240000 milliseconds
keep_alive TMR = 9000 milliseconds
keep_alive count = 1
keep_alive threshold = 18
RF debug mask = 0
Switching to the Standby Supervisor Engine
This task describes how to switchover to the standby supervisor engine, which is running the new
Cisco IOS XE software image. Perform the following steps at the active supervisor engine.
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# issu runversion [standby-slot] Forces a switchover from the active to the standby
[standby-image-new]] supervisor engine and reloads the former active (current
standby) supervisor engines with the old IOS XE image.
When you enter the issu runversion command, an SSO
switchover will be performed, and NSF procedures will be
invoked if so configured.
Step 3 Switch# show issu state [detail] Displays the state of the during the ISSU process. At this
point in the ISSU process, use this command to check that
a switchover occurs to slot 6.
Step 4 Switch# show redundancy [states] Displays redundancy facility state information.
This example shows how to cause a switchover to the former standby supervisor engine (slot 6), reset
the former active supervisor engine and reload it with the old IOS XE software image so it becomes the
standby supervisor engine:
Switch> enable
Switch# issu runversion 6 slavebootflash:new_image
%issu runversion initiated successfully
A switchover happens at this point. At the new active supervisor engine, do the following after old active
supervisor engine comes up as standby.
Switch# show issu state detail
Slot = 6
RP State = Active
ISSU State = Run Version
Operating Mode = Stateful Switchover
Current Image = bootflash:new_image
Pre-ISSU (Original) Image = bootflash:old_image
Post-ISSU (Targeted) Image = bootflash:new_image
Slot = 5
RP State = Standby
ISSU State = Run Version
Operating Mode = Stateful Switchover
Current Image = bootflash:old_image
Pre-ISSU (Original) Image = bootflash:old_image
Post-ISSU (Targeted) Image = bootflash:new_image
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-21
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Note The new active supervisor engine is now running the new version of software, and the standby supervisor
engine is running the old version of software and is in the standby hot state.
Switch# show redundancy states
my state = 13 -ACTIVE
peer state = 8 -STANDBY HOT
Mode = Duplex
Unit = Primary
Unit ID = 6
Redundancy Mode (Operational) = Stateful Switchover
Redundancy Mode (Configured) = Stateful Switchover
Redundancy State = Stateful Switchover
Manual Swact = enabled
Communications = Up
client count = 64
client_notification_TMR = 240000 milliseconds
keep_alive TMR = 9000 milliseconds
keep_alive count = 0
keep_alive threshold = 18
RF debug mask = 0
Once Runversion has completed, the new active supervisor engine will be running the new version of
software and the previously active supervisor engine will now become the standby supervisor engine.
The standby will be reset and reloaded, but it will remain on the previous version of software and come
back online in standbyhot status. The following example shows how to verify these conditions:
Switch# show redundancy
Redundant System Information :
------------------------------
Available system uptime = 12 minutes
Switchovers system experienced = 0
Standby failures = 0
Last switchover reason = none
Hardware Mode = Duplex
Configured Redundancy Mode = Stateful Switchover
Operating Redundancy Mode = Stateful Switchover
Maintenance Mode = Disabled
Communications = Up
Current Processor Information :
------------------------------
Active Location = slot 6
Current Software state = ACTIVE
Uptime in current state = 9 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Peer Processor Information :
------------------------------
Standby Location = slot 5
Current Software state = STANDBY HOT
Uptime in current state = 2 minutes
Software Configuration Guide—IOS-XE 3.1.0 SG
6-22 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Stopping the ISSU Rollback Timer (Optional)
This optional task describes how to stop the rollback timer.
If you do not run the following procedure before the rollback timer “timeout,” the system automatically
aborts the ISSU process and reverts to the original Cisco IOS XE software version. By default the
rollback timer is 45 minutes.
Use the following information to decide what action you should take:
• If you want to retain your switch in the runversion state for an extended period, you need to stop the
rollback timer by entering the acceptversion command. Then validate the new software and enter
the commitversion command (as described in the following section).
• If you want to proceed with the commitversion operation within the rollback timer window of 45
minutes (or the configured value), you do not need to use the acceptversion command to stop the
roll-back timer.
Note The issu acceptversion command may be optionally executed after the issu runversion command.
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# issu acceptversion [active-slot] Halts the rollback timer and ensures the new Cisco IOS XE
[active-image-new]] ISSU process is not automatically aborted during the ISSU
process.
Enter the issu acceptversion command within the time
period specified by the rollback timer to acknowledge that
the supervisor engine has achieved connectivity to the
outside world; otherwise, the ISSU process is terminated,
when the rollback timer expires, and the system reverts to
the previous version of Cisco IOS XE software by switching
to the standby supervisor engine.
Step 3 Switch# show issu rollback-timer Displays the amount of time left before an automatic
rollback will occur.
This example displays the Timer before you stop it. In the following example, the “Automatic Rollback
Time” information indicates the amount of time remaining before an automatic rollback will occur.
Switch> enable
Switch# show issu rollback-timer
Rollback Process State = 00:31:09 remaining
Configured Rollback Time = 00:45:00
Switch# issu acceptversion 6 bootflash:new_image
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-23
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
% Rollback timer stopped. Please issue the commitversion command.
Switch# show issu rollback-timer
Rollback Process State = Not in progress
Configured Rollback Time = 00:45:00
Loading New Cisco IOS XE Software on the New Standby Supervisor Engine
This task explains how to load new version of Cisco IOS XE software to the new standby supervisor
engine.
Perform the following steps at the active supervisor engine:
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# issu commitversion [standby-slot] Allows the new Cisco IOS XE software image to be loaded
[standby-image-new] into the standby supervisor engine.
Step 3 Switch# show redundancy [states] Displays redundancy facility state information.
Step 4 Switch# show issu state [detail] Displays the state of the during the ISSU process. At this
point in the ISSU process, use this command to check that
the standby supervisor engine is loaded with the new image.
This example shows how to reset and reload the current standby supervisor engine (slot 1) with the new
Cisco IOS XE software version. After you enter the commitversion command, the standby supervisor
engine boots in the Standby Hot state.
Switch> enable
Switch# issu commitversion 5 slavebootflash:new_image
%issu commitversion executed successfully
Use the following to verify that the standby supervisor engine is reloaded with the new software.
Switch# show redundancy states
my state = 13 -ACTIVE
peer state = 8 -STANDBY HOT
Mode = Duplex
Unit = Primary
Unit ID = 6
Redundancy Mode (Operational) = Stateful Switchover
Redundancy Mode (Configured) = Stateful Switchover
Redundancy State = Stateful Switchover
Manual Swact = enabled
Communications = Up
client count = 64
client_notification_TMR = 240000 milliseconds
keep_alive TMR = 9000 milliseconds
keep_alive count = 1
keep_alive threshold = 18
RF debug mask = 0
Switch# show redundancy
Redundant System Information :
Software Configuration Guide—IOS-XE 3.1.0 SG
6-24 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
------------------------------
Available system uptime = 12 minutes
Switchovers system experienced = 0
Standby failures = 0
Last switchover reason = none
Hardware Mode = Duplex
Configured Redundancy Mode = Stateful Switchover
Operating Redundancy Mode = Stateful Switchover
Maintenance Mode = Disabled
Communications = Up
Current Processor Information :
------------------------------
Active Location = slot 4
Current Software state = ACTIVE
Uptime in current state = 9 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Peer Processor Information :
------------------------------
Standby Location = slot 3
Current Software state = STANDBY HOT
Uptime in current state = 2 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Switch# show issu state detail
Slot = 6
RP State = Active
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:new_image
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Slot = 5
RP State = Standby
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:new_image
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
The ISSU process has completed. At this stage, any further Cisco IOS XE software version upgrade or
downgrade will require that a new ISSU process be invoked.
Using changeversion to Automate an ISSU Upgrade
This task describes how to use the issu changeversion command to perform a one step ISSU upgrade.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-25
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Prerequisites
• Ensure that the new version of Cisco IOS XE software image is already present in the file system of
both the active and standby supervisor engines. Also ensure that appropriate boot parameters
(BOOT string and config-register) are set for the active and standby supervisor engines
• Optionally, perform additional tests and commands to determine the current state of peers and
interfaces for later comparison.
• Ensure the system (both active and standby supervisor engines) is in SSO redundancy mode. If the
system is in RPR mode, you can still upgrade the system using the ISSU CLI commands, but the
system will experience extended packet loss during the upgrade.'
Refer to the Stateful Switchover document for more details on how to configure SSO mode on
supervisor engines (refer to Chapter 5, “Configuring Supervisor Engine Redundancy Using RPR
and SSO”).
• For ISSU to function, the IOS XE software image file names on the active and standby supervisor
engines must match.
Perform the following steps at the active supervisor engine:
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# issu changeversion [active-slot Initiates a single-step complete upgrade process cycle.
active-image-new]] [standby-slot Performs the logic of the four standard commands (issu
[standby-image-new]] [at hh:mm | in hh:mm]
[quick]
loadversion, issu runversion, issu acceptversion, and issu
commitversion) without user intervention.
active-slot—Defines the active slot number.
new-image—Specifies IOS XE image URL to be upgraded
to.
standby-slot—Defines the standby slot number.
standby-image—Specifies the standby IOS XE image URL.
at hh:mm—Schedules an ISSU upgrade to begin in the future.
Provides an exact time (hh:mm, 24 hour format) in the next 24
hours when the upgrade will occur.
in hh:mm—Schedules an ISSU upgrade to begin in the
future. Provides the number of hours and minutes (hh:mm
format) that will elapse before an upgrade will occur (99:59
max).
quick—Upon switchover, boots the standby supervisor
engine with the new, rather than old, image for faster
upgrade.
Step 3 Switch# show issu state [detail] Displays the state of the during the ISSU process. At this
point in the ISSU process, use this command to check that
the standby supervisor engine is loaded and is in SSO mode.
Step 4 Switch# show redundancy [states] Displays redundancy facility state information.
Software Configuration Guide—IOS-XE 3.1.0 SG
6-26 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
This example shows how to initiate an ISSU upgrade process using the issu changeversion command on
slot number 5, the slot for the current active supervisor engine. The show issu state detail and show
redundancy command output is included to show the supervisor state before and after the upgrade
procedure.
Note The success messages included in the output below is displayed after some delay because the ISSU
upgrade procedure progresses through the ISSU states.
Switch> enable
Switch# show issu state detail
Slot = 5
RP State = Active
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:x.bin
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Slot = 6
RP State = Standby
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:x.bin
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Switch# show redundancy
Redundant System Information :
------------------------------
Available system uptime = 12 minutes
Switchovers system experienced = 0
Standby failures = 0
Last switchover reason = none
Hardware Mode = Duplex
Configured Redundancy Mode = Stateful Switchover
Operating Redundancy Mode = Stateful Switchover
Maintenance Mode = Disabled
Communications = Up
Current Processor Information :
------------------------------
Active Location = slot 5
Current Software state = ACTIVE
Uptime in current state = 9 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Peer Processor Information :
------------------------------
Standby Location = slot 6
Current Software state = STANDBY HOT
Uptime in current state = 2 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-27
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Switch# issu changeversion bootflash:y.bin
% 'issu changeversion' is now executing 'issu loadversion'
% issu loadversion executed successfully, Standby is being reloaded
% changeversion finished executing loadversion, waiting for standby to reload and reach
SSO ...
Note Standby reloads with target image.
.....
.....
*Feb 25 20:41:00.479: %INSTALLER-7-ISSU_OP_SUCC: issu changeversion is now executing
'issu runversion'
*Feb 25 20:41:03.639: %INSTALLER-7-ISSU_OP_SUCC: issu changeversion successfully executed
'issu runversion'
Note Switchover occurs.
......
......
Look at the console of new active supervisor engine.
*Feb 25 20:47:39.859: %RF-5-RF_TERMINAL_STATE: Terminal state reached for (SSO)
*Feb 25 20:47:39.971: %INSTALLER-7-ISSU_OP_SUCC: issu changeversion is now executing
'issu commitversion'
…..
…..
Note The new standby supervisor engine reloads with target image; changeversion is successful upon
SSO terminal state is reached.
*Feb 25 20:54:16.092: %HA_CONFIG_SYNC-6-BULK_CFGSYNC_SUCCEED: Bulk Sync succeeded
*Feb 25 20:54:16.094: %RF-5-RF_TERMINAL_STATE: Terminal state reached for (SSO)
Switch#
Switch# show issu state detail
Slot = 6
RP State = Active
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:y.bin
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Slot = 5
RP State = Standby
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:y.bin
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Software Configuration Guide—IOS-XE 3.1.0 SG
6-28 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Switch# show redundancy
Redundant System Information :
------------------------------
Available system uptime = 12 minutes
Switchovers system experienced = 0
Standby failures = 0
Last switchover reason = none
Hardware Mode = Duplex
Configured Redundancy Mode = Stateful Switchover
Operating Redundancy Mode = Stateful Switchover
Maintenance Mode = Disabled
Communications = Up
Current Processor Information :
------------------------------
Active Location = slot 6
Current Software state = ACTIVE
Uptime in current state = 9 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Peer Processor Information :
------------------------------
Standby Location = slot 5
Current Software state = STANDBY HOT
Uptime in current state = 2 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
This example shows how to use issu changeversion with the at command option to schedule an ISSU
upgrade procedure to automatically start at the specified time. This example specifies that the ISSU
upgrade should be started at 16:30 (24 hour format). The show issu state detail and show redundancy
command output is included to show the supervisor state before and after the issu changeversion
command was entered.
Switch> enable
Switch# show issu state detail
Slot = 5
RP State = Active
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:x.bin
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Slot = 6
RP State = Standby
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:x.bin
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-29
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Switch# show redundancy
Redundant System Information :
------------------------------
Available system uptime = 12 minutes
Switchovers system experienced = 0
Standby failures = 0
Last switchover reason = none
Hardware Mode = Duplex
Configured Redundancy Mode = Stateful Switchover
Operating Redundancy Mode = Stateful Switchover
Maintenance Mode = Disabled
Communications = Up
Current Processor Information :
------------------------------
Active Location = slot 5
Current Software state = ACTIVE
Uptime in current state = 9 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Peer Processor Information :
------------------------------
Standby Location = slot 6
Current Software state = STANDBY HOT
Uptime in current state = 2 minutes
Image Version = Cisco IOS Software, IOS-XE Software, Catalyst 4500 L3
Switch Software (cat4500e-UNIVERSALK9-M), Version 03.00.00.1.68 CISCO UNIVERSAL
DEVELOPMENT K10 IOSD TEST VERSION
Copyright (c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 29-Aug-10 03:57 by gsbuprod
Configuration register = 0x2920
Switch# issu changeversion 5 bootflash:y.bin 6 slavebootflash:y at 16:30
% 'issu changeversion' was executed at [ Apr 12 16:27:43 ].
% The planned ISSU changeversion is to occur in (hh:mm:ss) [ 00:03:00 ] at [ Apr 12
16:30:43 ].
% Current system time: [ Apr 12 16:27:43 ]
% Planned upgrade image: bootflash:y.bin
% To cancel the planned upgrade, please execute 'issu abortversion'
Switch# show issu state detail
Slot = 5
RP State = Active
ISSU State = Init
Changeversion = TRUE
Operating Mode = Stateful Switchover
Current Image = bootflash:x.bin
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Slot = 6
RP State = Standby
ISSU State = Init
Changeversion = TRUE
Operating Mode = Stateful Switchover
Current Image = bootflash:x.bin
Software Configuration Guide—IOS-XE 3.1.0 SG
6-30 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Aborting a Software Upgrade During ISSU
You can abort the ISSU process at any stage manually (prior to entering the issu commitversion
command) by entering the issu abortversion command. The issu abortversion command may also be
issued after entering the issu changeversion command while the automatic ISSU upgrade is still in
progress. The ISSU process also aborts on its own if the software detects a failure.
Note If you enter the issu abortversion command before the standby supervisor engine becomes hot, the
traffic might be disrupted.
If you abort the process after you issue the issu loadversion command, the standby supervisor engine is
reset and reloaded with the original software.
If the process is aborted after you enter either the issu runversion or issu acceptversion command, then
a second switchover is performed to the new standby supervisor engine that is still running the original
software version. The supervisor engine that had been running the new software is reset and reloaded
with the original software version.
Note Ensure that the standby supervisor is fully booted before issuing the abortversion command on an active
supervisor engine.
The following task describes how to abort the ISSU process before you complete the ISSU process with
the issu commitversion command.
Perform the following task on the active supervisor engine.
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# issu abortversion [active slot Cancels the ISSU upgrade or downgrade process in
[active-image-new]] progress and restores the switch to its state before the
process had started.
This example shows how to abort the ISSU process on slot number 6, the slot for the current active
supervisor engine. In this example, the ISSU upgrade process is in the Runversion state when the issu
abortversion command is entered:
Switch> enable
Switch# show issu state detail
Slot = 6
RP State = Active
ISSU State = Run Version
Operating Mode = Stateful Switchover
Current Image = bootflash:x.bin
Pre-ISSU (Original) Image = bootflash:y.bin
Post-ISSU (Targeted) Image = bootflash:x.bin
Slot = 5
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-31
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
RP State = Standby
ISSU State = Run Version
Operating Mode = Stateful Switchover
Current Image = bootflash:y.bin
Pre-ISSU (Original) Image = bootflash:y.bin
Post-ISSU (Targeted) Image = bootflash:x.bin
Switch# issu abortversion 6
% issu abortversion initiated successfully
Switch# show issu state detail
Slot = 5
RP State = Active
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:y.bin
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Slot = 6
RP State = Standby
ISSU State = Init
Operating Mode = Stateful Switchover
Current Image = bootflash:y.bin
Pre-ISSU (Original) Image = N/A
Post-ISSU (Targeted) Image = N/A
Switch#
Configuring the Rollback Timer to Safeguard Against Upgrade Issues
Cisco IOS XE software maintains an ISSU rollback timer, to safeguard against an upgrade that may leave
the new active supervisor engine in a state in which communication with the standby supervisor engine
is severed.
You may want to configure the rollback timer to fewer than 45 minutes (the default) so that the user need
not wait in case the new software is not committed or the connection to the switch was lost while it was
in runversion mode. A user may want to configure the rollback timer to more than 45 minutes in order
to have enough time to verify the operation of the new Cisco IOS XE software before committing the
new software image.
Note The valid timer value range is from 0 to 7200 seconds (two hours). A value of 0 seconds disables the
rollback timer.
Once you are satisfied that the new image at the active supervisor engine has been successful and you
want to remain in the current state, you may indicate acceptance by issuing the issu acceptversion
command, which stops the rollback timer.
Issuing the issu commitversion command at this stage is equal to entering both the issu acceptversion
and the issu commitversion commands. Use the issu commitversion command if you do not intend to
run in the current state for a period of time and are satisfied with the new software version.
Note The rollback timer can be configured only in the ISSU Init state.
This task explains how to configure the rollback timer:
Software Configuration Guide—IOS-XE 3.1.0 SG
6-32 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# configure terminal Enters global configuration mode.
Step 3 Switch(config)# issu set rollback-timer value Configures the rollback timer value, which can range from
0 to 7200.
Step 4 Switch(config)# exit Returns the user to privileged EXEC mode.
Step 5 Switch# show issu rollback-timer Displays the current setting of the ISSU rollback timer.
This example shows how to set the rollback timer to 3600 seconds:
Switch> enable
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# issu set rollback-timer 3600
% Rollback timer value set to [ 3600 ] seconds
Switch(config)# exit
Switch# show issu rollback-timer
Rollback Process State = Not in progress
Configured Rollback Time = 60:00
The Rollback Timer cannot be set in loadversion or runversion state, as the following example illustrates:
Switch# show issu state detail
Slot = 5
RP State = Active
ISSU State = Load Version
Operating Mode = Stateful Switchover
Current Image = bootflash:old_image
Pre-ISSU (Original) Image = bootflash:old_image
Post-ISSU (Targeted) Image = bootflash:new_image
Slot = 6
RP State = Standby
ISSU State = Load Version
Operating Mode = Stateful Switchover
Current Image = bootflash:new_image
Pre-ISSU (Original) Image = bootflash:old_image
Post-ISSU (Targeted) Image = bootflash:new_image
Switch# show issu rollback-timer
Rollback Process State = Not in progress
Configured Rollback Time = 60:00
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# issu set rollback-timer 20
% ISSU state should be [ init ] to set the rollback timer
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-33
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
How to Perform the ISSU Process
Displaying ISSU Compatibility Matrix Information
The ISSU compatibility matrix contains information about other IOS XE software releases and the
version in question. This compatibility matrix represents the compatibility of the two software versions,
one running on the active and the other on the standby supervisor engine, and the matrix allows the
system to determine the highest operating mode it can achieve. This information helps the user identify
whether to use ISSU.
This task shows how to display information about the ISSU compatibility matrix.
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode. Enter your password if
prompted.
Step 2 Switch# show issu comp-matrix Displays information regarding the ISSU compatibility
{negotiated | stored | xml} matrix.
• negotiated—Displays negotiated compatibility matrix
information.
• stored—Displays negotiated compatibility matrix
information.
• xml—Displays negotiated compatibility matrix
information in XML format.
Note These commands display only the data within IOSd
process. Use the show package compatibility to
display the information for the whole system.
Step 3 Switch# show package compatibility Displays information regarding all client compatibility in
the system.
This example shows how to display negotiated information regarding the compatibility matrix:
Switch> enable
Switch# show issu comp-matrix negotiated
CardType: WS-C4507R-E(182), Uid: 4, Image Ver: 03.00.00.1.68
Image Name: cat4500e-UNIVERSALK9-M
Cid Eid Sid pSid pUid Compatibility
=======================================================
2 1 131078 3 3 COMPATIBLE
3 1 131100 5 3 COMPATIBLE
4 1 131123 9 3 COMPATIBLE
.....
.....
Message group summary:
Cid Eid GrpId Sid pSid pUid Nego Result
=============================================================
2 1 1 131078 3 3 Y
3 1 1 131100 5 3 Y
4 1 1 131123 9 3 Y
.....
.....
List of Clients:
Software Configuration Guide—IOS-XE 3.1.0 SG
6-34 OL-22250-01
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
Cisco High Availability Features in Cisco IOS XE 3.1.0 SG
Cid Client Name Base/Non-Base
================================================
2 ISSU Proto client Base
3 ISSU RF Base
4 ISSU CF client Base
.....
.....
This example shows how to display stored information regarding the compatibility matrix:
Switch# show issu comp-matrix stored
Number of Matrices in Table = 1
(1) Matrix for cat4500e-ENTSERVICESK9-M(182) - cat4500ex-ENTSERVICESK9-M(182)
==========================================
Start Flag (0xDEADBABE)
My Image ver: 03.01.00.SG
Peer Version Compatibility
------------ -------------
03.01.00.SG Comp(3)
Switch#
Dynamic Image Version Compatibility (DIVC) feature is supported in IOS XE releases. With DIVC, we
store Dynamic(0) rather than Incomp(1), Base(2), or Comp(3), and determine compatibility during
run-time when two different DIVC-capable IOS XE software images are running in the active and
standby supervisor engines during ISSU.
For Catalyst 4500 switches, a value of Dynamic(0) in the stored compatibility-matrix normally results
in Base(2) or Comp(3) upon run-time negotiation between the two IOS XE software images; as of today,
you never observe Incomp(1) as long as the other IOS XE name is present in the stored
compatibility-matrix.
This example shows how to display negotiated information regarding non-IOSd clients:
Switch# show package compatibility
PackageName PeerPackageName ModuleName Compatibility
----------- --------------- -------------------------------- -------------
rp_base rp_base aaa COMPATIBLE
rp_base rp_base aaacommon COMPATIBLE
rp_base rp_base access_policy COMPATIBLE
rp_base rp_base app_sess COMPATIBLE
rp_base rp_base app_sess_ios COMPATIBLE
rp_base rp_base auth_mgr COMPATIBLE
......
......
Cisco High Availability Features in Cisco IOS XE 3.1.0 SG
This section provides a list of High Availability software features that are supported in Cisco IOS XE
3.1.0SG. Links to the feature documentation are included.
Feature guides may contain information about more than one feature. To find information about a
specific feature within a feature guide, see the Feature Information table at the end of the guide.
Feature guides document features that are supported on many different software releases and platforms.
Your Cisco software release or platform may not support all the features documented in a feature guide.
See the Feature Information table at the end of the feature guide for information about which features in
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 6-35
Chapter 6 Configuring the Cisco IOS XE In Service Software Upgrade Process
Cisco High Availability Features in Cisco IOS XE 3.1.0 SG
that guide are supported in your software release. Use Cisco Feature Navigator to find information about
platform support and Cisco software image support. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
ISSU (IOS In-Service Software Upgrade)
http://www.cisco.com/en/US/products/ps7149/products_ios_protocol_group_home.html
Enhanced High System Availability
http://www.cisco.com/en/US/solutions/collateral/ns340/ns517/ns431/ns17/net_brochure0900aecd8044
dddd.pdf
Software Configuration Guide—IOS-XE 3.1.0 SG
6-36 OL-22250-01
CH A P T E R 7
Configuring Interfaces
This chapter describes how to configure interfaces for the Catalyst 4500 series switches. It also provides
guidelines, procedures, and configuration examples.
This chapter includes the following major sections:
• About Interface Configuration, page 7-2
• Using the interface Command, page 7-2
• Configuring a Range of Interfaces, page 7-4
• Defining and Using Interface-Range Macros, page 7-6
• Deploying SFP+ in X2 Ports, page 7-7
• Deploying 10-Gigabit Ethernet or Gigabit Ethernet Ports on WS-X4606-10GE-E, page 7-7
• Internal Management Port and Supervisor Engine 7-E, page 7-10
• Limitation and Restrictions on Supervisor Engine 7-E, page 7-10
• Digital Optical Monitoring Transceiver Support, page 7-10
• Configuring Optional Interface Features, page 7-11
• Understanding Online Insertion and Removal, page 7-23
• Monitoring and Maintaining the Interface, page 7-24
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-1
Chapter 7 Configuring Interfaces
About Interface Configuration
About Interface Configuration
By default, all interfaces are enabled. The 10/100-Mbps Ethernet interfaces autonegotiated connection
speed and duplex. The 10/100/1000-Mbps Ethernet interfaces negotiate speed, duplex, and flow control.
The 1000-Mbps Ethernet interfaces negotiate flow control only. Autonegotiation automatically selects
the fastest speed possible on that port for the given pair. If a speed is explicitly stated for an interface,
that interface defaults to half duplex unless it is explicitly set for full duplex.
Many features are enabled on a per-interface basis. When you enter the interface command, you must
specify the following:
• Interface type:
– Fast Ethernet (use the fastethernet keyword)
– Gigabit Ethernet (use the gigabitethernet keyword)
– 10-Gigabit Ethernet (use the tengigabitethernet keyword)
• Slot number—The slot in which the interface module is installed. Slots are numbered starting
with 1, from top to bottom.
• Interface number—The interface number on the module. The interface numbers always begin with 1.
When you are facing the front of the switch, the interfaces are numbered from left to right.
You can identify interfaces by physically checking the slot/interface location on the switch. You can also
use the Cisco IOS show commands to display information about a specific interface or all the interfaces.
The interfaces on WS-X45-SUP7-E and WS-X4712-SFP+E support both Gigabit Ethernet SFPs and Ten
Gigabit Ethernet SFP+s but are always termed Ten Gigabit Ethernet interfaces.
Using the interface Command
These general instructions apply to all interface configuration processes:
Step 1 At the privileged EXEC prompt, enter the configure terminal command to enter global configuration
mode:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)#
Step 2 In global configuration mode, enter the interface command. Identify the interface type and the number
of the connector on the interface card. The following example shows how to select Fast Ethernet, slot 5,
interface 1:
Switch(config)# interface fastethernet 5/1
Switch(config-if)#
Step 3 Interface numbers are assigned at the factory at the time of installation or when modules are added to a
system. Enter the show interfaces EXEC command to see a list of all interfaces installed on your switch.
A report is provided for each interface that your switch supports, as shown in this display:
Switch(config-if)#Ctrl-Z
Switch#show interfaces
Vlan1 is up, line protocol is down
Hardware is Ethernet SVI, address is 0004.dd46.7aff (bia 0004.dd46.7aff)
MTU 1500 bytes, BW 1000000 Kbit, DLY 10 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-2 OL-22250-01
Chapter 7 Configuring Interfaces
Using the interface Command
ARP type: ARPA, ARP Timeout 04:00:00
Last input never, output never, output hang never
Last clearing of "show interface" counters never
Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 0 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
0 packets input, 0 bytes, 0 no buffer
Received 0 broadcasts, 0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
0 packets output, 0 bytes, 0 underruns
0 output errors, 0 interface resets
0 output buffer failures, 0 output buffers swapped out
GigabitEthernet1/1 is up, line protocol is down
Hardware is Gigabit Ethernet Port, address is 0004.dd46.7700 (bia 0004.dd46.7700)
MTU 1500 bytes, BW 1000000 Kbit, DLY 10 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Keepalive set (10 sec)
Auto-duplex, Auto-speed
ARP type: ARPA, ARP Timeout 04:00:00
Last input never, output never, output hang never
Last clearing of "show interface" counters never
Input queue: 0/2000/0/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 0 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
0 packets input, 0 bytes, 0 no buffer
Received 0 broadcasts, 0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
0 input packets with dribble condition detected
0 packets output, 0 bytes, 0 underruns
0 output errors, 0 collisions, 0 interface resets
0 babbles, 0 late collision, 0 deferred
0 lost carrier, 0 no carrier
0 output buffer failures, 0 output buffers swapped out
GigabitEthernet1/2 is up, line protocol is down
Hardware is Gigabit Ethernet Port, address is 0004.dd46.7701 (bia 0004.dd46.7701)
MTU 1500 bytes, BW 1000000 Kbit, DLY 10 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Keepalive set (10 sec)
Auto-duplex, Auto-speed
ARP type: ARPA, ARP Timeout 04:00:00
Last input never, output never, output hang never
Last clearing of "show interface" counters never
Input queue: 0/2000/0/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 0 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
0 packets input, 0 bytes, 0 no buffer
Received 0 broadcasts, 0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
0 input packets with dribble condition detected
0 packets output, 0 bytes, 0 underruns
0 output errors, 0 collisions, 0 interface resets
0 babbles, 0 late collision, 0 deferred
0 lost carrier, 0 no carrier
0 output buffer failures, 0 output buffers swapped out
--More--
<...output truncated...>
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-3
Chapter 7 Configuring Interfaces
Configuring a Range of Interfaces
Step 4 To begin configuring Fast Ethernet interface 5/5, as shown in the following example, enter the interface
keyword, interface type, slot number, and interface number in global configuration mode:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 5/5
Switch(config-if)#
Note Adding a space between the interface type and interface number is not needed. For example, in
the preceding line you can specify either fastethernet 5/5 or fastethernet5/5.
Step 5 Follow each interface command with the interface configuration commands your particular interface
requires. The commands you enter define the protocols and applications that will run on the interface.
The commands are collected and applied to the interface command until you enter another interface
command or press Ctrl-Z to exit interface configuration mode and return to privileged EXEC mode.
Note On the Supervisor, WS-X45-SUP7-E and the linecard, WS-X4712-SFP+E, the interfaces can
support both Gigabit Ethernet SFPs and 10-Gigabit Ethernet SFP+s. For simplicity, these
interfaces are always termed 10-Gigabit Ethernet interfaces. All Gigabit Ethernet and 10-Gigabit
Ethernet parameters can be configured on these interfaces. However, the actual interface
configuration parameters that are valid for an interface depend on which transceiver type (SFP
or SFP+) is loaded. When an SFP is loaded, only the Gigabit Ethernet parameters are applicable
and the interface behaves exactly like a Gigabit Ethernet port. Similarly, when an SFP+ is
loaded, only the 10-Gigabit Ethernet parameters are applicable and the interface behaves exactly
like a 10-Gigabit Ethernet port.
Step 6 After you configure an interface, check its status by using the EXEC show commands listed in the
“Monitoring and Maintaining the Interface” section on page 7-24.
Configuring a Range of Interfaces
The interface-range configuration mode allows you to configure multiple interfaces with the same
configuration parameters. When you enter the interface-range configuration mode, all command
parameters you enter are attributed to all interfaces within that range until you exit interface-range
configuration mode.
To configure a range of interfaces with the same configuration, perform this task:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-4 OL-22250-01
Chapter 7 Configuring Interfaces
Configuring a Range of Interfaces
Command Purpose
Switch(config)# interface range Selects the range of interfaces to be configured. Note
{vlan vlan_ID - vlan_ID} | the following:
{{fastethernet | gigabitethernet |
tengigabitethernet | macro macro_name} • You are required to enter a space before the dash.
slot/interface - interface} [,
{vlan vlan_ID - vlan_ID} {{fastethernet • You can enter up to five comma-separated
| gigabitethernet | tengigabitethernet | ranges.
macro macro_name}
slot/interface - interface}] • You are not required to enter spaces before or
after the comma.
Note When you use the interface range command, you must add a space between the vlan, fastethernet,
gigabitethernet, tengigabitethernet, or macro keyword and the dash. For example, the command
interface range fastethernet 5/1 - 5 specifies a valid range; the command
interface range fastethernet 5/1-5 does not contain a valid range command.
Note The interface range command works only with VLAN interfaces that have been configured with the
interface vlan command (the show running-configuration command displays the configured VLAN
interfaces). VLAN interfaces that are not displayed by the show running-configuration command
cannot be used with the interface range command.
This example shows how to reenable all Fast Ethernet interfaces 5/1 to 5/5:
Switch(config)# interface range fastethernet 5/1 - 5
Switch(config-if-range)# no shutdown
Switch(config-if-range)#
*Oct 6 08:24:35: %LINK-3-UPDOWN: Interface FastEthernet5/1, changed state to up
*Oct 6 08:24:35: %LINK-3-UPDOWN: Interface FastEthernet5/2, changed state to up
*Oct 6 08:24:35: %LINK-3-UPDOWN: Interface FastEthernet5/3, changed state to up
*Oct 6 08:24:35: %LINK-3-UPDOWN: Interface FastEthernet5/4, changed state to up
*Oct 6 08:24:35: %LINK-3-UPDOWN: Interface FastEthernet5/5, changed state to up
*Oct 6 08:24:36: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet5/
5, changed state to up
*Oct 6 08:24:36: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet5/
3, changed state to up
*Oct 6 08:24:36: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet5/
4, changed state to up
Switch(config-if)#
This example shows how to use a comma to add different interface type strings to the range to re-enable
all Fast Ethernet interfaces ranging from 5/1 to 5/5 and both Gigabit Ethernet interfaces 1/1 and 1/2:
Switch(config-if)# interface range fastethernet 5/1 - 5, gigabitethernet 1/1 - 2
Switch(config-if)# no shutdown
Switch(config-if)#
*Oct 6 08:29:28: %LINK-3-UPDOWN: Interface FastEthernet5/1, changed state to up
*Oct 6 08:29:28: %LINK-3-UPDOWN: Interface FastEthernet5/2, changed state to up
*Oct 6 08:29:28: %LINK-3-UPDOWN: Interface FastEthernet5/3, changed state to up
*Oct 6 08:29:28: %LINK-3-UPDOWN: Interface FastEthernet5/4, changed state to up
*Oct 6 08:29:28: %LINK-3-UPDOWN: Interface FastEthernet5/5, changed state to up
*Oct 6 08:29:28: %LINK-3-UPDOWN: Interface GigabitEthernet1/1, changed state to
up
*Oct 6 08:29:28: %LINK-3-UPDOWN: Interface GigabitEthernet1/2, changed state to
up
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-5
Chapter 7 Configuring Interfaces
Defining and Using Interface-Range Macros
*Oct 6 08:29:29: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet5/
5, changed state to up
*Oct 6 08:29:29: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet5/
3, changed state to up
*Oct 6 08:29:29: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet5/
4, changed state to up
Switch(config-if)#
Note If you enter multiple configuration commands while you are in interface-range configuration mode, each
command is run as it is entered (they are not batched together and run after you exit interface-range
configuration mode). If you exit interface-range configuration mode while the commands are being run,
some commands might not be run on all interfaces in the range. Wait until the command prompt is
displayed before exiting interface-range configuration mode.
Defining and Using Interface-Range Macros
You can define an interface-range macro to automatically select a range of interfaces for configuration.
Before you can use the macro keyword in the interface-range macro command string, you must define
the macro.
To define an interface-range macro, perform this task:
Table 7-1
Command Purpose
Switch(config)# define interface-range macro_name Defines the interface-range macro and
{vlan vlan_ID - vlan_ID} | {{fastethernet | saves it in the running configuration file.
gigabitethernet | tengigabitethernet}
slot/interface - interface}
[, {vlan vlan_ID - vlan_ID} {{fastethernet |
gigabitethernet | tengigabitethernet}
slot/interface - interface}]
This example shows how to define an interface-range macro named enet_list to select Fast Ethernet
interfaces 5/1 through 5/4:
Switch(config)# define interface-range enet_list fastethernet 5/1 - 4
To show the defined interface-range macro configuration, perform this task:
Table 7-2
Command Purpose
Switch# show running-config Shows the defined interface-range macro
configuration.
This example shows how to display the defined interface-range macro named enet_list:
Switch# show running-config | include define
define interface-range enet_list FastEthernet5/1 - 4
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-6 OL-22250-01
Chapter 7 Configuring Interfaces
Deploying SFP+ in X2 Ports
To use an interface-range macro in the interface range command, perform this task:
Table 7-3
Command Purpose
Switch(config)# interface range macro Selects the interface range to be configured using
name the values saved in a named interface-range macro.
This example shows how to change to the interface-range configuration mode using the interface-range
macro enet_list:
Switch(config)# interface range macro enet_list
Switch(config-if)#
Deploying SFP+ in X2 Ports
Note This feature is supported on WS-X4606-X2-E.
To use an SFP+ in an X2 port to obtain 10-Gigabit Ethernet bandwidth, the Catalyst 4500 series switch
supports OneX Convertor modules. When you plug a OneX Converter module into an X2 port, it
converts the X2 port into an SFP+ port into which you can plug in an SFP+. An SFP+ in a OneX
Convertor module provides the same functionality as an X2 and maintains the same port numbering.
The output for the show idprom tengigabitethernet slot/interface command displays the contents of
both the SFP+ and the OneX Convertor module seeproms when an SFP+ in a OneX Convertor module
is plugged into an X2 port.
Deploying 10-Gigabit Ethernet or Gigabit Ethernet Ports on
WS-X4606-10GE-E
To increase the flexibility of X2 ports on WS-X4606-10GE-E, the Catalyst 4500 switch supports
TwinGig Convertor modules. When you plug a TwinGig Convertor module into an X2 hole, it converts
a single X2 hole (capable of holding one pluggable X2 optic) into two SFP holes (capable of holding
two pluggable SFP optics). This enables you to have 10 Gigabit ports and 1-Gigabit ports on the same
linecard. It also allows you to use Gigabit ports, and then switch to a 10-Gigabit port, when needed.
Topics include:
• Port Numbering TwinGig Convertors, page 7-7
• Selecting X2/TwinGig Convertor Mode, page 7-8
Port Numbering TwinGig Convertors
When a TwinGig Convertor is enabled or disabled, the number and type of ports on the linecard change
dynamically. The terminology must reflect this behavior. In Cisco IOS, 10-Gigabit ports are named
TenGigabit and 1-Gigabit ports are named Gigabit. To avoid having two ports named TenGigabit1/1 and
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-7
Chapter 7 Configuring Interfaces
Deploying 10-Gigabit Ethernet or Gigabit Ethernet Ports on WS-X4606-10GE-E
Gigabit1/1, the 10-Gigabit and 1-Gigabit port numbers are independent. For example, for a
WS-X4606-10GE-E module with six X2 holes, the X2 ports are named TenGigabit slot-num/<1-6>, and
the SFP ports are named Gigabit slot-num/<7-18>.
Figure 7-1 Faceplate for WS-X4606-10GE
X2 1 2 3 X2 4 5 6
231562
Status
SFP 7 8 9 10 11 12 SFP 13 14 15 16 17 18
In Cisco IOS, ports 1 through 18 always exist. This means that you can apply configurations on them
and they display in the CLI output. However, only the X2 or the SFP ports can be active at any particular
time. For example, if an X2 is plugged into the second hole, the X2 port 2 is active and SFP ports 9 and
10 are inactive. If a TwinGig Convertor is plugged into the second hole, the X2 port 2 is inactive, and
the SFP ports 9 and 10 are active.
Note When using both TwinGig and X2 transceivers on the WS-X4606-X2-E module, place ports 1-3 in one
group and ports 4-6 in another. (The mode selected with the show hw-module module port-group
command determines the behavior. See “Selecting X2/TwinGig Convertor Mode”.) Mixing within a port
group will not work. For example, you cannot have an X2 in port 1 and a TwinGig in port 2 and expect
both of them to function.
Selecting X2/TwinGig Convertor Mode
The default configuration mode is X2. So, if you plan to deploy 10-Gigabit interfaces, you don’t need to
configure anything. However, if you want to deploy Gigabit interfaces (that is, use TwinGig Convertors),
you must configure the associated port-group:
• To determine how the X2 holes on a module are grouped, enter the
show hw-module module m port-group p command.
Note For a 10-Gigabit port that accepts a HAMM, you must place it into 1-Gigabit mode instead of
10-Gigabit mode.
If you configure a 10-Gigabit port as 1-Gigabit port, an output similar to the following displays:
Switch# show hw-module module 5 port-group
Module Port-group Active Inactive
-------------------------------------------------------------
5 1 Gi5/3-6 Te5/1-2
Instead, if the port is set to the default, 10-Gigabit mode, an output similar to the following displays:
Switch# show hw-module module 6 port-group
Module Port-group Active Inactive
-------------------------------------------------------------
6 1 Te6/1-2 Gi6/3-6
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-8 OL-22250-01
Chapter 7 Configuring Interfaces
Deploying 10-Gigabit Ethernet or Gigabit Ethernet Ports on WS-X4606-10GE-E
Switch# show int status mod 1
Port Name Status Vlan Duplex Speed Type
Te1/1 notconnect 1 full 10G 10GBase-LR
Te1/2 connected 1 full 10G 10GBase-LR
Te1/3 notconnect 1 full 10G No X2
Te1/4 notconnect 1 full 10G No X2
Te1/5 notconnect 1 full 10G No X2
Te1/6 notconnect 1 full 10G No X2
Gi1/7 inactive 1 full 1000 No Gbic
Gi1/8 inactive 1 full 1000 No Gbic
Gi1/9 inactive 1 full 1000 No Gbic
Gi1/10 inactive 1 full 1000 No Gbic
Gi1/11 inactive 1 full 1000 No Gbic
Gi1/12 inactive 1 full 1000 No Gbic
Gi1/13 inactive 1 full 1000 No Gbic
Gi1/14 inactive 1 full 1000 No Gbic
Gi1/15 inactive 1 full 1000 No Gbic
Gi1/16 inactive 1 full 1000 No Gbic
Gi1/17 inactive 1 full 1000 No Gbic
Gi1/18 inactive 1 full 1000 No Gbic
Switch#
• To configure the modes of operation for each X2 port group in which you want to deploy Gigabit,
enter the hw-module module m port-group p select gigabitethernet command. This configuration
is preserved across power cycles and reloads.
To deploy Gigabit Ethernet interfaces using the TwinGig Convertor, perform this task:
Command Purpose
Step 1 Switch# configure terminal Establishes global configuration mode.
Step 2 Switch(config)# hw-module module m port-group p Selects the mode of operation for each X2 port-group.
select [gigabitethernet | tengigabitethernet]
Default is TenGigabit Ethernet (x2).
Step 3 Switch(config)# exit Exits configuration mode.
Step 4 Switch# show int status mod n Verifies the setting.
This example shows how to select Gigabit Ethernet interfaces on a WS-X4606-10GE-E using the
TwinGig Convertor:
Switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# hw-module module 1 port-group 1 select gigabitethernet
Switch(config)# exit
Switch# show int status mod 1
Port Name Status Vlan Duplex Speed Type
Te1/1 inactive 1 full 10G No X2
Te1/2 inactive 1 full 10G No X2
Te1/3 inactive 1 full 10G No X2
Te1/4 notconnect 1 full 10G No X2
Te1/5 notconnect 1 full 10G No X2
Te1/6 notconnect 1 full 10G No X2
Gi1/7 notconnect 1 full 1000 No Gbic
Gi1/8 notconnect 1 full 1000 No Gbic
Gi1/9 notconnect 1 full 1000 No Gbic
Gi1/10 notconnect 1 full 1000 No Gbic
Gi1/11 notconnect 1 full 1000 No Gbic
Gi1/12 notconnect 1 full 1000 No Gbic
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-9
Chapter 7 Configuring Interfaces
Internal Management Port and Supervisor Engine 7-E
Gi1/13 inactive 1 full 1000 No Gbic
Gi1/14 inactive 1 full 1000 No Gbic
Gi1/15 inactive 1 full 1000 No Gbic
Gi1/16 inactive 1 full 1000 No Gbic
Gi1/17 inactive 1 full 1000 No Gbic
Gi1/18 inactive 1 full 1000 No GbicI
Internal Management Port and Supervisor Engine 7-E
The Internal Management Port is not supported on WS-X45-SUP-7E. The configuration for the internal
management port always appears in the running configuration in shutdown state. The configuration
cannot be changed to the no shut state. One of the front panel ports on the WS-X45-SUP-7E or on a
linecard in the chassis can be configured and used as a management port.
Limitation and Restrictions on Supervisor Engine 7-E
Please note the following:
• When you use WS-X45-SUP7-E in RPR or SSO mode, only the first two uplinks on each supervisor
engine are available. The second two uplinks are unavailable.
Digital Optical Monitoring Transceiver Support
Command line interface (CLI) commands (show inventory, show idprom interface) are used on
transceivers to obtain serial number, model name, inventory information.
The following commands are specific to the transceivers that support the DOM capability:
• Displays current values and thresholds for all sensor on a particular interface transceiver:
show interfaces <int-name> transceiver [detail] [threshold]
• Enables or disables the entSensorThresholdNotification for all sensors in all the transceivers:
snmp-server enable trap transceiver
• Enables or disables transceiver monitoring:
transceiver type all
monitoring
Note This feature is only available when a DOM capable transceiver is present and configured for monitoring.
The frequency at which the sensor information is refreshed depends on default values configured in the
transceiver SEEPROM (Serial Electrically Erasable Programmable Read Only Memory).
Note For details on transceiver module compatibility, refer to this URL:
http://www.cisco.com/en/US/products/hw/modules/ps5455/products_device_support_tables_list.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-10 OL-22250-01
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
Configuring Optional Interface Features
The following subsections describe optional procedures:
• Configuring Ethernet Interface Speed and Duplex Mode, page 7-11
• Configuring Flow Control, page 7-14
• Configuring Jumbo Frame Support, page 7-16
• Interacting with Baby Giants, page 7-20
• Configuring the Port Debounce Timer, page 7-20
• Configuring auto-MDIX on a Port, page 7-21
Configuring Ethernet Interface Speed and Duplex Mode
• Speed and Duplex Mode Configuration Guidelines, page 7-11
• Setting the Interface Speed, page 7-11
• Setting the Interface Duplex Mode, page 7-12
• Displaying the Interface Speed and Duplex Mode Configuration, page 7-13
• Adding a Description for an Interface, page 7-13
Speed and Duplex Mode Configuration Guidelines
Note You do not configure the client device for autonegotiation. Rather, you configure the switch with the
speed, or range of speeds, that you want to autonegotiate.
You can configure the interface speed and duplex mode parameters to auto and allow the Catalyst 4500
series switch to negotiate the interface speed and duplex mode between interfaces. If you decide to
configure the interface speed and duplex commands manually, consider the following:
• If you enter the no speed command, the switch automatically configures both interface speed and
duplex to auto.
• When you set the interface speed to 1000 (Mbps) or auto 1000, the duplex mode is full duplex. You
cannot change the duplex mode.
• If the interface speed is set to 10 or 100, the duplex mode is set to half duplex by default unless you
explicitly configure it.
Caution Changing the interface speed and duplex mode configuration might shut down and restart the interface
during the reconfiguration.
Setting the Interface Speed
If you set the interface speed to auto on a 10/100-Mbps Ethernet interface, speed and duplex are
autonegotiated. The forced 10/100 autonegotiation feature allows you to limit interface speed auto
negotiation up to 100 Mbps on a 10/100/1000BASE-T port.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-11
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
To set the port speed for a 10/100-Mbps Ethernet interface, perform this task:
Command Purpose
Step 1 Switch(config)# interface fastethernet slot/interface Specifies the interface to be configured.
Step 2 Switch(config-if)# speed [10 | 100 | auto [10 | 100]] Sets the interface speed of the interface.
This example shows how to set the interface speed to 100 Mbps on the Fast Ethernet interface 5/4:
Switch(config)# interface fastethernet 5/4
Switch(config-if)# speed 100
This example shows how to allow Fast Ethernet interface 5/4 to autonegotiate the speed and duplex
mode:
Switch(config)# interface fastethernet 5/4
Switch(config-if)# speed auto
Note This is analogous to specifying speed auto 10 100.
This example shows how to limit the interface speed to 10 and 100 Mbps on the Gigabit Ethernet
interface 1/1 in auto-negotiation mode:
Switch(config)# interface gigabitethernet 1/1
Switch(config-if)# speed auto 10 100
This example shows how to limit speed negotiation to 100 Mbps on the Gigabit Ethernet interface 1/1:
Switch(config)# interface gigabitethernet 1/1
Switch(config-if)# speed auto 100
Note Turning off autonegotiation on a Gigabit Ethernet interface will result in the port being forced into
1000 Mbps and full-duplex mode.
To turn off the port speed autonegotiation for Gigabit Ethernet interface 1/1, perform this task:
Command Purpose
Step 1 Switch(config)# interface gigabitethernet1/1 Specifies the interface to be configured.
Step 2 Switch(config-if)# speed nonegotiate Disables autonegotiation on the interface.
To restore autonegotiation, enter the no speed nonegotiate command in the interface configuration
mode.
Note For the blocking ports on the WS-X4416 module, do not set the speed to autonegotiate.
Setting the Interface Duplex Mode
Note When the interface is set to 1000 Mbps, you cannot change the duplex mode from full duplex to half
duplex.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-12 OL-22250-01
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
To set the duplex mode of a Fast Ethernet interface, perform this task:
Command Purpose
Step 1 Switch(config)# interface fastethernet Specifies the interface to be configured.
slot/interface
Step 2 Switch(config-if)# duplex [auto | full | half] Sets the duplex mode of the interface.
This example shows how to set the interface duplex mode to full on Fast Ethernet interface 5/4:
Switch(config)# interface fastethernet 5/4
Switch(config-if)# duplex full
Displaying the Interface Speed and Duplex Mode Configuration
To display the interface speed and duplex mode configuration for an interface, perform this task:
Command Purpose
Switch# show interfaces [fastethernet | Displays the interface speed and duplex mode
gigabitethernet | tengigabitethernet] configuration.
slot/interface
This example shows how to display the interface speed and duplex mode of Fast Ethernet interface 6/1:
Switch# show interface fastethernet 6/1
FastEthernet6/1 is up, line protocol is up
Hardware is Fast Ethernet Port, address is 0050.547a.dee0 (bia 0050.547a.dee0)
MTU 1500 bytes, BW 100000 Kbit, DLY 100 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Keepalive set (10 sec)
Full-duplex, 100Mb/s
ARP type: ARPA, ARP Timeout 04:00:00
Last input 00:00:54, output never, output hang never
Last clearing of "show interface" counters never
Input queue: 50/2000/0/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 0 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
50 packets input, 11300 bytes, 0 no buffer
Received 50 broadcasts, 0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
0 input packets with dribble condition detected
1456 packets output, 111609 bytes, 0 underruns
0 output errors, 0 collisions, 0 interface resets
0 babbles, 0 late collision, 0 deferred
1 lost carrier, 0 no carrier
0 output buffer failures, 0 output buffers swapped out
Switch#
Adding a Description for an Interface
You can add a description about an interface to help you remember its function. The description appears
in the output of the following commands: show configuration, show running-config, and
show interfaces.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-13
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
To add a description for an interface, enter the following command:
Command Purpose
Switch(config-if)# description string Adds a description for an interface.
This example shows how to add a description on Fast Ethernet interface 5/5:
Switch(config)# interface fastethernet 5/5
Switch(config-if)# description Channel-group to "Marketing"
Configuring Flow Control
Gigabit Ethernet ports use Flow Control to slow-down the transmission of incoming packets. If a buffer
on a Gigabit Ethernet port runs out of space, the port transmits a special packet that requests remote ports
to delay sending packets for a period of time. The port can also receive this special packet from its
link-partner for the same purpose. This special packet is called a pause frame.
The default settings for Gigabit Ethernet interfaces are as follows:
• Sending pause frames is off—non-oversubscribed Gigabit Ethernet interfaces.
• Receiving pause frames is desired—non-oversubscribed Gigabit Ethernet interfaces.
• Sending pause frames is on—Oversubscribed Gigabit Ethernet interfaces.
• Receiving pause frames is desired—Oversubscribed Gigabit Ethernet interfaces
The default settings for Tengigabit Ethernet interfaces are as follows:
• Sending pause frames is off.
• Receiving pause frames is on.
Note desired is not a flow control option on the Tengigabit Ethernet interfaces.
To configure flow control, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode and specifies the interface to be
interface-id enabled for flowcontrol.
Step 3 Switch(config-if)# flowcontrol Configures a Gigabit Ethernet port to send or receive pause frames.
{receive | send} {off | on |
desired}
Step 4 Switch(config-if)# end Returns to configuration mode.
Step 5 Switch(config)# end Returns to privileged EXEC mode.
This example shows how to configure flow control on an oversubscribed Gigabit Ethernet port 7/5:
Switch# configure terminal
Switch(config)# interface g7/5
Switch(config-if)# flowcontrol send on
Switch(config-if)# end
Switch)# show interfaces gigabitEthernet 7/5 capabilities
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-14 OL-22250-01
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
GigabitEthernet7/5
Model: WS-X4548-GB-RJ45-RJ-45
Type: 10/100/1000-TX
Speed: 10,100,1000,auto
Duplex: half,full,auto
Trunk encap. type: 802.1Q,ISL
Trunk mode: on,off,desirable,nonegotiate
Channel: yes
Broadcast suppression: percentage(0-100), hw
Flowcontrol: rx-(off,on,desired),tx-(off,on,desired)
VLAN Membership: static, dynamic
Fast Start: yes
Queuing: rx-(N/A), tx-(1p3q1t, Sharing/Shaping)
CoS rewrite: yes
ToS rewrite: yes
Inline power: no
SPAN: source/destination
UDLD: yes
Link Debounce: no
Link Debounce Time: no
Port Security: yes
Dot1x: yes
Maximum MTU: 1552 bytes (Baby Giants)
Multiple Media Types: no
Diagnostic Monitoring: N/A
Switch)# show flowcontrol interface GigabitEthernet 7/5
Port Send FlowControl Receive FlowControl RxPause TxPause
admin oper admin oper
--------- -------- -------- -------- -------- ------- -------
Gi7/5 on off desired off 0 0
This example shows the output of the show interfaces and show flowcontrol commands on an
non-oversubscribed Gigabit Ethernet port 5/5:
Switch# show interfaces gigabitEthernet 5/5 capabilities
GigabitEthernet5/5
Model: WS-X4306-GB-Gbic
Type: No Gbic
Speed: 1000
Duplex: full
Trunk encap. type: 802.1Q,ISL
Trunk mode: on,off,desirable,nonegotiate
Channel: yes
Broadcast suppression: percentage(0-100), hw
Flowcontrol: rx-(off,on,desired),tx-(off,on,desired)
VLAN Membership: static, dynamic
Fast Start: yes
Queuing: rx-(N/A), tx-(1p3q1t, Sharing/Shaping)
CoS rewrite: yes
ToS rewrite: yes
Inline power: no
SPAN: source/destination
UDLD: yes
Link Debounce: no
Link Debounce Time: no
Port Security: yes
Dot1x: yes
Maximum MTU: 9198 bytes (Jumbo Frames)
Multiple Media Types: no
Diagnostic Monitoring: N/A
Switch# show flowcontrol interface gigabitEthernet 5/5
Port Send FlowControl Receive FlowControl RxPause TxPause
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-15
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
admin oper admin oper
--------- -------- -------- -------- -------- ------- -------
Gi5/5 off off desired off 0 0
This example shows the output of the show interfaces and show flowcontrol commands on an
unsupported Fast Ethernet port 3/5:
Switch# show interfaces fa3/5 capabilities
FastEthernet3/5
Model: WS-X4148-RJ-45
Type: 10/100BaseTX
Speed: 10,100,auto
Duplex: half,full,auto
Trunk encap. type: 802.1Q,ISL
Trunk mode: on,off,desirable,nonegotiate
Channel: yes
Broadcast suppression: percentage(0-100), sw
Flowcontrol: rx-(none),tx-(none)
VLAN Membership: static, dynamic
Fast Start: yes
Queuing: rx-(N/A), tx-(1p3q1t, Shaping)
CoS rewrite: yes
ToS rewrite: yes
Inline power: no
SPAN: source/destination
UDLD: yes
Link Debounce: no
Link Debounce Time: no
Port Security: yes
Dot1x: yes
Maximum MTU: 1552 bytes (Baby Giants)
Multiple Media Types: no
Diagnostic Monitoring: N/A
Switch# show flowcontrol interface fa3/5
Port Send FlowControl Receive FlowControl RxPause TxPause
admin oper admin oper
--------- -------- -------- -------- -------- ------- -------
Fa3/5 Unsupp. Unsupp. Unsupp. Unsupp. 0 0
Note Although all interfaces are termed 10-Gigabit interfaces on WS-X45-SUP7+E and WS-X4712-SFP+E,
if an interface has an SFP, the interface is treated as a Gigabit Ethernet interface.
Configuring Jumbo Frame Support
These subsections describe jumbo frame support:
• Ports and Modules that Support Jumbo Frames, page 7-16
• Jumbo Frame Support, page 7-17
• Configuring MTU Sizes, page 7-19
Ports and Modules that Support Jumbo Frames
The following ports and modules support jumbo frames:
• Supervisor uplink ports
• WS-X4306-GB: all ports
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-16 OL-22250-01
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
• WS-X4232-GB-RJ: ports 1-2
• WS-X4418-GB: ports 1-2
• WS-X4412-2GB-TX: ports 13-14
• WS-X4506-GB-T
• WS-X4606-X2-E
• WS-X4648-RJ45-E
• WS-X4648-RJ45V+E
• WS-X4648-RJ45V-E
• WS-X4712-SFP+E
• WS-X4748-UPOE+E
• WS-X4748-RJ45-E
• WS-X4748-RJ45V+E
Jumbo Frame Support
These sections describe jumbo frame support:
• Maximum Transmission Units, page 7-17
• Jumbo Frame Support Overview, page 7-17
• Ethernet Ports, page 7-18
• VLAN Interfaces, page 7-18
Maximum Transmission Units
The Catalyst 4500 series switch allows you to configure a maximum of 32 different maximum
transmission unit (MTU) sizes system wide. This means that the maximum number of different MTU
sizes that you can configure with the system mtu, mtu, ip mtu, and ipv6 mtu command on all Layer 2
and Layer 3 interfaces combined is 32.
Also, the system stores the ipv4 and ipv6 MTU sizes configured on an interface separately. So, for every
system mtu command or per interface mtu command, two separate MTU values are stored, one for ipv4
and one for ipv6. This further reduces the number of slots available (out of 32). However, only a single
MTU value is stored for each ip mtu and ipv6 mtu commands.
If the new MTU value you are configuring is already present in the system (that is, configured on some
other interface), then no new slot(s) will be allocated to store it again.
If the maximum limit of 32 is reached and an attempt is made to configure a new MTU size on a new
interface, the system will only allow configuration to proceed if the new MTU size has previously been
configured on some interface. Otherwise, an error message will be displayed and the default MTU size
will be assigned to the interface being configured.
Jumbo Frame Support Overview
A jumbo frame is a frame larger than the default Ethernet size. Enable jumbo frame support by
configuring a larger-than-default MTU size on a port or interface.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-17
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
Catalyst 4500 series switch Ethernet LAN ports configured with a nondefault MTU size accept frames
containing packets with a size between 1500 and 9216 bytes (including Ethernet payload, header and
trailer). (The maximum MTU size for a Catalyst 4948 series switch is 9198 bytes (not including header
and trailer.)) With a nondefault MTU size configured, the packet size of ingress frames is checked. If the
packet is larger than the configured MTU, it is dropped.
For traffic that needs to be routed, the MTU of the egress port is checked. If the MTU is smaller than the
packet size, the packet is forwarded to the CPU. If the “do not fragment bit” is not set, it is fragmented.
Otherwise, the packet is dropped.
Note Jumbo frame support does not fragment Layer 2 switched packets.
The Catalyst 4500 series switch does not compare the packet size with the MTU at the egress port, but
jumbo frames are dropped in ports that do not support them. The frames can be transmitted in ports that
do support jumbo frames, even though the MTU is not configured to jumbo size.
Note Jumbo frame support is only configured per interface; jumbo frame support cannot be configured
globally.
Ethernet Ports
These sections describe configuring nondefault MTU sizes on Ethernet ports:
• Ethernet Port Overview, page 7-18
• Layer 3 and Layer 2 EtherChannels, page 7-18
Ethernet Port Overview
Configuring a nondefault MTU size on certain Ethernet ports limits the size of ingress packets. The MTU
does not impact the egress packets.
Layer 3 and Layer 2 EtherChannels
You can configure all the interfaces in an EtherChannel provided that they have the same MTU.
Changing the MTU of an EtherChannel changes the MTU of all member ports. If the MTU of a member
port cannot be changed to the new value, that port is suspended (administratively shut down). A port
cannot join an EtherChannel if the port has a different MTU. If a member port of an EtherChannel
changes MTU, the member port is suspended.
VLAN Interfaces
If switch ports reside in the same VLAN, either configure all of the switch ports to handle jumbo frames
and support the same MTU size, or configure none of them. However, such uniformity of MTU size in
the same VLAN is not enforced.
When a VLAN has switch ports with different MTU size, packets received from a port with a larger MTU
might be dropped when they are forwarded to a port with a smaller MTU.
If the switch ports in a VLAN have jumbo frames enabled, the corresponding SVI can have jumbo frames
enabled. The MTU of an SVI should always be smaller than the smallest MTU among all the switch ports
in the VLAN, but this condition is not enforced.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-18 OL-22250-01
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
The MTU of a packet is not checked on the ingress side for an SVI; it is checked on the egress side of
an SVI. If the MTU of a packet is larger than the MTU of the egress SVI, the packet will be sent to the
CPU for fragmentation processing. If the “do not fragment” bit is not set, the packet is fragmented.
Otherwise, the packet is dropped.
Configuring MTU Sizes
To configure the MTU size, perform this task:
Command Purpose
Step 1 Switch(config)# interface {{vlan vlan_ID} | Selects the interface to configure.
{{type1 slot/port} | {port-channel
port_channel_number} slot/port}}
Step 2 Switch(config-if)# mtu mtu_size Configures the MTU size.
Switch(config-if)# no mtu Reverts to the default MTU size (1500 bytes).
Step 3 Switch(config-if)# end Exits configuration interface mode.
Step 4 Switch(config)# end Exits configuration mode.
Step 5 Switch# show running-config interface Verifies the running configuration.
[{fastethernet | gigabitethernet} slot/port]
1. type = fastethernet, gigabitethernet, or tengigabitethernet
Note When you remove a linecard, and then reinsert the card, some or all of the MTU values configured on
the ports of that linecard may be unconfigured. This will happen if the system wide limit of 32 different
MTUs is reached while the card is removed. Upon reinserting the linecard, the system attempts to
reapply the MTU configuration on the ports. If this attempt fails, the MTU values are set to the default.
Note When configuring the MTU size for VLAN interfaces and Layer 3 and Layer 2 Ethernet ports, note that
the supported MTU values are from 1500 to 9198 bytes.
This example shows how to configure the MTU size on Gigabit Ethernet port 1/1:
switch# conf terminal
switch(config)# interface gi1/1
switch(config-if)# mtu 9198
switch(config-if)# end
switch(config)# end
switch# show interface gigabitethernet 1/2
GigabitEthernet1/2 is administratively down, line protocol is down
Hardware is C6k 1000Mb 802.3, address is 0030.9629.9f88 (bia 0030.9629.9f88)
MTU 9216 bytes, BW 1000000 Kbit, DLY 10 usec,
<...Output Truncated...>
switch#
For details on how to configure IP MTU size, refer to Configuring MTU Sizes, page 7-19.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-19
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
Interacting with Baby Giants
The baby giants feature uses the global command system mtu <size> to set the global baby giant MTU.
This feature also allows certain interfaces to support Ethernet payload size of up to 1552 bytes.
Both the system mtu command and the per-interface mtu command can operate on interfaces that can
support jumbo frames, but the per-interface mtu command takes precedence.
For example, before setting the per-interface MTU for interface gi1/1, you issue the
system mtu 1550 command to change the MTU for gi1/1 to 1550 bytes. Next, you issue the per-interface
mtu command to change the MTU for gi1/1 to 9198 bytes. Now, if you change the baby giant MTU to
1540 bytes with the command system mtu 1540, the MTU for gi1/1 remains unchanged at 9198 bytes.
Configuring the Port Debounce Timer
The port debounce timer delays notification of a link change, which can decrease traffic loss due to
network reconfiguration. You can configure the port debounce timer separately on each LAN port.
Note You can only configure Port Debounce on 10GE ports.
Caution Enabling the port debounce timer causes link up and link down detections to be delayed, resulting in loss
of traffic during the debouncing period. This situation might affect the convergence and reconvergence
of some Layer 2 and Layer 3 protocols.
To configure the debounce timer on a port, perform this task:
Command Purpose
Step 1 Switch(config)# interface tengigabitethernet Selects the port to configure.
slot/port
Step 2 Switch(config-if)# link debounce [time Configures the debounce timer.
debounce_time]
Switch(config-if)# no link debounce Reverts to the default setting.
Step 3 Switch# show interfaces debounce Verifies the configuration.
When configuring the debounce timer on a port, you can increase the port debounce timer value between
10 milliseconds and 5000 milliseconds on the tengigabitethernet ports.
Note By default, debounce is disabled. If you configure debounce without a time, the value is set at 100ms.
This example shows how to enable the port debounce timer on TenGigabit Ethernet port 2/1 and to accept
the default value (10 ms):
Switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface tenGigabitEthernet 2/1
Switch(config-if)# link debounce
Warning: Enabling debounce feature causes link down detection to be delayed
Switch(config-if)# exit
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-20 OL-22250-01
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
This example shows how to enable the port debounce timer of 5000 ms on TenGigabit Ethernet port 2/2
and to verify the setting:
Switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface tenGigabitEthernet 2/2
Switch(config-if)# link debounce time 5000
Warning: Enabling debounce feature causes link down detection to be delayed
Switch(config-if)# end
Switch#
Switch# show interfaces debounce | include enable
Te2/1 enable 10
Te2/2 enable 5000
Switch#
Configuring auto-MDIX on a Port
When automatic medium-dependent-interface crossover (auto-MDIX) is enabled on an port, the port
automatically detects the required cable connection type (straight through or crossover) and configures
the connection appropriately. When connecting switches without the auto-MDIX feature, you must use
straight-through cables to connect to devices such as servers, workstations, or routers and crossover
cables to connect to other switches or repeaters. With auto-MDIX enabled, you can use either type of
cable to connect to other devices, and the interface automatically corrects for any incorrect cabling. For
more information about cabling requirements, see the hardware installation guide.
Auto-MDIX is enabled by default. When you enable auto-MDIX, you must also set the speed on the port
to auto so that for the feature to operate correctly. auto-MDIX is supported on copper media ports. It is
not supported on fiber media ports.
Note The following linecards support Auto-MDIX by default, when port auto-negotiation is enabled:
WS-X4424-GB-RJ45, WS-X4448-GB-RJ45,WS-X4548-GB-RJ45 and WS-X4412-2GB-T. You cannot
disable them with the mdix command.
Note The following linecards do not support Auto-MDIX, neither by default nor by CLI:
WS-X4548-GB-RJ45V, WS-X4524-GB-RJ45V, WS-X4506-GB-T,WS-X4148-RJ, WS-X4248-RJ21V,
WS-X4248-RJ45V, WS-X4224-RJ45V and WS-X4232-GB-RJ.
Note The following linecards support Auto-MDIX through the CLI on their copper media ports:
WS-X4124-RJ45, WS-X4148-RJ45 (hardware revision 3.0 or higher), and WS-X4232-GB-RJ45
(hardware revision 3.0, or higher), WS-X4920-GE-RJ45 and WS-4648-RJ45V+E (Auto-MDIX support
when inline power is disabled on the port).
Table 7-1 shows the link states that results from auto-MDIX settings and correct and incorrect cabling.
Table 7-1 Link Conditions and auto-MDIX Settings
Local Side auto-MDIX Remote Side auto-MDIX With Correct Cabling With Incorrect Cabling
On On Link up Link up
On Off Link up Link up
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-21
Chapter 7 Configuring Interfaces
Configuring Optional Interface Features
Table 7-1 Link Conditions and auto-MDIX Settings (continued)
Local Side auto-MDIX Remote Side auto-MDIX With Correct Cabling With Incorrect Cabling
Off On Link up Link up
Off Off Link up Link down
To configure auto-MDIX on a port, perform the following task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode
Step 2 Switch(config)# interface Enters interface configuration mode for the physical interface to be
interface-id configured.
Step 3 Switch(config-if)# speed auto Configures the port to autonegotiate speed with the connected device.
Step 4 Switch(config-if)# mdix auto Enables auto-MDIX on the port.
Step 5 Switch(config-if)# end Returns to privileged EXEC mode.
Step 6 Switch# show interfaces Verifies the configuration of the auto-MDIX feature on the interface.
interface-id
Step 7 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To disable auto-MDIX, use the no mdix auto interface configuration command.
This example shows how to enable auto-MDIX on a port:
Switch# configure terminal
Switch(config)# interface fastethernet 6/5
Switch(config-if)# speed auto
Switch(config-if)# mdix auto
Switch(config-if)# end
Displaying the Interface auto-MDIX Configuration
To display the interface speed and duplex mode configuration for an interface, perform this task:
Command Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
• Enter your password if prompted.
Step 2 Switch# show interfaces type slot/interface Displays the interface auto-MDIX configuration setting and
operational state.
Depending on how the speed auto and the mdix auto commands are configured on a supported linecard
interface, the show interfaces command displays the following possible auto-MDIX statuses:
Table 7-2 shows the auto-MDIX setting and operational state and the status of auto-MDIX.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-22 OL-22250-01
Chapter 7 Configuring Interfaces
Understanding Online Insertion and Removal
Table 7-2 Auto-MDIX and Operational State
Auto-MDIX Setting And Operational State
on an Interface Description
Auto-MDIX on (operational: on) Auto-MDIX is enabled and is fully functioning.
Auto-MDIX on (operational: off) Auto-MDIX is enabled on this interface but it is
not functioning. To allow auto-MDIX feature to
function properly, you must also set the interface
speed to be autonegotiated.
Auto-MDIX off Auto-MDIX has been disabled with the
no mdix auto command.
This example show s how to display the auto-MDIX configuration setting and its operational state on
Fast Ethernet interface 6/1:
Switch# show interfaces fastethernet 6/1
FastEthernet6/1 is up, line protocol is up (connected)
Hardware is Fast Ethernet Port, address is 0001.64fe.e5d0 (bia 0001.64fe.e5d0)
MTU 1500 bytes, BW 100000 Kbit, DLY 100 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Keepalive set (10 sec)
Full-duplex, 100Mb/s, link type is auto, media type is 10/100BaseTX
input flow-control is unsupported output flow-control is unsupported
Auto-MDIX on (operational: on)
ARP type: ARPA, ARP Timeout 04:00:00
Last input 00:00:16, output never, output hang never
Last clearing of "show interface" counters never
Input queue: 0/2000/0/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 0 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
511 packets input, 74464 bytes, 0 no buffer
Received 511 broadcasts (511 multicasts)
0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
0 input packets with dribble condition detected
3552 packets output, 269088 bytes, 0 underruns
0 output errors, 0 collisions, 0 interface resets
0 babbles, 0 late collision, 0 deferred
1 lost carrier, 0 no carrier
0 output buffer failures, 0 output buffers swapped out
Switch#
Understanding Online Insertion and Removal
The online insertion and removal (OIR) feature supported on the Catalyst 4500 series switch allows you
to remove and replace modules while the system is online. You can shut down the module before removal
and restart it after insertion without causing other software or interfaces to shut down.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-23
Chapter 7 Configuring Interfaces
Monitoring and Maintaining the Interface
You do not need to enter a command to notify the software that you are going to remove or install a
module. The system notifies the supervisor engine that a module has been removed or installed and scans
the system for a configuration change. The newly installed module is initialized, and each interface type
is verified against the system configuration; then the system runs diagnostics on the new interface. There
is no disruption to normal operation during module insertion or removal.
If you remove a module and then replace it, or insert a different module of the same type into the same
slot, no change to the system configuration is needed. An interface of a type that has been configured
previously will be brought online immediately. If you remove a module and insert a module of a different
type, the interface(s) on that module will be administratively up with the default configuration for that
module.
Monitoring and Maintaining the Interface
The following sections describe how to monitor and maintain the interfaces:
• Monitoring Interface and Controller Status, page 7-24
• Clearing and Resetting the Interface, page 7-25
• Shutting Down and Restarting an Interface, page 7-25
• Configuring Interface Link Status and Trunk Status Events, page 7-26
• Resetting the Interface to the Default Configuration, page 7-28
Monitoring Interface and Controller Status
The Cisco IOS software for the Catalyst 4500 series switch contains commands that you can enter at the
EXEC prompt to display information about the interface, including the version of the software and the
hardware, the controller status, and statistics about the interfaces. The following table lists some of the
interface monitoring commands. (You can display the full list of show commands by entering the show ?
command at the EXEC prompt.) These commands are fully described in the Interface Command
Reference.
To display information about the interface, perform this task:
Command Purpose
Step 1 Switch# show interfaces [type slot/interface] Displays the status and configuration of all interfaces or of a
specific interface.
Step 2 Switch# show running-config Displays the configuration currently running in RAM.
Step 3 Switch# show protocols [type slot/interface] Displays the global (system-wide) and interface-specific
status of any configured protocol.
Step 4 Switch# show version Displays the hardware configuration, software version, the
names and sources of configuration files, and the boot images.
This example shows how to display the status of Fast Ethernet interface 5/5:
Switch# show protocols fastethernet 5/5
FastEthernet5/5 is up, line protocol is up
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-24 OL-22250-01
Chapter 7 Configuring Interfaces
Monitoring and Maintaining the Interface
Clearing and Resetting the Interface
To clear the interface counters shown with the show interfaces command, enter the following command:
Command Purpose
Switch# clear counters {type slot/interface} Clears interface counters.
This example shows how to clear and reset the counters on Fast Ethernet interface 5/5:
Switch# clear counters fastethernet 5/5
Clear "show interface" counters on this interface [confirm] y
Switch#
*Sep 30 08:42:55: %CLEAR-5-COUNTERS: Clear counter on interface FastEthernet5/5
by vty1 (171.69.115.10)
Switch#
The clear counters command (without any arguments) clears all the current interface counters from all
interfaces.
Note The clear counters command does not clear counters retrieved with SNMP; it clears only those counters
displayed with the EXEC show interfaces command.
Shutting Down and Restarting an Interface
You can disable an interface, which disables all functions on the specified interface and marks the
interface as unavailable on all monitoring command displays. This information is communicated to other
network servers through all dynamic routing protocols. The interface will not be mentioned in any
routing updates.
To shut down an interface and then restart it, perform this task:
Command Purpose
Step 1 Switch(config)# interface {vlan vlan_ID} | Specifies the interface to be configured.
{{fastethernet | gigabitethernet |
tengigabitethernet} slot/port} | {port-channel
port_channel_number}
Step 2 Switch(config-if)# shutdown Shuts down the interface.
Step 3 Switch(config-if)# no shutdown Reenables the interface.
This example shows how to shut down Fast Ethernet interface 5/5:
Switch(config)# interface fastethernet 5/5
Switch(config-if)# shutdown
Switch(config-if)#
*Sep 30 08:33:47: %LINK-5-CHANGED: Interface FastEthernet5/5, changed state to a
administratively down
Switch(config-if)#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-25
Chapter 7 Configuring Interfaces
Monitoring and Maintaining the Interface
This example shows how to reenable Fast Ethernet interface 5/5:
Switch(config-if)# no shutdown
Switch(config-if)#
*Sep 30 08:36:00: %LINK-3-UPDOWN: Interface FastEthernet5/5, changed state to up
Switch(config-if)#
To verify whether an interface is disabled, enter the EXEC show interfaces command. An interface that
has been shut down will appear as “administratively down.”
Configuring Interface Link Status and Trunk Status Events
You can configure interface link status and trunk status events. On the Catalyst 4500 series switch, the
following interface logging event notifications are supported both globally and per interface:
• Enable/disable notification on the interface whenever its data link status is changed.
• Enable/disable notification on the trunk interface whenever its trunking status is changed.
Use the [no] logging event link-status [use-global] command to enable/disable the interface link status
event. Use the [no] logging event trunk-status [use-global] command to enable/disable the interface
trunk status event.
Each interface link status logging event can be configured in one of the following states:
• logging event link-status - Link status logging event is enabled explicitly on the interface
regardless of the switch global setting.
• no logging event link-status - Link status logging event is disabled explicitly on the interface
regardless of the switch global setting.
• logging event link-status use-global - This is the default link status logging event configuration on
the interface; its configuration should follow the switch global link status logging event setting.
The interface trunk status logging event can be configured in the same configuration states.
Configuring Link Status Event Notification for an Interface
To enable/disable a link status logging event, enter one of the following commands:
Command Purpose
Switch(config-if)# logging event link-status Enables interface link status logging.
Switch(config-if)# no logging event link-status Disables interface link status logging.
Switch(config-if)# logging event link-status use-global Specifies the global default setting for interface link status
logging.
Global Settings
You can also provide a global configuration for the corresponding logging event. A global configuration
provides default logging settings for all interfaces. The [no] logging event link-status global command
lets you enable/disable the interface link status logging for the entire switch. The [no] logging event
trunk-status global command lets you enable/disable interface trunk status logging for the entire
switch.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-26 OL-22250-01
Chapter 7 Configuring Interfaces
Monitoring and Maintaining the Interface
Each interface link status logging event, if not configured at the interface level, will use the following
global logging event setting:
• logging event link-status global - Link status logging event is enabled, if not configured on the
interface.
• no logging event link-status global - Link status logging event is disabled, if not configured on the
interface.
The interface trunk status logging event has similar global configurations.
Configuring a Switch Global Link Status Logging Event
To enable/disable the global link status logging event, enter one of the following commands:
Command Purpose
Switch(config-if)# logging event link-status global Enables global link status logging.
Switch(config-if)# no logging event link-status global Disables global link status logging.
Result
The following example displays a summary of the operating states for the interface logging event under
different combinations of global and interface logging settings:
global setting interface setting actual logging state
-------------- ----------------- --------------------
on on on
off on on
on off off
off off off
on default(use-global) on
off default(use-global) off
The following example displays the configuration and logging message output for link status and trunk
status logging events:
//
// The global link status and trunk status logging events are enabled.
//
Switch# show running | include logging
show running | include logging
logging event link-status global
logging event trunk-status global
Switch#
//
// The interface link status and trunk status logging settings
// are set to default values, which follow regardless of the global
// setting.
//
Switch# show running interface g1/4
Building configuration...
Current configuration: 97 bytes
!
interface GigabitEthernet1/4
switchport trunk encapsulation dot1q
switchport mode trunk
end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 7-27
Chapter 7 Configuring Interfaces
Monitoring and Maintaining the Interface
Switch#
//
// The trunk status logging messages for the interface are
// displayed whenever the interface trunking status is changed.
// Here we change the other end node's trunking encapsulation
// from dot1q to isl.
//
3d00h: %DTP-5-ILGLCFG: Illegal config(on,isl--on,dot1q) on Gi1/4
3d00h: %DTP-5-ILGLCFG: Illegal config(on,isl--on,dot1q) on Gi1/4
3d00h: %DTP-5-ILGLCFG: Illegal config(on,isl--on,dot1q) on Gi1/4
//
// The link and trunk status logging message for the interface
// are displayed whenever the interface link status is changed.
// Here we do a "shut" and "no shut" on the other end link node.
//
3d00h: %DTP-5-NONTRUNKPORTON: Port Gi1/4 has become non-trunk
3d00h: %LINEPROTO-5-UPDOWN: Line protocol on Interface
GigabitEthernet1/4, changed state to down
3d00h: %LINK-3-UPDOWN: Interface GigabitEthernet1/4, changed state to
down
3d00h: %LINK-3-UPDOWN: Interface GigabitEthernet1/4, changed state to up
3d00h: %DTP-5-TRUNKPORTON: Port Gi1/4 has become dot1q trunk
3d00h: %LINEPROTO-5-UPDOWN: Line protocol on Interface
GigabitEthernet1/4, changed state to up
Resetting the Interface to the Default Configuration
If you have configured a interface with many command lines and you want to clear all the configuration
on that interface, you can use the default interface global configuration command, as follows:
Switch(config)# default interface fastEthernet 3/5
Interface FastEthernet3/5 set to default configuration
This command will clear all the configurations and shutdown the interface:
Switch# show run interface fastethernet 3/5
Building configuration...
Current configuration : 58 bytes
!
interface FastEthernet3/5
no ip address
shutdown
end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
7-28 OL-22250-01
CH A P T E R 8
Checking Port Status and Connectivity
This chapter describes how to check switch port status and connectivity on the Catalyst 4500 series
switch.
This chapter includes the following major sections:
• Checking Module Status, page 8-2
• Checking Interfaces Status, page 8-2
• Displaying MAC Addresses, page 8-3
• Checking Cable Status Using Time Domain Reflectometer, page 8-3
• Using Telnet, page 8-5
• Changing the Logout Timer, page 8-6
• Monitoring User Sessions, page 8-6
• Using Ping, page 8-7
• Using IP Traceroute, page 8-8
• Using Layer 2 Traceroute, page 8-10
• Configuring ICMP, page 8-12
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 8-1
Chapter 8 Checking Port Status and Connectivity
Checking Module Status
Checking Module Status
The Catalyst 4500 series switch is a multimodule system. You can see which modules are installed, as
well as the MAC address ranges and version numbers for each module, by using the show module
command. You can use the [mod_num] argument to specify a particular module number to see detailed
information on that module.
This example shows how to check module status for all modules on your switch:
Switch# show module all
Mod Ports Card Type Model Serial No.
----+-----+--------------------------------------+-----------------+-----------
1 2 1000BaseX (GBIC) Supervisor Module WS-X4014 JAB012345AB
5 24 10/100/1000BaseTX (RJ45) WS-X4424-GB-RJ45 JAB045304EY
6 48 10/100BaseTX (RJ45) WS-X4148 JAB023402QK
M MAC addresses Hw Fw Sw Stat
--+--------------------------------+---+-----------------+---------------+-----
1 0004.dd46.9f00 to 0004.dd46.a2ff 0.0 12.1(10r)EW(1.21) 12.1(10)EW(1) Ok
5 0050.3e7e.1d70 to 0050.3e7e.1d87 0.0 Ok
6 0050.0f10.2370 to 0050.0f10.239f 1.0 Ok
Switch#
Checking Interfaces Status
You can view summary or detailed information on the switch ports using the show interfaces status
command. To see summary information on all ports on the switch, enter the
show interfaces status command with no arguments. Specify a particular module number to see
information on the ports on that module only. Enter both the module number and the port number to see
detailed information about the specified port.
To apply configuration commands to a particular port, you must specify the appropriate logical module.
For more information, see the “Checking Module Status” section on page 8-2.
This example shows how to display the status of all interfaces on a Catalyst 4500 series switch, including
transceivers. Output of this command displays “Unapproved GBIC” for non-Cisco transceivers:
Switch# show interfaces status
Port Name Status Vlan Duplex Speed Type
Gi1/1 notconnect 1 auto auto No Gbic
Gi1/2 notconnect 1 auto auto No Gbic
Gi5/1 notconnect 1 auto auto 10/100/1000-TX
Gi5/2 notconnect 1 auto auto 10/100/1000-TX
Gi5/3 notconnect 1 auto auto 10/100/1000-TX
Gi5/4 notconnect 1 auto auto 10/100/1000-TX
Fa6/1 connected 1 a-full a-100 10/100BaseTX
Fa6/2 connected 2 a-full a-100 10/100BaseTX
Fa6/3 notconnect 1 auto auto 10/100BaseTX
Fa6/4 notconnect 1 auto auto 10/100BaseTX
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
8-2 OL-22250-01
Chapter 8 Checking Port Status and Connectivity
Displaying MAC Addresses
This example shows how to display the status of interfaces in error-disabled state:
Switch# show interfaces status err-disabled
Port Name Status Reason
Fa9/4 err-disabled link-flap
informational error message when the timer expires on a cause
--------------------------------------------------------------
5d04h:%PM-SP-4-ERR_RECOVER:Attempting to recover from link-flap err-disable state on Fa9/4
Switch#
Displaying MAC Addresses
In addition to displaying the MAC address range for a module using the show module command, you
can display the MAC address table information of a specific MAC address or a specific interface in the
switch using the show mac-address-table address and show mac-address-table interface commands.
This example shows how to display MAC address table information for a specific MAC address:
Switch# show mac-address-table address 0050.3e8d.6400
vlan mac address type protocol qos ports
-----+---------------+--------+---------+---+--------------------------------
200 0050.3e8d.6400 static assigned -- Switch
100 0050.3e8d.6400 static assigned -- Switch
5 0050.3e8d.6400 static assigned -- Switch
4 0050.3e8d.6400 static ipx -- Switch
1 0050.3e8d.6400 static ipx -- Switch
1 0050.3e8d.6400 static assigned -- Switch
4 0050.3e8d.6400 static assigned -- Switch
5 0050.3e8d.6400 static ipx -- Switch
100 0050.3e8d.6400 static ipx -- Switch
200 0050.3e8d.6400 static ipx -- Switch
100 0050.3e8d.6400 static other -- Switch
200 0050.3e8d.6400 static other -- Switch
5 0050.3e8d.6400 static other -- Switch
4 0050.3e8d.6400 static ip -- Switch
1 0050.3e8d.6400 static ip -- Route
1 0050.3e8d.6400 static other -- Switch
4 0050.3e8d.6400 static other -- Switch
5 0050.3e8d.6400 static ip -- Switch
200 0050.3e8d.6400 static ip -- Switch
100 0050.3e8d.6400 static ip -- Switch
Switch#
This example shows how to display MAC address table information for a specific interface:
Switch# show mac-address-table interface gigabit 1/1
Multicast Entries
vlan mac address type ports
-------+---------------+-------+-------------------------------------------
1 ffff.ffff.ffff system Switch,Gi6/1,Gi6/2,Gi6/9,Gi1/1
Switch#
Checking Cable Status Using Time Domain Reflectometer
The Time Domain Reflectometer (TDR) feature allows you to determine if cable is OPEN or SHORT
when it is at fault.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 8-3
Chapter 8 Checking Port Status and Connectivity
Checking Cable Status Using Time Domain Reflectometer
Overview
With TDR, you can check the status of copper cables on the 48-port 10/100/1000 BASE-T modules for
the Catalyst 4500 series switch. TDR detects a cable fault by sending a signal through the cable and
reading the signal that is reflected back. All or part of the signal can be reflected back either by cable
defects or by the end of the cable.
Note Four pairs of standard category 5 cable exist. Each pair can assume one of the following states: open (not
connected), broken, shorted, or terminated. The TDR test detects all four states and displays the first
three as “Fault” conditions, and displays the fourth as “Terminated.” Although the CLI output is shown,
the cable length is displayed only if the state is “Faulty.”
TDR feature is supported on the following modules:
WS-X4524-GB-RJ45V
WS-X4548-GB-RJ45
WS-X4548-GB-RJ45V
WS-X4548-GB-RJ45V+
WS-X4548-RJ45V+
WS-X4748-RJ45+E
WS-X4748-RJ45V+E
WS-C4948E
TDR detects a cable fault by sending a signal along its wires and depending on the reflected signal it can
determine roughly where a cable fault could be. The variations on how TDR signal is reflected back
determine the results on TDR. On cat4k products, we only support cable fault types: OPEN or SHORT.
We do display Terminated status in case cable is proper terminated and this is done for illustrative
purpose.
Running the TDR Test
To start the TDR test, perform this task in privileged mode:
Command Purpose
Step 1 Switch# test cable-diagnostics tdr Starts the TDR test.
{interface {interface interface-number}}
Step 2 Switch# show cable-diagnostics tdr Displays the TDR test counter information.
{interface {interface interface-number}}
This example shows how to start the TDR test on port 1 on module 2:
Switch# test cable-diagnostics tdr int gi2/1
Switch#
This example shows the message that displays when the TDR test is not supported on a module:
Switch# test cable-diagnostics tdr int gi2/1
00:03:15:%C4K_IOSDIAGMAN-4-TESTNOTSUPPORTEDONMODULE: Online cable
diag tdr test is not supported on this module
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
8-4 OL-22250-01
Chapter 8 Checking Port Status and Connectivity
Using Telnet
This example shows how to display TDR test results for a port:
Switch# show cable-diagnostics tdr interface gi4/13
Interface Speed Local pair Cable length Remote channel Status
Gi4/13 0Mbps 1-2 102 +-2m Unknown Fault
3-6 100 +-2m Unknown Fault
4-5 102 +-2m Unknown Fault
7-8 102 +-2m Unknown Fault
Note After this command is deprecated, use the diagnostic start and the show diagnostic result commands to
run the TDR test and display the test results.
Note TDR is a port test; the port cannot handle traffic for the duration of the test (generally, 1 minute).
TDR Guidelines
The following guidelines apply to the use of TDR:
• If you connect a port undergoing a TDR test to an Auto-MDIX enabled port, the TDR result might
be invalid. In those instances, the port on the WS-X4148-RJ45V should be administratively down
before the start of the TDR test.
• If you connect a port undergoing a TDR test to a 100BASE-T port such as that on the
WS-X4148-RJ45V, the unused pairs (4-5 and 7-8) will be reported as faulty because the remote end
does not terminate these pairs.
• Do not change the port configuration while the TDR test is running.
• Due to cable characteristics, you should run the TDR test multiple times to get accurate results.
• Do not change port status (for example, remove the cable at the near or far end) because the results
might be inaccurate.
• TDR works best if the test cable is disconnected from the remote port. Otherwise, it might be
difficult for you to interpret results correctly.
• TDR operates across four wires. Depending on the cable conditions, the status might show one pair
is OPEN or SHORT while all other wire pairs display as faulty. This operation is acceptable because
you should declare a cable faulty provided one pair of wires is found to be OPEN or SHORT.
• TDR determines how poor a cable is functioning rather than where a faulty cable is located.
• When TDR locates a faulty cable, you should still use an offline cable diagnosis tool to better
diagnose the problem.
• TDR results might differ between runs on different Catalyst 4500 modules because of resolution
difference in TDR implementations. When this occurs, you should refer to offline cable diagnosis
tool.
Using Telnet
You can access the switch command-line interface (CLI) using Telnet. In addition, you can use Telnet
from the switch to access other devices in the network. You can have up to eight simultaneous Telnet
sessions.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 8-5
Chapter 8 Checking Port Status and Connectivity
Changing the Logout Timer
Before you can open a Telnet session to the switch, you must first set the IP address (and in some cases
the default gateway) for the switch. For information about setting the IP address and default gateway,
see Chapter 3, “Configuring the Switch for the First Time.”
Note To establish a Telnet connection to a host by using the hostname, configure and enable DNS.
To establish a Telnet connection to another device on the network from the switch, perform this task:
Command Purpose
Switch# telnet host [port] Opens a Telnet session to a remote host.
This example shows how to establish a Telnet connection from the switch to the remote host named
labsparc:
Switch# telnet labsparc
Trying 172.16.10.3...
Connected to labsparc.
Escape character is '^]'.
UNIX(r) System V Release 4.0 (labsparc)
login:
Changing the Logout Timer
The logout timer automatically disconnects a user from the switch when the user is idle for longer than
the specified time. To set the logout timer, perform this task:
Command Purpose
Switch# logoutwarning number Changes the logout timer value (a timeout value of 0 prevents idle
sessions from being disconnected automatically).
Use the no keyword to return to the default value.
Monitoring User Sessions
You can display the currently active user sessions on the switch using the show users command. The
command output lists all active console port and Telnet sessions on the switch.
To display the active user sessions on the switch, perform this task in privileged EXEC mode:
Command Purpose
Switch# show users [all] Displays the currently active user sessions on the
switch.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
8-6 OL-22250-01
Chapter 8 Checking Port Status and Connectivity
Using Ping
This example shows the output of the show users command when local authentication is enabled for
console and Telnet sessions (the asterisk [*] indicates the current session):
Switch# show users
Line User Host(s) Idle Location
* 0 con 0 idle 00:00:00
Interface User Mode Idle Peer Address
Switch# show users all
Line User Host(s) Idle Location
* 0 con 0 idle 00:00:00
1 vty 0 00:00:00
2 vty 1 00:00:00
3 vty 2 00:00:00
4 vty 3 00:00:00
5 vty 4 00:00:00
Interface User Mode Idle Peer Address
Switch#
To disconnect an active user session, perform this task:
Command Purpose
Switch# disconnect {console | ip_addr} Disconnects an active user session on the switch.
This example shows how to disconnect an active console port session and an active Telnet session:
Switch> disconnect console
Console session disconnected.
Console> (enable) disconnect tim-nt.bigcorp.com
Telnet session from tim-nt.bigcorp.com disconnected. (1)
Switch# show users
Session User Location
-------- ---------------- -------------------------
telnet jake jake-mac.bigcorp.com
* telnet suzy suzy-pc.bigcorp.com
Switch#
Using Ping
These sections describe how to use IP ping:
• Understanding How Ping Works, page 8-7
• Running Ping, page 8-8
Understanding How Ping Works
You can use the ping command to verify connectivity to remote hosts. If you attempt to ping a host in a
different IP subnetwork, you must define a static route to the network or configure a router to route
between those subnets.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 8-7
Chapter 8 Checking Port Status and Connectivity
Using IP Traceroute
The ping command is configurable from normal executive and privileged EXEC mode. Ping returns one
of the following responses:
• Normal response—The normal response (hostname is alive) occurs in 1 to 10 seconds, depending
on network traffic.
• Destination does not respond—If the host does not respond, a No Answer message is returned.
• Unknown host—If the host does not exist, an Unknown Host message is returned.
• Destination unreachable—If the default gateway cannot reach the specified network, a Destination
Unreachable message is returned.
• Network or host unreachable—If there is no entry in the route table for the host or network, a
Network or Host Unreachable message is returned.
To stop a ping in progress, press Ctrl-C.
Running Ping
To ping another device on the network from the switch, perform this task in normal executive and
privileged EXEC mode:
Command Purpose
Switch# ping host Checks connectivity to a remote host.
This example shows how to ping a remote host from normal executive mode:
Switch# ping labsparc
labsparc is alive
Switch> ping 72.16.10.3
12.16.10.3 is alive
Switch#
This example shows how to enter a ping command in privileged EXEC mode specifying the number of
packets, the packet size, and the timeout period:
Switch# ping
Target IP Address []: 12.20.5.19
Number of Packets [5]: 10
Datagram Size [56]: 100
Timeout in seconds [2]: 10
Source IP Address [12.20.2.18]: 12.20.2.18
!!!!!!!!!!
----12.20.2.19 PING Statistics----
10 packets transmitted, 10 packets received, 0% packet loss
round-trip (ms) min/avg/max = 1/1/1
Switch
Using IP Traceroute
These sections describe how to use IP traceroute feature:
• Understanding How IP Traceroute Works, page 8-9
• Running IP Traceroute, page 8-9
Software Configuration Guide—Release IOS-XE 3.1.0 SG
8-8 OL-22250-01
Chapter 8 Checking Port Status and Connectivity
Using IP Traceroute
Understanding How IP Traceroute Works
You can use IP traceroute to identify the path that packets take through the network on a hop-by-hop
basis. The command output displays all network layer (Layer 3) devices, such as routers, that the traffic
passes through on the way to the destination.
Layer 2 switches can participate as the source or destination of the trace command but will not appear
as a hop in the trace command output.
The trace command uses the Time To Live (TTL) field in the IP header to cause routers and servers to
generate specific return messages. Traceroute starts by sending a User Datagram Protocol (UDP)
datagram to the destination host with the TTL field set to 1. If a router finds a TTL value of 1 or 0, it
drops the datagram and sends back an Internet Control Message Protocol (ICMP) Time-Exceeded
message to the sender. Traceroute determines the address of the first hop by examining the source
address field of the ICMP Time-Exceeded message.
To identify the next hop, traceroute sends a UDP packet with a TTL value of 2. The first router
decrements the TTL field by 1 and sends the datagram to the next router. The second router sees a TTL
value of 1, discards the datagram, and returns the Time-Exceeded message to the source. This process
continues until the TTL is incremented to a value large enough for the datagram to reach the destination
host or until the maximum TTL is reached.
To determine when a datagram reaches its destination, traceroute sets the UDP destination port in the
datagram to a very large value that the destination host is unlikely to be using. When a host receives a
datagram with an unrecognized port number, it sends an ICMP Port Unreachable error message to the
source. The Port Unreachable error message indicates to traceroute that the destination has been reached.
Running IP Traceroute
To trace the path that packets take through the network, perform this task in EXEC or privileged EXEC
mode:
Command Purpose
Switch# trace [protocol] [destination] Runs IP traceroute to trace the path that packets
take through the network.
This example shows use the trace command to display the route a packet takes through the network to
reach its destination:
Switch# trace ip ABA.NYC.mil
Type escape sequence to abort.
Tracing the route to ABA.NYC.mil (26.0.0.73)
1 DEBRIS.CISCO.COM (192.180.1.6) 1000 msec 8 msec 4 msec
2 BARRNET-GW.CISCO.COM (192.180.16.2) 8 msec 8 msec 8 msec
3 EXTERNAL-A-GATEWAY.STANFORD.EDU (192.42.110.225) 8 msec 4 msec 4 msec
4 BB2.SU.BARRNET.NET (192.200.254.6) 8 msec 8 msec 8 msec
5 SU.ARC.BARRNET.NET (192.200.3.8) 12 msec 12 msec 8 msec
6 MOFFETT-FLD-MB.in.MIL (192.52.195.1) 216 msec 120 msec 132 msec
7 ABA.NYC.mil (26.0.0.73) 412 msec 628 msec 664 msec
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 8-9
Chapter 8 Checking Port Status and Connectivity
Using Layer 2 Traceroute
Using Layer 2 Traceroute
The Layer 2 traceroute feature allows the switch to identify the physical path that a packet takes from a
source device to a destination device. Layer 2 traceroute supports only unicast source and destination
MAC addresses. It determines the path by using the MAC address tables of the switches in the path.
When the switch detects a device in the path that does not support Layer 2 traceroute, the switch
continues to send Layer 2 trace queries and lets them time out.
If you want the switch to trace the path from a host on a source device to a host on a destination device,
the switch can identify only the path from the source device to the destination device. It cannot identify
the path that a packet takes from source host to the source device or from the destination device to the
destination host.
These sections describe how to use the Layer 2 traceroute feature:
• Layer 2 Traceroute Usage Guidelines, page 8-10
• Running Layer 2 Traceroute, page 8-11
Layer 2 Traceroute Usage Guidelines
These are the Layer 2 traceroute usage guidelines:
• CDP must be enabled on all the devices in the network. For Layer 2 traceroute to functional properly,
do not disable CDP.
If any devices in the physical path are transparent to CDP, the switch cannot identify the path
through these devices.
Note For more information about enabling CDP, see Chapter 20, “Configuring CDP.”
• All switches in the physical path must have IP connectivity. When a switch is reachable from another
switch, you can test connectivity by using the ping command in privileged EXEC mode.
• The maximum number of hops identified in the path is ten.
• You can enter the traceroute mac or the traceroute mac ip command in privileged EXEC mode on
a switch that is not in the physical path from the source device to the destination device. All switches
in the path must be reachable from this switch.
• The traceroute mac command output shows the Layer 2 path only when the specified source and
destination MAC addresses belong to the same VLAN. If you specify source and destination MAC
addresses that belong to different VLANs, the Layer 2 path is not identified, and an error message
appears.
• If you specify a multicast source or destination MAC address, the path is not identified, and an error
message appears.
• If the source or destination MAC address belongs to multiple VLANs, you must specify the VLAN
to which both the source and destination MAC addresses belong. If the VLAN is not specified, the
path is not identified, and an error message appears.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
8-10 OL-22250-01
Chapter 8 Checking Port Status and Connectivity
Using Layer 2 Traceroute
• The traceroute mac ip command output shows the Layer 2 path when the specified source and
destination IP addresses belong to the same subnet. When you specify the IP addresses, the switch
uses Address Resolution Protocol (ARP) to associate the IP address with the corresponding MAC
address and the VLAN ID.
– If an ARP entry exists for the specified IP address, the switch uses the associated MAC address
and identifies the physical path.
– If an ARP entry does not exist, the switch sends an ARP query and tries to resolve the IP
address. If the IP address is not resolved, the path is not identified, and an error message
appears.
• When multiple devices are attached to one port through hubs (for example, multiple CDP neighbors
are detected on a port), the Layer 2 traceroute feature is not supported. When more than one CDP
neighbor is detected on a port, the Layer 2 path is not identified, and an error message appears.
• This feature is not supported in Token Ring VLANs.
Running Layer 2 Traceroute
To display the physical path that a packet takes from a source device to a destination device, perform
either one of these tasks in privileged EXEC mode:
Command Purpose
Switch# traceroute mac {source-mac-address} Runs Layer 2 traceroute to trace the path that
{destination-mac-address} packets take through the network.
or
Command Purpose
Switch# traceroute mac ip {source-mac-address} Runs IP traceroute to trace the path that
{destination-mac-address} packets take through the network.
These examples show how to use the traceroute mac and traceroute mac ip commands to display the
physical path a packet takes through the network to reach its destination:
Switch# traceroute mac 0000.0201.0601 0000.0201.0201
Source 0000.0201.0601 found on con6[WS-C2950G-24-EI] (2.2.6.6)
con6 (2.2.6.6) :Fa0/1 => Fa0/3
con5 (2.2.5.5 ) : Fa0/3 => Gi0/1
con1 (2.2.1.1 ) : Gi0/1 => Gi0/2
con2 (2.2.2.2 ) : Gi0/2 => Fa0/1
Destination 0000.0201.0201 found on con2[WS-C3550-24] (2.2.2.2)
Layer 2 trace completed
Switch#
Switch# traceroute mac ip 2.2.66.66 2.2.22.22 detail
Translating IP to mac .....
2.2.66.66 => 0000.0201.0601
2.2.22.22 => 0000.0201.0201
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 8-11
Chapter 8 Checking Port Status and Connectivity
Configuring ICMP
Source 0000.0201.0601 found on con6[WS-C2950G-24-EI] (2.2.6.6)
con6 / WS-C2950G-24-EI / 2.2.6.6 :
Fa0/1 [auto, auto] => Fa0/3 [auto, auto]
con5 / WS-C2950G-24-EI / 2.2.5.5 :
Fa0/3 [auto, auto] => Gi0/1 [auto, auto]
con1 / WS-C3550-12G / 2.2.1.1 :
Gi0/1 [auto, auto] => Gi0/2 [auto, auto]
con2 / WS-C3550-24 / 2.2.2.2 :
Gi0/2 [auto, auto] => Fa0/1 [auto, auto]
Destination 0000.0201.0201 found on con2[WS-C3550-24] (2.2.2.2)
Layer 2 trace completed.
Switch#
Configuring ICMP
Internet Control Message Protocol (ICMP) provides many services that control and manage IP
connections. ICMP messages are sent by routers or access servers to hosts or other routers when a
problem is discovered with the Internet header. For detailed information on ICMP, refer to RFC 792.
Enabling ICMP Protocol Unreachable Messages
If the Cisco IOS software receives a nonbroadcast packet that uses an unknown protocol, it sends an
ICMP Protocol Unreachable message back to the source.
Similarly, if the software receives a packet that it is unable to deliver to the ultimate destination because
it knows of no route to the destination address, it sends an ICMP Host Unreachable message to the
source. This feature is enabled by default.
To enable the generation of ICMP Protocol Unreachable and Host Unreachable messages, enter the
following command in interface configuration mode:
Command Purpose
Switch (config-if)# [no] ip unreachables Enables ICMP destination unreachable messages.
Use the no keyword to disable the ICMP destination
unreachable messages.
Caution If you enter the no ip unreachables command, you will break the path MTU discovery” functionality.
Routers in the middle of the network might be forced to fragment packets.
To limit the rate that Internet Control Message Protocol (ICMP) destination unreachable messages are
generated, perform this task:
Command Purpose
Switch (config)# [no] ip icmp rate-limit Limits the rate that ICMP destination messages are
unreachable [df] milliseconds generated.
Use the no keyword to remove the rate limit and
reduce the CPU usage.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
8-12 OL-22250-01
Chapter 8 Checking Port Status and Connectivity
Configuring ICMP
Enabling ICMP Redirect Messages
Data routes are sometimes less than optimal. For example, it is possible for the router to be forced to
resend a packet through the same interface on which it was received. If this occurs, the Cisco IOS
software sends an ICMP Redirect message to the originator of the packet telling the originator that the
router is on a subnet directly connected to the receiving device, and that it must forward the packet to
another system on the same subnet. The software sends an ICMP Redirect message to the packet's
originator because the originating host presumably could have sent that packet to the next hop without
involving this device at all. The Redirect message instructs the sender to remove the receiving device
from the route and substitute a specified device representing a more direct path. This feature is enabled
by default.
However, when Hot Standby Router Protocol (HSRP) is configured on an interface, ICMP Redirect
messages are disabled (by default) for the interface. For more information on HSRP, refer to the
following URL:
http://www.cisco.com/en/US/docs/ios/ipapp/configuration/guide/ipapp_hsrp_ps6350_TSD_Products_Confi
guration_Guide_Chapter.html
To enable the sending of ICMP Redirect messages if the Cisco IOS software is forced to resend a packet
through the same interface on which it was received, enter the following command in interface
configuration mode:
Command Purpose
Switch (config-if)# [no] ip redirects Enables ICMP Redirect messages.
Use the no keyword to disable the ICMP Redirect
messages and reduce CPU usage.
Enabling ICMP Mask Reply Messages
Occasionally, network devices must know the subnet mask for a particular subnetwork in the
internetwork. To obtain this information, devices can send ICMP Mask Request messages. These
messages are responded to by ICMP Mask Reply messages from devices that have the requested
information. The Cisco IOS software can respond to ICMP Mask Request messages if the ICMP Mask
Reply function is enabled.
To have the Cisco IOS software respond to ICMP mask requests by sending ICMP Mask Reply
messages, perform this task:
Command Purpose
Switch (config-if)# [no] ip mask-reply Enables response to ICMP destination mask requests.
Use the no keyword to disable this functionality.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 8-13
Chapter 8 Checking Port Status and Connectivity
Configuring ICMP
Software Configuration Guide—Release IOS-XE 3.1.0 SG
8-14 OL-22250-01
CH A P T E R 9
Configuring Cisco NSF with SSO Supervisor
Engine Redundancy
This chapter describes how to configure supervisor engine redundancy using Cisco nonstop forwarding
(NSF) with stateful switchover (SSO).
This chapter consists of these sections:
• About NSF with SSO Supervisor Engine Redundancy, page 9-1
• Configuring NSF with SSO Supervisor Engine Redundancy, page 9-7
• Cisco High Availability Features in Cisco IOS XE 3.1.0SG, page 9-13
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About NSF with SSO Supervisor Engine Redundancy
These sections describe supervisor engine redundancy using NSF with SSO:
• About Cisco IOS NSF-Aware and NSF-Capable Support, page 9-2
• NSF with SSO Supervisor Engine Redundancy Overview, page 9-3
• SSO Operation, page 9-3
• NSF Operation, page 9-4
• Cisco Express Forwarding, page 9-4
• Routing Protocols, page 9-5
• NSF Guidelines and Restrictions, page 9-7
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 9-1
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
About NSF with SSO Supervisor Engine Redundancy
About Cisco IOS NSF-Aware and NSF-Capable Support
Cisco IOS Nonstop Forwarding (NSF) has two primary components:
• NSF-awareness—If neighboring router devices detect that an NSF router can still forward packets
when a supervisor engine switchover happens, this capability is referred to as NSF-awareness. Cisco
IOS enhancements to the Layer 3 routing protocols (OSPF, BGP, and EIGRP) are designed to
prevent route-flapping so that the CEF routing table does not time out or the NSF router does not
drop routes. An NSF-aware router helps to send routing protocol information to the neighboring
NSF router.
• NSF-capability—NSF works with SSO to minimize the amount of time that a Layer 3 network is
unavailable following a supervisor engine switchover by continuing to forward IP packets.
Reconvergence of Layer 3 routing protocols (BGP, EIGRP,and OSPF v2) is transparent to the user
and happens automatically in the background. The routing protocols recover routing information
from neighbor devices and rebuild the Cisco Express Forwarding (CEF) table.
Note NSF does not support IPv6 and is IPv4 Unicast only.
Note NSF capable devices include Catalyst 4500 series switches, Catalyst 6500 series switches, Cisco 7500
series routers, Cisco 10000 series routers, and Cisco 12000 series routers.
A typical topology for NSF and NSF-aware routers is given below.
Figure 9-1 Topology for NSF and NSF-Capable Switches
Catalyst 6500 NSF
Si
2 2
Si Si
147986
Catalyst 4500 Catalyst 4500
NSF-Capable NSF-Capable
The Catalyst 4500 series switch supports NSF capability and NSF-awareness for the EIGRP, OSPF, and
BGP protocols in Enterprise Services mode and NSF-awareness for the EIGRP-stub in IP Base mode.
NSF-awareness is turned on by default for EIGRP-stub, EIGRP, and OSPF protocols. For BGP, you need
to turn it on manually.
If the supervisor engine is configured for BGP (with the graceful-restart command), EIGRP, or OSPF
routing protocols, routing updates are automatically sent during the supervisor engine switchover of a
neighboring NSF capable switch.
Table 9-1 lists the supervisor engines and Catalyst 4500 series switches that support NSF-capable.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
9-2 OL-22250-01
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
About NSF with SSO Supervisor Engine Redundancy
Table 9-1 NSF-Capable Supervisor Engines
NSF-Capable Supervisor Engine Switch Support
Supervisor Engine 7-E (WS-X45-SUP7-E) WS-C4507R-E
Supervisor Engine 7-E (WS-X45-SUP7-E) WS-C4510R-E
Supervisor Engine 7-E (WS-X45-SUP7-E) WS-C4507R+E
Supervisor Engine 7-E (WS-X45-SUP7-E) WS-C4510R+E
NSF with SSO Supervisor Engine Redundancy Overview
Catalyst 4500 series switches support fault resistance by allowing a standby supervisor engine to take
over if the active supervisor engine fails. NSF works with SSO to minimize the amount of time a network
is unavailable to its users following a switchover.
NSF provides these benefits:
• Improved network availability
NSF continues forwarding network traffic and application state information so that user session
information is maintained after a switchover.
• Overall network stability
Network stability may be improved with the reduction in the number of route flaps, which were
created when routers in the network failed and lost their routing tables.
• Neighboring routers do not detect a link flap
Because the interfaces remain up during a switchover, neighboring routers do not detect a link flap
(the link does not go down and come back up).
• Prevents routing flaps
Because SSO continues forwarding network traffic during a switchover, routing flaps are avoided.
• Maintains user sessions established prior to the switchover
Catalyst 4500 series switches also support route processor redundancy (RPR). For information about
these redundancy modes, see Chapter 5, “Configuring Supervisor Engine Redundancy Using RPR and
SSO.”
SSO Operation
SSO establishes one of the supervisor engines as active while the other supervisor engine is designated
as standby, and then SSO synchronizes information between them. A switchover from the active to the
standby supervisor engine occurs when the active supervisor engine fails, or is removed from the switch,
or is manually shut down for maintenance.
In networking devices running SSO, both supervisor engines must be running the same Cisco IOS
software version (except during the ISSU upgrade/downgrade process) and ROMMON version so that
the standby supervisor engine is always ready to assume control following a fault on the active
supervisor engine. SSO switchover also preserves FIB and adjacency entries and can forward Layer 3
traffic after a switchover. Configuration information and data structures are synchronized from the active
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 9-3
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
About NSF with SSO Supervisor Engine Redundancy
to the standby supervisor engine and whenever changes to the active supervisor engine configuration
occur. Following an initial synchronization between the two supervisor engines, SSO maintains state
information between them, including forwarding information.
During switchover, system control and routing protocol execution is transferred from the active
supervisor engine to the standby supervisor engine.
Note Be aware that you can use the [no] service slave-log configuration command to forward all error
messages from the standby supervisor engine to the active engine. By default, this capability is enabled.
NSF Operation
NSF always runs with SSO and provides redundancy for Layer 3 traffic. NSF is supported by the BGP,
OSPF, and EIGRP routing protocols and is supported by Cisco Express Forwarding (CEF) for
forwarding. The routing protocols have been enhanced with NSF-capability and awareness, which means
that routers running these protocols can detect a switchover and take the necessary actions to continue
forwarding network traffic and to recover route information from the peer devices.
A networking device is NSF-aware if it is running NSF-compatible software. A device is NSF-capable
if it has been configured to support NSF; it rebuilds routing information from NSF-aware or
NSF-capable neighbors.
Each protocol depends on CEF to continue forwarding packets during switchover while the routing
protocols rebuild the Routing Information Base (RIB) tables. After the routing protocols have converged,
CEF updates the FIB table and removes stale route entries. CEF then updates the hardware with the new
FIB information.
Cisco Express Forwarding
A key element of NSF is packet forwarding. In a Cisco networking device, packet forwarding is provided
by Cisco Express Forwarding (CEF). CEF maintains the FIB and uses the FIB information that was
current at the time of the switchover to continue forwarding packets during a switchover. This feature
reduces traffic interruption during the switchover.
During normal NSF operation, CEF on the active supervisor engine synchronizes its current FIB and
adjacency databases with the FIB and adjacency databases on the standby supervisor engine. Upon
switchover, the standby supervisor engine initially has FIB and adjacency databases that are mirror
images of those that were current on the active supervisor engine. CEF keeps the forwarding engine on
the standby supervisor engine current with changes that are sent to it by CEF on the active supervisor
engine. The forwarding engine can continue forwarding after a switchover as soon as the interfaces and
a data path are available.
As the routing protocols start to repopulate the RIB on a prefix-by-prefix basis, the updates cause
prefix-by-prefix updates to CEF, which it uses to update the FIB and adjacency databases. Existing and
new entries receive the new version (“epoch”) number, indicating that they have been refreshed. The
forwarding information is updated on the forwarding engine during convergence. The supervisor engine
signals when the RIB has converged. The software removes all FIB and adjacency entries that have an
epoch older than the current switchover epoch. The FIB now represents the newest routing protocol
forwarding information.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
9-4 OL-22250-01
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
About NSF with SSO Supervisor Engine Redundancy
Routing Protocols
Note Use of the routing protocols require the Enterprise Services (entservices) level of Cisco IOS-XE
Software for the Catalyst 4500 series switch. EIGRP-stub and OSPF for routed access are supported on
IP Base level of Cisco IOS XE.
The routing protocols run only on the active supervisor engine, and they receive routing updates from
their neighbor routers. Routing protocols do not run on the standby supervisor engine. Following a
switchover, the routing protocols request that the NSF-aware neighbor devices send state information to
help rebuild the routing tables. NSF supports the BGP, OSPF, and EIGRP protocols.
Note For NSF operation, the routing protocols depend on CEF to continue forwarding packets while the
routing protocols rebuild the routing information.
BGP Operation
When an NSF-capable router begins a BGP session with a BGP peer, it sends an OPEN message to the
peer. Included in the message is a statement that the NSF-capable device has “graceful” restart
capability. Graceful restart is the mechanism by which BGP routing peers avoid a routing flap following
a switchover. If the BGP peer has received this capability, it is aware that the device sending the message
is NSF-capable. Both the NSF-capable router and its BGP peers need to exchange the graceful restart
capability in their OPEN messages at the time of session establishment. If both the peers do not exchange
the graceful restart capability, the session will not be capable of a graceful restart.
If the BGP session is lost during the supervisor engine switchover, the NSF-aware BGP peer marks all
the routes associated with the NSF-capable router as stale; however, it continues to use these routes to
make forwarding decisions for a set period of time. This functionality prevents packets from being lost
while the newly active supervisor engine is waiting for convergence of the routing information with the
BGP peers.
After a supervisor engine switchover occurs, the NSF-capable router reestablishes the session with the
BGP peer. In establishing the new session, it sends a new graceful restart message that identifies the
NSF-capable router as having restarted.
At this point, the routing information is exchanged between the two BGP peers. After this exchange is
complete, the NSF-capable device uses the routing information to update the RIB and the FIB with the
new forwarding information. The NSF-aware device uses the network information to remove stale routes
from its BGP table; the BGP protocol then is fully converged.
If a BGP peer does not support the graceful restart capability, it ignores the graceful restart capability in
an OPEN message but establishes a BGP session with the NSF-capable device. This function allows
interoperability with non-NSF-aware BGP peers (and without NSF functionality), but the BGP session
with non-NSF-aware BGP peers is not capable of a graceful restart.
Note BGP support in NSF requires that neighbor networking devices be NSF-aware; that is, the devices must
have the graceful restart capability and advertise that capability in their OPEN message during session
establishment. If an NSF-capable router discovers that a particular BGP neighbor does not have graceful
restart capability, it does not establish an NSF-capable session with that neighbor. All other neighbors
that have graceful restart capability continue to have NSF-capable sessions with this NSF-capable
networking device.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 9-5
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
About NSF with SSO Supervisor Engine Redundancy
OSPF Operation
When an OSPF NSF-capable router performs a supervisor engine switchover, it must perform the
following tasks in order to resynchronize its link state database with its OSPF neighbors:
• Relearn the available OSPF neighbors on the network without causing a reset of the neighbor
relationship
• Reacquire the contents of the link state database for the network
As quickly as possible after a supervisor engine switchover, the NSF-capable router sends an OSPF NSF
signal to neighboring NSF-aware devices. Neighbor networking devices recognize this signal as an
indicator that the neighbor relationship with this router should not be reset. As the NSF-capable router
receives signals from other routers on the network, it can begin to rebuild its neighbor list.
After neighbor relationships are reestablished, the NSF-capable router begins to resynchronize its
database with all of its NSF-aware neighbors. At this point, the routing information is exchanged
between the OSPF neighbors. Once this exchange is complete, the NSF-capable device uses the routing
information to remove stale routes, update the RIB, and update the FIB with the new forwarding
information. The OSPF protocols are then fully converged.
Note OSPF support in NSF requires that all neighbor networking devices be NSF-aware. If an NSF-capable
router discovers that it has non-NSF -aware neighbors on a particular network segment, it disables NSF
capabilities for that segment. Other network segments composed entirely of NSF-capable or NSF-aware
routers continue to provide NSF capabilities.
EIGRP Operation
When an EIGRP NSF-capable router initially re-boots after an NSF restart, it has no neighbor and its
topology table is empty. The router is notified by the standby (now active) supervisor engine when it
needs to bring up the interfaces, reacquire neighbors, and rebuild the topology and routing tables. The
restarting router and its peers must accomplish these tasks without interrupting the data traffic directed
toward the restarting router. EIGRP peer routers maintain the routes learned from the restarting router
and continue forwarding traffic through the NSF restart process.
To prevent an adjacency reset by the neighbors, the restarting router uses a new Restart (RS) bit in the
EIGRP packet header to indicate a restart. The RS bit is set in the hello packets and in the initial INIT
update packets during the NSF restart period. The RS bit in the hello packets allows the neighbors to be
quickly notified of the NSF restart. Without seeing the RS bit, the neighbor can only detect an adjacency
reset by receiving an INIT update or by the expiration of the hello hold timer. Without the RS bit, a
neighbor does not know if the adjacency reset should be handled using NSF or the normal startup
method.
When the neighbor receives the restart indication, either by receiving the hello packet or the INIT packet,
it recognizes the restarting peer in its peer list and maintains the adjacency with the restarting router. The
neighbor then sends it topology table to the restarting router with the RS bit set in the first update packet
indicating that it is NSF-aware and is helping out the restarting router. The neighbor does not set the RS
bit in their hello packets, unless it is also a NSF restarting neighbor.
Note A router may be NSF-aware but may not be helping the NSF restarting neighbor because booting from
a cold start.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
9-6 OL-22250-01
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
Configuring NSF with SSO Supervisor Engine Redundancy
If at least one of the peer routers is NSF-aware, the restarting router would then receive updates and
rebuild its database. The restarting router must then find out if it had converged so that it can notify the
routing information base (RIB). Each NSF-aware router is required to send an end of table (EOT) marker
in the last update packet to indicate the end of the table content. The restarting router knows it has
converged when it receives the EOT marker. The restarting router can then begin sending updates.
An NSF-aware peer would know when the restarting router had converged when it receives an EOT
indication from the restarting router. The peer then scans its topology table to search for the routes with
the restarted neighbor as the source. The peer compares the route timestamp with the restart event
timestamp to determine if the route is still available. The peer then goes active to find alternate paths for
the routes that are no longer available through the restarted router.
When the restarting router has received all EOT indications from its neighbors or when the NSF converge
timer expires, EIGRP notifies the RIB of convergence. EIGRP waits for the RIB convergence signal and
then floods its topology table to all awaiting NSF-aware peers.
NSF Guidelines and Restrictions
NSF with SSO has these restrictions:
• For NSF operation, you must have SSO configured on the device.
• NSF with SSO supports IP Version 4 traffic and protocols only; NSF with SSO does not support IPv6
traffic.
• The Virtual Redundancy Routing Protocols (VRRP) is not SSO-aware, meaning state information is
not maintained between the active and standby supervisor engine during normal operation. VRRP
and SSO can coexist but both features work independently. Traffic that relies on VRRP may switch
to the VRRP standby in the event of a supervisor engine switchover.
• All neighboring devices participating in BGP NSF must be NSF-capable and configured for BGP
graceful restart.
• OSPF NSF for virtual links is not supported.
• All OSPF networking devices on the same network segment must be NSF-aware (running an NSF
software image).
• For IETF, all neighboring devices must be running an NSF-aware software image.
Configuring NSF with SSO Supervisor Engine Redundancy
The following sections describe the configuration tasks for the NSF feature:
• Configuring SSO, page 9-8
• Configuring CEF NSF, page 9-8
• Verifying CEF NSF, page 9-9
• Configuring BGP NSF, page 9-9
• Verifying BGP NSF, page 9-10
• Configuring OSPF NSF, page 9-11
• Verifying OSPF NSF, page 9-11
• Configuring EIGRP NSF, page 9-12
• Verifying EIGRP NSF, page 9-13
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 9-7
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
Configuring NSF with SSO Supervisor Engine Redundancy
Configuring SSO
You must configure SSO in order to use NSF with any supported protocol. To configure SSO, perform
this task:
Command Purpose
Step 1 Switch(config)# redundancy Enters redundancy configuration mode.
Step 2 Switch(config-red)# mode sso Configures SSO. When this command is entered, the
standby supervisor engine is reloaded and begins to work
in SSO mode.
Step 3 Switch(config-red)# end Returns to EXEC mode.
Step 4 Switch# show running-config Verifies that SSO is enabled.
Step 5 Switch# show redundancy states Displays the operating redundancy mode.
Note The sso keyword is not supported if the IOS-XE software is running in LAN Base level.
This example shows how to configure the system for SSO and display the redundancy state:
Switch> enable
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# redundancy
Switch(config-red)# mode sso
Switch(config-red)# end
Switch# show redundancy states
my state = 13 -ACTIVE
peer state = 8 -STANDBY HOT
Mode = Duplex
Unit = Primary
Unit ID = 5
Redundancy Mode (Operational) = sso
Redundancy Mode (Configured) = sso
Split Mode = Disabled
Manual Swact = Enabled
Communications = Up
client count = 29
client_notification_TMR = 30000 milliseconds
keep_alive TMR = 9000 milliseconds
keep_alive count = 1
keep_alive threshold = 18
RF debug mask = 0x0
Switch#
Configuring CEF NSF
The CEF NSF feature operates by default while the networking device is running in SSO mode. No
configuration is necessary.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
9-8 OL-22250-01
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
Configuring NSF with SSO Supervisor Engine Redundancy
Verifying CEF NSF
To verify that CEF is NSF-capable, enter the show cef state command:
Switch# show cef state
CEF Status:
RP instance
common CEF enabled
IPv4 CEF Status:
CEF enabled/running
dCEF enabled/running
CEF switching enabled/running
universal per-destination load sharing algorithm, id DEA83012
IPv6 CEF Status:
CEF disabled/not running
dCEF disabled/not running
universal per-destination load sharing algorithm, id DEA83012
RRP state:
I am standby RRP: no
RF Peer Presence: yes
RF PeerComm reached: yes
RF Progression blocked: never
Redundancy mode: rpr(1)
CEF NSF sync: disabled/not running
CEF ISSU Status:
FIBHWIDB broker
No slots are ISSU capable.
FIBIDB broker
No slots are ISSU capable.
FIBHWIDB Subblock broker
No slots are ISSU capable.
FIBIDB Subblock broker
No slots are ISSU capable.
Adjacency update
No slots are ISSU capable.
IPv4 table broker
No slots are ISSU capable.
CEF push
No slots are ISSU capable.
Configuring BGP NSF
Note You must configure BGP graceful restart on all peer devices participating in BGP NSF.
To configure BGP for NSF, perform this task (repeat this procedure on each of the BGP NSF peer
devices):
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 9-9
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
Configuring NSF with SSO Supervisor Engine Redundancy
Command Purpose
Step 2 Switch(config)# router bgp as-number Enables a BGP routing process, which places the
switch in switch configuration mode.
Step 3 Switch(config-router)# bgp graceful-restart Enables the BGP graceful restart capability,
starting BGP NSF.
If you enter this command after the BGP session
has been established, you must restart the session
for the capability to be exchanged with the BGP
neighbor.
Use this command on the restarting switch and all
of its peers.
Verifying BGP NSF
To verify BGP NSF, you must check that BGP graceful restart is configured on the SSO-enabled
networking device and on the neighbor devices. To verify, follow these steps:
Step 1 Verify that “bgp graceful-restart” appears in the BGP configuration of the SSO-enabled switch by
entering the show running-config command:
Switch# show running-config
.
.
.
router bgp 120
.
.
.
bgp graceful-restart
neighbor 10.2.2.2 remote-as 300
.
.
.
Step 2 Repeat Step 1 on each of the BGP neighbors.
Step 3 On the SSO device and the neighbor device, verify that the graceful restart function is shown as both
advertised and received, and confirm the address families that have the graceful restart capability. If no
address families are listed, BGP NSF does not occur either:
Switch# show ip bgp neighbors
BGP neighbor is 31.31.31.7, remote AS 1, internal link
BGP version 4, remote router ID 7.7.7.7
BGP state = Established, up for 00:02:38
Last read 00:00:38, last write 00:00:35, hold time is 180, keepalive interval is 60
seconds
Neighbor capabilities:
Route refresh: advertised and received(new)
Address family IPv4 Unicast: advertised and received
Message statistics:
InQ depth is 0
OutQ depth is 0
Sent Rcvd
Opens: 1 1
Notifications: 0 0
Software Configuration Guide—Release IOS-XE 3.1.0 SG
9-10 OL-22250-01
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
Configuring NSF with SSO Supervisor Engine Redundancy
Updates: 0 0
Keepalives: 4 4
Route Refresh: 0 0
Total: 5 5
Default minimum time between advertisement runs is 0 seconds
............................................................
(Remaining output deleted)
Configuring OSPF NSF
Note All peer devices participating in OSPF NSF must be made OSPF NSF-aware, which happens
automatically when you install an NSF software image on the device.
To configure OSPF NSF, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# router ospf processID Enables an OSPF routing process, which places the
switch in router configuration mode.
Step 3 Switch(config-router)# nsf Enables NSF operations for OSPF.
Verifying OSPF NSF
To verify OSPF NSF, you must check that the NSF function is configured on the SSO-enabled
networking device. To verify OSPF NSF, follow these steps:
Step 1 Verify that ‘nsf’ appears in the OSPF configuration of the SSO-enabled device by entering the show
running-config command:
Switch# show running-config
route ospf 120
log-adjacency-changes
nsf
network 192.168.20.0 0.0.0.255 area 0
network 192.168.30.0 0.0.0.255 area 1
network 192.168.40.0 0.0.0.255 area 2
.
.
.
Step 2 Enter the show ip ospf command to verify that NSF is enabled on the device:
Switch> show ip ospf
Routing Process "ospf 1" with ID 187.1.1.1
Start time: 00:02:07.532, Time elapsed: 00:39:05.052
Supports only single TOS(TOS0) routes
Supports opaque LSA
Supports Link-local Signaling (LLS)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 9-11
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
Configuring NSF with SSO Supervisor Engine Redundancy
Supports area transit capability
Router is not originating router-LSAs with maximum metric
Initial SPF schedule delay 5000 msecs
Minimum hold time between two consecutive SPFs 10000 msecs
Maximum wait time between two consecutive SPFs 10000 msecs
Incremental-SPF disabled
Minimum LSA interval 5 secs
Minimum LSA arrival 1000 msecs
LSA group pacing timer 240 secs
Interface flood pacing timer 33 msecs
Retransmission pacing timer 66 msecs
Number of external LSA 0. Checksum Sum 0x000000
Number of opaque AS LSA 0. Checksum Sum 0x000000
Number of DCbitless external and opaque AS LSA 0
Number of DoNotAge external and opaque AS LSA 0
Number of areas in this router is 1. 1 normal 0 stub 0 nssa
Number of areas transit capable is 0
External flood list length 0
IETF Non-Stop Forwarding enabled
restart-interval limit: 120 sec
IETF NSF helper support enabled
Cisco NSF helper support enabled
Reference bandwidth unit is 100 mbps
Area BACKBONE(0)
Number of interfaces in this area is 3 (1 loopback)
Area has no authentication
SPF algorithm last executed 00:08:53.760 ago
SPF algorithm executed 2 times
Area ranges are
Number of LSA 3. Checksum Sum 0x025BE0
Number of opaque link LSA 0. Checksum Sum 0x000000
Number of DCbitless LSA 0
Number of indication LSA 0
Number of DoNotAge LSA 0
Flood list length 0
Switch#
Configuring EIGRP NSF
To configure EIGRP NSF, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# router eigrp as-number Enables an EIGRP routing process, which places
the switch in router configuration mode.
Step 3 Switch(config-router)# nsf Enables EIGRP NSF.
Use this command on the “restarting” switch and
all of its peers.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
9-12 OL-22250-01
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
Cisco High Availability Features in Cisco IOS XE 3.1.0SG
Verifying EIGRP NSF
To verify EIGRP NSF, you must check that the NSF function is configured on the SSO-enabled
networking device. To verify EIGRP NSF, follow these steps:
Step 1 Verify that “nsf” appears in the EIGRP configuration of the SSO-enabled device by entering the
show running-config command:
Switch# show running-config
..
.
router eigrp 100
auto-summary
nsf
..
.
Step 2 Enter the show ip protocols command to verify that NSF is enabled on the device:
Switch# show ip protocols
*** IP Routing is NSF aware ***
Routing Protocol is "ospf 1"
Outgoing update filter list for all interfaces is not set
Incoming update filter list for all interfaces is not set
Router ID 187.1.1.1
Number of areas in this router is 1. 1 normal 0 stub 0 nssa
Maximum path: 1
Routing for Networks:
Routing on Interfaces Configured Explicitly (Area 0):
Loopback0
GigabitEthernet5/3
TenGigabitEthernet3/1
Routing Information Sources:
Gateway Distance Last Update
121.1.1.1 110 00:01:02
Distance: (default is 110)
Routing Protocol is "bgp 601"
Outgoing update filter list for all interfaces is not set
Incoming update filter list for all interfaces is not set
IGP synchronization is disabled
Automatic route summarization is disabled
Neighbor(s):
Address FiltIn FiltOut DistIn DistOut Weight RouteMap
150.1.1.1
Maximum path: 1
Routing Information Sources:
Gateway Distance Last Update
150.1.1.1 20 00:01:03
Distance: external 20 internal 200 local 200
Switch#
Cisco High Availability Features in Cisco IOS XE 3.1.0SG
This section provides a list of High Availability software features that are supported in Cisco IOS XE
3.1.0SG. Links to the feature documentation are included.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 9-13
Chapter 9 Configuring Cisco NSF with SSO Supervisor Engine Redundancy
Cisco High Availability Features in Cisco IOS XE 3.1.0SG
Feature guides may contain information about more than one feature. To find information about a
specific feature within a feature guide, see the Feature Information table at the end of the guide.
Feature guides document features that are supported on many different software releases and platforms.
Your Cisco software release or platform may not support all the features documented in a feature guide.
See the Feature Information table at the end of the feature guide for information about which features in
that guide are supported in your software release. Use Cisco Feature Navigator to find information about
platform support and Cisco software image support. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
The following high availability features were introduced with Cisco IOS XE 3.1.0SG:
• Enhanced High System Availability
• NSF - Graceful Restart (GR) and Non Stop Routing (NSR) for IS-IS
• NSF - OSPF
• NSF/SSO (Nonstop Forwarding with Stateful Switchover)
• SSO - HDLC
• SSO - HSRP
• SSO - Multilink PPP (MLP)
• SSO - PPP
For details on Cisco High Availability, refer to the following URL:
http://www.cisco.com/en/US/products/ps6550/products_ios_technology_home.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
9-14 OL-22250-01
CH A P T E R 10
Environmental Monitoring and Power
Management
Note Before reading this chapter, read the “Preparing for Installation” section of the
Catalyst 4500 Series Installation Guide. It is important to ensure that your installation site has enough
power and cooling to accommodate the additional electrical load and heat introduced by Power over
Ethernet (PoE).
This chapter describes power management and environmental monitoring features in the Catalyst 4500
series switches. It provides guidelines, procedures, and configuration examples.
This chapter consists of the following major sections:
• About Environmental Monitoring, page 10-1
• Power Management, page 10-5
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Environmental Monitoring
This section contains the following subsections:
• Using CLI Commands to Monitor your Environment, page 10-2
• Displaying Environment Conditions, page 10-2
• Emergency Actions, page 10-3
• System Alarms, page 10-4
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 10-1
Chapter 10 Environmental Monitoring and Power Management
About Environmental Monitoring
Environmental monitoring of chassis components provides early warning indications of possible
component failure. This warning helps you to ensure the safe and reliable operation of your system and
avoid network interruptions.
This section describes how to monitor critical system components so that you can identify and rapidly
correct hardware-related problems.
Using CLI Commands to Monitor your Environment
Use the show environment CLI command to monitor the system. This section gives a basic overview of
the command and keywords you need.
Enter the show environment [alarm | status | temperature] command to display system status
information. Keyword descriptions are listed in Table 10-1.
Table 10-1 show environment Keyword Descriptions
Keyword Purpose
alarm Displays environmental alarms for the system.
status Displays field-replaceable unit (FRU) operational status and power
and power supply fan sensor information.
temperature Displays temperature of the chassis.
Displaying Environment Conditions
Supervisor Engine 7-E and its associated linecards support multiple temperature sensors per card. The
environment condition output includes the temperature reading from each sensor and the temperature
thresholds for each sensor. These linecards support three thresholds: warning, critical, and shutdown.
The following example illustrates how to display the environment condition on a Supervisor Engine 7-E.
The thresholds appear within parentheses.
Switch# show environment
Module Sensor Temperature Status
------+--------------------------+--------------------+------------
1 Xgstub A 39C (48C,62C,65C) ok
1 Xgstub B 32C (45C,60C,63C) ok
1 XPP 47C (62C,75C,78C) ok
1 VFE2 59C (74C,85C,88C) ok
1 NFE 44C (63C,75C,78C) ok
1 CPU 55C (57C,72C,75C) ok
1 FPGA 37C (52C,66C,69C) ok
4 Power macro 30C (56C,68C,71C) ok
4 Air inlet 27C (46C,59C,62C) ok
4 Xgstub 31C (66C,76C,79C) ok
4 Air outlet 30C (60C,71C,74C) ok
Power Fan Inline
Supply Model No Type Status Sensor Status
------ ---------------- --------- ----------- ------- -------
PS1 PWR-C45-1300ACV AC 1300W good good good
PS2 none -- -- -- --
Power supplies needed by system : 1
Power supplies currently available : 1
Software Configuration Guide—Release 15.0(1)XO
10-2 OL-22250-01
Chapter 10 Environmental Monitoring and Power Management
About Environmental Monitoring
Chassis Type : WS-C4506-E
Power consumed by backplane : 0 Watts
Switch Bandwidth Utilization : 0%
Supervisor Led Color : Green
Module 1 Status Led Color : Green
Module 4 Status Led Color : Green PoE Led Color : Green
Module 6 Status Led Color : Green PoE Led Color : Green
Fantray : Good
Fantray removal timeout : 30
Power consumed by Fantray : 120 Watts
Emergency Actions
Chassis with Supervisor Engine 7-E can power down a single card, providing a detailed response to
over-temperature conditions on linecards. However, Supervisor Engine 7-E cannot safely operate when
the temperature of the supervisor itself exceeds the critical threshold. Therefore, the supervisor engine
turns off the chassis’ power supplies to protect itself from overheating. When this happens, you can
recover the switch only by cycling the power on and off switches on the power supplies or by cycling the
AC or DC inputs to the power supplies.
Critical and shutdown temperature emergencies trigger the same action. Table 10-2 lists temperature
emergencies but does not distinguish between critical and shutdown emergencies.
Table 10-2 Emergency and Action for Supervisor Engines 7-E
Case 1. Complete fan failure emergency. Power down the chassis.
Case 2. Temperature emergency on a Power down the linecard.
linecard.
Case 3. Temperature emergency on the Power down the standby supervisor engine.
standby supervisor engine.
Case 4. Temperature emergency on the Reset the active supervisor engine.
active supervisor engine with the standby
supervisor engine in the hot standby or cold
standby redundancy state.
Case 5. Temperature emergency on the Power down the chassis.
active supervisor engine with no standby
supervisor engine or with a standby
supervisor engine that is not in hot standby
or cold standby redundancy state.
In Case 4, the standby supervisor engine takes over when the active engine resets itself. Then, if the
temperature emergency remains, the newly active supervisor engine resets the standby supervisor
engine.
Case 5 applies to nonredundant chassis and to chassis with a standby supervisor engine that has been
shutdown or which has not fully booted.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 10-3
Chapter 10 Environmental Monitoring and Power Management
About Environmental Monitoring
System Alarms
Any system has two types of alarms: major and minor. A major alarm indicates a critical problem that
could lead to system shutdown. A minor alarm is informational—it alerts you to a problem that could
become critical if corrective action is not taken.
Table 10-3 lists the possible environment alarms.
Table 10-3 Possible Environmental Alarms
A temperature sensor over its warning threshold minor
A temperature sensor over its critical threshold major
A temperature sensor over its shutdown threshold major
A partial fan failure minor
A complete fan failure major
Fan failure alarms are issued as soon as the fan failure condition is detected and are canceled when the
fan failure condition clears. Temperature alarms are issued as soon as the temperature reaches the
threshold temperature and are canceled when the temperature drops more than 5 degree C below the
threshold. 5 degree C is a hysteresis value designed to prevent toggling alarms.
An LED on the supervisor engine indicates whether an alarm has been issued.
When the system issues a major alarm, it starts a timer whose duration depends on the alarm. If the alarm
is not canceled before the timer expires, the system takes emergency action to protect itself from the
effects of overheating. The timer values and the emergency actions depend on the type of supervisor
engine.
Note Refer to the Catalyst 4500 Series Switch Module Installation Guide for information on LEDs, including
the startup behavior of the supervisor engine system LED.
Table 10-4 describes the alarms on Supervisor Engine 7-E.
Table 10-4 Alarms on Supervisor Engine 7-E
Alarm Supervisor LED
Event Type Color Timeout Description and Action
Card temperature exceeds the Major Red 15 min Syslog message displays when the alarm is
critical threshold. issued.
See Table 10-2 for the action on timeout.
Card temperature exceeds the Major Red 30 min Syslog message displays when the alarm is
shutdown threshold. issued.
See Table 10-2 for the action on timeout.
Supervisor engine fails power-on Major Red — Syslog message is displayed.
self-test (POST).
The supervisor fails to come up.
Chassis fan tray fails. Major Red 30 sec Syslog message displays when the alarm is
issued.
See Table 10-2 for the action on timeout.
Software Configuration Guide—Release 15.0(1)XO
10-4 OL-22250-01
Chapter 10 Environmental Monitoring and Power Management
Power Management
Table 10-4 Alarms on Supervisor Engine 7-E
Alarm Supervisor LED
Event Type Color Timeout Description and Action
Chassis temperature exceeds the Minor Orange — Syslog message displays when the alarm is
warning threshold. issued.
Chassis fan tray experiences Minor Orange — Syslog message displays when the alarm is
partial failure. issued.
Power Management
This section describes the power management feature in the Catalyst 4500 series switches. It includes
the following topics:
• Power Management for the Catalyst 4500 Series Switches, page 10-5
• Powering Down a Module, page 10-18
Note For power consumption of all Catalyst 4000/4500 family modules, see “Appendix A, Specifications,” in
the Catalyst 4500 Series Module Installation Guide. Enter the show power command to display the
current power redundancy and the current system power usage.
Power Management for the Catalyst 4500 Series Switches
This section includes the following subsections:
• Supported Power Supplies, page 10-5
• Power Management Modes for the Catalyst 4500 Switch, page 10-7
• Selecting a Power Management Mode, page 10-7
• Power Management Limitations in Catalyst 4500 Series Switches, page 10-8
• Available Power for Catalyst 4500 Series Switches Power Supplies, page 10-12
• Special Considerations for the 4200 W AC and 6000 W AC Power Supplies, page 10-13
• Combined Mode Power Resiliency, page 10-15
• Special Considerations for the 1400 W DC Power Supply, page 10-16
• Special Considerations for the 1400 W DC SP Triple Input Power Supply, page 10-17
Supported Power Supplies
You can select from several different power supplies to ensure that you have enough power for the
modules installed in your switch.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 10-5
Chapter 10 Environmental Monitoring and Power Management
Power Management
Note You should select a power supply based on the modules and the amount of PoE desired using the Cisco
Power Calculator:
http://tools.cisco.com/cpc/
The choice between 1000 AC and 1400 AC should depend on the type of linecards that the customer
plans to use in the chassis.
The Catalyst 4500 series switches support the following power supplies:
• Fixed Wattage—These power supplies always deliver a fixed amount of PoE and system power.
– 1000 W AC—Supports up to 1050 W of system power. (Not recommended on the Catalyst
4510R switch, PoE not supported)
– 1400 W AC—Supports up to 1400 W system power. (PoE not supported)
– 2800 W AC—Supports up to 1400 W of system power and up to 1400 W of PoE.
• Variable Wattage—These power supplies automatically adjust the wattage to accommodate PoE and
system power requirements.
– 1300 W AC—Supports up to 1050 W of system power and 800 W of PoE, limited to a total of
1300 W.
– 1400 W DC—Supports up to 1400 W of system power and variable amounts of PoE, depending
on the input feed to the power supply. See “Special Considerations for the 1400 W DC Power
Supply” section on page 10-16 for more information.
– 1400 W DC Service Provider—Uses up to three lines (12.5 A, 15 A, 15 A) of DC input and
delivers varying amounts of system power ranging from 400 W to 1400 W depending on the
lines powered. See “Special Considerations for the 1400 W DC SP Triple Input Power Supply”
section on page 10-17 for more information. (PoE not supported)
– 4200 W AC and 6000 W AC—Supports varying amounts of system power and PoE depending
on the number of inputs powered and input voltage.
Note All Catalyst 4500 series switch AC-input power supplies require single-phase source AC. The source AC
can be out of phase between multiple power supplies or multiple AC-power plugs on the same power
supply because all AC power supply inputs are isolated. Each chassis power supply should ideally have
its own dedicated branch circuit sized to local and national codes.
When you insert power supplies in your switch, use power supplies that are of the same wattage.
Multi-input power supplies such as 1400 W DC triple-input, 4200 W AC, and 6000 W AC have
additional restrictions. Read the sections on special considerations for these power supplies. If you mix
power supplies, the switch uses the one with the higher wattage and ignores the other power supply. The
power supply status displays as err-disable and the summary displays as all zeros (0) for wattage values
in the output for the show power command. The following example shows the output for the show
power command for mixed power supplies:
Switch# show power
Power Fan Inline
Supply Model No Type Status Sensor Status
------ ---------------- --------- ----------- ------ ------
PS1 PWR-C45-2800AC AC 2800W good good good
PS2 PWR-C45-1000AC AC 1000W err-disable good n.a.
Software Configuration Guide—Release 15.0(1)XO
10-6 OL-22250-01
Chapter 10 Environmental Monitoring and Power Management
Power Management
*** Power Supplies of different type have been detected***
Power supplies needed by system :1
Power supplies currently available :1
Power Summary Maximum
(in Watts) Used Available
---------------------- ---- ---------
System Power (12V) 328 1360
Inline Power (-50V) 0 1400
Backplane Power (3.3V) 10 40
---------------------- ----
Total Used 338 (not to exceed Total Maximum Available = 750)
Switch#
Power Management Modes for the Catalyst 4500 Switch
The Catalyst 4500 series switches support two power management modes:
• Redundant mode—Redundant mode uses one power supply as a primary power supply and the
second power supply as a back-up. If the primary power supply fails, the second power supply
immediately supports the switch without any disruption in the network. Both power supplies must
be the same wattage. A single power supply must have enough power to support the switch
configuration.
• Combined mode—Combined mode uses the power from all installed power supplies to support the
switch configuration power requirements. However, combined mode has no power redundancy. If a
power supply fails, one or more modules might shut down.
Note On the Catalyst 4510R switch, the 1000 W AC power supply is not enough to support redundant
mode for all possible configurations. It is able to support redundant mode for limited
configurations that require less than 1050 W.
Note The 1400 W DC power supply supports combined mode for data power. It does not support
combined mode for PoE power.
Selecting a Power Management Mode
By default, a switch is set to redundant mode. In the show power command, if the
power supplies needed by system is 1, the switch is in redundant mode; if the
power supplies needed by system is 2, the switch is in combined mode.
Your switch hardware configuration dictates which power supply or supplies you should use. For
example, if your switch configuration requires more power than a single power supply provides, use the
combined mode. In combined mode, however, the switch has no power redundancy. Consider the
following possibilities:
• The supervisor engine consumes 110 W, the fan boxes for the Catalyst 4503 switch consume 30 W
each, the fan boxes for the Catalyst 4506 and Catalyst 4507 switches consume 50 W each, the
backplane for the Catalyst 4503 and Catalyst 4506 switches consumes 10 W, and the backplane for
the Catalyst 4507 switch consumes 40 W.
• 1000 W can support a fully loaded Catalyst 4503 switch with no powered device support.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 10-7
Chapter 10 Environmental Monitoring and Power Management
Power Management
• 1300 W can support a fully loaded Catalyst 4503 switch with Cisco powered devices.
• Each PoE port on a WS-X4148-RJ45V module requires 6.3 W. Five fully loaded WS-X4148-RJ45V
modules in a switch comprise 240 ports. This configuration requires 1512 W of PoE, plus 300 W for
the modules.
Power Management Limitations in Catalyst 4500 Series Switches
Limitation 1
It is possible to configure a switch that requires more power than the power supplies provide. The two
ways you could configure a switch to exceed the power capabilities are as follows:
• The power requirements for the installed modules exceed the power provided by the power supplies.
If you insert a single power supply and then set the switch to combined mode, the switch displays
this error message:
Insufficient power supplies present for specified configuration.
This error message also displays in the output for the show power command. This error message
displays because, by definition, combined mode requires that two working power supplies be
installed in your switch.
If the power requirements for the installed modules exceeds the power provided by the power
supplies, the switch displays this error message:
Insufficient power available for the current chassis configuration.
This error message also appears in the show power command output.
If you attempt to insert additional modules into your switch and exceed the power supply, the switch
immediately places the newly inserted module into reset mode, and the switch displays these error
messages:
Module has been inserted
Insufficient power supplies operating.
Additionally, if you power down a functioning switch and insert an additional module or change the
module configuration so that the power requirements exceed the available power, one or more
modules enter reset mode when you power on the switch again.
• The power requirements for the PoE exceed the PoE provided by the power supplies.
If you have too many IP phones drawing power from the system, power to IP phones is cut, and some
phones may be powered down to reduce the power requirements to match the power supplies.
In the first scenario (power requirements exceed the power supplied), the system attempts to resolve this
power usage limitation by evaluating the type and number of modules installed. During the evaluation
cycle, beginning from the bottom of the chassis, the system puts the modules that it is unable to support
(for lack of power) into reset mode. The supervisor engine and modules for which there is adequate
power always remain enabled, with no disruption of network connectivity. Modules placed in reset mode
still consume some power and can be removed from the chassis to further reduce power requirements. If
you configure the chassis correctly, the system does not enter the evaluation cycle.
A module in reset mode continues to draw power as long as it is installed in the chassis; use the show
power module command to determine how much power is required to bring the module online.
Software Configuration Guide—Release 15.0(1)XO
10-8 OL-22250-01
Chapter 10 Environmental Monitoring and Power Management
Power Management
To compute the power requirements for your system and verify that your system has enough power, add
the power consumed by the supervisor engine module(s), the fan box(es), and the installed modules
(including PoE). For PoE, total the requirements for all the phones. See the “Powering Down a Module”
section on page 10-18 for more information on the power consumption for the various components of
your switch.
The 802.3af-compliant PoE modules can consume up to 20 W of PoE to power FPGAs and other
hardware components on the module. Be sure to add at least 20 W to your PoE requirements for each
802.3af-compliant PoE module to ensure that the system has adequate power for the PDs connected to
the switch.
On the WS-X4148-RJ45V PoE module, PoE consumption cannot be measured. Therefore, for all PoE
calculations, the PoE consumption on this module is presumed to be equal to its administrative PoE.
Use the show module command to verify which modules are active and which, if any, have been placed
in reset.
The following example shows the show module command output for a system with inadequate power
for all installed modules. The system does not have enough power for Module 5; the Status displays it
as PwrDeny.
If the PoE that is consumed by the module is more than 50 W above the PoE you allocated using the
power inline consumption default command, the Status displays as PwrOver. If the PoE consumed by
the module is more than 50 W above the PoE module limit, the Status displays as PwrFault.
Switch# show module
Mod Ports Card Type Model Serial No.
----+-----+--------------------------------------+-----------------+-----------
1 2 1000BaseX (GBIC) Supervisor(active) WS-X4014 JAB054109GH
2 6 1000BaseX (GBIC) WS-X4306 00000110
3 18 1000BaseX (GBIC) WS-X4418 JAB025104WK
5 0 Not enough power for module WS-X4148-FX-MT 00000000000
6 48 10/100BaseTX (RJ45) WS-X4148 JAB023402RP
M MAC addresses Hw Fw Sw Status
--+--------------------------------+---+------------+----------------+---------
1 005c.9d1a.f9d0 to 005c.9d1a.f9df 0.5 12.1(11br)EW 12.1(20020313:00 Ok
2 0010.7bab.9920 to 0010.7bab.9925 0.2 Ok
3 0050.7356.2b36 to 0050.7356.2b47 1.0 Ok
5 0001.64fe.a930 to 0001.64fe.a95f 0.0 PwrDeny
6 0050.0f10.28b0 to 0050.0f10.28df 1.0 Ok
Switch#
Limitation 2
Certain configurations on the Catalyst 4507R and Catalyst 4510R chassis exceeds the maximum amount
of data power available. These configurations include the combination of the follow PIDs:
• 7-slot configuration
• Chassis: WS-C4507R-E, WS-C4510R-E
• Dual supervisor engines: WS-X45-Sup6-E
• One or more: WS-X4448-GB-RJ45 or WS-X4148-FX-MT
To maximize the 10/100/1000 port density of 7 and 10 slot chassis when using redundant Supervisor
engine 6-E install WS-X4548-GB-RJ45 linecards instead of WS-X4448-GB-RJ45 linecards. If
WS-X4448-GB-RJ45 linecards are required two options are available.
• Option 1
Only 4 linecard slots can be used on the Cat4507R and 6 linecard slots on the Cat4510R chassis.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 10-9
Chapter 10 Environmental Monitoring and Power Management
Power Management
• Option 2
When all slots are required only one WS-X4448-GB-RJ45 linecard can be used.
To maximize the 100-BASE-FX port density of 7 and 10 slot chassis when using Supervisor engine 6-E
install WS-4248-FE-SFP linecards with FX optics instead of WS-X4148-FX-MT linecards. If
WS-X4148-FX-MT linecards are required two options are available.
• Option 1
Only 4 linecard slots can be used on the Cat4507R and 6 linecard slots on the Cat4510R chassis.
• Option 2
When all slots are required only one WS-X4448-GB-RJ45 linecard can be used.
Configuring Redundant Mode on a Catalyst 4500 Series Switch
By default, the power supplies in a Catalyst 4500 series switch are set to operate in redundant mode. To
effectively use redundant mode, follow these guidelines:
• Use two power supplies of the same type.
• If you have the power management mode set to redundant mode and only one power supply
installed, your switch accepts the configuration but operates without redundancy.
Caution If you have power supplies with different types or different wattages installed in your switch, the switch
does not recognize one of the power supplies and does not have power redundancy.
• For fixed power supplies, choose a power supply that by itself is powerful enough to support the
switch configuration.
• For variable power supplies, choose a power supply that provides enough power so that the chassis
and PoE requirements are less than the maximum available power. Variable power supplies
automatically adjust the power resources at startup to accommodate the chassis and PoE
requirements. Modules are brought up first, followed by IP phones.
• The maximum available power for chassis and PoE for each power supply are listed in Table 10-5
on page 10-12.
To configure redundant mode on your Catalyst 4500 series switch, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# power redundancy-mode redundant Sets the power management mode to
redundant mode.
Step 3 Switch(config)# end Exits configuration mode.
Step 4 Switch# show power supplies Verifies the power redundancy mode for
the switch.
The following example shows how to set the power management mode to redundant mode.
Switch (config)# power redundancy-mode redundant
Switch (config)# end
Switch#
Software Configuration Guide—Release 15.0(1)XO
10-10 OL-22250-01
Chapter 10 Environmental Monitoring and Power Management
Power Management
The following example shows how to display the current power redundancy mode. The power supplies
needed by system: 1 indicates that the switch is in redundant mode.
Switch# show power supplies
Power supplies needed by system:1
Switch#
An option in the combined mode provides a form of redundancy available with only the 4200 W AC and
6000 W AC power supplies. Refer to the section “Combined Mode Power Resiliency” on page 15.
Configuring Combined Mode on a Catalyst 4500 Series Switch
If your switch configuration requires more power than a single power supply can provide, set the power
management mode to combined mode. Combined mode utilizes the available power for both power
supplies; however, your switch has no power redundancy.
To effectively use combined mode, follow these guidelines:
• Use power supplies of the same type and wattage (fixed or variable and AC or DC).
• If you use power supplies with different types or wattages, the switch utilizes only one of the power
supplies.
• For variable power supplies, choose a power supply that provides enough power so that the chassis
and PoE requirements are less than the maximum available power. Variable power supplies
automatically adjust the power resources at startup to accommodate the chassis and PoE
requirements.
• If you have the power management mode set to combined mode and only one power supply installed,
your switch accepts the configuration, but power is available from only one power supply.
• When your switch is configured to combined mode, the total available power is not the mathematical
sum of the individual power supplies. The power supplies have a predetermined current sharing ratio
(See Table 10-5 on page 10-12 for more information.)
• The maximum available power for chassis and PoE for each power supply are listed in Table 10-5
on page 10-12.
To configure combined mode on your Catalyst 4500 series switch, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# power redundancy-mode combined Sets the power management mode to
combined mode.
Step 3 Switch(config)# end Exits configuration mode.
Step 4 Switch# show power supplies Verifies the power redundancy mode for
the switch.
The following example shows how to set the power management mode to combined mode.
Switch (config)# power redundancy-mode combined
Switch (config)# end
Switch#
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 10-11
Chapter 10 Environmental Monitoring and Power Management
Power Management
The following example shows how to display the current power redundancy mode. The power supplies
needed by system: 2 indicates that the switch is in combined mode.
Switch# show power supplies
Power supplies needed by system:2
Switch#
Available Power for Catalyst 4500 Series Switches Power Supplies
Table 10-5 lists the power available for use in the various Catalyst 4500 series switches power supplies.
When your switch is configured to combined mode, the total available power in not the mathematical
sum of the individual power supplies. The power supplies have a sharing ratio predetermined by the
hardware. In combined mode, the total power available is P + (P * sharing-ratio), where P is the amount
of power in the power supply.
Table 10-5 Available Power for Switch Power Supplies
Power Supply Redundant Mode (W) Combined Mode (W) Sharing Ratio
1
1000 W AC Chassis = 1050 Chassis = 1667 2/3
PoE = 0 PoE = 0
1300 W AC Chassis (max) = 1050 Chassis (min) = 767 2/3
PoE (max) = 800 PoE (max) = 1333
Chassis + PoE + Backplane < Chassis (max) = 1667
1300 PoE (min) = 533
Chassis + PoE +
Backplane < 2200
1400 W DC Chassis (min) = 200 Chassis = 22674 Chassis—2/3
5
Chassis (max) = 1360 PoE PoE—0
PoE (max)2 = (DC Input3 -
[Chassis (min) + Backplane] /
0.75) * 0.96
1400 W AC Chassis = 1360 Chassis = 2473 9/11
6
PoE = 0 PoE = 0
2800 W AC Chassis = 1360 Chassis = 2473 Chassis7—9/11
PoE = 1400 PoE = 2333 PoE8—2/3
1. Chassis power includes power for the supervisor(s), all linecards, and the fan tray.
2. The efficiency for the 1400 W DC power supply is 0.75, and 0.96 is applied to PoE.
3. DC input can vary for the 1400 W DC power supply and is configurable. For more information, see “Special Considerations
for the 1400 W DC Power Supply” on page 16.
4. Not available for PoE.
5. Not available for PoE.
6. No voice power.
7. Data-only.
8. Inline power.
Software Configuration Guide—Release 15.0(1)XO
10-12 OL-22250-01
Chapter 10 Environmental Monitoring and Power Management
Power Management
Special Considerations for the 4200 W AC and 6000 W AC Power Supplies
The 4200 W AC and 6000 W AC power supply has two inputs: each can be powered at 110 or 220 V.
The output of the show power command for the 4200 W AC and 6000 W AC power supplies are similar
to that of 1400 W DC triple-input power supply (that is, the status of the sub-modules (multiple inputs)
is displayed). With these two power supplies, you can distinguish sub-module “failed” versus “off,” and
the status of the sub-modules (good, bad, or off):
Switch# show power
Power Fan Inline
Supply Model No Type Status Sensor Status
------ ---------------- --------- ----------- ------- -------
PS1 PWR-C45-4200ACV AC 4200W good good good
PS1-1 220V good
PS1-2 off
PS2 PWR-C45-4200ACV AC 4200W bad/off good bad/off
PS2-1 220V good
PS2-2 220V bad
Power supplies needed by system : 1
Power supplies currently available : 2
Power Summary Maximum
(in Watts) Used Available
---------------------- ---- ---------
System Power (12V) 140 1360
Inline Power (-50V) 0 1850
Backplane Power (3.3V) 0 40
---------------------- ---- ---------
Total 140 (not to exceed Total Maximum Available = 2100)
Switch#
As with other power supplies, the two power supplies must be of the same type (6000 W AC or 4200 W
AC or 1400 W DC). Otherwise, the right power supply are put in err-disable state and the left one is
selected. In addition, all the inputs to the chassis must be at the same voltage. In redundant mode, the
inputs to the left and right power supplies must be identical. If the left and right power supplies are
powered in redundant mode, the power values are based on the power supply that has higher output
wattage.
Note When the system is powered with a 4200 W or 6000 W power supply either in 110 V or 220 V combined
mode operation, the available power is determined by the configuration of the system (the type of
linecards, the number of linecards, number of ports consuming inline power etc.) and does not reflect
the absolute maximum power.
Note In a matched redundant power supply configuration, if a power supply sub-module fails, the other (good)
power supply provides power to its full capability.
Table 10-6 illustrates how the 4200 W AC power supply is evaluated in redundant mode.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 10-13
Chapter 10 Environmental Monitoring and Power Management
Power Management
Table 10-6 Power Output in Redundant Mode for the 4200 W AC Power Supply
Power Supply 12 V 3.3 V -50 V Total
110 V 660 40 700 1050
110 V+110 V 1360 40 1850 2100
or 220 V
220 V+220 V 1360 40 3700 4200
In combined mode, all the inputs to the chassis must be at the same voltage.
Table 10-7 illustrates how the 4200 W AC power supply is evaluated in combined mode.
Table 10-7 Combined Mode Output for the 4200 W AC Power Supply
Power Supply 12 V 3.3 V -50 V Maximum
Both sides (bays) at 110 V 1200 40 1320 1870
110 V+110 V, other side 110 V 1800 40 2000 2730
Both sides at 110 V+110 V 2200 40 3100 3800
Both sides at 220 V 2200 40 3100 3800
220 V+220 V, other side 220 V 2200 40 4700 5500
Both sides at 220 V+220 V 2200 40 6200 7600
Table 10-8 illustrates how the 6000 W AC power supply is evaluated in redundant mode.
Table 10-8 Power Output in Redundant Mode for the 6000 W AC Power Supply
Power Supply 12 V 3.3 V -50 V Total
110 V 850 40 922 1050
110 V+110 V or 220V 1700 40 1850 2100
220 V+220 V 2200 40 4800 6000
In combined mode, all the inputs to the chassis must be at the same voltage.
Table 10-9 illustrates how the 6000 W AC power supply is evaluated in combined mode.
Table 10-9 Combined Mode Output for the 6000 W AC Power Supply
Power Supply 12 V 3.3 V -50 V Maximum
Both sides (bays) at 110 V 1400 40 1670 1700
110 V+110 V, other side 110 V 2360 40 2560 2800
Both sides at 110 V+110 V 3090 40 3360 3700
Both sides at 220 V 4000 40 4360 5400
220 V+220 V, other side 220 V 4000 40 6600 6200
Both sides at 220 V+220 V 4000 40 8700 10900
Software Configuration Guide—Release 15.0(1)XO
10-14 OL-22250-01
Chapter 10 Environmental Monitoring and Power Management
Power Management
Combined Mode Power Resiliency
Note This feature only applies in combined mode when both power supply bays contain the 4200 W AC or
6000 W AC power supply.
Using the combined mode power resiliency feature, you can limit the power usage to a maximum of two
or three (configurable) inputs.
With two 4200 W AC or 6000 W AC power supplies, a maximum of four inputs are available. This
feature allows you to cap the power usage to that of two or three inputs. If one of the power supplies
fails, no loss of power occurs because you have capped its usage to a smaller number of inputs.
To configure the combined mode resiliency feature, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode
Step 2 Switch(config)# power redundancy combined max Limits the power usage to two or three
inputs {2 | 3} inputs.
Note The max inputs part of the command
is ignored by all power supplies other
than the 4200 W AC or 6000 W AC.
Step 3 Switch(config)# end Exits configuration mode.
Let’s say that you have max inputs 3 configured with 4 “good” (220 V) inputs and you limit the user to
5500 W instead of 7600 W with the following configuration. If one sub-unit fails or is powered off, the
user would have three “good” inputs providing 5500 W and the chassis is powered at the same rate as it
was prior to the failure event.
Switch# configuration terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# power redundancy combined max inputs 3
Switch(config)# end
Switch#
14:32:01: %SYS-5-CONFIG_I: Configured from console by console
Here is the output of the show power command prior to invoking this feature:
Switch# show power
sh power
Power Fan Inline
Supply Model No Type Status Sensor Status
------ ---------------- --------- ----------- ------- -------
PS1 PWR-C45-4200ACV AC 4200W good good good
PS1-1 110V good
PS1-2 110V good
PS2 PWR-C45-4200ACV AC 4200W good good good
PS2-1 110V good
PS2-2 110V good
Power supplies needed by system : 1
Power supplies currently available : 2
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 10-15
Chapter 10 Environmental Monitoring and Power Management
Power Management
Power Summary Maximum
(in Watts) Used Available
---------------------- ---- ---------
System Power (12V) 140 1360
Inline Power (-50V) 0 1850
Backplane Power (3.3V) 0 40
---------------------- ---- ---------
Total 140 (not to exceed Total Maximum Available = 2100)
Here is the output after invoking this features: Before combined mode was indicated as
Power supplies needed = 2 in the output of the show power command, combined mode is now indicated
by the phrase Power supplies needed by system : 2 Maximum Inputs = 3.
Switch# show power
show power
Power Fan Inline
Supply Model No Type Status Sensor Status
------ ---------------- --------- ----------- ------- -------
PS1 PWR-C45-4200ACV AC 4200W good good good
PS1-1 110V good
PS1-2 110V good
PS2 PWR-C45-4200ACV AC 4200W good good good
PS2-1 110V good
PS2-2 110V good
Power supplies needed by system : 2 Maximum Inputs = 3
Power supplies currently available : 2
Power Summary Maximum
(in Watts) Used Available
---------------------- ---- ---------
System Power (12V) 140 2400
Inline Power (-50V) 0 2000
Backplane Power (3.3V) 0 40
---------------------- ---- ---------
Total 140 (not to exceed Total Maximum Available = 2728)
Switch#
Special Considerations for the 1400 W DC Power Supply
Caution Do not mix the 1400 W DC power supply with any other power supply, even for a hot swap or other
short-term emergency. Doing so can seriously damage your switch.
Keep in mind the following guidelines when using a 1400 W DC power supply with your Catalyst 4500
series switch:
• The 1400 W DC power supply works with a variety of DC sources. The DC input can vary from
300 W to 7500 W. Refer to the power supply documentation for additional information.
• The supervisor engine cannot detect the DC source plugged into the 1400 W DC power supply. If
you are using the 1400 W DC power supply, use the power dc input command to set the DC input
power. For more information on this command, see the “Configuring the DC Input for a Power
Supply” section on page 10-17.
Software Configuration Guide—Release 15.0(1)XO
10-16 OL-22250-01
Chapter 10 Environmental Monitoring and Power Management
Power Management
• The software automatically adjusts between system power (for modules, backplane, and fans) and
PoE. Although PoE is 96 percent efficient, system power has only 75 percent efficiency. For
example, each 120 W of system power requires 160 W from the DC input. This requirement is
reflected in the “Power Used” column of the output for the show power available command.
• The 1400 W DC power supply has a separate power on or off switch for PoE. The power supply fan
status and main power supply status are tied together. If either of them fails, both the power supply
and its fan report as bad/off. You should verify that the main power is on before turning on the power
for the inline switch. In addition, you should verify that the power for the inline switch is off before
turning off the main power.
Configuring the DC Input for a Power Supply
To configure the DC input power for the 1400 W DC power supply or a power shelf, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode
Step 2 Switch(config)# power dc input watts Sets the capacity of the DC input source.
Step 3 Switch(config)# end Exits configuration mode.
The same configuration is applied to both power slots. For example, if you set the dc power input to
1000 W, the switch expects 1000 W as the external DC source for both slot 1and slot 2 (if present)
respectively.
The following example shows how to set the external DC power source to 1000 W:
Switch# configure terminal
Switch (config)# power dc input 1000
Switch (config)# end
Switch#
If you use the 1400 W DC SP power supply in combined mode, the inputs do not have to match.
Special Considerations for the 1400 W DC SP Triple Input Power Supply
Unlike the 1400 W DC power supply, the 1400 W DC SP power supply has sub-modules (multiple
inputs) that can be powered on or off. With Cisco IOS Release 12.2(25)EW, output of the
show power command is modified to display the status of these sub-modules:
Switch# show power
Power Fan Inline
Supply Model No Type Status Sensor Status
------ ---------------- --------- ----------- ------- ------
PS1 PWR-C45-1400DC DCSP1400W good good n.a.
PS1-1 12.5A good
PS1-2 15.0A bad
PS1-3 15.0A off
PS2 none -- -- -- --
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 10-17
Chapter 10 Environmental Monitoring and Power Management
Power Management
Observe the following guidelines when using a 1400 W DC SP power supply with your Catalyst 4500
series switch:
• When you use two 48 V power rails to drive two power supplies, you might employ cross-wiring to
connect the power supplies (to rails) to minimize the inrush current drawn during an initial power
up. In this situation, you should configure the switch in combined mode before you take a rail down
for maintenance.
• Ordinarily, when configured for redundancy, two power supplies must be matched (have identical
inputs). For example, you might provide power to inputs 1 and 3 on both PS1 and PS2. If power
supplies are mismatched upon bootup, the right (second) power supply is in err-disable state.
In a matched redundant power supply configuration, if a power supply sub-module fails, the other (good)
power supply provides maximum power.
Powering Down a Module
If your system does not have enough power for all modules installed in the switch, you can power down
a module, and place it in low power mode. To power down a module, perform this task:
Command Purpose
Switch(config)# no hw-module module num power Turns power down to the specified module by
placing it in low power mode.
To power on a module that has been powered down, perform this task:
Command Purpose
Switch(config)# hw-module module num power Turns power on to the specified module.
This example shows how to power down module 6:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# no hw-module module 6 power
Switch(config)# end
Switch#
Software Configuration Guide—Release 15.0(1)XO
10-18 OL-22250-01
CH A P T E R 11
Configuring Power over Ethernet
Note Before reading this chapter, read the "Preparing for Installation” section of the
Catalyst 4500 Series Installation Guide. You must ensure that your installation site has enough power
and cooling to accommodate the additional electrical load and heat introduced by PoE.
This chapter describes how to configure Power over Ethernet (PoE) on the Catalyst 4500 series switch.
This chapter contains the following sections:
• About Power over Ethernet, page 11-1
• Power Management Modes, page 11-3
• Configuring Power Consumption for Powered Devices on an Interface, page 11-5
• Displaying the Operational Status for an Interface, page 11-6
• Displaying the PoE Consumed by a Module, page 11-7
• PoE Policing and Monitoring, page 11-11
• Enhanced Power PoE Support on the E-Series Chassis, page 11-15
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Power over Ethernet
The Catalyst 4500 series switch provides support for Power over Ethernet (PoE) for both Cisco
Prestandard PoE and the IEEE 802.3af standard. Certain linecards also support the higher 802.3at
standard. PoE is supported by all Catalyst 4500+E series chassis and requires a PoE module and power
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 11-1
Chapter 11 Configuring Power over Ethernet
About Power over Ethernet
EFT Draft - Conf idential
supply. The amount of PoE power available depends on the PoE capabilities of individual power
supplies. Support for PoE enables the system to power inline devices, such as IP phones, IP video
phones, and wireless access points over standard copper cabling (Category 5, 5e, or 6 cabling).
In addition, with PoE, you do not need to provide wall power for each PoE enabled device. This action
eliminates the cost for additional electrical cabling that would otherwise be necessary for connected
devices. Moreover, PoE enables you to isolate critical devices on a single power system, enabling the
entire system to be supported by UPS backup.
You typically deploy a Catalyst 4500 series switch in one of two deployment scenarios. The first scenario
is data-only, which requires power to operate the switch and the associated modules. The second scenario
supports data and PoE (also termed “inline power”) for deployments where the attached device derives
power from the Ethernet port.
Catalyst 4500 series switches can sense if a powered device is connected to a PoE module. They can
supply PoE to the powered device if there is no power on the circuit. (If there is power on the circuit, the
switch does not supply it.) The powered device can also be connected to an AC power source and supply
its own power to the voice circuit.
Note You should select the amount of PoE desired using the Cisco Power Calculator:
http://tools.cisco.com/cpc/
Hardware Requirements
To power a device using PoE, your chassis must use at least one of the power supplies listed in
Table 11-1, and connect the device to at least one of the switching modules listed in Table 11-1.
Table 11-1 Hardware Requirements
Switching Modules Power Supplies
WS-X4148-RJ45V PWR-C45-1300ACV=
WS-X4224-RJ45V PWR-C45-1400DCV=
WS-X4248-RJ21V PWR-C45-2800ACV=
WS-X4248-RJ45V PWR-C45-4200ACV=
WS-X4506-GB-T
WS-X4524-GB-RJ45V
WS-X4548-RJ45V+
WS-X4548-GB-RJ45V
WS-X4648-RJ45V-E
WS-X4648-RJ45V+E
WS-X4748-RJ45V+E
WS-X4748-RJ45V+E
Software Configuration Guide—Release 15.0(1)XO
11-2 OL-22250-01
Chapter 11 Configuring Power over Ethernet
Power Management Modes
Power Management Modes
If your switch has a module capable of providing PoE to end stations, you can set each interface on the
module to automatically detect and apply PoE if the end station requires power.
The Catalyst 4500 series switch has three PoE modes:
• auto—PoE interface. The supervisor engine directs the switching module to power up the interface
only if the switching module discovers the phone and the switch has enough power. You can specify
the maximum wattage that is allowed on the interface. If you do not specify a wattage, then the
switch delivers no more than the hardware-supported maximum value. This mode has no effect if
the interface is not capable of providing PoE.
• static—High priority PoE interface. The supervisor engine preallocates power to the interface, even
when nothing is connected, guaranteeing that power exists for the interface. You can specify the
maximum wattage that is allowed on the interface. If you do not specify a wattage, then the switch
preallocates the hardware-supported maximum value. If the switch does not have enough power for
the allocation, the command fails. The supervisor engine directs the switching module to power up
the interface only if the switching module discovers the powered device.
• never—Data interface only The supervisor engine never powers up the interface, even if an
unpowered phone is connected. This mode is only needed when you want to make sure power is
never applied to a PoE-capable interface.
The switch can measure the actual PoE consumption for an 802.3af-compliant PoE module, and displays
this consumption in the show power module command.
PoE consumption cannot be measured on the WS-X4148-RJ45V PoE module. Therefore, for all PoE
calculations, the PoE consumption on this module is presumed to be equal to its administrative PoE.
For more information, see the “Displaying the PoE Consumed by a Module” section on page 11-7.
For most users, the default configuration of “auto” works well, providing plug and play capability. No
further configuration is required. However, to make an interface higher priority or data only, or to specify
a maximum wattage, perform this task:
Command Purpose
Step 1 Switch(config)# interface {fastethernet | Selects the interface to configure.
gigabitethernet} slot/port
Step 2 Switch(config-if)# power inline {auto [max The auto keyword sets the interface to automatically detect
milli-watts] | never | static [max and supply power to the powered device. This is the default
milli-watts]}
configuration.
The static keyword sets the interface to higher priority than
auto.
If necessary, use the max keyword to specify the maximum
wattage allowed on the interface (4000 to 15400 mW for
most switching modules. As of Cisco IOS release
12.2(44)SG the WS-X4648-RJ45V+E can support up to 30
W available per port and the WS-X4648-RJ45V-E supports
up to 20 W. For more information, see “Enhanced Power PoE
Support on the E-Series Chassis” on page 15).
Use the never keyword to disable detection and power for
the PoE capable interface.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 11-3
Chapter 11 Configuring Power over Ethernet
Power Management Modes
EFT Draft - Conf idential
Command Purpose
Step 3 Switch(config-if)# end Exits configuration mode.
Step 4 Switch# show power inline {fastethernet | Displays the PoE state for the switch.
gigabitethernet} slot/port
Note If you set a non-PoE-capable interface to automatically detect and apply power, an error message
indicates that the configuration is not valid.
The following example shows how to set the Fast Ethernet interface 4/1 to automatically detect PoE and
send power through that interface, and to verify the PoE configuration:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 4/1
Switch(config-if)# power inline auto
Switch(config-if)# end
Switch# show power inline fastethernet 4/1
Available:677(w) Used:11(w) Remaining:666(w)
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Fa4/1 auto on 11.2 10.0 Ieee PD 0
Interface AdminPowerMax AdminConsumption
(Watts) (Watts)
---------- --------------- --------------------
Fa4/1 15.4 10.0
Switch#
The following example shows how to configure an interface so that it never supplies power through the
interface:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 5/2
Switch(config-if)# power inline never
Switch(config-if)# end
Switch#
Intelligent Power Management
All Catalyst 4500 PoE-capable modules use Intelligent Power Management to provide power on each
interface. When a powered device (PD) is attached to a PoE-capable port, the port detects the PD and
provision power accordingly. If a Cisco PD is used, the switch and PD negotiate power using CDP
packets to determine the precise amount of power needed by the PD. If the PD is 802.3af or 802.3at
compatible, the switch and the PD negotiate using LLDP-MED or LLDP Power-Management TLVs if
the TLV is enabled and present. The difference of power in the class-based power allocation and power
negotiation is returned back to the switch power budget for use by other attached devices. So, power
negotiation enables customers to stretch their power budget and use it more effectively.
Power negotiation also enables the interoperability of newer Cisco powered devices with older legacy
PoE-capable ports from Cisco. Newer Cisco PDs do not consume more than what the switch port can
provide.
Software Configuration Guide—Release 15.0(1)XO
11-4 OL-22250-01
Chapter 11 Configuring Power over Ethernet
Configuring Power Consumption for Powered Devices on an Interface
Configuring Power Consumption for Powered Devices
on an Interface
By default, when the switch detects a powered device on an interface, it assumes the powered device
consumes the maximum the port can provide (7 W on a legacy Power over Ethernet (PoE) module and
15.4W on the IEEE PoE modules introduced in Cisco IOS Release 12.2(18)EW). Then, when the switch
receives a CDP/LLDP packet from the powered device, the wattage automatically adjusts downward to
the specific amount required by that device.Normally, this automatic adjustment works well, and no
further configuration is required or recommended. However, you can specify the powered device's
consumption for a particular interface to provide extra functionality from your switch. This behavior is
useful when CDP/LLDP is disabled or not available.
Note When manually configuring the consumption for powered devices, you need to account for the power
loss over the cable between the switch and the powered device.
To change the power consumption of a single powered device, perform this task:
Command Purpose
Step 1 Switch(config)# interface {fastethernet | Selects the interface to configure.
gigabitethernet} slot/port
Step 2 Switch(config-if)# [no] power inline Sets the PoE consumption (in milliwatts) of the powered
consumption milli-watts device connected to a specific interface. The power
consumption can range from 4000 to 15,400.
To re-enable the automatic adjustment of consumption,
either use the no keyword or specify 15,400 milliwatts.
Step 3 Switch(config-if)# end Exits configuration mode.
Step 4 Switch# show power inline consumption Displays the PoE consumption for the interface.
{fastethernet | gigabitethernet} slot/port
This example shows how to set the PoE consumption to 5000 milliwatts for interface gi 7/1 regardless
what is mandated by the 802.3af class of the discovered device, or by any CDP packet received from the
powered device. This example also verifies the PoE consumption on interface gi 7/1.
The following output displays the initial power consumption of the interface.
Switch# show power inline gi 7/1
Available:627(w) Used:267(w) Remaining:360(w)
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Gi7/1 auto on 7.9 7.0 IP Phone 7941 3
Interface AdminPowerMax AdminConsumption
(Watts) (Watts)
---------- --------------- --------------------
Gi7/1 15.4 15.4
Switch# conf terminal
Enter configuration commands, one per line. End with CNTL/Z.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 11-5
Chapter 11 Configuring Power over Ethernet
Displaying the Operational Status for an Interface
EFT Draft - Conf idential
Switch(config)# int gi 7/1
Switch(config-if)# power inline consumption 5000
Switch(config-if)# exit
Switch(config)# exit
The following output displays the power consumption after issuing the power inline consumption
command against the interface:
Switch# show power inline gi 7/1
Available:627(w) Used:265(w) Remaining:362(w)
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Gi7/1 auto on 5.6 5.0 Ieee PD 3
Interface AdminPowerMax AdminConsumption
(Watts) (Watts)
---------- --------------- --------------------
Gi7/1 15.4 5.0
Displaying the Operational Status for an Interface
Each interface has an operational status which reflects the PoE status for an interface. The operational
status for an interface is defined as one of the following:
• on—Power is supplied by the port.
• off—Power is not supplied by the port. If a powered device is connected to an interface with external
power, the switch does not recognize the powered device. The “Device” column in the show power
inline command displays as n/a.
• Power-deny—The supervisor engine does not have enough power to allocate to the port, or the
power that is configured for the port is less than the power required by the port; power is not being
supplied by the port.
• err-disable—The port is unable to provide power to the connected device that is configured in static
mode.
• faulty—The port failed diagnostics tests.
Use the show power inline command to view the operational status for an interface.
This example shows how to display the operational status for all interfaces on module 3.
Switch# show power inline module 3
Available:677(w) Used:117(w) Remaining:560(w)
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Fa3/1 auto on 17.3 15.4 Ieee PD 0
Fa3/2 auto on 4.5 4.0 Ieee PD 1
Fa3/3 auto on 7.1 6.3 Cisco IP Phone 7960 0
Fa3/4 auto on 7.1 6.3 Cisco IP Phone 7960 n/a
Fa3/5 auto on 17.3 15.4 Ieee PD 0
Fa3/6 auto on 17.3 15.4 Ieee PD 0
Software Configuration Guide—Release 15.0(1)XO
11-6 OL-22250-01
Chapter 11 Configuring Power over Ethernet
Displaying the PoE Consumed by a Module
Fa3/7 auto on 4.5 4.0 Ieee PD 1
Fa3/8 auto on 7.9 7.0 Ieee PD 2
Fa3/9 auto on 17.3 15.4 Ieee PD 3
Fa3/10 auto on 17.3 15.4 Ieee PD 4
Fa3/11 auto off 0 0 n/a n/a
Fa3/12 auto off 0 0 n/a n/a
Fa3/13 auto off 0 0 n/a n/a
Fa3/14 auto off 0 0 n/a n/a
Fa3/15 auto off 0 0 n/a n/a
Fa3/16 auto off 0 0 n/a n/a
Fa3/17 auto off 0 0 n/a n/a
Fa3/18 auto off 0 0 n/a n/a
--------- ------ ---------- ---------- ---------- ------------------- -----
Totals: 10 on 117.5 104.6
Switch#
This example shows how to display the operational status for Fast Ethernet interface 4/1:
Switch# show power inline fa4/1
Available:677(w) Used:11(w) Remaining:666(w)
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Fa4/1 auto on 11.2 10.0 Ieee PD 0
Interface AdminPowerMax AdminConsumption
(Watts) (Watts)
---------- --------------- --------------------
Fa4/1 15.4 10.0
Switch#
Displaying the PoE Consumed by a Module
A Catalyst 4500 series switch can measure the actual PoE consumption for an 802.3af-compliant PoE
module. You can observe this consumption with the show power module and show power detail
commands. For all PoE calculations, presume that the PoE consumption on the WS-X4148-RJ45V
module equals its administrative PoE.
The 802.3af-compliant PoE modules can consume up to 20 W of PoE to power FPGAs and other
hardware components on the module. To ensure that the system has sufficient power for the PDs
connected to the switch, add at least 20 W to your PoE requirements for each 802.3af-compliant PoE
module.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 11-7
Chapter 11 Configuring Power over Ethernet
Displaying the PoE Consumed by a Module
EFT Draft - Conf idential
The following example uses the show power module command to display the PoE consumption for an
802.3af-compliant module:
Switch# show power module
Watts Used of System Power (12V)
Mod Model currently out of reset in reset
---- ----------------- --------- ------------ --------
1 WS-X4013+TS 330 330 330
2 WS-X4548-GB-RJ45V 60 60 20
3 WS-X4548-GB-RJ45V 60 60 20
-- Fan Tray 30 -- --
----------------------- --------- ------------ -------
Total 480 450 370
Watts used of Chassis Inline Power (-50V)
Inline Power Admin Inline Power Oper
Mod Model PS Device PS Device Efficiency
---- ----------------- ---------------- ---------------- ----------
2 WS-X4548-GB-RJ45V 138 123 73 65 89
3 WS-X4548-GB-RJ45V 0 0 22 20 89
----------------------- ---------------- ---------------- ----------
Total 138 123 95 85
Watts used of Module Inline Power (12V -> -50V)
Inline Power Admin Inline Power Oper
Mod Model PS Device PS Device Efficiency
---- ----------------- ---------------- ---------------- ----------
1 WS-X4013+TS 128 128 63 63 100
----------------------- ---------------- ---------------- ----------
Switch#
The Inline Power Oper column displays the amount of PoE consumed by the powered devices that are
attached to the module, in addition to the PoE consumed by the FPGAs and other hardware components
on the module.
The Inline Power Admin column displays only the amount of PoE allocated by the powered devices
attached to the module.
Note The operating PoE consumption for an 802.3af-compliant module can be non-zero, even when there are
no powered devices attached to the module, because of the PoE consumed by FPGAs and other hardware
components on the module. In addition, the operating PoE can vary because of fluctuations in the PoE
consumed by the hardware components.
The following example uses the show power detail and show power inline commands to display the
PoE consumption for an 802.3af-compliant module:
Switch# show power detail
Power Fan Inline
Supply Model No Type Status Sensor Status
------ ---------------- --------- ----------- ------- -------
PS1 PWR-C45-1300ACV AC 1300W good good good
PS2 none -- -- -- --
Power supplies needed by system : 1
Power supplies currently available : 1
Software Configuration Guide—Release 15.0(1)XO
11-8 OL-22250-01
Chapter 11 Configuring Power over Ethernet
Displaying the PoE Consumed by a Module
Power Summary Maximum
(in Watts) Used Available
---------------------- ---- ---------
System Power (12V) 480 1000
Inline Power (-50V) 138 800
Backplane Power (3.3V) 0 0
---------------------- ---- ---------
Total 618 (not to exceed Total Maximum Available = 1300)
Module Inline Power Summary (Watts)
(12V -> -48V on board conversion)
---------------------------------
Maximum
Mod Used Available
--- ---- ---------
1 128 158
--- ---- ---------
Watts Used of System Power (12V)
Mod Model currently out of reset in reset
---- ----------------- --------- ------------ --------
1 WS-X4013+TS 330 330 330
2 WS-X4548-GB-RJ45V 60 60 20
3 WS-X4548-GB-RJ45V 60 60 20
-- Fan Tray 30 -- --
----------------------- --------- ------------ -------
Total 480 450 370
Watts used of Chassis Inline Power (-50V)
Inline Power Admin Inline Power Oper
Mod Model PS Device PS Device Efficiency
---- ----------------- ---------------- ---------------- ----------
2 WS-X4548-GB-RJ45V 138 123 73 65 89
3 WS-X4548-GB-RJ45V 0 0 22 20 89
----------------------- ---------------- ---------------- ----------
Total 138 123 95 85
Watts used of Module Inline Power (12V -> -50V)
Inline Power Admin Inline Power Oper
Mod Model PS Device PS Device Efficiency
---- ----------------- ---------------- ---------------- ----------
1 WS-X4013+TS 128 128 64 64 100
----------------------- ---------------- ---------------- ----------
Switch# show power inline g1/1
Module 1 Inline Power Supply: Available:158(w) Used:128(w) Remaining:30(w)
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Gi1/1 auto on 10.3 10.3 CNU Platform 3
Interface AdminPowerMax AdminConsumption
(Watts) (Watts)
---------- --------------- --------------------
Gi1/1 15.4 15.4
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 11-9
Chapter 11 Configuring Power over Ethernet
Displaying the PoE Consumed by a Module
EFT Draft - Conf idential
switch# show power inline g2/1
Chassis Inline Power Supply: Available:800(w) Used:138(w) Remaining:662(w)
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Gi2/1 auto on 11.5 10.2 CNU Platform n/a
Interface AdminPowerMax AdminConsumption
(Watts) (Watts)
---------- --------------- --------------------
Gi2/1 15.4 15.4
Switch# show power inline module 1
Module 1 Inline Power Supply: Available:158(w) Used:128(w) Remaining:30(w)
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Gi1/1 auto on 10.3 10.3 CNU Platform 3
Gi1/2 auto on 10.3 10.3 CNU Platform 3
Gi1/3 auto on 10.3 10.3 CNU Platform 3
Gi1/4 auto on 10.3 10.3 CNU Platform 3
Gi1/5 auto on 10.3 10.3 CNU Platform 3
Gi1/6 auto on 10.3 10.3 CNU Platform 3
Gi1/7 auto on 10.3 10.3 CNU Platform 3
Gi1/8 auto on 10.3 10.3 CNU Platform 3
Gi1/9 auto on 10.3 10.3 CNU Platform 3
Gi1/10 auto on 15.4 15.4 Cisco/Ieee PD 3
Gi1/11 auto on 10.3 10.3 CNU Platform 3
Gi1/12 auto on 10.3 10.3 CNU Platform 3
--------- ------ ---------- ---------- ---------- ------------------- -----
Totals: 12 on 128.2 128.2
switch#
switch# show power inline module 2
Chassis Inline Power Supply: Available:800(w) Used:138(w) Remaining:662(w)
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Gi2/1 auto on 11.5 10.2 CNU Platform n/a
Gi2/2 auto on 11.5 10.2 CNU Platform n/a
Gi2/3 auto on 11.5 10.2 CNU Platform n/a
Gi2/4 auto on 11.5 10.2 CNU Platform n/a
Gi2/5 auto off 0.0 0.0 n/a n/a
Gi2/6 auto off 0.0 0.0 n/a n/a
Gi2/7 auto off 0.0 0.0 n/a n/a
Gi2/8 auto off 0.0 0.0 n/a n/a
Gi2/9 auto on 11.5 10.2 CNU Platform 3
Gi2/10 auto on 11.5 10.2 CNU Platform n/a
Gi2/11 auto on 11.5 10.2 CNU Platform n/a
Gi2/12 auto on 11.5 10.2 CNU Platform n/a
Gi2/13 auto on 11.5 10.2 CNU Platform 3
Gi2/14 auto on 11.5 10.2 CNU Platform 3
Gi2/15 auto on 11.5 10.2 CNU Platform 3
Software Configuration Guide—Release 15.0(1)XO
11-10 OL-22250-01
Chapter 11 Configuring Power over Ethernet
PoE Policing and Monitoring
Gi2/16 auto on 11.5
10.2 CNU Platform 3
Gi2/17 auto off 0.00.0 n/a n/a
Gi2/18 auto off 0.00.0 n/a n/a
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Gi2/19 auto off 0.00.0 n/a n/a
Gi2/20 auto off 0.00.0 n/a n/a
Gi2/21 auto off 0.00.0 n/a n/a
Gi2/22 auto off 0.00.0 n/a n/a
Gi2/23 auto off 0.00.0 n/a n/a
Gi2/24 auto off 0.00.0 n/a n/a
Gi2/25 auto off 0.00.0 n/a n/a
Gi2/26 auto off 0.00.0 n/a n/a
Gi2/27 auto off 0.00.0 n/a n/a
Gi2/28 auto off 0.00.0 n/a n/a
Gi2/29 auto off 0.00.0 n/a n/a
Gi2/30 auto off 0.00.0 n/a n/a
Gi2/31 auto off 0.00.0 n/a n/a
Gi2/32 auto off 0.00.0 n/a n/a
Gi2/33 auto off 0.00.0 n/a n/a
Gi2/34 auto off 0.00.0 n/a n/a
Gi2/35 auto off 0.00.0 n/a n/a
Gi2/36 auto off 0.00.0 n/a n/a
Gi2/37 auto off 0.00.0 n/a n/a
Gi2/38 auto off 0.00.0 n/a n/a
Gi2/39 auto off 0.00.0 n/a n/a
Gi2/40 auto off 0.00.0 n/a n/a
Interface Admin Oper Power(Watts) Device Class
From PS To Device
--------- ------ ---------- ---------- ---------- ------------------- -----
Gi2/41 auto off 0.0 0.0 n/a n/a
Gi2/42 auto off 0.0 0.0 n/a n/a
Gi2/43 auto off 0.0 0.0 n/a n/a
Gi2/44 auto off 0.0 0.0 n/a n/a
Gi2/45 auto off 0.0 0.0 n/a n/a
Gi2/46 auto off 0.0 0.0 n/a n/a
Gi2/47 auto off 0.0 0.0 n/a n/a
Gi2/48 auto off 0.0 0.0 n/a n/a
--------- ------ ---------- ---------- ---------- ------------------- -----
Totals: 12 on 138.2 123.0
Switch#
PoE Policing and Monitoring
Note This functionality is supported on the WS-X4548-RJ45V+, WS-X4648-RJ45V-E, and
WS-X4648-RJ45V+E linecards.
PoE policing protects a switch from faulty inline powered devices that may draw more current than they
were designed for. When a device is connected to a port, a linecard detects the type of device connected
and allocates the appropriate amount of power. It sets a PoE policing threshold to a value 5 per cent
greater than the allocated power. If the device consumes more power than specified by the policing
threshold for a more than 1 second, the port shuts down. Depending on the policing action configured,
the port may then be error-disabled, or a message might be logged to the console and the port restarted.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 11-11
Chapter 11 Configuring Power over Ethernet
PoE Policing and Monitoring
EFT Draft - Conf idential
PoE monitoring lets you display the true power consumption of inline powered devices attached to the
switch, allowing you determine your actual power consumption.
Topics include:
• PoE Policing Modes, page 11-12
• Configuring Power Policing on an Interface, page 11-12
• Displaying Power Policing on an Interface, page 11-13
• Configuring Errdisable Recovery, page 11-14
PoE Policing Modes
PoE policing comprises two modes, which determine the action to take on the interface after a port shuts
down because of an inline-power policing violation:
Logging - An error message is logged to the console and the interface restarts; the device powers up.
Errdisable (Default) - In addition to logging an error message to the console, the interface is placed
in an errdisable state so that the device attached to the port does not receive inline-power until you
restart the port or configure an errdisable autorecovery mechanism.
Note After an inline-power policing violation occurs and the port shuts down, PoE policing automatically
turns on again when the port restarts. So, if the connected device exceeds its allocated power again, the
port once again shuts down.
Configuring Power Policing on an Interface
The default policing levels are determined by the discovery and power allocation methods (listed in
order of priority):
• Configured consumption values, in case any exist
• ?oCDP/LLDP allocated values (for Cisco devices using CDP, or IEEE devices using LLDP)
• Allocated power from IEEE discovery (for devices using this mechanism)
To activate default PoE policing, enter the following:
Switch# conf t
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# int g2/1
Switch(config-if)# power inline police
Switch(config-if)# end
Switch# show power inline police g2/1
Available:800(w) Used:32(w) Remaining:768(w)
Interface Admin Oper Admin Oper Cutoff Oper
State State Police Police Power Power
--------- ------ ---------- ---------- ---------- ------ -----
Gi2/1 auto on errdisable ok 17.2 16.7
Software Configuration Guide—Release 15.0(1)XO
11-12 OL-22250-01
Chapter 11 Configuring Power over Ethernet
PoE Policing and Monitoring
The default action for power policing is to set the port to errdisable; the power inline police command
is equivalent to the power inline police action errdisable command, as the above example illustrates.
The following example illustrates how to configure the logging policing action:
Switch# conf t
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# int g2/1
Switch(config-if)# power inline police action log
Switch(config-if)# end
Switch# show power inline police g2/1
Available:800(w) Used:32(w) Remaining:768(w)
Interface Admin Oper Admin Oper Cutoff Oper
State State Police Police Power Power
--------- ------ ---------- ---------- ---------- ------ -----
Gi2/1 auto on log ok 17.2 16.7
When a PD consumes more than its allocated power, the port shuts down and a warning message similar
to the following appears on the console.
For the WS-X4648-GB-RJ45V and WS-X4648-GB-RJ45V+:
*Sep 12 09:15:28.583: %C4K_ETHPORTMAN-3-INLINEPOWEROVERDRAWN: Inline powered
device connected on port Gi3/25 exceeded its policed threshold.
For the WS-X4548-RJ45V+:
*Sep 26 09:23:21.355: %C4K_SWITCHMANAGER-3-INLINEPOWEROVERDRAWN: Inline
powered device connected on port Gi2/1 exceeded its policed threshold.
For actions of Log type, the port restarts itself and the device reboots. In contrast, when the action is to
set the port in an errdisable state, a log message like the following appears:
*Sep 26 09:30:20.463: %PM-4-ERR_DISABLE: inline-power error detected on Gi2/1, putting
Gi2/1 in err-disable state
Switch# show power inline police g2/1
Available:800(w) Used:16(w) Remaining:784(w)
Interface Admin Oper Admin Oper Cutoff Oper
State State Police Police Power Power
--------- ------ ---------- ---------- ---------- ------ -----
Gi2/1 auto errdisable errdisable overdrawn 0.0 0.0
Displaying Power Policing on an Interface
You can display power policing on an interface, on a module, or for all the PoE-capable linecards in a
chassis.
The following example shows output for the show power inline police command:
Switch# show power inline police
Available:623(w) Used:6(w) Remaining:617(w)
Interface Admin Oper Admin Oper Cutoff Oper
State State Police Police Power Power
--------- ------ ---------- ---------- ---------- ------ -----
Gi2/1 auto off none n/a n/a 0.0
Gi2/2 auto on none n/a n/a 16.7
Gi2/3 auto off errdisable n/a 0.0 0.0
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 11-13
Chapter 11 Configuring Power over Ethernet
PoE Policing and Monitoring
EFT Draft - Conf idential
Gi2/4 auto on errdisable ok 16.6 11.4
Gi2/5 auto on log ok 16.6 11.2
Gi2/6 auto on errdisable overdrawn 0.0 0.0
The following table lists the interface and the status.
Interface Configuration State
Gi2/1 No PD connected, no policing configured.
Gi2/2 PD connected, no policing configured.
Gi2/3 No PD connected, policing configured (gets enabled when PD is
connected). Policing action is errdisable.
Gi2/4 PD connected, policing configured. Configured policing action is
errdisable. Port is currently operating within policing limits.
Gi2/5 PD connected, policing configured. Configured policing action is log.
Port is currently operating within policing limits.
Gi2/6 PD connected, policing configured. Configured policing action is
errdisable. Port is currently in errdisable state as it has overdrawn its
policed power level.
If you enter the show power inline command at the global level (show power inline police), the last
line of the output under the Oper Power field displays the total of true inline power consumption of all
devices connected to the switch.
Configuring Errdisable Recovery
By default, errdisable auto recovery for inline-power is disabled; when an interface is placed in an
errdisable state because of an inline-power policing violation, it remains in that state. You must enter
shut and no shut on the affected interface to revive it.
The errdisable autorecovery mechanism allows you to configure a timer for errdisable recovery so that
when an interface enters errdisable state (after the timer expires), the interface returns from the
errdisable state.
errdisable detection
By default, errdisable detection for inline-power is enabled, as the following example illustrates:
Switch# show errdisable detect
ErrDisable Reason Detection Mode
----------------- --------- ----
inline-power Enabled port
Note If detection is disabled (through the errdisable detect cause inline-power command), the port is not
placed in errdisable state when it exceeds its power policing threshold.
Software Configuration Guide—Release 15.0(1)XO
11-14 OL-22250-01
Chapter 11 Configuring Power over Ethernet
Enhanced Power PoE Support on the E-Series Chassis
errdisable recovery
By default, errdisable recovery for inline-power is disabled. To enable errdisable recovery, enter the
errdisable detect cause line-power command:
Switch# conf t
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# errdisable detect cause inline-power
Switch(config)# end
Switch# show errdisable recovery
ErrDisable Reason Timer Status
----------------- --------------
----------- ----------
inline-power Enabled
Enhanced Power PoE Support on the E-Series Chassis
The WS-X4648-RJ45V-E, WS-X4648-RJ45V+E, and WS-X4548-RJ45V+ switching modules support
IEEE 802.3af PoE as well as the Cisco proprietary Inline Power standard. With
Cisco IOS Release 12.2(44)SG, the WS-X4648-RJ45V+E linecard can also support the IEEE 802.3at
standard with up to 30 W available per port. Furthermore, the WS-X4648-RJ45V-E linecard supports up
to 20 W. The WS-X4548-RJ45V+ switching module is supported with Cisco IOS Release 12.2(50)SG
and can provide up to 30 W of inline power per port. The WS-X4747-RJ45V+ linecard introduced in
Cisco IOS Release 15.0(1)XO provides up to 30 watts per port.
For these switching modules, the valid milliwatt ranges for the power inline command have been
increased appropriately for the module, as the following table illustrates:
Linecard Standard Max Power/Port Cisco IOS Release
WS-X4648-RJ45V-E IEEE 802.3af 20 W 12.2(44)SG
IEEE 802.3at
WS-X4648-RJ45V+E IEEE 802.3af 30 W 12.2(44)SG
IEEE 802.3at
WS-X4548-RJ45V+ IEEE 802.3af 30 W 12.2(50)SG
IEEE 802.3at
WS-X4748-RJ45V+ IEEE 802.3af 30 W 15.0(1)XO
IEEE 802.3at
Ordinarily, the default power inline configurations suffice; no additional configuration is required even
for high power consumption Cisco powered devices (for example, a Cisco AP1250 Wireless Access
Point). When a high power consumption device is attached to a port on a WS-X4648-RJ45V-E or
WS-X4648-RJ45V+E linecard, the switch and device negotiate power using CDP/LLDP packets to
automatically determine the extended amount of power needed by the device.
Depending on the deployment requirements and design, you specify a specific configuration with the
power inline command.
The following example shows how to pre-allocate PoE allocation to 16500 mW for Gi 2/1, regardless of
what is mandated either by the 802.3af class of the discovered device or by any CDP packet that is
received from the powered device:
Switch# configure terminal
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 11-15
Chapter 11 Configuring Power over Ethernet
Enhanced Power PoE Support on the E-Series Chassis
EFT Draft - Conf idential
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface gigabitethernet 2/1
Switch(config-if)# power inline static max 16500
Switch(config-if)# end
Switch#
Software Configuration Guide—Release 15.0(1)XO
11-16 OL-22250-01
CH A P T E R 12
Configuring VLANs, VTP, and VMPS
This chapter describes VLANs on Catalyst 4500 series switches. It also describes how to enable the
VLAN Trunking Protocol (VTP) and to configure the Catalyst 4500 series switch as a VMPS client.
This chapter includes the following major sections:
• VLANs, page 12-1
• VLAN Trunking Protocol, page 12-7
• VLAN Membership Policy Server, page 12-20
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
VLANs
This section includes the following major subsections:
• About VLANs, page 12-1
• VLAN Configuration Guidelines and Restrictions, page 12-3
• VLAN Default Configuration, page 12-4
• Configuring VLANs, page 12-5
About VLANs
A VLAN is a group of devices on one or more LANs that are configured to communicate as if they were
attached to the same wire, when in fact they are located on a number of different LAN segments. Because
VLANs are based on logical instead of physical connections, they are extremely flexible.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-1
Chapter 12 Configuring VLANs, VTP, and VMPS
VLANs
Note VTP version 3 updates do not pass through promiscuous trunk ports.
VLANs define broadcast domains in a Layer 2 network. A broadcast domain is the set of all devices that
receives broadcast frames originating from any device within the set. Broadcast domains are typically
bounded by switches because switches do not forward broadcast frames. Layer 2 switches create
broadcast domains based on the configuration of the switch. Switches are multiport bridges that allow
you to create multiple broadcast domains. Each broadcast domain is like a distinct virtual bridge within
a switch.
You can define one or many virtual bridges within a switch. Each virtual bridge you create in the switch
defines a new broadcast domain (VLAN). Traffic cannot pass directly to another VLAN (between
broadcast domains) within the switch or between two switches. To interconnect two different VLANs,
you must use switches or Layer 3 switches. See the “Overview of Layer 3 Interfaces” section on
page 26-1 for information on inter-VLAN routing on Catalyst 4500 series switches.
Figure 12-1 shows an example of three VLANs that create logically defined networks.
Figure 12-1 Sample VLANs
Engineering Marketing Accounting
VLAN VLAN VLAN
Cisco router
Floor 3
Fast
Ethernet
Floor 2
Floor 1
16751
VLANs are often associated with IP subnetworks. For example, all of the end stations in a particular IP
subnet belong to the same VLAN. Traffic between VLANs must be routed. You must assign LAN
interface VLAN membership on an interface-by-interface basis (this is known as interface-based or
static VLAN membership).
You can set the following parameters when you create a VLAN in the management domain:
• VLAN number
• VLAN name
• VLAN type
Software Configuration Guide—Release 15.0(1)XO
12-2 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLANs
• VLAN state (active or suspended)
• Maximum transmission unit (MTU) for the VLAN
• Security Association Identifier (SAID)
• VLAN number to use when translating from one VLAN type to another
Note When the software translates from one VLAN type to another, it requires a different VLAN number for
each media type.
VLAN Configuration Guidelines and Restrictions
Follow these guidelines and restrictions when creating and modifying VLANs in your network:
• Before creating a VLAN, put the Catalyst 4500 series switch in VTP server mode or VTP
transparent mode. If the Catalyst 4500 series switch is a VTP server, you must define a VTP domain.
For information on configuring VTP, see the section VLAN Trunking Protocol, page 12-7.
• The Cisco IOS end command is not supported in VLAN database mode.
• You cannot use Ctrl-Z to exit VLAN database mode.
• If a Catalyst 4948 switch running MSTP and configured with all possible VLANs (4094) is in the
path of two HSRP peers with the timeout set below 500 ms., HSRP flaps.
Workarounds:
– Use fewer VLANs.
– Set the timers greater than 600 ms.
– Enter the commands no igmp snooping (globally) and access-list hardware capture mode
VLAN.
VLAN Ranges
Note You must enable the extended system ID to use 4094 VLANs. See the “Understanding the Bridge ID”
section on page 16-2.
With Cisco IOS Release 12.2(25)EWA and later, Catalyst 4500 series switches support 4096 VLANs in
compliance with the IEEE 802.1Q standard. These VLANs are organized into three ranges: reserved,
normal, and extended.
Some of these VLANs are propagated to other switches in the network when you use the VLAN
Trunking Protocol (VTP). The extended-range VLANs are not propagated, so you must configure
extended-range VLANs manually on each network device.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-3
Chapter 12 Configuring VLANs, VTP, and VMPS
VLANs
Table 12-1 describes the uses for VLAN ranges.
Table 12-1 VLAN Ranges
Prop
VLANs Range Usage by VT
0, 4095 Reserved For system use only. You cannot see or use these VLANs. —
1 Normal Cisco default. You can use this VLAN but you cannot delete it. Yes
2–1001 Normal Used for Ethernet VLANs; you can create, use, and delete these VLANs. Yes
1002–1005 Normal Cisco defaults for FDDI and Token Ring. You cannot delete VLANs 1002–1005. Yes
1006–4094 Extended For Ethernet VLANs only. When configuring extended-range VLANs, note the No
following:
• Layer 3 ports and some software features require internal VLANs. Internal
VLANs are allocated from 1006 and up. You cannot use a VLAN that has been
allocated for such use. To display the VLANs used internally, enter the show
vlan internal usage command.
• Switches running Catalyst product family software do not support
configuration of VLANs 1006–1024. If you configure VLANs 1006–1024,
ensure that the VLANs do not extend to any switches running Catalyst product
family software.
• You must enable the extended system ID to use extended range VLANs.
Configurable Normal-Range VLAN Parameters
Note Ethernet VLANs 1 and 1006 through 4094 use only default values.
You can configure the following parameters for VLANs 2 through 1001:
• VLAN name
• VLAN type
• VLAN state (active or suspended)
• SAID
• STP type for VLANs
VLAN Default Configuration
Table 12-2 shows the default VLAN configuration values.
Table 12-2 Ethernet VLAN Defaults and Ranges
Parameter Default Valid Values
VLAN ID 1 1–4094
VLAN name VLANx, where x is a number assigned by No range
the software.
Software Configuration Guide—Release 15.0(1)XO
12-4 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLANs
Table 12-2 Ethernet VLAN Defaults and Ranges (continued)
Parameter Default Valid Values
802.10 SAID 100,001 1–4,294,967,294
MTU size 1500 1500–18,190
Translational bridge 1 1002 0–1005
Translational bridge 2 1003 0–1005
VLAN state active active; suspend; shutdown
Note Catalyst 4500 series switches do not support Token Ring or FDDI media. The switch does not forward
FDDI, FDDI-NET, TrCRF, or TrBRF traffic, but it does propagate the VLAN configuration via VTP. The
software reserves parameters for these media types, but they are not truly supported.
Configuring VLANs
Note Before you configure VLANs, you must use VLAN Trunking Protocol (VTP) to maintain global VLAN
configuration information for your network. For complete information on VTP, see the “VLAN Trunking
Protocol” section on page 7.
Note VLANs support a number of parameters that are not discussed in detail in this section. For complete
information, refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference.
Note The VLAN configuration is stored in the vlan.dat file, which is stored in nonvolatile memory. You can
cause inconsistency in the VLAN database if you manually delete the vlan.dat file. If you want to
modify the VLAN configuration or VTP, use the commands described in the following sections and in
the Catalyst 4500 Series Switch Cisco IOS Command Reference.
The following sections describe how to configure VLANs:
• Configuring VLANs in Global Configuration Mode, page 12-5
• Assigning a Layer 2 LAN Interface to a VLAN, page 12-7
Configuring VLANs in Global Configuration Mode
If the switch is in VTP server or transparent mode (see the “VLAN Trunking Protocol” section on
page 12-7), you can configure VLANs in global and VLAN configuration modes. When you configure
VLANs in global and config-vlan configuration modes, the VLAN configuration is saved in the vlan.dat
files, not the running-config or startup-config files. To display the VLAN configuration, enter the show
vlan command.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-5
Chapter 12 Configuring VLANs, VTP, and VMPS
VLANs
If the switch is in VLAN transparent mode, use the copy running-config startup-config command to
save the VLAN configuration to the startup-config file. After you save the running configuration as the
startup configuration, the show running-config and show startup-config commands display the VLAN
configuration.
Note When the switch boots, if the VTP domain name and VTP mode in the startup-config and vlan.dat files
do not match, the switch uses the configuration in the vlan.dat file.
You use the interface configuration command mode to define the port membership mode and add and
remove ports from a VLAN. The results of these commands are written to the running-config file, and
you can display the contents of the file by entering the show running-config command.
User-configured VLANs have unique IDs from 1 to 4094. To create a VLAN, enter the vlan command
with an unused ID. To verify whether a particular ID is in use, enter the show vlan id ID command. To
modify a VLAN, enter the vlan command for an existing VLAN.
See the “VLAN Default Configuration” section on page 12-4 for the list of default parameters that are
assigned when you create a VLAN. If you do not use the media keyword when specifying the VLAN
type, the VLAN is an Ethernet VLAN.
To create a VLAN, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# vlan vlan_ID Adds an Ethernet VLAN.
Switch(config-vlan)#
Note You cannot delete the default VLANs for these media types:
Ethernet VLAN 1 and FDDI or Token Ring VLANs 1002 to
1005.
When you delete a VLAN, any LAN interfaces configured as
access ports assigned to that VLAN become inactive. They
remain associated with the VLAN (and thus inactive) until you
assign them to a new VLAN.
You can use the no keyword to delete a VLAN.
When the prompt reads Switch(config-vlan)#, you are in
vlan-configuration mode. If you wish to change any of the parameters
for the newly created VLAN, use this mode.
Step 3 Switch(config-vlan)# end Returns to enable mode from vlan-configuration mode.
Step 4 Switch# show vlan [id | name] Verifies the VLAN configuration.
vlan_name
When you create or modify an Ethernet VLAN, note the following:
• Because Layer 3 ports and some software features require internal VLANs allocated from 1006 and
up, configure extended-range VLANs starting with 4094 and work downward.
• You can configure extended-range VLANs only in global configuration mode. You cannot configure
extended-range VLANs in VLAN database mode.
• Layer 3 ports and some software features use extended-range VLANs. If the VLAN you are trying
to create or modify is being used by a Layer 3 port or a software feature, the switch displays a
message and does not modify the VLAN configuration.
Software Configuration Guide—Release 15.0(1)XO
12-6 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
• When you create VLANs with the VLAN configuration command, they are automatically added to
the existing VTP domain; no action is required of the user.
This example shows how to create an Ethernet VLAN in global configuration mode and verify the
configuration:
Switch# configure terminal
Switch(config)# vlan 3
Switch(config-vlan)# end
Switch# show vlan id 3
VLAN Name Status Ports
---- -------------------------------- --------- -------------------------------
3 VLAN0003 active
VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
3 enet 100003 1500 - - - - - 0 0
Primary Secondary Type Interfaces
------- --------- ----------------- -------------------------------------------
Switch#
Assigning a Layer 2 LAN Interface to a VLAN
A VLAN created in a management domain remains unused until you assign one or more LAN interfaces
to the VLAN.
Note Make sure you assign LAN interfaces to a VLAN of the proper type. Assign Fast Ethernet, Gigabit
Ethernet, and 10-Gigabit Ethernet interfaces to Ethernet-type VLANs.
To assign one or more LAN interfaces to a VLAN, complete the procedures in the “Configuring Ethernet
Interfaces for Layer 2 Switching” section on page 14-5.
VLAN Trunking Protocol
This section describes the VLAN Trunking Protocol (VTP) on the Catalyst 4500 series switches.
This section includes the following major subsections:
• About VTP, page 12-7
• VTP Configuration Guidelines and Restrictions, page 12-12
• VTP Default Configuration, page 12-13
• Configuring VTP, page 12-14
About VTP
VTP is a Layer 2 messaging protocol that maintains VLAN configuration consistency by managing the
addition, deletion, and renaming of VLANs within a VTP domain. A VTP domain (also called a VLAN
management domain) is made up of one or more network devices that share the same VTP domain name
and that are interconnected with trunks. VTP minimizes misconfigurations and configuration
inconsistencies that can result in a number of problems, such as duplicate VLAN names, incorrect
VLAN-type specifications, and security violations.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-7
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
Before you create VLANs, you must decide whether you want to use VTP in your network. With VTP,
you can make configuration changes centrally on one or more network devices and have those changes
automatically communicated to all the other network devices in the network. For details on configuring
VLANs, see VLANs, page 12-1
These sections describe how VTP works:
• Understanding the VTP Domain, page 12-8
• Understanding VTP Modes, page 12-8
• Understanding VTP Advertisements, page 12-9
• Understanding VTP Versions, page 12-9
• Understanding VTP Pruning, page 12-11
Understanding the VTP Domain
A VTP domain is made up of one or more interconnected network devices that share the same VTP
domain name. A network device can be configured to be in only one VTP domain. You make global
VLAN configuration changes for the domain using either the command-line interface (CLI) or Simple
Network Management Protocol (SNMP).
By default, the Catalyst 4500 series switch is in VTP server mode and the domain is set to NULL until
the switch receives an advertisement for a domain over a trunk link or you configure a management
domain. You cannot create or modify VLANs on a VTP server until the management domain name is
specified or learned.
If the switch receives a VTP advertisement over a trunk link, it inherits the management domain name
and the VTP configuration revision number. The switch ignores advertisements with a different
management domain name or an earlier configuration revision number.
If you configure the switch as VTP transparent, you can create and modify VLANs, but the changes
affect only the individual switch.
When you make a change to the VLAN configuration on a VTP server, the change is propagated to all
network devices in the VTP domain. VTP advertisements are transmitted out all Inter-Switch Link (ISL)
and IEEE 802.1Q trunk connections.
VTP maps VLANs dynamically across multiple LAN types with unique names and internal index
associations. Mapping eliminates unnecessary device administration for network administrators.
Understanding VTP Modes
You can configure a Catalyst 4500 series switch to operate in any one of these VTP modes:
• Server—In VTP server mode, you can create, modify, and delete VLANs and specify other
configuration parameters (such as VTP version and VTP pruning) for the entire VTP domain. VTP
servers advertise their VLAN configuration to other network devices in the same VTP domain and
synchronize their VLAN configuration with other network devices based on advertisements received
over trunk links. VTP server is the default mode.
Note In VTP version 3, manipulation of VLANs can be done only to primary servers.
• Client—VTP clients behave the same way as VTP servers, but you cannot create, change, or delete
VLANs on a VTP client.
Software Configuration Guide—Release 15.0(1)XO
12-8 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
• Transparent—VTP transparent network devices do not participate in VTP. A VTP transparent
network device does not advertise its VLAN configuration and does not synchronize its VLAN
configuration based on received advertisements. However, in VTP version 2, transparent network
devices do forward VTP advertisements that they receive on their trunking LAN interfaces.
• Off—In VTP off mode, a network device functions in the same manner as a VTP transparent device
except that it does not forward VTP advertisements.
Note Catalyst 4500 series switches automatically change from VTP server mode to VTP client mode if the
switch detects a failure while writing configuration to NVRAM. If this happens, the switch cannot be
returned to VTP server mode until the NVRAM is functioning.
Understanding VTP Advertisements
Each network device in the VTP domain sends periodic advertisements out each trunking LAN interface
to a reserved multicast address. VTP advertisements are received by neighboring network devices, which
update their VTP and VLAN configurations as necessary.
The following global configuration information is distributed in VTP advertisements:
• VLAN IDs (ISL and 802.1Q)
• Emulated LAN names (for ATM LANE)
• 802.10 SAID values (FDDI)
• VTP domain name
• VTP configuration revision number
• VLAN configuration, including maximum transmission unit (MTU) size for each VLAN
• Frame format
Understanding VTP Versions
VTP Version 2
If you use VTP in your network, you must decide whether to use VTP version 1 or version 2.
Note Catalyst 4500 series switches do not support Token Ring or FDDI media. The switch does not forward
FDDI, FDDI-Net, Token Ring Concentrator Relay Function [TrCRF], or Token Ring Bridge Relay
Function [TrBRF] traffic, but it does propagate the VLAN configuration via VTP.
VTP version 2 supports the following features, which are not supported in version 1:
• Token Ring support—VTP version 2 supports Token Ring LAN switching and VLANs (TrBRF and
TrCRF).
• Unrecognized Type-Length-Value (TLV) Support—A VTP server or client propagates configuration
changes to its other trunks, even for TLVs it is not able to parse. The unrecognized TLV is saved in
NVRAM.
• Version-Dependent Transparent Mode—In VTP version 1 and version 2, a VTP transparent network
device forwards VTP messages in transparent mode without checking the version.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-9
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
• Consistency Checks—In VTP version 2, VLAN consistency checks (such as VLAN names and
values) are performed only when you enter new information through the CLI or SNMP. Consistency
checks are not performed when new information is obtained from a VTP message or when
information is read from NVRAM. If the digest on a received VTP message is correct, its
information is accepted without consistency checks.
VTP Version 3
VTP version 3 supports the following features not supported in version 1 or version 2:
• Hidden Password Support—VTP version 3 supports the option of configuring the password as
hidden or secret.
When the hidden keyword is specified, that password must be reentered if a takeover command is
issued in the domain. The secret key generated from the password string is saved in the
const_nvram:vlan.dat file. When configured with this option, the password does not appear in plain
text in the configuration. Instead, the secret key associated with the password is saved in
hexadecimal format in the running configuration. If the hidden keyword is not specified, the
password is saved in clear text in the const_nvram:vlan.dat file as in VTP version 1 and VTP
version 2.
When the secret keyword is specified, the password secret key can be directly configured.
• Support for extended VLAN Database Propagation—In VTP version 2, VLAN configuration
information is propagated only for VLANs numbered 1 to 1000. In VTP version 3, information also
is propagated for extended-range VLANs (VLANs numbered 1006 to 4094).
• On Catalyst 4500 series switches running VTP version 1, VTP version 2, or VTP version 3, default
VLANs 1 and 1002 to 1005 cannot be modified.
Note VTP pruning continues to apply only to VLANs numbered 1 to 1000.
• Propagation of Any Database in a Domain—In addition to propagating VLAN database information,
VTP can propagate Multiple Spanning Tree (MST) protocol database information.
• Disabling VTP—When VTP is disabled on a trunking port, it applies to all VTP instances on that
port. When VTP is disabled globally, the setting applies to all the trunking ports in the system.
• In VTP version 1 and VTP version 2, the role of a VTP server is to back up the database to NVRAM
and to allow the administrator to change database information. VTP version 3 introduces the roles
of VTP Primary Server and VTP Secondary Server. A VTP Primary Server is used to update the
database information. The updates sent out are honored by all the devices in the system. A VTP
Secondary Server can only back up to its NVRAM the VTP configuration received via updates from
the VTP Primary Server.
The status of primary and secondary servers is a runtime status and is not a configurable option. By
default, all devices are initiated as secondary servers. Primary server status is needed only when
database updates are needed, and is obtained when the administrator issues a takeover message in
the domain. (See the “Starting a Takeover” section on page 12-19.)
Primary server status is lost upon reload of the device, or when switchover or domain parameters
change. Secondary servers back up the configuration and continue to propagate it. Because of that,
it is possible to have a working VTP domain without any primary servers.
Software Configuration Guide—Release 15.0(1)XO
12-10 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
Understanding VTP Pruning
VTP pruning enhances network bandwidth use by reducing unnecessary flooded traffic, such as
broadcast, multicast, and unicast packets. VTP pruning increases available bandwidth by restricting
flooded traffic to those trunk links that the traffic must use to access the appropriate network devices.
By default, VTP pruning is disabled.
For VTP pruning to be effective, all devices in the management domain must either support VTP pruning
or, on devices that do not support VTP pruning, you must manually configure the VLANs allowed on
trunks.
Figure 12-2 shows a switched network without VTP pruning enabled. Interface 1 on Switch 1 and
Interface 2 on Switch 4 are assigned to the Red VLAN. A broadcast is sent from the host connected to
Switch 1. Switch 1 floods the broadcast and every network device in the network receives it, even though
Switches 3, 5, and 6 have no interfaces in the Red VLAN.
You can enable pruning globally on the Catalyst 4500 series switch (see the “Enabling VTP Pruning”
section on page 12-15).
Figure 12-2 Flooding Traffic without VTP Pruning
Catalyst series
switch 4
Interface 2
Catalyst series Catalyst series
switch 5 switch 2
Red
VLAN
Interface 1
94151
Catalyst series Catalyst series Catalyst series
switch 6 switch 3 switch 1
Figure 12-3 shows the same switched network with VTP pruning enabled. The broadcast traffic from
Switch 1 is not forwarded to Switches 3, 5, and 6 because traffic for the Red VLAN has been pruned on
the links indicated (Interface 5 on Switch 2 and Interface 4 on Switch 4).
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-11
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
Figure 12-3 Flooding Traffic with VTP Pruning
Switch 4
Interface 2
Interface 4
Flooded traffic
is pruned.
Switch 2
Red
VLAN
Switch 5 Interface 5
Interface 1
31075
Switch 6 Switch 3 Switch 1
Enabling VTP pruning on a VTP server enables pruning for the entire management domain. VTP pruning
takes effect several seconds after you enable it. By default, VLANs 2 through 1000 are eligible for
pruning. VTP pruning does not prune traffic from pruning-ineligible VLANs. VLAN 1 is always
ineligible for pruning; traffic from VLAN 1 cannot be pruned.
To configure VTP pruning on a trunking LAN interface, use the switchport trunk pruning vlan
command. VTP pruning operates when a LAN interface is trunking. You can set VLAN pruning
eligibility regardless of whether VTP pruning is enabled or disabled for the VTP domain, whether any
given VLAN exists, and regardless of whether the LAN interface is currently trunking.
VTP Configuration Guidelines and Restrictions
Follow these guidelines and restrictions when implementing VTP in your network:
• Supervisor engine redundancy does not support nondefault VLAN data file names or locations. Do
not enter the vtp file file_name command on a switch that has a redundant supervisor engine.
• Before installing a redundant supervisor engine, enter the no vtp file command to return to the
default configuration.
• When a VTP version 3 device on a trunk port receives messages from a VTP version 2 device, it
sends a scaled-down version of the VLAN database on that particular trunk in a VTP version 2
format. A VTP version 3 device does not send out VTP version 2 formatted packets on a trunk port
unless it first receives VTP version 2 packets on that trunk.
• Even when a VTP version 3 device detects a VTP version 2 device on a trunk port, it continues to
send VTP version 3 packets in addition to VTP version 2 packets, to allow co-existence of two kinds
of neighbors off the trunk.
• A VTP version 3 device does not accept configuration information from a VPT version 2 or
version 1 device.
• Unlike in VPT version 2, when VTP is configured to be version 3, this does not configure all the
version-3-capable devices in the domain to start behaving as VPT version 3 systems.
• When a VTP version 1 device, capable of version 2 or version 3, receives a VTP version 3 packet,
the device is configured as a VTP version 2 device provided a VTP version 2 conflict does not exist.
• Devices that are only VTP version 1 capable cannot interoperate with VTP version 3 devices.
Software Configuration Guide—Release 15.0(1)XO
12-12 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
• In a Token Ring environment, you must enable VTP version 2 or version 3 for Token Ring VLAN
switching to function properly.
• Two VPT version 3 regions can only communicate in transparent mode over a VTP version 1 or VTP
version 2 region.
• All network devices in a VTP domain must run the same VTP version.
• You must configure a password on each network device in the management domain when VTP is in
secure mode.
Caution If you configure VTP in secure mode, the management domain does not function properly if you do not
assign a management domain password to each network device in the domain.
• A VTP version 2-capable network device can operate in the same VTP domain as a network device
running VTP version 1 if VTP version 2 is disabled on the VTP version 2-capable network device
(VTP version 2 is disabled by default).
• Do not enable VTP version 2 on a network device unless all of the network devices in the same VTP
domain are version 2-capable. When you enable VTP version 2 on a server, all of the
version 2-capable network devices in the domain enable VTP version 2.
• Enabling or disabling VTP pruning on a VTP server enables or disables VTP pruning for the entire
management domain.
• Configuring VLANs as eligible for pruning on a Catalyst 4500 series switch affects pruning
eligibility for those VLANs on that switch only, not on all network devices in the VTP domain.
• The VLAN database is saved in the NVRAM file in a format compliant with the VTP version
running on the system. Since older images supporting only VTP version 2 do not recognize the VTP
version 3 file format, the NVRAM VLAN database information is lost if the system is downgraded
from a new image supporting VTP to one that does not.
VTP Default Configuration
Table 12-3 shows the default VTP configuration.
Table 12-3 VTP Default Configuration
Feature Default Value
VTP domain name Null
VTP mode Server
VTP version 2 enable state Version 2 is disabled
VTP password None
VTP pruning Disabled
The default VTP mode for newly manufactured Catalyst 4500 supervisor engines, Catalyst 4900 series
switches, and the Cisco ME 4924-10GE switch is transparent. Deleting vlan.dat or issuing the
erase cat4000_flash: command, and resetting the switch changes the VTP mode to server.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-13
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
Configuring VTP
These sections describe how to configure VTP:
• Configuring VTP Global Parameters, page 12-14
• Configuring the VTP Mode, page 12-16
• Starting a Takeover, page 12-19
• Displaying VTP Statistics, page 12-19
• Displaying VTP Devices in a Domain, page 12-20
Configuring VTP Global Parameters
These sections describe configuring the VTP global parameters:
• Configuring a VTP Password, page 12-14
• Enabling VTP Pruning, page 12-15
• Enabling the VTP Version Number, page 12-15
Note You can enter the VTP global parameters in either global configuration mode or in EXEC mode.
Configuring a VTP Password
To configure the VTP global parameters, use these commands:
Command Purpose
Switch(config)# vtp password Sets a password, which can be from 8 to
password_string [hidden | secret] 64 characters long, for the VTP domain.
In VTP version 3 the keywords hidden and secret
are available.
• If the hidden keyword is used, the secret key
generated from the password string is saved
in the const_nvram:vlan.dat file. If a takeover
command is issued, that password must be
reentered.
• If the secret keyword is used, the password
secret key can be directly configured. The
secret password must contain 32
hexadecimal characters.
Switch(config)# no vtp password Clears the password.
This example shows one way to configure a VTP password in global configuration mode:
Switch# configure terminal
Switch(config)# vtp password WATER
Setting device VLAN database password to WATER.
Switch#
This example shows how to configure a VTP password in EXEC mode:
Software Configuration Guide—Release 15.0(1)XO
12-14 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
Switch# vtp password WATER
Setting device VLAN database password to WATER.
Switch#
Note The password is not stored in the running-config file.
This example shows how to configure a hidden password:
Switch# configure terminal
Switch(config)# vtp password WATER hidden
Generating the secret associated to the password.
Switch(config)#
This example shows how the password WATER is displayed when it is configured with the hidden
keyword.
Switch# show vtp password
VTP Password: 89914640C8D90868B6A0D8103847A733
Switch#
Enabling VTP Pruning
To enable VTP pruning in the management domain, perform this task:
Command Purpose
Step 1 Switch(config)# vtp pruning Enables VTP pruning in the management domain.
Step 2 Switch# show vtp status | include pruning (Optional) Verifies the configuration.
This example shows one way to enable VTP pruning in the management domain:
Switch# configure terminal
Switch(config)# vtp pruning
Pruning switched ON
This example shows how to enable VTP pruning in the management domain with any release:
Switch# vtp pruning
Pruning switched ON
This example shows how to verify the configuration:
Switch# show vtp status | include Pruning
VTP Pruning Mode: Enabled
Switch#
For information about configuring prune eligibility, see the “Understanding VTP Pruning” section on
page 12-11.
Enabling the VTP Version Number
VTP version 2 is disabled by default on VTP version-2-capable network devices. When you enable VTP
version 2 on a network device, every VTP version-2-capable network device in the VTP domain enables
version 2.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-15
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
Caution VTP version 1 and VTP version 2 are not interoperable on network devices in the same VTP domain.
Every network device in the VTP domain must use the same VTP version. Do not enable VTP version 2
unless every network device in the VTP domain supports version 2.
Note In a Token Ring environment, you must enable VTP version 2 or VTP version 3 for Token Ring VLAN
switching to function properly on devices that support Token Ring interfaces.
To enable the VTP version, perform this task:
Command Purpose
Step 1 Switch(config)# vtp version {1 | 2 | 3} Enables the VTP version.
Step 2 Switch# show vtp status | include {v1 | v2 | v3} (Optional) Verifies the configuration.
This example shows one way to enable VTP version 2:
Switch# configure terminal
Switch(config)# vtp version 2
V2 mode enabled.
Switch(config)#
This example shows how to enable VTP version 2 with any release:
Switch# vtp version 2
V2 mode enabled.
Switch#
This example shows how to verify the configuration:
Switch# show vtp status | include V2
VTP V2 Mode: Enabled
Switch#
Configuring the VTP Mode
To configure the VTP mode, perform this task:
Command Purpose
Step 1 Switch(config)# vtp mode {client | server | Configures the VTP mode.
transparent | off}
Step 2 Switch(config)# vtp domain domain_name (Optional; for server mode only) Defines the VTP domain
name, which can be up to 32 characters long. VTP server
mode requires a domain name. If the switch has a trunk
connection to a VTP domain, the switch learns the
domain name from the VTP server in the domain.
Note You cannot clear the domain name.
Step 3 Switch(config)# end Exits VLAN configuration mode.
Step 4 Switch# show vtp status (Optional) Verifies the configuration.
Software Configuration Guide—Release 15.0(1)XO
12-16 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
Note When VTP is disabled, you can enter VLAN configuration commands in configuration mode instead of
the VLAN database mode and the VLAN configuration is stored in the startup configuration file.
This example shows how to configure the switch as a VTP server:
Switch# configure terminal
Switch(config)# vtp mode server
Setting device to VTP SERVER mode.
Switch(config)# vtp domain Lab_Network
Setting VTP domain name to Lab_Network
Switch(config)# end
Switch#
This example shows how to configure the switch as a VTP client:
Switch# configure terminal
Switch(config)# vtp mode client
Setting device to VTP CLIENT mode.
Switch(config)# end
Switch#
This example shows how to disable VTP on the switch:
Switch# configure terminal
Switch(config)# vtp mode transparent
Setting device to VTP TRANSPARENT mode.
Switch(config)# end
Switch#
This example shows how to disable VTP on the switch and to disable VTP advertisement forwarding:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# vtp mode off
Setting device to VTP OFF mode.
Switch(config)# end
Switch#
This example shows an example of the VTP configuration parameters when the device is running VTP
version 1:
Switch# show vtp status
VTP Version capable : 1 to 3
VTP version running : 1
VTP Domain Name : Lab_Network
VTP Pruning Mode : Enabled
VTP Traps Generation : Disabled
Device ID : 0016.9c6d.5300
Configuration last modified by 127.0.0.12 at 10-18-07 10:12:42
Local updater ID is 127.00.12 at 10-18-07 10:2:42
Feature VLAN:
--------------
VTP Operating Mode : Server
Maximum number of existing VLANs : 5
Configuration Revision : 1
MD5 digest : 0x92 0xF1 0xE8 0x52 0x2E ox5C 0x36 0x10 0x70 0x61 0xB8
0x24 0xB6 0x93 0x21 0x09
Switch#
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-17
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
This example shows an example of the VTP configuration parameters when the device is running VTP
version 2:
Switch# show vtp status
VTP Version capable : 1 to 3
VTP version running : 2
VTP Domain Name : Lab_Network
VTP Pruning Mode : Disabled
VTP Traps Generation : Disabled
Device ID : 0012.44dc.b800
Configuration lst modified by 127.0.0.12 at 10-18-07 10:38:45
Local updater ID is 127.0.0.12 on interface EO 0/0 (first interface found)
Feature VLAN:
--------------
VTP Operating Mode : Server
Maximum VLANs supported locally: 1005
Number of existing VLANs : 1005
Configuration Revision : 1
MD5 digest : 0x2E 0x6B 0x99 0x58 0xA2 0x4F 0xD5 0x150x70 0x61 0xB8
0x24 0xB6 0x93 0x21 0x09
Switch#
This example shows an example of the VTP configuration parameters when the device is running VTP
version 3:
Switch# show vtp status
VTP Version capable : 1 to 3
VTP version running : 3
VTP Domain Name : Lab_Network
VTP Pruning Mode : Disabled
VTP Traps Generation : Disabled
Device ID : 0012.44dc.b800
Feature VLAN:
--------------
VTP Operating Mode : Server
Number of existing VLANs : 1005
Number of existing extended VLANs: 3074
Configuration Revision : 18
Primary ID : 0012.4371.9ec0
Primary Description :
Switch#
Software Configuration Guide—Release 15.0(1)XO
12-18 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Trunking Protocol
Starting a Takeover
This process applies to VTP version 3 only. To start a takeover, perform this task:
Command Purpose
Switch# vtp primary-server [vlan | mst]| [force] Changes the operational state of a switch from a
secondary to a primary server and advertises the
configuration to the whole domain. (If the password for
this device is configured with the hidden keyword, the
user is prompted to re-enter it.)
Note Using the force keyword overwrites the
configuration of any conflicting servers. If not
using the force keyword, you are prompted for
confirmation prior to proceeding with the
takeover.
Specify where to direct the takeover by selecting the
appropriate feature (vlan or mst). If no feature is
selected, the takeover is directed to the VLAN database.
This example shows how to start a takeover and direct it to the vlan database:
Switch# vtp primary-server vlan
Enter VTP password:password
This system is becoming primary for feature vlan
VTP Feature Conf Revision Primary Server Device ID Description
----------- ------------- -------------- -------- -------------------
MST Yes 4 0012.4371.9ec0=0012.4371.9ec0 R1
Do you want to continue? (confirm)
Switch#
Displaying VTP Statistics
To display VTP statistics, including VTP advertisements sent and received and VTP errors, perform this
task:
Command Purpose
Switch# show vtp counters Displays VTP statistics.
This example shows how to display VTP statistics:
Switch# show vtp counters
VTP statistics:
Summary advertisements received : 7
Subset advertisements received : 5
Request advertisements received : 0
Summary advertisements transmitted : 997
Subset advertisements transmitted : 13
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-19
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
Request advertisements transmitted : 3
Number of config revision errors : 0
Number of config digest errors : 0
Number of V1 summary errors : 0
VTP pruning statistics:
Trunk Join Transmitted Join Received
Summary advts received from
non-pruning-capable device
---------------- ---------------- ---------------- ---------------------------
Fa5/8 43071 42766 5
Displaying VTP Devices in a Domain
To display information for all the VTP devices in a domain, perform this task:
Command Purpose
Switch# show vtp devices [conflicts] Gathers and displays information for all the VTP devices
in the domain.
Note No information is gathered or displayed from
switchs set to vtp modes off or to transparent
for a particular feature.
The conflicts keyword (optional) displays the
information of devices that have conflicting primary
servers.
This example shows how to display information for VTP devices in a domain:
Switch# show vtp devices
Retrieving information from the VTP domain, please wait for 5 seconds.
VTP Feature Conf Revision Primary Server Device ID Device Description
----------- ---- -------- ------------------------------ ------------------
VLAN No 18 0016.9c6d.5300 0012.011a.0d00 R2
VLAN No 18 0016.9c6d.5300 0012.4371.9ec0 R1
MST Yes 4 0012.4371.9ec0=0012.4371.9ec0 R1
Switch#
VLAN Membership Policy Server
This section describes how to configure dynamic port VLAN membership through the VLAN
Membership Policy Server (VMPS).
This section includes the following subsections:
• About VMPS, page 12-21
• Overview of VMPS Clients, page 12-23
• Dynamic Port VLAN Membership Configuration Example, page 12-29
• VMPS Database Configuration File Example, page 12-32
Software Configuration Guide—Release 15.0(1)XO
12-20 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
About VMPS
These subsections describe what a VMPS server does and how it operates:
• VMPS Server, page 12-21
• Security Modes for VMPS Server, page 12-22
• Fallback VLAN, page 12-23
• Illegal VMPS Client Requests, page 12-23
VMPS Server
A VLAN Membership Policy Server (VMPS) provides a centralized server for selecting the VLAN for
a port dynamically based on the MAC address of the device connected to the port. When the host moves
from a port on one switch in the network to a port on another switch in the network, that switch
dynamically assigns the new port to the proper VLAN for that host.
A Catalyst 4500 series switch running Cisco IOS software does not support the functionality of a VMPS.
It can only function as a VLAN Query Protocol (VQP) client, which communicates with a VMPS
through the VQP. For VMPS functionality, you need to use a Catalyst 4500 series switch (or Catalyst
6500 series switch) running Catalyst operating system (OS) software.
VMPS uses a UDP port to listen to VQP requests from clients, so, it is not necessary for VMPS clients
to know if the VMPS resides on a local or remote device on the network. Upon receiving a valid request
from a VMPS client, a VMPS server searches its database for an entry of a MAC-address to VLAN
mapping.
In response to a request, the VMPS takes one of the following actions:
• If the assigned VLAN is restricted to a group of ports, the VMPS verifies the requesting port against
this group and responds as follows:
– If the VLAN is allowed on the port, the VMPS sends the VLAN name to the client in response.
– If the VLAN is not allowed on the port and the VMPS is not in secure mode, the VMPS sends
an “access-denied” response.
– If the VLAN is not allowed on the port and the VMPS is in secure mode, the VMPS sends a
“port-shutdown” response.
• If the VLAN in the database does not match the current VLAN on the port and there are active hosts
on the port, the VMPS sends an “access-denied” (open), a “fallback VLAN name” (open with
fallback VLAN configured), a “port-shutdown” (secure), or a “new VLAN name” (multiple)
response, depending on the secure mode setting of the VMPS.
If the switch receives an “access-denied” response from the VMPS, the switch continues to block
traffic from the MAC address to or from the port. The switch continues to monitor the packets
directed to the port and sends a query to the VMPS when it identifies a new address. If the switch
receives a “port-shutdown” response from the VMPS, the switch disables the port. The port must be
manually re-enabled by using the CLI, Cisco Visual Switch Manager (CVSM), or SNMP.
You can also use an explicit entry in the configuration table to deny access to specific MAC
addresses for security reasons. If you enter the none keyword for the VLAN name, the VMPS sends
an “access-denied” or “port-shutdown” response.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-21
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
Security Modes for VMPS Server
VMPS operates in three different modes. The way a VMPS server responds to illegal requests depends
on the mode in which the VMPS is configured:
• Open Mode, page 12-22
• Secure Mode, page 12-22
• Multiple Mode, page 12-22
Open Mode
If no VLAN is assigned to this port, VMPS verifies the requesting MAC address against this port:
• If the VLAN associated with this MAC address is allowed on the port, the VLAN name is returned
to the client.
• If the VLAN associated with this MAC address is not allowed on the port, the host receives an
“access denied” response.
If a VLAN is already assigned to this port, VMPS verifies the requesting MAC address against this port:
• If the VLAN associated with this MAC address in the database does not match the current VLAN
assigned on the port, and a fallback VLAN name is configured, VMPS sends the fallback VLAN
name to the client.
• If a VLAN associated with this MAC address in the database does not match the current VLAN
assigned on the port, and a fallback VLAN name is not configured, the host receives an “access
denied” response.
Secure Mode
If no VLAN is assigned to this port, VMPS verifies the requesting MAC address against this port:
• If the VLAN associated with this MAC address is allowed on the port, the VLAN name is returned
to the client.
• If the VLAN associated with this MAC address is not allowed on the port, the port is shut down.
If a VLAN is already assigned to this port, VMPS verifies the requesting MAC address against this port:
• If a VLAN associated with this MAC address in the database does not match the current VLAN
assigned on the port, the port is shutdown, even if a fallback VLAN name is configured.
Multiple Mode
Multiple hosts (MAC addresses) can be active on a dynamic port if they are all in the same VLAN. If the
link fails on a dynamic port, the port returns to the unassigned state. Any hosts that come online through
the port are checked again with VMPS before the port is assigned to a VLAN.
If multiple hosts connected to a dynamic port belong to different VLANs, the VLAN matching the MAC
address in the last request is returned to the client provided that multiple mode is configured on the
VMPS server.
Note Although Catalyst 4500 series and Catalyst 6500 series switches running Catalyst operating system
software support VMPS in all three operation modes, the User Registration Tool (URT) supports open
mode only.
Software Configuration Guide—Release 15.0(1)XO
12-22 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
Fallback VLAN
You can configure a fallback VLAN name on a VMPS server.
If no VLAN has been assigned to this port, VMPS compares the requesting MAC address to this port:
• If you connect a device with a MAC address that is not in the database, the VMPS sends the fallback
VLAN name to the client.
• If you do not configure a fallback VLAN name and the MAC address does not exist in the database,
the VMPS sends an “access-denied” response.
If a VLAN is already assigned to this port, VMPS compares the requesting MAC address to this port:
• If the VMPS is in secure mode, it sends a “port-shutdown” response, whether a fallback VLAN has
been configured on the server.
Illegal VMPS Client Requests
Two examples of illegal VMPS client requests are as follows:
• When a MAC-address mapping is not present in the VMPS database and “no fall back” VLAN is
configured on the VMPS.
• When a port is already assigned a VLAN (and the VMPS mode is not “multiple”) but a second
VMPS client request is received on the VMPS for a different MAC-address.
Overview of VMPS Clients
The following subsections describe how to configure a switch as a VMPS client and configure its ports
for dynamic VLAN membership.
The following topics are included:
• Understanding Dynamic VLAN Membership, page 12-23
• Default VMPS Client Configuration, page 12-24
• Configuring a Switch as a VMPS Client, page 12-24
• Administering and Monitoring the VMPS, page 12-28
• Troubleshooting Dynamic Port VLAN Membership, page 12-29
Understanding Dynamic VLAN Membership
When a port is configured as “dynamic,” it receives VLAN information based on the MAC-address that
is on the port. The VLAN is not statically assigned to the port; it is dynamically acquired from the VMPS
based on the MAC-address on the port.
A dynamic port can belong to one VLAN only. When the link becomes active, the switch does not
forward traffic to or from this port until the port is assigned to a VLAN. The source MAC address from
the first packet of a new host on the dynamic port is sent to the VMPS as part of the VQP request, which
attempts to match the MAC address to a VLAN in the VMPS database. If there is a match, the VMPS
sends the VLAN number for that port. If there is no match, the VMPS either denies the request or shuts
down the port (depending on the VMPS security mode setting). See the “About VMPS” section on
page 12-21 for a complete description of possible VMPS responses.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-23
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
Multiple hosts (MAC addresses) can be active on a dynamic port if all are in the same VLAN. If the link
goes down on a dynamic port, the port returns to the unassigned state and does not belong to a VLAN.
Any hosts that come online through the port are checked again with the VMPS before the port is assigned
to a VLAN.
For this behavior to work, the client device must be able to reach the VMPS. A VMPS client sends VQP
requests as UDP packets, trying a certain number of times before giving up. For details on how to set the
retry interval, refer to section “Configuring the Retry Interval” on page 27.
The VMPS client also periodically reconfirms the VLAN membership. For details on how to set the
reconfirm frequency, refer to section “Administering and Monitoring the VMPS” on page 28.
A maximum of 50 hosts are supported on a given port at any given time. After this maximum is exceeded,
the port is shut down, irrespective of the operating mode of the VMPS server.
Note The VMPS shuts down a dynamic port if more than 50 hosts are active on that port.
Default VMPS Client Configuration
Table 12-4 shows the default VMPS and dynamic port configuration on client switches.
Table 12-4 Default VMPS Client and Dynamic Port Configuration
Feature Default Configuration
VMPS domain server None
VMPS reconfirm interval 60 minutes
VMPS server retry count 3
Dynamic ports None configured
Configuring a Switch as a VMPS Client
This section contains the following topics:
• Configuring the IP Address of the VMPS Server, page 12-24
• Configuring Dynamic Access Ports on a VMPS Client, page 12-25
• Reconfirming VLAN Memberships, page 12-26
• Configuring Reconfirmation Interval, page 12-26
• Reconfirming VLAN Memberships, page 12-26
Configuring the IP Address of the VMPS Server
To configure a Catalyst 4500 series switch as a VMPS client, you must enter the IP address or hostname
of the switch acting as the VMPS.
Software Configuration Guide—Release 15.0(1)XO
12-24 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
To define the primary and secondary VMPS on a Catalyst 4500 series switch, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# vmps server Specifies the IP address or hostname of the switch acting as the
{ipaddress | hostname} primary primary VMPS server.
Step 3 Switch(config)# vmps server Specifies the IP address or hostname of the switch acting as a
{ipaddress | hostname} secondary VMPS server.
Step 4 Switch(config)# end Returns to privileged EXEC mode.
Step 5 Switch# show vmps Verifies the VMPS server entry.
This example shows how to define the primary and secondary VMPS devices:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# vmps server 172.20.128.179 primary
Switch(config)# vmps server 172.20.128.178
Switch(config)# end
Note You can configure up to four VMPS servers using this CLI on the VMPS client.
Switch# show vmps
VQP Client Status:
--------------------
VMPS VQP Version: 1
Reconfirm Interval: 60 min
Server Retry Count: 3
VMPS domain server: 172.20.128.179 (primary, current)
172.20.128.178
Reconfirmation status
---------------------
VMPS Action: No Dynamic Port
Configuring Dynamic Access Ports on a VMPS Client
To configure a dynamic access port on a VMPS client switch, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface Enters interface configuration mode and specifies the port to be
configured.
Step 3 Switch(config-if)# switchport mode Sets the port to access mode.
access
Step 4 Switch(config-if)# switchport access Configures the port as eligible for dynamic VLAN access.
vlan dynamic
Step 5 Switch(config-if)# end Returns to privileged EXEC mode.
Step 6 Switch# show interface interface Verifies the entry.
switchport
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-25
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
This example shows how to configure a dynamic access port and to verify the entry:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fa1/1
Switch(config-if)# switchport mode access
Switch(config-if)# switchport access vlan dynamic
Switch(config-if)# end
Switch# show interface fa1/1 switchport
Name: Fa0/1
Switchport: Enabled
Administrative mode: dynamic auto
Operational Mode: dynamic access
Administrative Trunking Encapsulation: isl
Operational Trunking Encapsulation: isl
Negotiation of Trunking: Disabled
Access Mode VLAN: 0 ((Inactive))
Trunking Native Mode VLAN: 1 (default)
Trunking VLANs Enabled: NONE
Pruning VLANs Enabled: NONE
Voice Ports
If a VVID (voice VLAN ID) is configured on a dynamic access port, the port can belong to both an
access VLAN and a voice VLAN. Consequently, an access port configured for connecting an IP phone
can have separate VLANs for the following:
• Data traffic to and from the PC that is connected to the switch through the access port of the IP phone
(access VLAN)
• Voice traffic to and from the IP phone (voice VLAN)
Reconfirming VLAN Memberships
To confirm the dynamic port VLAN membership assignments that the switch has received from the
VMPS, perform this task:
Command Purpose
Step 1 Switch# vmps reconfirm Reconfirms dynamic port VLAN membership.
Step 2 Switch# show vmps Verifies the dynamic VLAN reconfirmation status.
Configuring Reconfirmation Interval
VMPS clients periodically reconfirm the VLAN membership information received from the VMPS. You
can set the number of minutes the VMPS client waits before reconfirming the VLAN-to-MAC-address
assignments.
To configure the reconfirmation interval, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# vmps reconfirm minutes Specifies the number of minutes between reconfirmations of the
dynamic VLAN membership.
Software Configuration Guide—Release 15.0(1)XO
12-26 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
Command Purpose
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show vmps Verifies the dynamic VLAN reconfirmation status.
This example shows how to change the reconfirmation interval to 60 minutes and verify the change:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# vmps reconfirm 60
Switch(config)# end
Switch# show vmps
VQP Client Status:
--------------------
VMPS VQP Version: 1
Reconfirm Interval: 60 min
Server Retry Count: 10
VMPS domain server: 172.20.130.50 (primary, current)
Reconfirmation status
---------------------
VMPS Action: No Host
Configuring the Retry Interval
You can set the number of times that the VMPS client attempts to contact the VMPS before querying the
next server.
To configure the retry interval, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# vmps retry count Specifies the retry count for the VPQ queries. Default is 3. Range is
from 1 to 10.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show vmps Verifies the retry count.
This example shows how to change the retry count to 5 and to verify the change:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# vmps retry 5
Switch(config)# end
Switch# show vmps
VQP Client Status:
--------------------
VMPS VQP Version: 1
Reconfirm Interval: 60 min
Server Retry Count: 5
VMPS domain server: 172.20.130.50 (primary, current)
Reconfirmation status
---------------------
VMPS Action: No Host
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-27
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
Administering and Monitoring the VMPS
You can display the following information about the VMPS with the show vmps command:
VQP Version The version of VQP used to communicate with the VMPS. The
switch queries the VMPS using VQP Version 1.
Reconfirm Interval The number of minutes the switch waits before reconfirming the
VLAN-to-MAC-address assignments.
Server Retry Count The number of times VQP resends a query to the VMPS. If no
response is received after this many tries, the switch starts to
query the secondary VMPS.
VMPS domain server The IP address of the configured VLAN membership policy
servers. The switch currently sends queries to the one marked
“current.” The one marked “primary” is the primary server.
VMPS Action The result of the most-recent reconfirmation attempt. This action
can occur automatically when the reconfirmation interval
expired, or you can force it by entering the vmps reconfirm
command or its CVSM or SNMP equivalent.
The following example shows how to display VMPS information:
Switch# show vmps
VQP Client Status:
--------------------
VMPS VQP Version: 1
Reconfirm Interval: 60 min
Server Retry Count: 3
VMPS domain server:
Reconfirmation status
---------------------
VMPS Action: other
The following example shows how to display VMPS statistics:
Switch# show vmps statistics
VMPS Client Statistics
----------------------
VQP Queries: 0
VQP Responses: 0
VMPS Changes: 0
VQP Shutdowns: 0
VQP Denied: 0
VQP Wrong Domain: 0
VQP Wrong Version: 0
VQP Insufficient Resource: 0
Note Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference for details on VMPS statistics.
Software Configuration Guide—Release 15.0(1)XO
12-28 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
Troubleshooting Dynamic Port VLAN Membership
VMPS errdisables a dynamic port under the following conditions:
• The VMPS is in secure mode, and it does not allow the host to connect to the port. The VMPS
errdisables the port to prevent the host from connecting to the network.
• More than 50 active hosts reside on a dynamic port.
For information on how to display the status of interfaces in error-disabled state, refer to
Chapter 8, “Checking Port Status and Connectivity.” To recover an errdisabled port, use the
errdisable recovery cause vmps global configuration command.
Dynamic Port VLAN Membership Configuration Example
Figure 12-4 on page 12-30 shows a network with a VMPS servers and VMPS client switches with
dynamic ports. In this example, these assumptions apply:
• The VMPS server and the VMPS client are separate switches.
• The Catalyst 4000 family Switch 1 (running CatOS) is the primary VMPS server.
• The Catalyst 6000 family Switch 3 (running CatOS) and the URT are secondary VMPS servers.
• End stations are connected to these clients:
– Catalyst 4500 series XL Switch 2 (running Catalyst IOS)
– Catalyst 4500 series XL Switch 9 (running Catalyst IOS)
• The database configuration file is called Bldg-G.db and is stored on the TFTP server with the IP
address 172.20.22.7.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-29
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
Figure 12-4 Dynamic Port VLAN Membership Configuration
Catalyst 4000 TFTP server
(CatOS)
Primary VMPS
Server 1 Switch 1 172.20.26.150 Router
172.20.22.7
3/1 Client
End
station 1 172.20.26.151
Switch 2
Catalyst 6000
(CatOS)
Secondary VMPS
172.20.26.152
Server 2 Switch 3
172.20.26.153
Switch 4
Ethernet segment
172.20.26.154
Switch 5
172.20.26.155
Switch 6
172.20.26.156
Switch 7
172.20.26.157
Switch 8
Client
End
station 2 172.20.26.158
Switch 9
130105
URT
Secondary VMPS
172.20.26.159
Server 3 Switch 10
Two topologies are possible. Figure 12-5 illustrates a topology with one end station attached directly to
a Catalyst 4500 series switch operating as a VMPS client. Figure 12-6 illustrates a topology with an end
station attached to a Cisco IP Phone, which is attached to a Catalyst 4500 series switch.
Figure 12-5 Topology with an End Station Attached Directly to a Catalyst 4500 Series Switch
Operating as a VMPS Client
Internet
Endstation Catalyst 4500 (IOS) Catalyst 4500 (CatOS)/
(in VLAN 10) (VMPS client) Catalyst 6500 (CatOS)/
130118
URT
(VMPS server)
Software Configuration Guide—Release 15.0(1)XO
12-30 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
Figure 12-6 Topology with an End Station Attached to a Cisco IP Phone that is Attached to a
Catalyst 4500 Series Switch
Endstation
(in VLAN 20)
Internet
IP
Cisco IP phone Catalyst 4500 (IOS) Catalyst 4500 (CatOS)/
(in VLAN 10) (VMPS client) Catalyst 6500 (CatOS)/
130119
URT
(VMPS server)
In the following procedure, the Catalyst 4000 and Catalyst 6000 series switches (running CatOS) are the
VMPS servers. Use this procedure to configure the Catalyst 4500 series switch clients in the network:
Step 1 Configure the VMPS server addresses on Switch 2, the client switch.
a. Starting from privileged EXEC mode, enter global configuration mode:
switch# configuration terminal
b. Enter the primary VMPS server IP address:
switch(config)# vmps server 172.20.26.150 primary
c. Enter the secondary VMPS server IP addresses:
switch(config)# vmps server 172.20.26.152
d. To verify your entry of the VMPS IP addresses, return to privileged EXEC mode:
switch(config)# exit
e. Display VMPS information configured for the switch:
switch# show vmps
VQP Client Status:
--------------------
VMPS VQP Version: 1
Reconfirm Interval: 60 min
Server Retry Count: 3
VMPS domain server: 172.20.26.152
172.20.26.150 (primary, current
Step 2 Configure port Fa0/1 on Switch 2 as a dynamic port.
a. Return to global configuration mode:
switch# configure terminal
b. Enter interface configuration mode:
switch(config)# interface fa2/1
c. Configure the VLAN membership mode for static-access ports:
switch(config-if)# switchport mode access
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-31
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
d. Assign the port dynamic VLAN membership:
switch(config-if)# switchport access vlan dynamic
e. Return to privileged EXEC mode:
switch(config-if)# exit
switch#
Step 3 Connect End Station 2 on port Fa2/1. When End Station 2 sends a packet, Switch 2 sends a query to the
primary VMPS server, Switch 1. Switch 1 responds with the VLAN ID for port Fa2/1. If spanning-tree
PortFast mode is enabled on Fa2/1, port Fa2/1 connects immediately and begins forwarding.
Step 4 Set the VMPS reconfirmation period to 60 minutes. The reconfirmation period is the number of minutes
the switch waits before reconfirming the VLAN to MAC address assignments.
switch# config terminal
switch(config)# vmps reconfirm 60
Step 5 Confirm the entry from privileged EXEC mode:
switch# show vmps
VQP Client Status:
--------------------
VMPS VQP Version: 1
Reconfirm Interval: 60 min
Server Retry Count: 3
VMPS domain server:
Reconfirmation status
---------------------
VMPS Action: No Dynamic Port
Step 6 Repeat Steps 1 and 2 to configure the VMPS server addresses, and assign dynamic ports on each VMPS
client switch.
VMPS Database Configuration File Example
This example shows a sample VMPS database configuration file as it appears on a VMPS server. A
VMPS database configuration file is an ASCII text file that is stored on a TFTP server accessible to the
switch that functions as the VMPS server.
!vmps domain <domain-name>
! The VMPS domain must be defined.
!vmps mode { open | secure }
! The default mode is open.
!vmps fallback <vlan-name>
!vmps no-domain-req { allow | deny }
!
! The default value is allow.
vmps domain WBU
vmps mode open
vmps fallback default
vmps no-domain-req deny
!
!
Software Configuration Guide—Release 15.0(1)XO
12-32 OL-22250-01
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
!MAC Addresses
!
vmps-mac-addrs
!
! address <addr> vlan-name <vlan_name>
!
address 0012.2233.4455 vlan-name hardware
address 0000.6509.a080 vlan-name hardware
address aabb.ccdd.eeff vlan-name Green
address 1223.5678.9abc vlan-name ExecStaff
address fedc.ba98.7654 vlan-name --NONE--
address fedc.ba23.1245 vlan-name Purple
!
!Port Groups
!
!vmps-port-group <group-name>
! device <device-id> { port <port-name> | all-ports }
!
vmps-port-group WiringCloset1
device 198.92.30.32 port Fa1/3
device 172.20.26.141 port Fa1/4
vmps-port-group “Executive Row”
device 198.4.254.222 port es5%Fa0/1
device 198.4.254.222 port es5%Fa0/2
device 198.4.254.223 all-ports
!
!VLAN groups
!
!vmps-vlan-group <group-name>
! vlan-name <vlan-name>
!
vmps-vlan-group Engineering
vlan-name hardware
vlan-name software
!
!VLAN port Policies
!
!vmps-port-policies {vlan-name <vlan_name> | vlan-group <group-name> }
! { port-group <group-name> | device <device-id> port <port-name> }
!
vmps-port-policies vlan-group Engineering
port-group WiringCloset1
vmps-port-policies vlan-name Green
device 198.92.30.32 port Fa0/9
vmps-port-policies vlan-name Purple
device 198.4.254.22 port Fa0/10
port-group “Executive Row”
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 12-33
Chapter 12 Configuring VLANs, VTP, and VMPS
VLAN Membership Policy Server
Software Configuration Guide—Release 15.0(1)XO
12-34 OL-22250-01
CH A P T E R 13
Configuring IP Unnumbered Interface
This chapter discusses the IP Unnumbered Interface feature, which allows you to enable IP processing
on an interface without assigning an explicit IP address.
This chapter contains these sections:
• About IP Unnumbered Support, page 13-2
• Limitations and Restrictions, page 13-4
• Configuring IP Unnumbered Interface Support with DHCP Server, page 13-5
• Configuring IP Unnumbered Interface Support with Connected Host Polling, page 13-7
• Displaying IP Unnumbered Interface Settings, page 13-8
• Troubleshooting IP Unnumbered, page 13-9
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 13-1
Chapter 13 Configuring IP Unnumbered Interface
About IP Unnumbered Support
EFT Draft - Conf idential
Related Documents
Related Topic Document Title
DHCP and other IP addressing configuration tasks “IP Addressing and Services” section of the Cisco IOS IP
Addressing Services Configuration Guide, Release 12.4
DHCP and other IP addressing commands Cisco IOS IP Addressing Services Command Reference,
Release 12.4 T
VLAN configuration tasks “Virtual LANs” chapter of the Cisco IOS LAN Switching
Configuration Guide, Release 12.4
VLAN configuration commands Cisco IOS LAN Switching Command Reference, Release 12.4 T
About IP Unnumbered Support
Before you configure VLANs and LAN interfaces with IP unnumbered interfaces, you should
understand the following concepts:
• IP Unnumbered Interface Support with DHCP Server and Relay Agent, page 13-2
• IP Unnumbered with Connected Host Polling, page 13-4
IP Unnumbered Interface Support with DHCP Server and Relay Agent
The IP unnumbered interface configuration allows you to enable IP processing on an interface without
assigning it an explicit IP address. The IP unnumbered interface can “borrow” the IP address from
another interface that is already configured on the Catalyst 4500 series switch, thereby conserving
network and address space. When employed with the DHCP server/relay agent, this feature allows a host
address assigned by the DHCP server to be learned dynamically at the DHCP relay agent.
Figure 13-1 shows a sample network topology implementing the IP Unnumbered Interface feature. In
this topology, IP routes are dynamically established by the aggregation switch when the DHCP server
assigns IP addresses to the hosts.
Software Configuration Guide—Release 15.0(1)XO
13-2 OL-22250-01
Chapter 13 Configuring IP Unnumbered Interface
About IP Unnumbered Support
Figure 13-1 Sample Network Topology Using the VLANs over IP Unnumbered Interfaces Feature
DSL access multiplexer DHCP server
with Gigabit Ethernet (GE) uplink
DSL DSL GE
IP/MPLS
GE GE
DSL Multilayer Aggregation
Ethernet router
GE switch
DSL
IP unnumbered
DSL interface
95961
802.1Q VLAN
DHCP Option 82
DHCP provides a framework for passing configuration information to hosts on a TCP/IP network.
Configuration parameters and other control information are carried in tagged data items that are stored
in the options field of the DHCP message. The data items are also called options. Option 82 is organized
as a single DHCP option that contains information known by the relay agent.
The IP Unnumbered Interface feature communicates information to the DHCP server using a suboption
of the DHCP relay agent information option called agent remote ID. The information sent in the agent
remote ID includes an IP address identifying the relay agent and information about the interface and the
connection over which the DHCP request entered. The DHCP server can use this information to make
IP address assignments and security policy decisions.
Figure 13-2 shows the agent remote ID suboption format that is used with the IP Unnumbered Interfaces
feature.
Figure 13-2 Format of the Agent Remote ID Suboption
1 12 bytes
Type Length Reserved NAS IP address Interface Reserved VLAN ID
103088
(byte 1) (byte 2) (bytes 3-4) (bytes 5-8) (byte 9) (byte 10) (bytes 11-12)
Table 13-1 describes the agent remote ID suboption fields displayed in Figure 13-2.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 13-3
Chapter 13 Configuring IP Unnumbered Interface
Limitations and Restrictions
EFT Draft - Conf idential
Table 13-1 Agent Remote ID Suboption Field Descriptions
Field Description
Type Format type. The value 2 specifies the format for use with this feature.
(1 byte)
Length Length of the Agent Remote ID suboption, not including the type and
length fields. (1 byte)
Reserved Reserved. (2 bytes)
NAS IP Address IP address of the interface specified by the ip unnumbered command.
(4 bytes)
Interface Physical interface. This field has the following format:
slot (4 bits) | module (1 bit) | port (3 bits).
For example, if the interface name is interface ethernet 2/1/1, the slot
is 2, the module is 1, and the port is 1. (1 byte)
Reserved Reserved. (1 byte)
VLAN ID VLAN identifier for the Ethernet interface. (2 bytes)
IP Unnumbered with Connected Host Polling
Note This feature option is applicable to LAN and VLAN interfaces only.
In some cases, the host IP address is assigned statically. The IP Unnumbered Interfaces feature can learn
the static host IP address dynamically.
Limitations and Restrictions
Limitations and restrictions include:
• For IP unnumbered interfaces, the following features are not supported:
– Dynamic routing protocols
– HSRP/VRRP
– Static arp
– Unnumbered interface and Numbered interface in different VRFs
• The option to add dhcp host routes as connected routes is available in Cisco IOS. When using
connected mode, however, the clear ip route * command deletes the dhcp host connected routes
permanently.
Workarounds:
– For a layer 3 interface (SVI), enter shut then no shut.
– To enable IP unnumbered to use static routes, enter the ip dhcp route static command.
• IP Redirect is not sent by an interface configured with IP unnumbered. (CSCse75660).
• An IP unnumbered interface is unable to forward multicast source packets. (CSCse61766)
Software Configuration Guide—Release 15.0(1)XO
13-4 OL-22250-01
Chapter 13 Configuring IP Unnumbered Interface
Configuring IP Unnumbered Interface Support with DHCP Server
Configuring IP Unnumbered Interface Support with DHCP Server
Note DHCP must be configured and operational.
This section contains the following procedures:
• Configuring IP Unnumbered Interface Support on LAN and VLAN Interfaces, page 13-5
• Configuring IP Unnumbered Interface Support on a Range of Ethernet VLANs, page 13-6
Configuring IP Unnumbered Interface Support on LAN and VLAN Interfaces
To configure IP unnumbered interface support on a single LAN or VLAN interface, perform this task.
SUMMARY STEPS
1. enable
2. configure terminal
3. interface [fastethernet | gigabitethernet | tengigabitethernet | vlan vlan} port-channel |
loopback]
4. ip unnumbered type number
DETAILED STEPS
Command Purpose
Step 1 Switch# enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# configure terminal Enters global configuration mode.
Step 3 Switch(config)# interface [fastethernet | Enters interface configuration mode and the interface to be
gigabitethernet | tengigabitethernet | vlan configured as a tunnel port.
vlan | port-channel | loopback]
Step 4 Switch(config-if)# ip unnumbered type number Enables IP processing on an interface without assigning an
explicit IP address to the interface.
The type and number arguments specify another interface
on which the switch has an assigned IP address. The
interface specified cannot be another unnumbered interface.
Step 5 Switch(config-if)# exit Returns to global configuration mode.
Step 6 Switch(config)# end Returns to privileged EXEC mode.
Step 7 Switch# show running-config Verifies that IP unnumbered support has been configured
correctly.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 13-5
Chapter 13 Configuring IP Unnumbered Interface
Configuring IP Unnumbered Interface Support with DHCP Server
EFT Draft - Conf idential
In the following example, Ethernet VLAN 10 is configured as an IP unnumbered interfaces:
Switch> enable
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface vlan 10
Switch(config-if)# ip unnumbered Lookback 0
Configuring IP Unnumbered Interface Support on a Range of Ethernet VLANs
To configure IP unnumbered interface support on a range of Ethernet VLAN interfaces, perform this
task:
SUMMARY STEPS
1. enable
2. configure terminal
3. interface range {{fastethernet | gigabitethernet | vlan vlan} slot/interface {fastethernet |
gigabitethernet | vlan vlan} slot/interface macro macro-name}
4. ip unnumbered type number
DETAILED STEPS
Command or Action Purpose
Step 1 Switch# enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# configure terminal Enters global configuration mode.
Step 3 Switch(config)# interface range {{fastethernet Executes commands on multiple interfaces at the same
| gigabitethernet | vlan vlan} slot/interface time.
{fastethernet | gigabitethernet | vlan vlan}
slot/interface | macro macro-name} A hyphen must be entered with a space on either side to
separate the range information.
Step 4 Switch(config-if)# ip unnumbered type number Enables IP processing on an interface without assigning an
explicit IP address to the interface.
The type and number arguments specify another interface
on which the switch has an assigned IP address. The
specified interface cannot be another unnumbered interface.
Step 5 Switch(config-if)# exit Returns to global configuration mode.
Step 6 Switch(config)# end Returns to privileged EXEC mode.
Step 7 Switch# show running-config Verifies that IP unnumbered support has been configured
correctly.
Software Configuration Guide—Release 15.0(1)XO
13-6 OL-22250-01
Chapter 13 Configuring IP Unnumbered Interface
Configuring IP Unnumbered Interface Support with Connected Host Polling
In the following example, Vlan in the range from 1 to 10 are configured as IP unnumbered interfaces,
sharing ip address of fastethernet 3/1:
Switch> enable
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface range vlan 1 - 10
Switch(config-if)# ip unnumbered fastethernet 3/1
Switch(config-if)# exit
Switch(config)# end
Configuring IP Unnumbered Interface Support
with Connected Host Polling
To configure IP unnumbered interface support with connected host polling, perform this task:
Command Purpose
Step 1 Switch# enable Enables privileged EXEC mode.
Enter your password if prompted.
Step 2 Switch# configure terminal Enters global configuration mode.
Step 3 Switch(config)# interface vlan vlan-id Enters interface configuration mode and the interface to
be configured as a tunnel port.
Step 4 Switch(config-if)# ip unnumbered type number poll Enables IP processing and connected host polling on an
interface without assigning an explicit IP address to the
interface
type and number specify another interface on which the
switch has an assigned IP address. The interface specified
cannot be another unnumbered interface.
The type argument can have the values: loopback,
fastethernet, gigabitethernet, svi, and portchannel.
Step 5 Switch(config-if)# exit Returns to global configuration mode.
Step 6 Switch(config)# ip arp poll queue <10-10000> Configures the global backlog queue of host addresses to
be discovered.
Default for the queue size is 1000
Step 7 Switch(config)# ip arp poll rate <10-10000> Configures the maximum number of arp requests sent
over unnumbered interfaces.
Default number of arp requests is 1000 packet per second
Step 8 Switch(config)# end Returns to privileged EXEC mode.
Step 9 Switch# show running-config Verifies that IP unnumbered support has been configured
correctly.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 13-7
Chapter 13 Configuring IP Unnumbered Interface
Displaying IP Unnumbered Interface Settings
EFT Draft - Conf idential
The following example shows how to enable IP processing and connected host polling on Fast Ethernet
interface 6/2. It also shows how to set the global backlog queue to 2000 and the maximum number of
arp requests to 500:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastEthernet 6/2
Switch(config-if)# no switchport
Switch(config-if)# ip unnumbered loopback 0 poll
Warning: dynamic routing protocols will not work on non-point-to-point interfaces with IP
unnumbered configured.
Switch(config-if)# exit
Switch(config)# ip arp poll queue 2000
Switch(config)# ip arp poll rate 500
Switch(config)# end
Displaying IP Unnumbered Interface Settings
Use the show ip interface unnumbered command to display status of an unnumbered interface with
connected host polling for the switch.
To display status of an unnumbered interface, perform one or more of these tasks:
Command Purpose
Switch# show ip interface [type number] Displays the status of unnumbered interface with connected
unnumbered [detail] host polling for the Catalyst 4500 series switch.
The following example shows how to display the status of unnumbered interface with connected host
polling:
Switch# show ip interface loopback 0 unnumbered detail
Number of unnumbered interfaces with polling: 1
Number of IP addresses processed for polling: 2
10.1.1.7
10.1.1.8
Number of IP addresses in queue for polling: 2(high water mark: 3)
10.1.1.17
10.1.1.18
To display key statistic for the backlog of unnumbered interface with connected host polling for the
switch, use the show ip arp poll command.
Command Purpose
Switch# show ip arp poll [detail] display key statistic for the backlog of unnumbered interface
with connected host polling for the switch
Software Configuration Guide—Release 15.0(1)XO
13-8 OL-22250-01
Chapter 13 Configuring IP Unnumbered Interface
Troubleshooting IP Unnumbered
The following example shows how to display key statistic for the backlog of unnumbered interface with
connected host polling:
Switch# show ip arp poll
Number of IP addresses processed for polling: 439
Number of IP addresses in queue for polling: 3 (high water mark: 0, max: 1000)
Number of requests dropped:
Queue was full: 0
Request was throttled by incomplete ARP: 0
Duplicate request was found in queue: 0
To clear the key statistic for the backlog of unnumbered interface, use the clear ip arp poll statistic
command, as follows:
Switch# clear ip arp poll statistic
Switch# show ip arp poll
Number of IP addresses processed for polling: 0
Number of IP addresses in queue for polling: 0 (high water mark: 0, max: 1000)
Number of requests dropped:
Queue was full: 0
Request was throttled by incomplete ARP: 0
Duplicate request was found in queue: 0
Troubleshooting IP Unnumbered
To understand how to debug connect host polling, see the IOS documentation of the debug arp command
on cisco.com.
When an IP unnumbered interface shares the IP address of a loopback interface whose prefix is
advertised in an OSPF network, you must modify the loopback interface as a point to point interface.
Otherwise, only the loopback interface host route is advertised to an OSPF neighbor.
Switch(config)# int loopback 0
Switch(config-if)# ip address
Switch(config-if)# ip address 10.1.0.1 255.255.0.0
Switch(config-if)# ip ospf network point-to-point
Switch(config-if)# end
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 13-9
Chapter 13 Configuring IP Unnumbered Interface
Troubleshooting IP Unnumbered
EFT Draft - Conf idential
Software Configuration Guide—Release 15.0(1)XO
13-10 OL-22250-01
CH A P T E R 14
Configuring Layer 2 Ethernet Interfaces
This chapter describes how to use the command-line interface (CLI) to configure Fast Ethernet and
Gigabit Ethernet interfaces for Layer 2 switching on Catalyst 4500 series switches. It also provides
guidelines, procedures, and configuration examples. The configuration tasks in this chapter apply to Fast
Ethernet and Gigabit Ethernet interfaces on any module, including the uplink ports on the supervisor
engine.
This chapter includes the following major sections:
• About Layer 2 Ethernet Switching, page 14-1
• Default Layer 2 Ethernet Interface Configuration, page 14-4
• Layer 2 Interface Configuration Guidelines and Restrictions, page 14-5
• Configuring Ethernet Interfaces for Layer 2 Switching, page 14-5
Note To configure Layer 3 interfaces, see Chapter 26, “Configuring Layer 3 Interfaces.”
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Layer 2 Ethernet Switching
The following sections describe how Layer 2 Ethernet switching works on Catalyst 4500 series switches:
• Layer 2 Ethernet Switching, page 14-2
• VLAN Trunks, page 14-3
• Layer 2 Interface Modes, page 14-4
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 14-1
Chapter 14 Configuring Layer 2 Ethernet Interfaces
About Layer 2 Ethernet Switching
Layer 2 Ethernet Switching
Catalyst 4500 series switches support simultaneous, parallel connections between Layer 2 Ethernet
segments. Switched connections between Ethernet segments last only for the duration of the packet. New
connections can be made between different segments for successive packets.
Note With release 12.1(13)EW, the Catalyst 4500 series switches can handle packets of 1600 bytes, rather
than treat them as “oversized” and discard them. This size is larger than the usual IEEE Ethernet
Maximum Transmission Unit (MTU) (1518 bytes) and 802.1q MTU (1522 bytes). The ability to handle
larger packets is required to support two nested 802.1q headers and Multiprotocol Label Switching
(MPLS) on a network.
The Catalyst 4500 series solves congestion problems caused by high-bandwidth devices and a large
number of users by assigning each device (for example, a server) to its own 10-, 100-, or 1000-Mbps
segment. Because each Ethernet interface on the switch represents a separate Ethernet segment, servers
in a properly configured switched environment achieve full access to the bandwidth.
Because collisions are a major bottleneck in Ethernet networks, an effective solution is full-duplex
communication. Normally, Ethernet operates in half-duplex mode, which means that stations can either
receive or transmit. In full-duplex mode, two devices can transmit and receive at the same time. When
packets can flow in both directions simultaneously, effective Ethernet bandwidth doubles to 20 Mbps
for 10-Mbps interfaces and to 200 Mbps for Fast Ethernet interfaces. Gigabit Ethernet interfaces on the
Catalyst 4500 series switch are full-duplex mode only, providing 2-Gbps effective bandwidth.
Switching Frames Between Segments
Each Ethernet interface on a Catalyst 4500 series switch can connect to a single workstation or server,
or to a hub through which workstations or servers connect to the network.
On a typical Ethernet hub, all ports connect to a common backplane within the hub, and the bandwidth
of the network is shared by all devices attached to the hub. If two devices establish a session that uses a
significant level of bandwidth, the network performance of all other stations attached to the hub is
degraded.
To reduce degradation, the switch treats each interface as an individual segment. When stations on
different interfaces need to communicate, the switch forwards frames from one interface to the other at
wire speed to ensure that each session receives full bandwidth.
To switch frames between interfaces efficiently, the switch maintains an address table. When a frame
enters the switch, it associates the MAC address of the sending station with the interface on which it was
received.
Building the MAC Address Table
The Catalyst 4500 series builds the MAC address table by using the source address of the frames
received. When the switch receives a frame for a destination address not listed in its MAC address table,
it floods the frame to all interfaces of the same VLAN except the interface that received the frame. When
the destination device replies, the switch adds its relevant source address and interface ID to the address
table. The switch then forwards subsequent frames to a single interface without flooding to all interfaces.
The address table can store at least 32,000 address entries without flooding any entries. The switch uses
an aging mechanism, defined by a configurable aging timer, so if an address remains inactive for a
specified number of seconds, it is removed from the address table.
Software Configuration Guide—Release 15.0(1)XO
14-2 OL-22250-01
Chapter 14 Configuring Layer 2 Ethernet Interfaces
About Layer 2 Ethernet Switching
VLAN Trunks
A trunk is a point-to-point link between one or more Ethernet switch interfaces and another networking
device such as a router or a switch. Trunks carry the traffic of multiple VLANs over a single link and
allow you to extend VLANs across an entire network.
Two trunking encapsulations are available on all Ethernet interfaces:
• Inter-Switch Link (ISL) Protocol—ISL is a Cisco-proprietary trunking encapsulation.
Note Supervisor Engine 7-E does not support ISL trunking. so the switchport trunk encapsulate
command is not supported.
Note The blocking Gigabit ports on the WS-X4418-GB and WS-X4412-2GB-T modules do not
support ISL. Ports 3 to 18 are blocking Gigabit ports on the WS-X4418-GB module. Ports 1to
12 are blocking Gigabit ports on the WS-X4412-2GB-T module.
• 802.1Q—802.1Q is an industry-standard trunking encapsulation.
You can configure a trunk on a single Ethernet interface or on an EtherChannel bundle. For more
information about EtherChannel, see Chapter 19, “Configuring EtherChannel.”
Ethernet trunk interfaces support different trunking modes (see Table 14-2). You can specify whether the
trunk uses ISL encapsulation, 802.1Q encapsulation, or if the encapsulation type is autonegotiated.
To autonegotiate trunking, make sure your interfaces are in the same VTP domain. Use the trunk or
nonegotiate keywords to force interfaces in different domains to trunk. For more information on VTP
domains, see Chapter 12, “Configuring VLANs, VTP, and VMPS.”
Trunk negotiation is managed by the Dynamic Trunking Protocol (DTP). DTP supports autonegotiation
of both ISL and 802.1Q trunks.
Encapsulation Types
Table 14-1 lists the Ethernet trunk encapsulation types.
Table 14-1 Ethernet Trunk Encapsulation Types
Encapsulation Type Encapsulation Command Purpose
ISL switchport trunk encapsulation isl Specifies ISL encapsulation on the trunk link.
802.1Q switchport trunk encapsulation dot1q Specifies 802.1Q encapsulation on the trunk link.
Negotiate switchport trunk encapsulation negotiate Specifies that the interface negotiate with the
neighboring interface to become an ISL (preferred)
or 802.1Q trunk, depending on the configuration
and capabilities of the neighboring interface.
The trunking mode, the trunk encapsulation type, and the hardware capabilities of the two connected
interfaces determine whether a link becomes an ISL or 802.1Q trunk.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 14-3
Chapter 14 Configuring Layer 2 Ethernet Interfaces
Default Layer 2 Ethernet Interface Configuration
Layer 2 Interface Modes
Table 14-2 lists the Layer 2 interface modes and describes how they function on Ethernet interfaces.
Table 14-2 Layer 2 Interface Modes
Mode Purpose
switchport mode access Puts the interface into permanent nontrunking mode and
negotiates to convert the link into a nontrunking link. The
interface becomes a nontrunk interface even if the neighboring
interface does not change.
switchport mode Makes the interface actively attempt to convert the link to a
dynamic desirable trunking link. The interface becomes a trunk interface if the
neighboring interface is set to trunk, desirable, or auto mode.
switchport mode dynamic auto Makes the interface convert the link to a trunking link if the
neighboring interface is set to trunk or desirable mode. This is
the default mode for all Ethernet interfaces.
switchport mode trunk Puts the interface into permanent trunking mode and negotiates to
convert the link into a trunking link. The interface becomes a
trunk interface even if the neighboring interface does not change.
switchport nonegotiate Puts the interface into permanent trunking mode but prevents the
interface from generating DTP frames. You must configure the
neighboring interface manually as a trunk interface to establish a
trunking link.
Note DTP is a point-to-point protocol. However, some internetworking devices might forward DTP frames
improperly. To avoid this problem, ensure that interfaces connected to devices that do not support DTP
are configured with the access keyword if you do not intend to trunk across those links. To enable
trunking to a device that does not support DTP, use the nonegotiate keyword to cause the interface to
become a trunk without generating DTP frames.
Default Layer 2 Ethernet Interface Configuration
Table 14-3 shows the Layer 2 Ethernet interface default configuration.
Table 14-3 Layer 2 Ethernet Interface Default Configuration
Feature Default Value
Interface mode switchport mode dynamic auto
Trunk encapsulation switchport trunk encapsulation negotiate
Allowed VLAN range VLANs 1–1005
VLAN range eligible for pruning VLANs 2–1001
Default VLAN (for access ports) VLAN 1
Software Configuration Guide—Release 15.0(1)XO
14-4 OL-22250-01
Chapter 14 Configuring Layer 2 Ethernet Interfaces
Layer 2 Interface Configuration Guidelines and Restrictions
Table 14-3 Layer 2 Ethernet Interface Default Configuration (continued)
Feature Default Value
Native VLAN (for 802.1Q only VLAN 1
trunks)
STP1 Enabled for all VLANs
STP port priority 128
STP port cost • 100 for 10-Mbps Ethernet LAN ports
• 19 for 10/100-Mbps Fast Ethernet ports
• 19 for 100-Mbps Fast Ethernet ports
• 4 for 1000-Mbps Gigabit Ethernet ports
• 2 for 10,000-Mbps 10-Gigabit Ethernet LAN ports
1. STP = Spanning Tree Protocol
Layer 2 Interface Configuration Guidelines and Restrictions
Keep the following guidelines and restrictions in mind when you configure Layer 2 interfaces:
• In a network of Cisco switches connected through 802.1Q trunks, the switches maintain one instance
of spanning tree for each VLAN allowed on the trunks. Non-Cisco 802.1Q switches maintain only
one instance of spanning tree for all VLANs allowed on the trunks.
When you connect a Cisco switch to a non-Cisco device through an 802.1Q trunk, the Cisco switch
combines the spanning tree instance of the native VLAN of the trunk with the spanning tree instance
of the non-Cisco 802.1Q switch. However, spanning tree information for each VLAN is maintained
by Cisco switches separated by a cloud of non-Cisco 802.1Q switches. The non-Cisco 802.1Q cloud
separating the Cisco switches is treated as a single trunk link between the switches.
• Make sure the native VLAN for an 802.1Q trunk is the same on both ends of the trunk link. If the
VLAN on one end of the trunk is different from the VLAN on the other end, spanning tree loops
might result.
• Disabling spanning tree on any VLAN of an 802.1Q trunk can cause spanning tree loops.
Configuring Ethernet Interfaces for Layer 2 Switching
The following sections describe how to configure Layer 2 switching on a Catalyst 4500 series switch:
• Configuring an Ethernet Interface as a Layer 2 Trunk, page 14-6
• Configuring an Interface as a Layer 2 Access Port, page 14-8
• Clearing Layer 2 Configuration, page 14-9
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 14-5
Chapter 14 Configuring Layer 2 Ethernet Interfaces
Configuring Ethernet Interfaces for Layer 2 Switching
Configuring an Ethernet Interface as a Layer 2 Trunk
Note The default for Layer 2 interfaces is switchport mode dynamic auto. If the neighboring interface
supports trunking and is configured to trunk mode or dynamic desirable mode, the link becomes a
Layer 2 trunk. By default, trunks negotiate encapsulation. If the neighboring interface supports ISL and
802.1Q encapsulation and both interfaces are set to negotiate the encapsulation type, the trunk uses ISL
encapsulation.
Note Supervisor Engine 7-E does not support ISL trunking.
To configure an interface as a Layer 2 trunk, perform this task:
Command Purpose
Step 1 Switch(config)# interface {fastethernet | Specifies the interface to configure.
gigabitethernet | tengigabitethernet}
slot/port
Step 2 Switch(config-if)# shutdown (Optional) Shuts down the interface to prevent traffic flow until
configuration is complete.
Step 3 Switch(config-if)# switchport trunk (Optional) Specifies the encapsulation.
encapsulation {isl | dot1q | negotiate}
Note You must enter this command with either the isl or dot1q
keyword to support the switchport mode trunk
command, which is not supported by the default mode
(negotiate).
Note Supervisor Engine 7E does not support ISL trunking.
Step 4 Switch(config-if)# switchport mode Configures the interface as a Layer 2 trunk. (Required only if the
{dynamic {auto | desirable} | trunk} interface is a Layer 2 access port or to specify the trunking mode.)
Step 5 Switch(config-if)# switchport access vlan (Optional) Specifies the access VLAN, which is used if the
vlan_num interface stops trunking. The access VLAN is not used as the
native VLAN.
Note The vlan_num parameter is either a single VLAN number
from 1 to 1005 or a range of VLANs described by two
VLAN numbers, the lesser one first, separated by a dash.
Do not enter any spaces between comma-separated vlan
parameters or in dash-specified ranges.
Step 6 Switch(config-if)# switchport trunk For 802.1Q trunks, specifies the native VLAN.
native vlan vlan_num
Note If you do not set the native VLAN, the default is used
(VLAN 1).
Step 7 Switch(config-if)# switchport trunk (Optional) Configures the list of VLANs allowed on the trunk. All
allowed vlan {add | except | all | VLANs are allowed by default. You cannot remove any of the
remove}
vlan_num[,vlan_num[,vlan_num[,....]]
default VLANs from a trunk.
Software Configuration Guide—Release 15.0(1)XO
14-6 OL-22250-01
Chapter 14 Configuring Layer 2 Ethernet Interfaces
Configuring Ethernet Interfaces for Layer 2 Switching
Command Purpose
Step 8 Switch(config-if)# switchport trunk (Optional) Configures the list of VLANs allowed to be pruned
pruning vlan {add | except | none | from the trunk (see the “VLAN Trunking Protocol” section on
remove}
vlan_num[,vlan_num[,vlan_num[,....]]
page 12-7). The default list of VLANs allowed to be pruned
contains all VLANs, except for VLAN 1.
Step 9 Switch(config-if)# no shutdown Activates the interface. (Required only if you shut down the
interface.)
Step 10 Switch(config-if)# end Exits interface configuration mode.
Step 11 Switch# show running-config interface Displays the running configuration of the interface.
{fastethernet | gigabitethernet |
tengigabitethernet} slot/port
Step 12 Switch# show interfaces [fastethernet | Displays the switch port configuration of the interface.
gigabitethernet | tengigabitethernet]
slot/port switchport
Step 13 Switch# show interfaces [{fastethernet | Displays the trunk configuration of the interface.
gigabitethernet | tengigabitethernet}
slot/port] trunk
This example shows how to configure the Fast Ethernet interface 5/8 as an 802.1Q trunk. This example
assumes that the neighbor interface is configured to support 802.1Q trunking and that the native VLAN
defaults to VLAN 1:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 5/8
Switch(config-if)# shutdown
Switch(config-if)# switchport mode dynamic desirable
Switch(config-if)# switchport trunk encapsulation dot1q
Switch(config-if)# no shutdown
Switch(config-if)# end
Switch# exit
This example shows how to verify the running configuration:
Switch# show running-config interface fastethernet 5/8
Building configuration...
Current configuration:
!
interface FastEthernet5/8
switchport mode dynamic desirable
switchport trunk encapsulation dot1q
end
This example shows how to verify the switch port configuration:
Switch# show interfaces fastethernet 5/8 switchport
Name: Fa5/8
Switchport: Enabled
Administrative Mode: dynamic desirable
Operational Mode: trunk
Administrative Trunking Encapsulation: negotiate
Operational Trunking Encapsulation: dot1q
Negotiation of Trunking: Enabled
Access Mode VLAN: 1 (default)
Trunking Native Mode VLAN: 1 (default)
Trunking VLANs Enabled: ALL
Pruning VLANs Enabled: 2-1001
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 14-7
Chapter 14 Configuring Layer 2 Ethernet Interfaces
Configuring Ethernet Interfaces for Layer 2 Switching
This example shows how to verify the trunk configuration:
Switch# show interfaces fastethernet 5/8 trunk
Port Mode Encapsulation Status Native vlan
Fa5/8 desirable n-802.1q trunking 1
Port Vlans allowed on trunk
Fa5/8 1-1005
Port Vlans allowed and active in management domain
Fa5/8 1-6,10,20,50,100,152,200,300,303-305,349-351,400,500,521,524,570,801-8
02,850,917,999,1002-1005
Port Vlans in spanning tree forwarding state and not pruned
Fa5/8 1-6,10,20,50,100,152,200,300,303-305,349-351,400,500,521,524,570,801-8
02,850,917,999,1002-1005
Switch#
Configuring an Interface as a Layer 2 Access Port
Note If you assign an interface to a VLAN that does not exist, the interface is not operational until you create
the VLAN in the VLAN database (see the “Configuring VLANs in Global Configuration Mode” section
on page 12-5).
To configure an interface as a Layer 2 access port, perform this task:
Command Purpose
Step 1 Switch(config)# interface {fastethernet | Specifies the interface to configure.
gigabitethernet | tengigabitethernet}
slot/port
Step 2 Switch(config-if)# shutdown (Optional) Shuts down the interface to prevent traffic flow until
configuration is complete.
Step 3 Switch(config-if)# switchport Configures the interface for Layer 2 switching:
• You must enter the switchport command once without any
keywords to configure the interface as a Layer 2 port before
you can enter additional switchport commands with
keywords.
• Required only if you previously entered the no switchport
command for the interface.
Step 4 Switch(config-if)# switchport mode access Configures the interface as a Layer 2 access port.
Step 5 Switch(config-if)# switchport access vlan Place the interface in a VLAN.
vlan_num
Step 6 Switch(config-if)# no shutdown Activates the interface. (Required only if you had shut down the
interface.)
Step 7 Switch(config-if)# end Exits interface configuration mode.
Software Configuration Guide—Release 15.0(1)XO
14-8 OL-22250-01
Chapter 14 Configuring Layer 2 Ethernet Interfaces
Configuring Ethernet Interfaces for Layer 2 Switching
Command Purpose
Step 8 Switch# show running-config interface Displays the running configuration of the interface.
{fastethernet | gigabitethernet} slot/port
Step 9 Switch# show interfaces [{fastethernet | Displays the switch port configuration of the interface.
gigabitethernet | tengigabitethernet}
slot/port] switchport
This example shows how to configure the Fast Ethernet interface 5/6 as an access port in VLAN 200:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 5/6
Switch(config-if)# shutdown
Switch(config-if)# switchport mode access
Switch(config-if)# switchport access vlan 200
Switch(config-if)# no shutdown
Switch(config-if)# end
Switch# exit
This example shows how to verify the running configuration:
Switch# show running-config interface fastethernet 5/6
Building configuration...
!
Current configuration :33 bytes
interface FastEthernet 5/6
switchport access vlan 200
switchport mode access
end
This example shows how to verify the switch port configuration:
Switch# show interface fastethernet 5/6 switchport
Name:Fa5/6
Switchport:Enabled
Administrative Mode:dynamic auto
Operational Mode:static access
Administrative Trunking Encapsulation:negotiate
Operational Trunking Encapsulation:native
Negotiation of Trunking:On
Access Mode VLAN:1 (default)
Trunking Native Mode VLAN:1 (default)
Administrative private-vlan host-association:none
Administrative private-vlan mapping:none
Operational private-vlan:none
Trunking VLANs Enabled:ALL
Pruning VLANs Enabled:2-1001
Switch#
Clearing Layer 2 Configuration
To clear the Layer 2 configuration on an interface, perform this task:
Command Purpose
Step 1 Switch(config)# default interface {fastethernet | Specifies the interface to clear.
gigabitethernet | tengigabitethernet} slot/port
Step 2 Switch(config-if)# end Exits interface configuration mode.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 14-9
Chapter 14 Configuring Layer 2 Ethernet Interfaces
Configuring Ethernet Interfaces for Layer 2 Switching
Command Purpose
Step 3 Switch# show running-config interface Displays the running configuration of the interface.
{fastethernet | gigabitethernet |
tengigabitethernet} slot/port
Step 4 Switch# show interfaces [{fastethernet | Displays the switch port configuration of the interface.
gigabitethernet | tengigabitethernet} slot/port]
switchport
This example shows how to clear the Layer 2 configuration on the Fast Ethernet interface 5/6:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# default interface fastethernet 5/6
Switch(config)# end
Switch# exit
This example shows how to verify that the Layer 2 configuration was cleared:
Switch# show running-config interface fastethernet 5/6
Building configuration...
Current configuration:
!
interface FastEthernet5/6
end
This example shows how to verify the switch port configuration:
Switch# show interfaces fastethernet 5/6 switchport
Name: Fa5/6
Switchport: Enabled
Switch#
Software Configuration Guide—Release 15.0(1)XO
14-10 OL-22250-01
CH A P T E R 15
Configuring SmartPort Macros
This chapter describes how to configure and apply SmartPort macros on your switch. It consists of these
sections:
• About SmartPort Macros, page 15-1
• Configuring SmartPort Macros, page 15-2
• Displaying SmartPort Macros, page 15-12
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About SmartPort Macros
SmartPort macros provide a convenient way to save and share common configurations. They enable
features and settings based on the location of a switch in the network and for mass configuration
deployments across the network.
Each SmartPort macro is a set of CLI commands that you define. SmartPort macro sets do not contain
new CLI commands; Each SmartPort macro is a group of existing CLI commands.
When you apply a SmartPort macro on an interface, the CLI commands contained within the macro are
configured on the interface. When the macro is applied to an interface, the existing interface
configurations are not lost. The new commands are added to interface and are saved in the running
configuration file.
There are Cisco-default SmartPorts macros embedded in the switch software (see Table 15-1). You can
display these macros and the commands they contain by using the show parser macro user EXEC
command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 15-1
Chapter 15 Configuring SmartPort Macros
Configuring SmartPort Macros
Table 15-1 Cisco-Default SmartPorts Macros
Macro Name1 Description
cisco-global Use this global configuration macro to enable rapid PVST+, loop guard, and dynamic
port error recovery for link state failures.
cisco-desktop Use this interface configuration macro for increased network security and reliability
when connecting a desktop device, such as a PC, to a switch port.
cisco-phone Use this interface configuration macro when connecting a desktop device such as a
PC with a Cisco IP Phone to a switch port. This macro is an extension of the
cisco-desktop macro and provides the same security and resiliency features, but with
the addition of dedicated voice VLANs to ensure proper treatment of delay-sensitive
voice traffic.
cisco-switch Use this interface configuration macro when connecting an access switch and a
distribution switch or between access switches connected using GigaStack modules
or GBICs.
cisco-router Use this interface configuration macro when connecting the switch and a WAN
router.
1. Cisco-default SmartPorts macros vary depending on the software version running on your switch.
Cisco also provides a collection of pretested, Cisco-recommended baseline configuration templates for
Catalyst switches. The online reference guide templates provide the CLI commands that you use to
create SmartPorts macros based on the usage of the port. The configuration templates allow you to create
SmartPorts macros to build and deploy Cisco-recommended network designs and configurations.
Configuring SmartPort Macros
You can create a new SmartPort macro or use an existing macro as a template to create a new macro that
is specific to your application. After you create the macro, you can apply it to an interface or a range of
interfaces.
This section includes information about these topics:
• Passing Parameters Through the Macro, page 15-2
• Default SmartPort Macro Configuration, page 15-3
• SmartPort Macro Configuration Guidelines, page 15-6
• Creating SmartPorts Macros, page 15-7
• Applying SmartPorts Macros, page 15-8
Passing Parameters Through the Macro
Some commands might not be sufficiently generic for all the interfaces; for example, VLAN ID for
Layer 2 interfaces and the IP address for Layer 3 interface. Retaining such commands in macro
definitions requires that you change the value of such parameters (like VLAN ID or IP address) before
applying the macro to different interfaces. Alternatively, it requires that you create different macros for
each possible value of its parameters.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
15-2 OL-22250-01
Chapter 15 Configuring SmartPort Macros
Configuring SmartPort Macros
The macro infrastructure can be enhanced to support accepting parameters while applying a macro. The
parameters are passed as keyword-value pairs.
The CLI limits the number of keyword-value pairs to a maximum of three, where the first parameter must
be the keyword, the second is its corresponding value, and the third parameter would be the keyword for
the second keyword-value pair. Here is an example of how to pass parameters to a command-macro:
Switch(config)# macro name parameter-test
Enter macro commands one per line. End with the character '@'.
switchport mode access
switchport access vlan $VLANID
switchport port-security
switchport port-security maximum $MAXHOST
If the above macro is applied to some interface without parameters, the invalid commands fail. Instead,
you should apply the macro with appropriate keyword-value pair parameters, as follows:
Switch(config-if)# macro apply parameter-test $VLANID 1 $MAXHOST 5
The above command applies the macro after replacing $VLANID with 1 and $MAXHOST with 5. Be
aware that you can specify any string in the macro as a keyword.
Macro Parameter Help
It is often difficult to remember the macro keywords while applying a macro to an interface or switch.
Macros can contain the definitions for mandatory keywords. If you apply a macro without those
keyword values, the commands are considered invalid and they fail.
You can enhance the macro infrastructure to provide help on keywords defined in macros. While creating
a macro, you can specify a help string (as a comment) to list the mandatory keywords for that macro.
The following example illustrates how to specify the help string for the keywords:
Switch(config)# macro name test
switchport access vlan $VLANID
switchport port-security maximum $MAX
#macro keywords $VLANID $MAX
Help string can be anywhere in the macro. The following example illustrates an alternate way to specify
the help string:
Switch(config)# macro name test
switchport access vlan $VLANID
#macro keywords $VLANID
switchport port-security maximum $MAX
#macro keywords $MAX
Default SmartPort Macro Configuration
This section illustrates the default configurations for the four supported macros. These macros can only
be viewed and applied; they cannot be modified by the user.
• cisco-global, page 15-4
• cisco-desktop, page 15-4
• cisco-phone, page 15-4
• cisco-router, page 15-5
• cisco-switch, page 15-5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 15-3
Chapter 15 Configuring SmartPort Macros
Configuring SmartPort Macros
cisco-global
This is the example for the cisco-global macro:
# Enable dynamic port error recovery for link state failures.
errdisable recovery cause link-flap
errdisable recovery interval 60
# VTP requires Transparent mode for future 802.1x Guest VLAN
# and current Best Practice
vtp domain [smartports]
vtp mode transparent
# Enable aggressive mode UDLD on all fiber uplinks
udld aggressive
# Enable Rapid PVST+ and Loopguard
spanning-tree mode rapid-pvst
spanning-tree loopguard default
spanning-tree extend system-id
cisco-desktop
This is the example for the cisco-desktop macro:
# Basic interface - Enable data VLAN only
# Recommended value for access vlan (AVID) should not be 1
switchport access vlan $AVID
switchport mode access
# Enable port security limiting port to a single
# MAC address -- that of desktop
switchport port-security
# Ensure port-security age is greater than one minute
# and use inactivity timer
# “Port-security maximum 1” is the default and will not
# Show up in the config
switchport port-security violation restrict
switchport port-security aging time 2
switchport port-security aging type inactivity
# Configure port as an edge network port
spanning-tree portfast
spanning-tree bpduguard enable
cisco-phone
This is the example for the cisco-phone macro:
# VoIP enabled interface - Enable data VLAN
# and voice VLAN (VVID)
# Recommended value for access vlan (AVID) should not be 1\
switchport access vlan $AVID
switchport mode access
# Update the Voice VLAN (VVID) value which should be
# different from data VLAN
# Recommended value for voice vlan (VVID) should not be 1
switchport voice vlan $VVID
# Enable port security limiting port to a 2 MAC
# addressess -- One for desktop and two for phone
switchport port-security
switchport port-security maximum 2
# Ensure port-security age is greater than one minute
# and use inactivity timer
Software Configuration Guide—Release IOS-XE 3.1.0 SG
15-4 OL-22250-01
Chapter 15 Configuring SmartPort Macros
Configuring SmartPort Macros
switchport port-security violation restrict
switchport port-security aging time 2
switchport port-security aging type inactivity
# Enable auto-qos to extend trust to attached Cisco phone
auto qos voip cisco-phone
# Configure port as an edge network port
spanning-tree portfast
spanning-tree bpduguard enable@
cisco-router
This is the example for the cisco-router macro:
# Access Uplink to Distribution
switchport trunk encapsulation dot1q
# Define unique Native VLAN on trunk ports
# Recommended value for native vlan (NVID) should not be 1
switchport trunk native vlan $NVID
# Update the allowed VLAN range (VRANGE) such that it
# includes data, voice and native VLANs
# switchport trunk allowed vlan $VRANGE
# Hardcode trunk and disable negotiation to
# speed up convergence
# Hardcode speed and duplex to router
switchport mode trunk
switchport nonegotiate
speed 100
duplex full
# Configure qos to trust this interface
auto qos voip trust
qos trust dscp
# Ensure fast access to the network when enabling the interface.
# Ensure that switch devices cannot become active on the interface.
spanning-tree portfast
spanning-tree bpduguard enable
cisco-switch
This is the example for the cisco-switch macro:
# Access Uplink to Distribution
switchport trunk encapsulation dot1q
# Define unique Native VLAN on trunk ports
# Recommended value for native vlan (NVID) should not be 1
switchport trunk native vlan $NVID
# Update the allowed VLAN range (VRANGE) such that it
# includes data, voice and native VLANs
# switchport trunk allowed vlan $VRANGE
# Hardcode trunk and disable negotiation to
# speed up convergence
switchport mode trunk
switchport nonegotiate
# Configure qos to trust this interface
auto qos voip trust
# 802.1w defines the link as pt-pt for rapid convergence
spanning-tree link-type point-to-point
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 15-5
Chapter 15 Configuring SmartPort Macros
Configuring SmartPort Macros
SmartPort Macro Configuration Guidelines
Follow these guidelines when configuring macros on your switch:
• If a command fails when you apply a macro, either due to a syntax error or to a configuration error,
the macro continues to apply the remaining commands to the interface.
• cisco-global needs to be applied at the global configuration mode. Cisco recommends that you apply
this macro before any other interface level macro.
• Specific keywords are required when you apply the system-defined macros (cisco-desktop,
cisco-phone, cisco-switch, and cisco-router) on an interface.
• When using the cisco-phone macro to apply port security, the port security maximum is 2
(switchport port-security maximum 2).
• At most, 3 keyword-value pairs are allowed per system-defined macro.
• When creating a macro, do not use the exit or end commands or change the command mode by using
interface interface-id. This could cause commands that follow exit, end, or interface interface-id
to execute in a different command mode.
• When creating a macro, ensure that all CLI commands are in the same configuration mode.
• When creating a macro that requires the assignment of unique values, use the parameter value
keywords to designate values specific to the interface. Keyword matching is case sensitive. All
matching occurrences of the keyword are replaced with the corresponding value. Any full match of
a keyword, even if it is part of a larger string, is considered a match and is replaced by the
corresponding value.
• Macro names are case sensitive. For example, the commands macro name Sample-Macro and
macro name sample-macro result in two separate macros.
• Some macros might contain keywords that require a parameter value. Use the macro global apply
macro-name ? global configuration command or the macro apply macro-name ? interface
configuration command to display a list of any required values in the macro. If you apply a macro
without entering the keyword values, the commands are invalid and are not applied.
• When a macro is applied globally to a switch or to a switch interface, all existing configuration on
the interface is retained. This is helpful when applying an incremental configuration.
• If you modify a macro definition by adding or deleting commands, the changes are not reflected on
the interface where the original macro was applied. You need to reapply the updated macro on the
interface to apply the new or changed commands.
• Use the macro global trace macro-name global configuration command or the macro trace
macro-name interface configuration command to apply and debug a macro to find any syntax or
configuration errors. If a command fails because of a syntax error or a configuration error, the macro
continues to apply the remaining commands.
• Some CLI commands are specific to certain interface types. If a macro is applied to an interface that
does not accept the configuration, the macro fails the syntax check or the configuration check, and
the switch returns an error message.
• Applying a macro to an interface range is the same as applying a macro to a single interface. When
you use an interface range, the macro is applied sequentially to each interface within the range. If a
macro command fails on one interface, it is still applied to the remaining interfaces.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
15-6 OL-22250-01
Chapter 15 Configuring SmartPort Macros
Configuring SmartPort Macros
• When you apply a macro to a switch or a switch interface, the macro name is automatically added
to the macro description of the switch or interface. You can display the applied commands and macro
names by using the show parser macro description user EXEC command.
• The user-configurable macro has a buffer that can take commands and comments up to 3000
characters. Each newline would take 2 characters and empty lines are counted as is.
There are Cisco-default SmartPorts macros embedded in the switch software (see Table 15-1). You can
display these macros and the commands they contain by using the show parser macro user EXEC
command.
Follow these guidelines when you apply a Cisco-default SmartPorts macro on an interface:
• Display all macros on the switch by using the show parser macro user EXEC command. Display
the contents of a specific macro by using the show parser macro macro-name user EXEC
command.
• Keywords that begin with $ mean that a unique parameter value is required. Append the
Cisco-default macro with the required values by using the parameter value keywords.
The Cisco-default macros use the $ character to help identify required keywords. There is no
restriction on using the $ character to define keywords when you create a macro.
Creating SmartPorts Macros
To create a SmartPorts macro, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# macro name Creates a macro definition, and enter a macro name. A macro definition
macro-name can contain up to 3000 characters.
Enter the macro commands with one command per line. Use the @
character to end the macro. Use the # character at the beginning of a line
to enter comment text within the macro.
Macro names are case sensitive. For example, the commands macro
name Sample-Macro and macro name sample-macro result in two
separate macros.
We recommend that you do not use the exit or end commands or change
the command mode by using interface interface-id in a macro. This
could cause any commands following exit, end, or interface
interface-id to execute in a different command mode. For best results,
all commands in a macro should be in the same configuration mode.
Note The no form of the macro name global configuration command
only deletes the macro definition. It does not affect the
configuration of those interfaces on which the macro is already
applied.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show parser macro name Verifies that the macro was created.
macro-name
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 15-7
Chapter 15 Configuring SmartPort Macros
Configuring SmartPort Macros
Applying SmartPorts Macros
To apply a SmartPorts macro, follow these steps:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# macro global {apply | Applies each individual command defined in the macro to the switch by
trace} macro-name [parameter { value}] entering macro global apply macro-name. Specify macro global trace
[parameter {value}] [parameter
{value}] macro-name to apply and debug a macro to find any syntax or
configuration errors.
(Optional) Specify unique parameter values that are specific to the
switch. You can enter up to three keyword-value pairs. Parameter
keyword matching is case sensitive. All matching occurrences of the
keyword are replaced with the corresponding value.
Some macros might contain keywords that require a parameter value.
Use the macro global apply macro-name ? command to display a list of
any required values in the macro. If you apply a macro without entering
the keyword values, the commands are invalid and are not applied.
Step 3 Switch(config)# macro global (Optional) Enters a description about the macro that is applied to the
description text switch.
Step 4 Switch(config-if)# interface (Optional) Enters interface configuration mode, and specify the
interface-id interface on which to apply the macro.
Step 5 Switch(config-if)# default interface (Optional) Clears all configuration from the specified interface.
interface-id
Step 6 Switch(config-if)# macro {apply | Applies each individual command defined in the macro to the interface
trace} macro-name [parameter { value}] by entering macro apply macro-name. Specify macro trace
[parameter {value}] [parameter
{value}] macro-name to apply and debug a macro to find any syntax or
configuration errors.
(Optional) Specify unique parameter values that are specific to the
interface. You can enter up to three keyword-value pairs. Parameter
keyword matching is case sensitive. All matching occurrences of the
keyword are replaced with the corresponding value.
Some macros might contain keywords that require a parameter value.
Use the macro apply macro-name ? command to display a list of any
required values in the macro. If you apply a macro without entering the
keyword values, the commands are invalid and are not applied.
For example, here is how you apply this command:
Switch(config-if)# macro apply cisco-phone ?
WORD Keyword to replace with a value e.g. $AVID, $VVID
<cr>
Step 7 Switch(config-if)# macro description (Optional) Enters a description about the macro that is applied to the
text interface.
Step 8 Switch(config-if)# end Returns to privileged EXEC mode.
Step 9 Switch# show parser macro Verifies that the macro is applied to the interface.
description [interface interface-id]
Step 10 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Software Configuration Guide—Release IOS-XE 3.1.0 SG
15-8 OL-22250-01
Chapter 15 Configuring SmartPort Macros
Configuring SmartPort Macros
You can delete a global macro-applied configuration on a switch only by entering the no version of each
command that is in the macro. You can delete a macro-applied configuration on an interface by entering
the default interface interface-id interface configuration command.
The no form of the macro name global configuration command deletes only the macro definition. It
does not affect the configuration of those interfaces on which the macro is already applied. You can
delete a macro-applied configuration on an interface by entering the default interface interface-id
interface configuration command. Alternatively, you can create an anti-macro for an existing macro that
contains the no form of all the corresponding commands in the original macro. Then, apply the
anti-macro to the interface.
The following sections illustrate how to apply and display the attachments on each of the supported
macros:
• cisco-global, page 15-9
• cisco-desktop, page 15-9
• cisco-phone, page 15-10
• cisco-switch, page 15-11
• cisco-router, page 15-11
cisco-global
This example shows how to use the system-defined macro cisco-global:
Switch(config)# macro global apply cisco-global
Changing VTP domain name from gsg-switch to [smartports]
Setting device to VTP TRANSPARENT mode.
Switch(config)# end
Switch# show parser macro name cisco-global
Macro name : cisco-global
Macro type : default global
# Enable dynamic port error recovery for link state failures.
errdisable recovery cause link-flap
errdisable recovery interval 60
# VTP requires Transparent mode for future 802.1x Guest VLAN
# and current Best Practice vtp domain [smartports] vtp mode transparent
# Enable aggressive mode UDLD on all fiber uplinks udld aggressive
# Enable Rapid PVST+ and Loopguard
spanning-tree mode rapid-pvst
spanning-tree loopguard default
spanning-tree extend system-id
cisco-desktop
This example shows how to use the system-defined macro cisco-desktop to assign a value of 35 to the
access VLAN of the Fast Ethernet interface 2/9.
Note This macro requires the $AVID keyword, which is the access VLAN of the port.
Switch(config)# interface fastethernet2/9
Switch(config-if)# macro apply cisco-desktop $AVID 35
Switch(config-if)# end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 15-9
Chapter 15 Configuring SmartPort Macros
Configuring SmartPort Macros
Switch# show parser macro name cisco-desktop
Macro name : cisco-desktop
Macro type : customizable
# Basic interface - Enable data VLAN only
# Recommended value for access vlan (AVID) should not be 1
switchport access vlan $AVID [access_vlan_id]
switchport mode access
# Enable port security limiting port to a single
# MAC address -- that of desktop
switchport port-security
# Ensure port-security age is greater than one minute
# and use inactivity timer
# “Port-security maximum 1” is the default and will not
# Show up in the config
switchport port-security violation restrict
switchport port-security aging time 2
switchport port-security aging type inactivity
# Configure port as an edge network port
spanning-tree portfast
spanning-tree bpduguard enable
Switch# show parser macro description
Interface Macro Description
--------------------------------------------------------------
Fa2/9 cisco-desktop
--------------------------------------------------------------
cisco-phone
This example shows how to use the system-defined macro cisco-phone to assign a value of 35 to the
access VLAN and 56 to the voice VLAN on the Fast Ethernet interface 2/9.
Note This macro requires the $AVID and $VVID keywords, which are the access and voice VLANs of the
port.
Switch(config)# interface fastethernet2/9
Switch(config-if)# macro apply cisco-phone
Switch(config-if)# macro description cisco-phone $AVID 35 $VVID 56
Switch(config-if)# end
Switch# show parser macro name cisco-phone
Macro name : cisco-phone
Macro type : customizable
# VoIP enabled interface - Enable data VLAN
# and voice VLAN (VVID)
# Recommended value for access vlan (AVID) should not be 1\
switchport access vlan $AVID [access_vlan_id]
switchport mode access
# Update the Voice VLAN (VVID) value which should be
# different from data VLAN
# Recommended value for voice vlan (VVID) should not be 1
switchport voice vlan $VVID [voice_vlan_id]
# Enable port security limiting port to a 2 MAC
# addressess -- One for desktop and one for phone
switchport port-security
switchport port-security maximum 2
# Ensure port-security age is greater than one minute
# and use inactivity timer
switchport port-security violation restrict
switchport port-security aging time 2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
15-10 OL-22250-01
Chapter 15 Configuring SmartPort Macros
Configuring SmartPort Macros
switchport port-security aging type inactivity
# Enable auto-qos to extend trust to attached Cisco phone
auto qos voip cisco-phone
# Configure port as an edge network port
spanning-tree portfast
spanning-tree bpduguard enable@
Switch# show parser macro description
Interface Macro Description
--------------------------------------------------------------
Fa2/9 cisco-phone
--------------------------------------------------------------
cisco-switch
This example shows how to use the system-defined macro cisco-switch to assign a value of 38 to the
native VLAN on the Fast Ethernet interface 2/9.
Note This macro requires the $NVID keyword, which is the native VLANs of the port.
Switch(config)# interface fastethernet2/9
Switch(config-if)# macro apply cisco-switch
Switch(config-if)# macro description cisco-switch $NVID 38
Switch(config-if)# end
Switch# show parser macro name cisco-switch
Macro name : cisco-switch
Macro type : customizable
# Access Uplink to Distribution
switchport trunk encapsulation dot1q
# Define unique Native VLAN on trunk ports
# Recommended value for native vlan (NVID) should not be 1
switchport trunk native vlan $NVID [native_vlan_id]
# Update the allowed VLAN range (VRANGE) such that it
# includes data, voice and native VLANs
# switchport trunk allowed vlan $VRANGE [vlan_range]
# Hardcode trunk and disable negotiation to
# speed up convergence
switchport mode trunk
switchport nonegotiate
# Configure qos to trust this interface
auto qos voip trust
# 802.1w defines the link as pt-pt for rapid convergence
spanning-tree link-type point-to-point
Switch# show parser macro description
Interface Macro Description
--------------------------------------------------------------
Fa2/9 cisco-switch
--------------------------------------------------------------
cisco-router
This example shows how to use the system-defined macro cisco-router to assign a value of 451 to the
native VLAN on the Fast Ethernet interface 2/9.
Note This macro requires the $NVID keyword, which is the native VLANs of the port.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 15-11
Chapter 15 Configuring SmartPort Macros
Displaying SmartPort Macros
Switch(config)# interface fastethernet2/9
Switch(config-if)# macro apply cisco-router
Switch(config-if)# macro description cisco-router $NVID 45I
Switch(config-if)# end
Switch# show parser macro name cisco-router
Macro name : cisco-router
Macro type : customizable
# Access Uplink to Distribution
switchport trunk encapsulation dot1q
# Define unique Native VLAN on trunk ports
# Recommended value for native vlan (NVID) should not be 1
switchport trunk native vlan $NVID [native_vlan_id]
# Update the allowed VLAN range (VRANGE) such that it
# includes data, voice and native VLANs
# switchport trunk allowed vlan $VRANGE [vlan_range]
# Hardcode trunk and disable negotiation to
# speed up convergence
# Hardcode speed and duplex to router
switchport mode trunk
switchport nonegotiate
speed 100
duplex full
# Configure qos to trust this interface
auto qos voip trust
qos trust dscp
# Ensure fast access to the network when enabling the interface.
# Ensure that switch devices cannot become active on the interface.
spanning-tree portfast
spanning-tree bpduguard enable
Switch# show parser macro description
Interface Macro Description
--------------------------------------------------------------
Fa2/9 cisco-router
--------------------------------------------------------------
Displaying SmartPort Macros
To display the SmartPort macros, use one or more of the privileged EXEC commands in Table 15-2.
Table 15-2 Commands for Displaying SmartPort Macros
Command Purpose
show parser macro Displays all configured macros.
show parser macro name macro-name Displays a specific macro.
show parser macro brief Displays the configured macro names.
show parser macro description [interface Displays the macro description for all interfaces or for a specified
interface-id] interface.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
15-12 OL-22250-01
CH A P T E R 16
Configuring STP and MST
This chapter describes how to configure the Spanning Tree Protocol (STP) on a Catalyst 4500 series
switch. This chapter also describes how to configure the IEEE 802.1s Multiple Spanning Tree (MST)
protocol on the Catalyst 4500 series switch. MST is a new IEEE standard derived from Cisco's
proprietary Multi-Instance Spanning-Tree Protocol (MISTP) implementation. With MST, you can map
a single spanning-tree instance to several VLANs.
This chapter provides guidelines, procedures, and configuration examples. It includes the following
major sections:
• Overview of STP, page 16-1
• Default STP Configuration, page 16-6
• Configuring STP, page 16-7
• Overview of MST, page 16-21
• MST Configuration Restrictions and Guidelines, page 16-29
• Configuring MST, page 16-29
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Overview of STP
STP is a Layer 2 link management protocol that provides path redundancy while preventing undesirable
loops in the network. For a Layer 2 Ethernet network to function properly, only one active path can exist
between any two stations. A loop-free subset of a network topology is called a spanning tree. The
operation of a spanning tree is transparent to end stations, which cannot detect whether they are
connected to a single LAN segment or a switched LAN of multiple segments.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-1
Chapter 16 Configuring STP and MST
Overview of STP
A Catalyst 4500 series switch use STP (the IEEE 802.1D bridge protocol) on all VLANs. By default, a
single spanning tree runs on each configured VLAN (provided you do not manually disable the spanning
tree). You can enable and disable a spanning tree on a per-VLAN basis.
When you create fault-tolerant internetworks, you must have a loop-free path between all nodes in a
network. The spanning tree algorithm calculates the best loop-free path throughout a switched Layer 2
network. Switches send and receive spanning tree frames at regular intervals. The switches do not
forward these frames, but use the frames to construct a loop-free path.
Multiple active paths between end stations cause loops in the network. If a loop exists in the network,
end stations might receive duplicate messages and switches might learn end station MAC addresses on
multiple Layer 2 interfaces. These conditions result in an unstable network.
A spanning tree defines a tree with a root switch and a loop-free path from the root to all switches in the
Layer 2 network. A spanning tree forces redundant data paths into a standby (blocked) state. If a network
segment in the spanning tree fails and a redundant path exists, the spanning tree algorithm recalculates
the spanning tree topology and activates the standby path.
When two ports on a switch are part of a loop, the spanning tree port priority and port path cost setting
determine which port is put in the forwarding state and which port is put in the blocking state. The
spanning tree port priority value represents the location of an interface in the network topology and how
well located it is to pass traffic. The spanning tree port path cost value represents media speed.
Understanding the Bridge ID
Each VLAN on each network device has a unique 64-bit bridge ID consisting of a bridge priority value,
an extended system ID, and an STP MAC address allocation.
Bridge Priority Value
The bridge priority value determines whether a given redundant link receives priority and is considered
part of a given span in a spanning tree. Preference is given to lower values, and if you want to manually
configure a preference, assign a lower bridge priority value to a link than to its redundant possibility.
With Cisco IOS releases prior to 12.1(12c)EW, the bridge priority is a 16-bit value (see Table 16-1).With
Cisco IOS Release 12.1(12c)EW and later releases, the bridge priority is a 4-bit value when the extended
system ID is enabled (see Table 16-2). See the “Configuring the Bridge Priority of a VLAN” section on
page 16-16.
Extended System ID
Extended system IDs are VLAN IDs between 1025 and 4096. Cisco IOS Releases 12.1(12c)EW and later
releases support a 12-bit extended system ID field as part of the bridge ID (see Table 16-2). Chassis that
support only 64 MAC addresses always use the 12-bit extended system ID. On chassis that support 1024
MAC addresses, you can enable use of the extended system ID. STP uses the VLAN ID as the extended
system ID. See the “Enabling the Extended System ID” section on page 16-8.
Table 16-1 Bridge Priority Value with the Extended System ID Disabled
Bridge Priority Value
Bit 16 Bit 15 Bit 14 Bit 13 Bit 12 Bit 11 Bit 10 Bit 9 Bit 8 Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1
32768 16384 8192 4096 2048 1024 512 256 128 64 32 16 8 4 2 1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-2 OL-22250-01
Chapter 16 Configuring STP and MST
Overview of STP
Table 16-2 Bridge Priority Value and Extended System ID with the Extended System ID Enabled
Bridge Priority Value Extended System ID (Set Equal to the VLAN ID)
Bit 16 Bit 15 Bit 14 Bit 13 Bit 12 Bit 11 Bit 10 Bit 9 Bit 8 Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1
32768 16384 8192 4096 VLAN ID
STP MAC Address Allocation
A Catalyst 4500 series switch chassis has either 64 or 1024 MAC addresses available to support software
features like STP. Enter the show module command to view the MAC address range on your chassis.
Cisco IOS Release 12.1(12c)EW and later releases support chassis with 64 or 1024 MAC addresses. For
chassis with 64 MAC addresses, STP uses the extended system ID plus a MAC address to make the
bridge ID unique for each VLAN.
Earlier releases support chassis with 1024 MAC addresses. With earlier releases, STP uses one MAC
address per VLAN to make the bridge ID unique for each VLAN.
Bridge Protocol Data Units
The following elements determine the stable active spanning tree topology of a switched network:
• The unique bridge ID (bridge priority and MAC address) associated with each VLAN on each switch
• The spanning tree path cost (or bridge priority value) to the root bridge
• The port identifier (port priority and MAC address) associated with each Layer 2 interface
Bridge protocol data units (BPDUs) contain information about the transmitting bridge and its ports,
including the bridge and MAC addresses, bridge priority, port priority, and path cost. The system
computes the spanning tree topology by transmitting BPDUs among connecting switches, and in one
direction from the root switch. Each configuration BPDU contains at least the following:
• The unique bridge ID of the switch that the transmitting switch believes to be the root switch
• The spanning tree path cost to the root
• The bridge ID of the transmitting bridge
• The age of the message
• The identifier of the transmitting port
• Values for the hello, forward delay, and max-age protocol timers
When a switch transmits a BPDU frame, all switches connected to the LAN on which the frame is
transmitted receive the BPDU. When a switch receives a BPDU, it does not forward the frame but instead
uses the information in the frame to calculate a BPDU and, if the topology changes, initiate a BPDU
transmission.
A BPDU exchange results in the following:
• One switch is elected as the root bridge.
• The shortest distance to the root bridge is calculated for each switch based on the path cost.
• A designated bridge for each LAN segment is selected. This is the switch closest to the root bridge
through which frames are forwarded to the root.
• A root port is selected. This is the port providing the best path from the bridge to the root bridge.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-3
Chapter 16 Configuring STP and MST
Overview of STP
• Ports included in the spanning tree are selected.
Election of the Root Bridge
For each VLAN, the switch with the highest bridge priority (the lowest numerical priority value) is
elected as the root bridge. If all switches are configured with the default priority value (32,768), the
switch with the lowest MAC address in the VLAN becomes the root bridge.
The spanning tree root bridge is the logical center of the spanning tree topology in a switched network.
All paths that are not required to reach the root bridge from anywhere in the switched network are placed
in spanning tree blocking mode.
A spanning tree uses the information provided by BPDUs to elect the root bridge and root port for the
switched network, as well as the root port and designated port for each switched segment.
STP Timers
Table 16-3 describes the STP timers that affect the performance of the entire spanning tree.
Table 16-3 Spanning Tree Protocol Timers
Variable Description
hello_time Determines how often the switch broadcasts hello messages to other
switches.
forward_time Determines how long each of the listening and learning states lasts before the
port begins forwarding.
max_age Determines the amount of time that protocol information received on a port
is stored by the switch.
Creating the STP Topology
The goal of the spanning tree algorithm is to make the most direct link the root port. When the spanning
tree topology is calculated based on default parameters, the path between source and destination end
stations in a switched network might not be optimal according to link speed. For instance, connecting
higher-speed links to a port that has a higher number than the current root port can cause a root-port
change.
In Figure 16-1, Switch A is elected as the root bridge. (This could happen if the bridge priority of all the
switches is set to the default value [32,768] and Switch A has the lowest MAC address.) However, due
to traffic patterns, the number of forwarding ports, or link types, Switch A might not be the ideal root
bridge. By increasing the STP port priority (lowering the numerical value) of the ideal switch so that it
becomes the root bridge, you force a spanning tree recalculation to form a new spanning tree topology
with the ideal switch as the root.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-4 OL-22250-01
Chapter 16 Configuring STP and MST
Overview of STP
Figure 16-1 Spanning Tree Topology
DP
DP
A DP D
DP RP DP DP
RP RP DP
S5688
B C
RP = Root Port
DP = Designated Port
For example, assume that one port on Switch B is a fiber-optic link, and another port on Switch B (an
unshielded twisted-pair [UTP] link) is the root port. Network traffic might be more efficient over the
high-speed fiber-optic link. By changing the spanning tree port priority on the fiber-optic port to a higher
priority (lower numerical value) than the priority set for the root port, the fiber-optic port becomes the
new root port.
STP Port States
Propagation delays can occur when protocol information passes through a switched LAN. As a result,
topology changes can take place at different times and at different places in a switched network. When
a Layer 2 interface transitions directly from nonparticipation in the spanning tree topology to the
forwarding state, it can create temporary data loops. Ports must wait for new topology information to
propagate through the switched LAN before starting to forward frames. They must allow the frame
lifetime to expire for frames that have been forwarded under the old topology.
Each Layer 2 interface on a switch that uses spanning tree exists in one of the following five states:
• Blocking—In this state, the Layer 2 interface does not participate in frame forwarding.
• Listening—This state is the first transitional state after the blocking state when spanning tree
determines that the Layer 2 interface should participate in frame forwarding.
• Learning—In this state, the Layer 2 interface prepares to participate in frame forwarding.
• Forwarding—In this state, the Layer 2 interface forwards frames.
• Disabled—In this state, the Layer 2 interface does not participate in spanning tree and does not
forward frames.
MAC Address Allocation
The supervisor engine has a pool of 1024 MAC addresses that are used as the bridge IDs for the VLAN
spanning trees. Use the show module command to view the MAC address range (allocation range for
the supervisor) that the spanning tree uses for the algorithm.
MAC addresses for the Catalyst 4506 switch are allocated sequentially, with the first MAC address in
the range assigned to VLAN 1, the second MAC address in the range assigned to VLAN 2, and so forth.
For example, if the MAC address range is 00-e0-1e-9b-2e-00 to 00-e0-1e-9b-31-ff, the VLAN 1 bridge
ID is 00-e0-1e-9b-2e-00, the VLAN 2 bridge ID is 00-e0-1e-9b-2e-01, the VLAN 3 bridge ID is
00-e0-1e-9b-2e-02, and so on. On other Catalyst 4500 series platforms, all VLANS map to the same
MAC address rather than mapping to separate MAC addresses.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-5
Chapter 16 Configuring STP and MST
Default STP Configuration
STP and IEEE 802.1Q Trunks
802.1Q VLAN trunks impose some limitations on the spanning tree strategy for a network. In a network
of Cisco switches connected through 802.1Q trunks, the switches maintain one instance of spanning tree
for each VLAN allowed on the trunks. However, non-Cisco 802.1Q switches maintain only one instance
of spanning tree for all VLANs allowed on the trunks.
When you connect a Cisco switch to a non-Cisco device (that supports 802.1Q) through an 802.1Q trunk,
the Cisco switch combines the spanning tree instance of the 802.1Q native VLAN of the trunk with the
spanning tree instance of the non-Cisco 802.1Q switch. However, all per-VLAN spanning tree
information is maintained by Cisco switches separated by a network of non-Cisco 802.1Q switches. The
non-Cisco 802.1Q network separating the Cisco switches is treated as a single trunk link between the
switches.
Note For more information on 802.1Q trunks, see Chapter 14, “Configuring Layer 2 Ethernet Interfaces.”
Per-VLAN Rapid Spanning Tree
Per-VLAN Rapid Spanning Tree (PVRST+) is the same as PVST+, although PVRST+ utilizes a rapid
STP based on IEEE 802.1w rather than 802.1D to provide faster convergence. PVRST+ uses roughly the
same configuration as PVST+ and needs only minimal configuration. In PVRST+, dynamic CAM entries
are flushed immediately on a per-port basis when any topology change is made. UplinkFast and
BackboneFast are enabled but not active in this mode, because the functionality is built into the Rapid
STP. PVRST+ provides for rapid recovery of connectivity following the failure of a bridge, bridge port,
or LAN.
Note When you interconnect PVST and Rapid-PVST bridges, if the PVST bridge has a higher priority than
the Rapid PVST bridge, then the Rapid PVST bridge transitions directly to the forwarding state,
bypassing the intermediate transition states.
Like Per Vlan Spanning Tree (PVST+), Per Vlan Rapid Spanning Tree (PVRST+) instances are equal to
the number of vlans configured on the switch and can go up to a maximum of 4094 instances.
For enabling information, see “Enabling Per-VLAN Rapid Spanning Tree” on page 20.
Default STP Configuration
Table 16-4 shows the default spanning tree configuration.
Table 16-4 Spanning Tree Default Configuration Values
Feature Default Value
Enable state Spanning tree enabled for all VLANs
Bridge priority value 32,768
Spanning tree port priority value (configurable on a 128
per-interface basis—used on interfaces configured as
Layer 2 access ports)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-6 OL-22250-01
Chapter 16 Configuring STP and MST
Configuring STP
Table 16-4 Spanning Tree Default Configuration Values (continued)
Feature Default Value
Spanning tree port cost (configurable on a per-interface • 10-Gigabit Ethernet: 2
basis—used on interfaces configured as Layer 2 access
• Gigabit Ethernet: 4
ports)
• Fast Ethernet: 19
Spanning tree VLAN port priority value (configurable on 128
a per-VLAN basis—used on interfaces configured as
Layer 2 trunk ports)
Spanning tree VLAN port cost (configurable on a • 10-Gigabit Ethernet: 2
per-VLAN basis—used on interfaces configured as
• Gigabit Ethernet: 4
Layer 2 trunk ports)
• Fast Ethernet: 19
Hello time 2 sec
Forward delay time 15 sec
Maximum aging time 20 sec
Configuring STP
The following sections describe how to configure spanning tree on VLANs:
• Enabling STP, page 16-7
• Enabling the Extended System ID, page 16-8
• Configuring the Root Bridge, page 16-9
• Configuring a Secondary Root Switch, page 16-12
• Configuring STP Port Priority, page 16-13
• Configuring STP Port Cost, page 16-15
• Configuring the Bridge Priority of a VLAN, page 16-16
• Configuring the Hello Time, page 16-17
• Configuring the Maximum Aging Time for a VLAN, page 16-18
• Configuring the Forward-Delay Time for a VLAN, page 16-18
• Disabling Spanning Tree Protocol, page 16-19
• Enabling Per-VLAN Rapid Spanning Tree, page 16-20
Note The spanning tree commands described in this chapter can be configured on any interface except those
configured with the no switchport command.
Enabling STP
Note By default, spanning tree is enabled on all the VLANs.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-7
Chapter 16 Configuring STP and MST
Configuring STP
You can enable a spanning tree on a per-VLAN basis. The switch maintains a separate instance of
spanning tree for each VLAN (except on VLANs on which you have disabled a spanning tree).
To enable a spanning tree on a per-VLAN basis, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# spanning-tree vlan vlan_ID Enables spanning tree for VLAN vlan_id. The vlan_ID value
can range from 1 to 4094.
Step 3 Switch(config)# end Exits configuration mode.
Step 4 Switch# show spanning-tree vlan vlan_ID Verifies that spanning tree is enabled.
This example shows how to enable a spanning tree on VLAN 200:
Switch# configure terminal
Switch(config)# spanning-tree vlan 200
Switch(config)# end
Switch#
Note Because spanning tree is enabled by default, issuing a show running command to view the resulting
configuration does not display the command you entered to enable spanning tree.
This example shows how to verify that spanning tree is enabled on VLAN 200:
Switch# show spanning-tree vlan 200
VLAN200 is executing the ieee compatible Spanning Tree protocol
Bridge Identifier has priority 32768, address 0050.3e8d.6401
Configured hello time 2, max age 20, forward delay 15
Current root has priority 16384, address 0060.704c.7000
Root port is 264 (FastEthernet5/8), cost of root path is 38
Topology change flag not set, detected flag not set
Number of topology changes 0 last change occurred 01:53:48 ago
Times: hold 1, topology change 24, notification 2
hello 2, max age 14, forward delay 10
Timers: hello 0, topology change 0, notification 0
Port 264 (FastEthernet5/8) of VLAN200 is forwarding
Port path cost 19, Port priority 128, Port Identifier 129.9.
Designated root has priority 16384, address 0060.704c.7000
Designated bridge has priority 32768, address 00e0.4fac.b000
Designated port id is 128.2, designated path cost 19
Timers: message age 3, forward delay 0, hold 0
Number of transitions to forwarding state: 1
BPDU: sent 3, received 3417
Switch#
Enabling the Extended System ID
Note The extended system ID is enabled permanently on chassis that support 64 MAC addresses.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-8 OL-22250-01
Chapter 16 Configuring STP and MST
Configuring STP
Use the spanning-tree extend system-id command to enable the extended system ID on chassis that
support 1024 MAC addresses. See the “Understanding the Bridge ID” section on page 16-2.
To enable the extended system ID, perform this task:
Command Purpose
Step 1 Switch(config)# spanning-tree extend system-id Enables the extended system ID.
Disables the extended system ID.
Note You cannot disable the extended system ID on
chassis that support 64 MAC addresses or when
you have configured extended range VLANs (see
“Table 16-4Spanning Tree Default Configuration
Values” section on page 16-6).
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show spanning-tree vlan vlan_ID Verifies the configuration.
Note When you enable or disable the extended system ID, the bridge IDs of all active STP instances are
updated, which might change the spanning tree topology.
This example shows how to enable the extended system ID:
Switch# configure terminal
Switch(config)# spanning-tree extend system-id
Switch(config)# end
Switch#
This example shows how to verify the configuration:
Switch# show spanning-tree summary | include extended
Extended system ID is enabled.
Configuring the Root Bridge
A Catalyst 4000 family switch maintains an instance of spanning tree for each active VLAN configured
on the switch. A bridge ID, consisting of the bridge priority and the bridge MAC address, is associated
with each instance. For each VLAN, the switch with the lowest bridge ID becomes the root bridge for
that VLAN. Whenever the bridge priority changes, the bridge ID also changes. This results in the
recomputation of the root bridge for the VLAN.
To configure a switch to become the root bridge for the specified VLAN, use the spanning-tree vlan
vlan-ID root command to modify the bridge priority from the default value (32,768) to a significantly
lower value. The bridge priority for the specified VLAN is set to 8192 if this value causes the switch to
become the root for the VLAN. If any bridge for the VLAN has a priority lower than 8192, the switch
sets the priority to 1 less than the lowest bridge priority.
For example, assume that all the switches in the network have the bridge priority for VLAN 100 set to
the default value of 32,768. Entering the spanning-tree vlan 100 root primary command on a switch
sets the bridge priority for VLAN 100 to 8192, causing this switch to become the root bridge for
VLAN 100.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-9
Chapter 16 Configuring STP and MST
Configuring STP
Note The root switch for each instance of spanning tree should be a backbone or distribution switch. Do not
configure an access switch as the spanning tree primary root.
Use the diameter keyword to specify the Layer 2 network diameter (the maximum number of bridge
hops between any two end stations in the network). When you specify the network diameter, a switch
automatically picks an optimal hello time, forward delay time, and maximum age time for a network of
that diameter. This behavior can significantly reduce the spanning tree convergence time.
Use the hello-time keyword to override the automatically calculated hello time.
Note We recommend that you avoid manually configuring the hello time, forward delay time, and maximum
age time after configuring the switch as the root bridge.
To configure a switch as the root switch, perform this task:
Command Purpose
Step 1 Switch(config)# [no] spanning-tree vlan vlan_ID Configures a switch as the root switch.
root primary [diameter hops [hello-time seconds]]
Use the no keyword to restore the defaults.
Step 2 Switch(config)# end Exits configuration mode.
This example shows how to configure a switch as the root bridge for VLAN 10, with a network diameter
of 4:
Switch# configure terminal
Switch(config)# spanning-tree vlan 10 root primary diameter 4
Switch(config)# end
Switch#
This example shows how the configuration changes when a switch becomes a spanning tree root. This
is the configuration before the switch becomes the root for VLAN 1:
Switch#show spanning-tree vlan 1
VLAN1 is executing the ieee compatible Spanning Tree protocol
Bridge Identifier has priority 32768, address 0030.94fc.0a00
Configured hello time 2, max age 20, forward delay 15
Current root has priority 32768, address 0001.6445.4400
Root port is 323 (FastEthernet6/3), cost of root path is 19
Topology change flag not set, detected flag not set
Number of topology changes 2 last change occurred 00:02:19 ago
from FastEthernet6/1
Times: hold 1, topology change 35, notification 2
hello 2, max age 20, forward delay 15
Timers:hello 0, topology change 0, notification 0, aging 300
Port 323 (FastEthernet6/3) of VLAN1 is forwarding
Port path cost 19, Port priority 128, Port Identifier 129.67.
Designated root has priority 32768, address 0001.6445.4400
Designated bridge has priority 32768, address 0001.6445.4400
Designated port id is 129.67, designated path cost 0
Timers:message age 2, forward delay 0, hold 0
Number of transitions to forwarding state:1
BPDU:sent 3, received 91
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-10 OL-22250-01
Chapter 16 Configuring STP and MST
Configuring STP
Port 324 (FastEthernet6/4) of VLAN1 is blocking
Port path cost 19, Port priority 128, Port Identifier 129.68.
Designated root has priority 32768, address 0001.6445.4400
Designated bridge has priority 32768, address 0001.6445.4400
Designated port id is 129.68, designated path cost 0
Timers:message age 2, forward delay 0, hold 0
Number of transitions to forwarding state:0
BPDU:sent 1, received 89
Now, you can set the switch as the root:
Switch# configure terminal
Switch(config)# spanning-tree vlan 1 root primary
Switch(config)# spanning-tree vlan 1 root primary
VLAN 1 bridge priority set to 8192
VLAN 1 bridge max aging time unchanged at 20
VLAN 1 bridge hello time unchanged at 2
VLAN 1 bridge forward delay unchanged at 15
Switch(config)# end
This is the configuration after the switch becomes the root:
Switch# show spanning-tree vlan 1
VLAN1 is executing the ieee compatible Spanning Tree protocol
Bridge Identifier has priority 8192, address 0030.94fc.0a00
Configured hello time 2, max age 20, forward delay 15
We are the root of the spanning tree
Topology change flag set, detected flag set
Number of topology changes 3 last change occurred 00:00:09 ago
Times: hold 1, topology change 35, notification 2
hello 2, max age 20, forward delay 15
Timers:hello 0, topology change 25, notification 0, aging 15
Port 323 (FastEthernet6/3) of VLAN1 is forwarding
Port path cost 19, Port priority 128, Port Identifier 129.67.
Designated root has priority 8192, address 0030.94fc.0a00
Designated bridge has priority 8192, address 0030.94fc.0a00
Designated port id is 129.67, designated path cost 0
Timers:message age 0, forward delay 0, hold 0
Number of transitions to forwarding state:1
BPDU:sent 9, received 105
Port 324 (FastEthernet6/4) of VLAN1 is listening
Port path cost 19, Port priority 128, Port Identifier 129.68.
Designated root has priority 8192, address 0030.94fc.0a00
Designated bridge has priority 8192, address 0030.94fc.0a00
Designated port id is 129.68, designated path cost 0
Timers:message age 0, forward delay 5, hold 0
Number of transitions to forwarding state:0
BPDU:sent 6, received 102
Switch#
Note Because the bridge priority is now set at 8192, this switch becomes the root of the spanning tree.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-11
Chapter 16 Configuring STP and MST
Configuring STP
Configuring a Secondary Root Switch
When you configure a switch as the secondary root, the spanning tree bridge priority is modified from
the default value (32,768) to 16,384. This action means that the switch is likely to become the root bridge
for the specified VLANs if the primary root bridge fails (assuming the other switches in the network use
the default bridge priority of 32,768).
You can run this command on more than one switch to configure multiple backup root switches. Use the
same network diameter and hello time values that you used when configuring the primary root switch.
Note We recommend that you avoid manually configuring the hello time, forward delay time, and maximum
age time after configuring the switch as the root bridge.
To configure a switch as the secondary root switch, perform this task:
Command Purpose
Step 1 Switch(config)# [no] spanning-tree vlan vlan_ID Configures a switch as the secondary root switch.
root secondary [diameter hops [hello-time
seconds]] Use the no keyword to restore the defaults.
Step 2 Switch(config)# end Exits configuration mode.
This example shows how to configure the switch as the secondary root switch for VLAN 10, with a
network diameter of 4:
Switch# configure terminal
Switch(config)# spanning-tree vlan 10 root secondary diameter 4
VLAN 10 bridge priority set to 16384
VLAN 10 bridge max aging time set to 14
VLAN 10 bridge hello time unchanged at 2
VLAN 10 bridge forward delay set to 10
Switch(config)# end
Switch#
This example shows how to verify the configuration of VLAN 1:
Switch#sh spanning-tree vlan 1
VLAN0001
Spanning tree enabled protocol ieee
Root ID Priority 32768
Address 0003.6b10.e800
This bridge is the root
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Bridge ID Priority 32768
Address 0003.6b10.e800
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Aging Time 300
Interface Role Sts Cost Prio.Nbr Status
---------------- ---- --- --------- -------- --------------------------------
Fa3/1 Desg FWD 19 128.129 P2p
Fa3/2 Desg FWD 19 128.130 P2p
Fa3/48 Desg FWD 19 128.176 Edge P2p
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-12 OL-22250-01
Chapter 16 Configuring STP and MST
Configuring STP
Configuring STP Port Priority
In the event of a loop, a spanning tree considers port priority when selecting an interface to put into the
forwarding state. You can assign higher priority values to interfaces that you want a spanning tree to
select first and lower priority values to interfaces that you want a spanning tree to select last. If all
interfaces have the same priority value, a spanning tree puts the interface with the lowest interface
number in the forwarding state and blocks other interfaces. The possible priority range is 0 through 240,
configurable in increments of 16 (the default is 128).
Note The Cisco IOS software uses the port priority value when the interface is configured as an access port
and uses VLAN port priority values when the interface is configured as a trunk port.
To configure the spanning tree port priority of an interface, perform this task:
Command Purpose
Step 1 Switch(config)# interface {{fastethernet | Specifies an interface to configure.
gigabitethernet | tengigabitethernet} slot/port}
| {port-channel port_channel_number}
Step 2 Switch(config-if)# [no] spanning-tree Configures the port priority for an interface. The
port-priority port_priority port_priority value can be from 0 to 240, in increments
of 16.
Use the no keyword to restore the defaults.
Step 3 Switch(config-if)# [no] spanning-tree vlan Configures the VLAN port priority for an interface. The
vlan_ID port-priority port_priority port_priority value can be from 0 to 240, in increments
of 16.
Use the no keyword to restore the defaults.
Step 4 Switch(config-if)# end Exits configuration mode.
Step 5 Switch# show spanning-tree interface Verifies the configuration.
{{fastethernet | gigabitethernet} slot/port} |
{port-channel port_channel_number}
show spanning-tree vlan vlan_ID
This example shows how to configure the spanning tree port priority of a Fast Ethernet interface:
Switch# configure terminal
Switch(config)# interface fastethernet 5/8
Switch(config-if)# spanning-tree port-priority 100
Switch(config-if)# end
Switch#
This example shows how to verify the configuration of a Fast Ethernet interface when it is configured as
an access port:
Switch# show spanning-tree interface fastethernet 3/1
Vlan Role Sts Cost Prio.Nbr Status
---------------- ---- --- --------- -------- --------------------------------
VLAN0001 Desg FWD 19 128.129 P2p
VLAN1002 Desg FWD 19 128.129 P2p
VLAN1003 Desg FWD 19 128.129 P2p
VLAN1004 Desg FWD 19 128.129 P2p
VLAN1005 Desg FWD 19 128.129 P2p
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-13
Chapter 16 Configuring STP and MST
Configuring STP
This example shows how to display the details of the interface configuration when the interface is
configured as an access port:
Switch# show spanning-tree interface fastethernet 3/1 detail
Port 129 (FastEthernet3/1) of VLAN0001 is forwarding
Port path cost 19, Port priority 128, Port Identifier 128.129.
Designated root has priority 32768, address 0003.6b10.e800
Designated bridge has priority 32768, address 0003.6b10.e800
Designated port id is 128.129, designated path cost 0
Timers:message age 0, forward delay 0, hold 0
Number of transitions to forwarding state:1
Link type is point-to-point by default
BPDU:sent 187, received 1
Port 129 (FastEthernet3/1) of VLAN1002 is forwarding
Port path cost 19, Port priority 128, Port Identifier 128.129.
Designated root has priority 32768, address 0003.6b10.ebe9
Designated bridge has priority 32768, address 0003.6b10.ebe9
Designated port id is 128.129, designated path cost 0
Timers:message age 0, forward delay 0, hold 0
Number of transitions to forwarding state:1
Link type is point-to-point by default
BPDU:sent 94, received 2
Port 129 (FastEthernet3/1) of VLAN1003 is forwarding
Port path cost 19, Port priority 128, Port Identifier 128.129.
Designated root has priority 32768, address 0003.6b10.ebea
Designated bridge has priority 32768, address 0003.6b10.ebea
Designated port id is 128.129, designated path cost 0
Timers:message age 0, forward delay 0, hold 0
Number of transitions to forwarding state:1
Link type is point-to-point by default
BPDU:sent 94, received 2
Port 129 (FastEthernet3/1) of VLAN1004 is forwarding
Port path cost 19, Port priority 128, Port Identifier 128.129.
Designated root has priority 32768, address 0003.6b10.ebeb
Designated bridge has priority 32768, address 0003.6b10.ebeb
Designated port id is 128.129, designated path cost 0
Timers:message age 0, forward delay 0, hold 0
Number of transitions to forwarding state:1
Link type is point-to-point by default
BPDU:sent 95, received 2
Port 129 (FastEthernet3/1) of VLAN1005 is forwarding
Port path cost 19, Port priority 128, Port Identifier 128.129.
Designated root has priority 32768, address 0003.6b10.ebec
Designated bridge has priority 32768, address 0003.6b10.ebec
Designated port id is 128.129, designated path cost 0
Timers:message age 0, forward delay 0, hold 0
Number of transitions to forwarding state:1
Link type is point-to-point by default
BPDU:sent 95, received 2
Switch#
Note The show spanning-tree port-priority command displays only information for ports with an active
link. If there is no port with an active link, enter a show running-config interface command to verify
the configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-14 OL-22250-01
Chapter 16 Configuring STP and MST
Configuring STP
This example shows how to configure the spanning tree VLAN port priority of a Fast Ethernet interface:
Switch# configure terminal
Switch(config)# interface fastethernet 5/8
Switch(config-if)# spanning-tree vlan 200 port-priority 64
Switch(config-if)# end
Switch#
This example shows how to verify the configuration of VLAN 200 on the interface when it is configured
as a trunk port:
Switch# show spanning-tree vlan 200
<...output truncated...>
Port 264 (FastEthernet5/8) of VLAN200 is forwarding
Port path cost 19, Port priority 64, Port Identifier 129.8.
Designated root has priority 32768, address 0010.0d40.34c7
Designated bridge has priority 32768, address 0010.0d40.34c7
Designated port id is 128.1, designated path cost 0
Timers: message age 2, forward delay 0, hold 0
Number of transitions to forwarding state: 1
BPDU: sent 0, received 13513
<...output truncated...>
Switch#
Configuring STP Port Cost
The default value for spanning tree port path cost is derived from the interface media speed. In the event
of a loop, spanning tree considers port cost when selecting an interface to put into the forwarding state.
You can assign lower cost values to interfaces that you want spanning tree to select first, and higher cost
values to interfaces that you want spanning tree to select last. If all interfaces have the same cost value,
spanning tree puts the interface with the lowest interface number in the forwarding state and blocks other
interfaces. The possible cost range is 1 through 200,000,000 (the default is media-specific).
Spanning tree uses the port cost value when the interface is configured as an access port and uses VLAN
port cost values when the interface is configured as a trunk port.
To configure the spanning tree port cost of an interface, perform this task:
Command Purpose
Step 1 Switch(config)# interface {{fastethernet | Specifies an interface to configure.
gigabitethernet | tengigabitethernet} slot/port}
| {port-channel port_channel_number}
Step 2 Switch(config-if)# [no] spanning-tree cost Configures the port cost for an interface. The port_cost
port_cost value can be from 1 to 200,000,000.
Use the no keyword to restore the defaults.
Step 3 Switch(config-if)# [no] spanning-tree vlan Configures the VLAN port cost for an interface. The
vlan_ID cost port_cost port_cost value can be from 1 to 200,000,000.
Use the no keyword to restore the defaults.
Step 4 Switch(config-if)# end Exits configuration mode.
Step 5 Switch# show spanning-tree interface Verifies the configuration.
{{fastethernet | gigabitethernet} slot/port} |
{port-channel port_channel_number}
show spanning-tree vlan vlan_ID
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-15
Chapter 16 Configuring STP and MST
Configuring STP
This example shows how to change the spanning tree port cost of a Fast Ethernet interface:
Switch# configure terminal
Switch(config)# interface fastethernet 5/8
Switch(config-if)# spanning-tree cost 18
Switch(config-if)# end
Switch#
This example shows how to verify the configuration of the interface when it is configured as an access
port:
Switch# show spanning-tree interface fastethernet 5/8
Port 264 (FastEthernet5/8) of VLAN200 is forwarding
Port path cost 18, Port priority 100, Port Identifier 129.8.
Designated root has priority 32768, address 0010.0d40.34c7
Designated bridge has priority 32768, address 0010.0d40.34c7
Designated port id is 128.1, designated path cost 0
Timers: message age 2, forward delay 0, hold 0
Number of transitions to forwarding state: 1
BPDU: sent 0, received 13513
Switch#
This example shows how to configure the spanning tree VLAN port cost of a Fast Ethernet interface:
Switch# configure terminal
Switch(config)# interface fastethernet 5/8
Switch(config-if)# spanning-tree vlan 200 cost 17
Switch(config-if)# end
Switch#
This example shows how to verify the configuration of VLAN 200 on the interface when it is configured
as a trunk port:
Switch# show spanning-tree vlan 200
<...output truncated...>
Port 264 (FastEthernet5/8) of VLAN200 is forwarding
Port path cost 17, Port priority 64, Port Identifier 129.8.
Designated root has priority 32768, address 0010.0d40.34c7
Designated bridge has priority 32768, address 0010.0d40.34c7
Designated port id is 128.1, designated path cost 0
Timers: message age 2, forward delay 0, hold 0
Number of transitions to forwarding state: 1
BPDU: sent 0, received 13513
<...output truncated...>
Switch#
Note The show spanning-tree command displays only information for ports with an active link (green light
is on). If there is no port with an active link, you can issue a show running-config command to confirm
the configuration.
Configuring the Bridge Priority of a VLAN
Note Exercise care when configuring the bridge priority of a VLAN. In most cases, we recommend that you
enter the spanning-tree vlan vlan_ID root primary and the spanning-tree vlan vlan_ID root
secondary commands to modify the bridge priority.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-16 OL-22250-01
Chapter 16 Configuring STP and MST
Configuring STP
To configure the spanning tree bridge priority of a VLAN, perform this task:
Command Purpose
Step 1 Switch(config)# [no] spanning-tree vlan vlan_ID Configures the bridge priority of a VLAN. The
priority bridge_priority bridge_priority value can be from 1 to 65,534.
Use the no keyword to restore the defaults.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show spanning-tree vlan vlan_ID bridge Verifies the configuration.
[brief]
This example shows how to configure the bridge priority of VLAN 200 to 33,792:
Switch# configure terminal
Switch(config)# spanning-tree vlan 200 priority 33792
Switch(config)# end
Switch#
This example shows how to verify the configuration:
Switch# show spanning-tree vlan 200 bridge brief
Hello Max Fwd
Vlan Bridge ID Time Age Delay Protocol
---------------- -------------------- ---- ---- ----- --------
VLAN200 33792 0050.3e8d.64c8 2 20 15 ieee
Switch#
Configuring the Hello Time
Note Exercise care when configuring the hello time. In most cases, we recommend that you use the
spanning-tree vlan vlan_ID root primary and the spanning-tree vlan vlan_ID root secondary
commands to modify the hello time.
To configure the spanning tree hello time of a VLAN, perform this task:
Command Purpose
Step 1 Switch(config)# [no] spanning-tree vlan vlan_ID Configures the hello time of a VLAN. The hello_time
hello-time hello_time value can be from 1 to 10 seconds.
Use the no keyword to restore the defaults.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show spanning-tree vlan vlan_ID bridge Verifies the configuration.
[brief]
This example shows how to configure the hello time for VLAN 200 to 7 seconds:
Switch# configure terminal
Switch(config)# spanning-tree vlan 200 hello-time 7
Switch(config)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-17
Chapter 16 Configuring STP and MST
Configuring STP
This example shows how to verify the configuration:
Switch# show spanning-tree vlan 200 bridge brief
Hello Max Fwd
Vlan Bridge ID Time Age Delay Protocol
---------------- -------------------- ---- ---- ----- --------
VLAN200 49152 0050.3e8d.64c8 7 20 15 ieee
Switch#
Configuring the Maximum Aging Time for a VLAN
Note Exercise care when configuring aging time. In most cases, we recommend that you use the
spanning-tree vlan vlan_ID root primary and the spanning-tree vlan vlan_ID root secondary
commands to modify the maximum aging time.
To configure the spanning tree maximum aging time for a VLAN, perform this task:
Command Purpose
Step 1 Switch(config)# [no] spanning-tree vlan vlan_ID Configures the maximum aging time of a VLAN. The
max-age max_age max_age value can be from 6 to 40 seconds.
Use the no keyword to restore the defaults.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show spanning-tree vlan vlan_ID bridge Verifies the configuration.
[brief]
This example shows how to configure the maximum aging time for VLAN 200 to 36 seconds:
Switch# configure terminal
Switch(config)# spanning-tree vlan 200 max-age 36
Switch(config)# end
Switch#
This example shows how to verify the configuration:
Switch# show spanning-tree vlan 200 bridge brief
Hello Max Fwd
Vlan Bridge ID Time Age Delay Protocol
---------------- -------------------- ---- ---- ----- --------
VLAN200 49152 0050.3e8d.64c8 2 36 15 ieee
Switch#
Configuring the Forward-Delay Time for a VLAN
Note Exercise care when configuring forward-delay time. In most cases, we recommend that you use the
spanning-tree vlan vlan_ID root primary and the spanning-tree vlan vlan_ID root secondary
commands to modify the forward delay time.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-18 OL-22250-01
Chapter 16 Configuring STP and MST
Configuring STP
To configure the spanning tree forward delay time for a VLAN, perform this task:
Command Purpose
Step 1 Switch(config)# [no] spanning-tree vlan vlan_ID Configures the forward time of a VLAN. The
forward-time forward_time forward_time value can be from 4 to 30 seconds.
Use the no keyword to restore the defaults.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show spanning-tree vlan vlan_ID bridge Verifies the configuration.
[brief]
This example shows how to configure the forward delay time for VLAN 200 to 21 seconds:
Switch# configure terminal
Switch(config)# spanning-tree vlan 200 forward-time 21
Switch(config)# end
Switch#
This example shows how to verify the configuration:
Switch# show spanning-tree vlan 200 bridge brief
Hello Max Fwd
Vlan Bridge ID Time Age Delay Protocol
---------------- -------------------- ---- ---- ----- --------
VLAN200 49152 0050.3e8d.64c8 2 20 21 ieee
Switch#
This example shows how to display spanning tree information for the bridge:
Switch# show spanning-tree bridge
Hello Max Fwd
Vlan Bridge ID Time Age Dly Protocol
---------------- --------------------------------- ----- --- --- --------
VLAN200 49152 0050.3e8d.64c8 2 20 15 ieee
VLAN202 49152 0050.3e8d.64c9 2 20 15 ieee
VLAN203 49152 0050.3e8d.64ca 2 20 15 ieee
VLAN204 49152 0050.3e8d.64cb 2 20 15 ieee
VLAN205 49152 0050.3e8d.64cc 2 20 15 ieee
VLAN206 49152 0050.3e8d.64cd 2 20 15 ieee
Switch#
Disabling Spanning Tree Protocol
To disable spanning tree on a per-VLAN basis, perform this task:
Command Purpose
Step 1 Switch(config)# no spanning-tree vlan vlan_ID Disables spanning tree on a per-VLAN basis.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show spanning-tree vlan vlan_ID Verifies that spanning tree is disabled.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-19
Chapter 16 Configuring STP and MST
Configuring STP
This example shows how to disable spanning tree on VLAN 200:
Switch# configure terminal
Switch(config)# no spanning-tree vlan 200
Switch(config)# end
Switch#
This example shows how to verify the configuration:
Switch# show spanning-tree vlan 200
Spanning tree instance for VLAN 200 does not exist.
Switch#
Enabling Per-VLAN Rapid Spanning Tree
Per-VLAN Rapid Spanning Tree (PVRST+) uses the existing PVST+ framework for configuration
purposes and for interaction with other features. It also supports some of the PVST+ extensions.
To configure PVRST+, perform this task:
Command Purpose
Step 1 Switch(config)# [no] spantree mode rapid-pvst Enables rapid-PVST+.
Step 2 Switch(config)# interface interface/port Switches to interface configuration mode.
Step 3 Switch(config)# Sets the link-type to point-to-point mode for the port.
spanning-tree link-type point-to-point
Step 4 Switch(config-if)# exit Exits interface mode.
Step 5 Switch(config)# exit Exits configuration mode.
Step 6 Switch(config-if)# clear spantree Detects any legacy bridges on the port
detected-protocols mod/port
Step 7 Switch# show spanning-tree summary totals Verifies the rapid-PVST+ configuration.
The following example shows how to configure Rapid-PVST+:
Switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# spanning-tree mode rapid-pvst
Switch(config)# int fa 6/4
Switch(config-if)# spanning-tree link-type point-to-point
Switch(config-if)# end
Switch(config)# end
Switch#
23:55:32:%SYS-5-CONFIG_I:Configured from console by console
Switch# clear spanning-tree detected-protocols
The following example shows how to verify the configuration:
Switch# show spanning-tree summary totals
Switch is in rapid-pvst mode
Root bridge for:VLAN0001
Extended system ID is disabled
Portfast Default is disabled
PortFast BPDU Guard Default is disabled
Portfast BPDU Filter Default is disabled
Loopguard Default is disabled
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-20 OL-22250-01
Chapter 16 Configuring STP and MST
Overview of MST
EtherChannel misconfig guard is enabled
UplinkFast is disabled
BackboneFast is disabled
Pathcost method used is short
Name Blocking Listening Learning Forwarding STP Active
---------------------- -------- --------- -------- ---------- ----------
1 vlan 0 0 0 2 2
Switch#
Specifying the Link Type
Rapid connectivity is established only on point-to-point links. Spanning tree views a point-to-point link
as a segment connecting only two switches running the spanning tree algorithm. Because the switch
assumes that all full-duplex links are point-to-point links and that half-duplex links are shared links, you
can avoid explicitly configuring the link type. To configure a specific link type, use the spanning-tree
linktype command.
Restarting Protocol Migration
A switch running both MSTP and RSTP supports a built-in protocol migration process that enables the
switch to interoperate with legacy 802.1D switches. If this switch receives a legacy 802.1D configuration
BPDU (a BPDU with the protocol version set to 0), it sends only 802.1D BPDUs on that port.
Furthermore, when an MSTP switch receives a legacy BPDU, it can also detect the following:
• that a port is at the boundary of a region
• an MST BPDU (version 3) associated with a different region, or
• an RST BPDU (version 2).
The switch, however, does not automatically revert to the MSTP mode if it no longer receives 802.1D
BPDUs because it cannot determine whether or not the legacy switch has been removed from the link
unless the legacy switch is the designated switch. A switch also might continue to assign a boundary role
to a port when the switch to which it is connected has joined the region.
To restart the protocol migration process on the entire switch (that is, to force renegotiation with
neighboring switches), use the clear spanning-tree detected-protocols commands in privileged EXEC
mode. To restart the protocol migration process on a specific interface, enter the clear spanning-tree
detected-protocols interface command in interface-id privileged EXEC mode.
Overview of MST
The following sections describe how MST works on a Catalyst 4000 family switch:
• IEEE 802.1s MST, page 16-22
• IEEE 802.1w RSTP, page 16-23
• MST-to-SST Interoperability, page 16-24
• Common Spanning Tree, page 16-25
• MST Instances, page 16-26
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-21
Chapter 16 Configuring STP and MST
Overview of MST
• MST Configuration Parameters, page 16-26
• MST Regions, page 16-26
• Message Age and Hop Count, page 16-28
• MST-to-PVST+ Interoperability, page 16-28
IEEE 802.1s MST
MST extends the IEEE 802.1w rapid spanning tree (RST) algorithm to multiple spanning trees. This
extension provides both rapid convergence and load balancing in a VLAN environment. MST converges
faster than Per VLAN Spanning Tree Plus (PVST+) and is backward compatible with 802.1D STP,
802.1w (Rapid Spanning Tree Protocol [RSTP]), and the Cisco PVST+ architecture.
MST allows you to build multiple spanning trees over trunks. You can group and associate VLANs to
spanning tree instances. Each instance can have a topology independent of other spanning tree instances.
This architecture provides multiple forwarding paths for data traffic and enables load balancing.
Network fault tolerance is improved because a failure in one instance (forwarding path) does not affect
other instances.
In large networks, you can more easily administer the network and use redundant paths by locating
different VLAN and spanning tree instance assignments in different parts of the network. A
spanning tree instance can exist only on bridges that have compatible VLAN instance assignments. You
must configure a set of bridges with the same MST configuration information, which allows them to
participate in a specific set of spanning tree instances. Interconnected bridges that have the same MST
configuration are referred to as an MST region.
MST uses the modified RSTP, MSTP. MST has the following characteristics:
• MST runs a variant of spanning tree called Internal Spanning Tree (IST). IST augments Common
Spanning Tree (CST) information with internal information about the MST region. The MST region
appears as a single bridge to adjacent single spanning tree (SST) and MST regions.
• A bridge running MST provides interoperability with SST bridges as follows:
– MST bridges run IST, which augments CST information with internal information about the
MST region.
– IST connects all the MST bridges in the region and appears as a subtree in the CST that includes
the whole bridged domain. The MST region appears as a virtual bridge to adjacent SST bridges
and MST regions.
– The Common and Internal Spanning Tree (CIST) is the collection of the following: ISTs in each
MST region, the CST that interconnects the MST regions, and the SST bridges. CIST is
identical to an IST inside an MST region and identical to a CST outside an MST region. The
STP, RSTP, and MSTP together elect a single bridge as the root of the CIST.
• MST establishes and maintains additional spanning trees within each MST region. These spanning
trees are termed MST instances (MSTIs). The IST is numbered 0, and the MSTIs are numbered 1,
2, 3, and so on. Any MSTI is local to the MST region and is independent of MSTIs in another region,
even if the MST regions are interconnected.
MST instances combine with the IST at the boundary of MST regions to become the CST as follows:
– Spanning tree information for an MSTI is contained in an MSTP record (M-record).
M-records are always encapsulated within MST bridge protocol data units (BPDUs). The
original spanning trees computed by MSTP are called M-trees, which are active only within the
MST region. M-trees merge with the IST at the boundary of the MST region and form the CST.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-22 OL-22250-01
Chapter 16 Configuring STP and MST
Overview of MST
• MST provides interoperability with PVST+ by generating PVST+ BPDUs for the non-CST VLANs.
• MST supports some of the PVST+ extensions in MSTP as follows:
– UplinkFast and BackboneFast are not available in MST mode; they are part of RSTP.
– PortFast is supported.
– BPDU filter and BPDU guard are supported in MST mode.
– Loop guard and root guard are supported in MST. MST preserves the VLAN 1 disabled
functionality except that BPDUs are still transmitted in VLAN 1.
– MST switches operate as if MAC reduction is enabled.
– For private VLANs (PVLANs), you must map a secondary VLAN to the same instance as the
primary.
IEEE 802.1w RSTP
RSTP, specified in 802.1w, supersedes STP specified in 802.1D, but remains compatible with STP. You
configure RSTP when you configure the MST feature. For more information, see the “Configuring MST”
section on page 16-29.
RSTP provides the structure on which the MST operates, significantly reducing the time to reconfigure
the active topology of a network when its physical topology or configuration parameters change. RSTP
selects one switch as the root of a spanning-tree-connected active topology and assigns port roles to
individual ports of the switch, depending on whether that port is part of the active topology.
RSTP provides rapid connectivity following the failure of a switch, switch port, or a LAN. A new root
port and the designated port on the other side of the bridge transition to the forwarding state through an
explicit handshake between them. RSTP allows switch port configuration so the ports can transition to
forwarding directly when the switch reinitializes.
RSTP provides backward compatibility with 802.1D bridges as follows:
• RSTP selectively sends 802.1D-configured BPDUs and Topology Change Notification (TCN)
BPDUs on a per-port basis.
• When a port initializes, the migration delay timer starts and RSTP BPDUs are transmitted. While
the migration delay timer is active, the bridge processes all BPDUs received on that port.
• If the bridge receives an 802.1D BPDU after a port’s migration delay timer expires, the bridge
assumes it is connected to an 802.1D bridge and starts using only 802.1D BPDUs.
• When RSTP uses 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.
RSTP Port Roles
In RSTP, the port roles are defined as follows:
• Root—A forwarding port elected for the spanning tree topology.
• Designated—A forwarding port elected for every switched LAN segment.
• Alternate—An alternate path to the root bridge to that provided by the current root port.
• Backup—A backup for the path provided by a designated port toward the leaves of the spanning tree.
Backup ports can exist only where two ports are connected together in a loopback mode or bridge
with two or more connections to a shared LAN segment.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-23
Chapter 16 Configuring STP and MST
Overview of MST
• Disabled—A port that has no role within the operation of spanning tree.
The system assigns port roles as follows:
• A root port or designated port role includes the port in the active topology.
• An alternate port or backup port role excludes the port from the active topology.
RSTP Port States
The port state controls the forwarding and learning processes and provides the values of discarding,
learning, and forwarding. Table 16-5 shows the STP port states and RSTP port states.
Table 16-5 Comparison Between STP and RSTP Port States
Operational Status STP Port State RSTP Port State Port Included in Active Topology
1 2
Enabled Blocking Discarding No
Enabled Listening Discarding No
Enabled Learning Learning Yes
Enabled Forwarding Forwarding Yes
Disabled Disabled Discarding No
1. IEEE 802.1D port state designation.
2. IEEE 802.1w port state designation. Discarding is the same as blocking in MST.
In a stable topology, RSTP ensures that every root port and designated port transitions to the forwarding
state while all alternate ports and backup ports are always in the discarding state.
MST-to-SST Interoperability
A virtual bridged LAN may contain interconnected regions of SST and MST bridges. Figure 16-2 shows
this relationship.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-24 OL-22250-01
Chapter 16 Configuring STP and MST
Overview of MST
Figure 16-2 Network with Interconnected SST and MST Regions
MST
Region B
r
B B
F B
F F
F
r F F r
SST r r
b r
Region F b SST
F Region
r
F B
F F
F F
F/f = Forwarding R
B/b = Blocking MST
R = Root Bridge
68285
Region
r = Root port
To STP running in the SST region, an MST region appears as a single SST or pseudobridge, which
operates as follows:
• Although the values for root identifiers and root path costs match for all BPDUs in all
pseudobridges, a pseudobridge differs from a single SST bridge as follows:
– The pseudobridge BPDUs have different bridge identifiers. This difference does not affect STP
operation in the neighboring SST regions because the root identifier and root cost are the same.
– BPDUs sent from the pseudobridge ports may have significantly different message ages.
Because the message age increases by one second for each hop, the difference in the message
age is measured in seconds.
• Data traffic from one port of a pseudobridge (a port at the edge of a region) to another port follows
a path entirely contained within the pseudobridge or MST region. Data traffic belonging to different
VLANs might follow different paths within the MST regions established by MST.
• The system prevents looping by doing either of the following:
– Blocking the appropriate pseudobridge ports by allowing one forwarding port on the boundary
and blocking all other ports.
– Setting the CST partitions to block the ports of the SST regions.
Common Spanning Tree
CST (802.1Q) is a single spanning tree for all the VLANs. In a Catalyst 4500 series switch running
PVST+, the VLAN 1 spanning tree corresponds to CST. In a Catalyst 4500 series switch running MST,
IST (instance 0) corresponds to CST.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-25
Chapter 16 Configuring STP and MST
Overview of MST
MST Instances
We support 65 instances including instance 0. Each spanning tree instance is identified by an instance
ID that ranges from 0 to 4094. Instance 0 is mandatory and is always present. Rest of the instances are
optional.
MST Configuration Parameters
MST configuration has three parts, as follows:
• Name—A 32-character string (null padded) that identifies the MST region.
• Revision number—An unsigned 16-bit number that identifies the revision of the current MST
configuration.
Note You must set the revision number when required as part of the MST configuration. The
revision number is not incremented automatically each time you commit the MST
configuration.
• MST configuration table—An array of 4096 bytes. Each byte, interpreted as an unsigned integer,
corresponds to a VLAN. The value is the instance number to which the VLAN is mapped. The first
byte that corresponds to VLAN 0 and the 4096th byte that corresponds to VLAN 4095 are unused
and always set to zero.
You must configure each byte manually. Use SNMP or the CLI to perform the configuration.
MST BPDUs contain the MST configuration ID and the checksum. An MST bridge accepts an MST
BPDU only if the MST BPDU configuration ID and the checksum match its own MST region
configuration ID and checksum. If either value is different, the MST BPDU is considered to be an
SST BPDU.
MST Regions
These sections describe MST regions:
• MST Region Overview, page 16-26
• Boundary Ports, page 16-27
• IST Master, page 16-27
• Edge Ports, page 16-27
• Link Type, page 16-28
MST Region Overview
Interconnected bridges that have the same MST configuration are referred to as an MST region. There
is no limit on the number of MST regions in the network.
To form an MST region, bridges can be either of the following:
• An MST bridge that is the only member of the MST region.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-26 OL-22250-01
Chapter 16 Configuring STP and MST
Overview of MST
• An MST bridge interconnected by a LAN. A LAN’s designated bridge has the same MST
configuration as an MST bridge. All the bridges on the LAN can process MST BPDUs.
If you connect two MST regions with different MST configurations, the MST regions do the following:
• Load balance across redundant paths in the network. If two MST regions are redundantly connected,
all traffic flows on a single connection with the MST regions in a network.
• Provide an RSTP handshake to enable rapid connectivity between regions. However, the
handshaking is not as fast as between two bridges. To prevent loops, all the bridges inside the region
must agree upon the connections to other regions. This situation introduces a delay. We do not
recommend partitioning the network into a large number of regions.
Boundary Ports
A boundary port is a port that connects to a LAN, the designated bridge of which is either an SST bridge
or a bridge with a different MST configuration. A designated port knows that it is on the boundary if it
detects an STP bridge or receives an agreement message from an RST or MST bridge with a different
configuration.
At the boundary, the role of MST ports do not matter; their state is forced to be the same as the IST port
state. If the boundary flag is set for the port, the MSTP Port Role selection mechanism assigns a port
role to the boundary and the same state as that of the IST port. The IST port at the boundary can take up
any port role except a backup port role.
IST Master
The IST master of an MST region is the bridge with the lowest bridge identifier and the least path cost
to the CST root. If an MST bridge is the root bridge for CST, then it is the IST master of that MST region.
If the CST root is outside the MST region, then one of the MST bridges at the boundary is selected as
the IST master. Other bridges on the boundary that belong to the same region eventually block the
boundary ports that lead to the root.
If two or more bridges at the boundary of a region have an identical path to the root, you can set a slightly
lower bridge priority to make a specific bridge the IST master.
The root path cost and message age inside a region stay constant, but the IST path cost is incremented
and the IST remaining hops are decremented at each hop. Enter the show spanning-tree mst command
to display the information about the IST master, path cost, and remaining hops for the bridge.
Edge Ports
A port that is connected to a nonbridging device (for example, a host or a switch) is an edge port. A port
that connects to a hub is also an edge port if the hub or any LAN that is connected to it does not have a
bridge. An edge port can start forwarding as soon as the link is up.
MST requires that you configure each port connected to a host. To establish rapid connectivity after a
failure, you need to block the non-edge designated ports of an intermediate bridge. If the port connects
to another bridge that can send back an agreement, then the port starts forwarding immediately.
Otherwise, the port needs twice the forward delay time to start forwarding again. You must explicitly
configure the ports that are connected to the hosts and switches as edge ports while using MST.
To prevent a misconfiguration, the PortFast operation is turned off if the port receives a BPDU. You can
display the configured and operational status of PortFast by using the show spanning-tree mst interface
command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-27
Chapter 16 Configuring STP and MST
Overview of MST
Link Type
Rapid connectivity is established only on point-to-point links. You must configure ports explicitly to a
host or switch. However, cabling in most networks meets this requirement, and you can avoid explicit
configuration by treating all full-duplex links as point-to-point links by entering the spanning-tree
linktype command.
Message Age and Hop Count
IST and MST instances do not use the message age and maximum age timer settings in the BPDU. IST
and MST use a separate hop count mechanism that is very similar to the IP time-to live (TTL)
mechanism. You can configure each MST bridge with a maximum hop count. The root bridge of the
instance sends a BPDU (or M-record) with the remaining hop count that is equal to the maximum hop
count. When a bridge receives a BPDU (or M-record), it decrements the received remaining hop count
by one. The bridge discards the BPDU (M-record) and ages out the information held for the port if the
count reaches zero after decrementing. The nonroot bridges propagate the decremented count as the
remaining hop count in the BPDUs (M-records) they generate.
The message age and maximum age timer settings in the RST portion of the BPDU remain the same
throughout the region, and the same values are propagated by the region’s designated ports at the
boundary.
MST-to-PVST+ Interoperability
Keep these guidelines in mind when you configure MST switches (in the same region) to interact with
PVST+ switches:
• Configure the root for all VLANs inside the MST region as shown in this example:
Switch# show spanning-tree mst interface gigabitethernet 1/1
GigabitEthernet1/1 of MST00 is root forwarding
Edge port: no (trunk) port guard : none (default)
Link type: point-to-point (auto) bpdu filter: disable (default)
Boundary : boundary (PVST) bpdu guard : disable (default)
Bpdus sent 10, received 310
Instance Role Sts Cost Prio.Nbr Vlans mapped
-------- ---- --- --------- -------- -------------------------------
0 Root FWD 20000 128.1 1-2,4-2999,4000-4094
3 Boun FWD 20000 128.1 3,3000-3999
The ports that belong to the MST switch at the boundary simulate PVST+ and send PVST+ BPDUs
for all the VLANs.
If you enable loop guard on the PVST+ switches, the ports might change to a loop-inconsistent state
when the MST switches change their configuration. To correct the loop-inconsistent state, you must
disable and renewable loop guard on that PVST+ switch.
• Do not locate the root for some or all of the VLANs inside the PVST+ side of the MST switch
because when the MST switch at the boundary receives PVST+ BPDUs for all or some of the
VLANs on its designated ports, root guard sets the port to the blocking state.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-28 OL-22250-01
Chapter 16 Configuring STP and MST
MST Configuration Restrictions and Guidelines
When you connect a PVST+ switch to two different MST regions, the topology change from the PVST+
switch does not pass beyond the first MST region. In such a case, the topology changes are propagated
only in the instance to which the VLAN is mapped. The topology change stays local to the first MST
region, and the Cisco Access Manager (CAM) entries in the other region are not flushed. To make the
topology change visible throughout other MST regions, you can map that VLAN to IST or connect the
PVST+ switch to the two regions through access links.
MST Configuration Restrictions and Guidelines
Follow these restrictions and guidelines to avoid configuration problems:
• Do not disable spanning tree on any VLAN in any of the PVST bridges.
• Do no use PVST bridges as the root of CST.
• Do not connect switches with access links, because access links may partition a VLAN.
• Ensure that all PVST root bridges have lower (numerically higher) priority than the CST root bridge.
• Ensure that trunks carry all of the VLANs mapped to an instance or do not carry any VLANs at all
for this instance.
• Complete any MST configuration that incorporates a large number of either existing or new logical
VLAN ports during a maintenance window because the complete MST database gets reinitialized
for any incremental change (such as adding new VLANs to instances or moving VLANs across
instances).
Configuring MST
The following sections describe how to configure MST:
• Enabling MST, page 16-29
• Configuring MST Instance Parameters, page 16-31
• Configuring MST Instance Port Parameters, page 16-32
• Restarting Protocol Migration, page 16-33
• Displaying MST Configurations, page 16-33
Enabling MST
To enable and configure MST on a Catalyst 4500, perform this task:
Command Purpose
Step 1 Switch(config)# spanning-tree mode mst Enters MST mode.
Step 2 Switch(config)# spanning-tree mst configuration Enters MST configuration submode.
Use the no keyword to clear the MST configuration.
Step 3 Switch(config-mst)# show current Displays the current MST configuration.
Step 4 Switch(config-mst)# name name Sets the MST region name.
Step 5 Switch(config-mst)# revision revision_number Sets the MST configuration revision number.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-29
Chapter 16 Configuring STP and MST
Configuring MST
Command Purpose
Step 6 Switch(config-mst)# instance instance_number vlan Maps the VLANs to an MST instance.
vlan_range
If you do not specify the vlan keyword, Use the no
keyword to unmap all the VLANs that were mapped to an
MST instance.
If you specify the vlan keyword, Use the no keyword to
unmap a specified VLAN from an MST instance.
Step 7 Switch(config-mst)# show pending Displays the new MST configuration to be applied.
Step 8 Switch(config-mst)# end Applies the configuration and exit MST configuration
submode.
Step 9 Switch# show spanning-tree mst configuration Displays the current MST configuration.
This example show how to enable MST:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# spanning-tree mode mst
Switch(config)# spanning-tree mst configuration
Switch(config-mst)# show current
Current MST configuration
Name []
Revision 0
Instance Vlans mapped
-------- ---------------------------------------------------------------------
0 1-4094
-------------------------------------------------------------------------------
Switch(config-mst)# name cisco
Switch(config-mst)# revision 2
Switch(config-mst)# instance 1 vlan 1
Switch(config-mst)# instance 2 vlan 1-1000
Switch(config-mst)# show pending
Pending MST configuration
Name [cisco]
Revision 2
Instance Vlans mapped
-------- ---------------------------------------------------------------------
0 1001-4094
2 1-1000
-------------------------------------------------------------------------------
Switch(config-mst)# no instance 2
Switch(config-mst)# show pending
Pending MST configuration
Name [cisco]
Revision 2
Instance Vlans mapped
-------- ---------------------------------------------------------------------
0 1-4094
-------------------------------------------------------------------------------
Switch(config-mst)# instance 1 vlan 2000-3000
Switch(config-mst)# no instance 1 vlan 1500
Switch(config-mst)# show pending
Pending MST configuration
Name [cisco]
Revision 2
Instance Vlans mapped
-------- ---------------------------------------------------------------------
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-30 OL-22250-01
Chapter 16 Configuring STP and MST
Configuring MST
0 1-1999,2500,3001-4094
1 2000-2499,2501-3000
-------------------------------------------------------------------------------
Switch(config-mst)# end
Switch(config)# no spanning-tree mst configuration
Switch(config)# end
Switch# show spanning-tree mst configuration
Name []
Revision 0
Instance Vlans mapped
-------- ---------------------------------------------------------------------
0 1-4094
-------------------------------------------------------------------------------
Configuring MST Instance Parameters
To configure MST instance parameters, perform this task:
Command Purpose
Step 1 Switch(config)# spanning-tree mst X priority Y Configures the priority for an MST instance.
Step 2 Switch(config)# spanning-tree mst X root [primary | Configures the bridge as root for an MST instance.
secondary]
Step 3 Switch(config)# Ctrl-Z Exits configuration mode.
Step 4 Switch# show spanning-tree mst Verifies the configuration.
This example shows how to configure MST instance parameters:
Switch(config)# spanning-tree mst 1 priority ?
<0-61440> bridge priority in increments of 4096
Switch(config)# spanning-tree mst 1 priority 1
% Bridge Priority must be in increments of 4096.
% Allowed values are:
0 4096 8192 12288 16384 20480 24576 28672
32768 36864 40960 45056 49152 53248 57344 61440
Switch(config)# spanning-tree mst 1 priority 49152
Switch(config)#
Switch(config)# spanning-tree mst 0 root primary
mst 0 bridge priority set to 24576
mst bridge max aging time unchanged at 20
mst bridge hello time unchanged at 2
mst bridge forward delay unchanged at 15
Switch(config)# ^Z
Switch#
Switch# show spanning-tree mst
###### MST00 vlans mapped: 11-4094
Bridge address 00d0.00b8.1400 priority 24576 (24576 sysid 0)
Root this switch for CST and IST
Configured hello time 2, forward delay 15, max age 20, max hops 20
Interface Role Sts Cost Prio.Nbr Status
---------------- ---- --- --------- -------- --------------------------------
Fa4/4 Back BLK 1000 240.196 P2p
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-31
Chapter 16 Configuring STP and MST
Configuring MST
Fa4/5 Desg FWD 200000 128.197 P2p
Fa4/48 Desg FWD 200000 128.240 P2p Bound(STP)
###### MST01 vlans mapped: 1-10
Bridge address 00d0.00b8.1400 priority 49153 (49152 sysid 1)
Root this switch for MST01
Interface Role Sts Cost Prio.Nbr Status
---------------- ---- --- --------- -------- --------------------------------
Fa4/4 Back BLK 1000 160.196 P2p
Fa4/5 Desg FWD 200000 128.197 P2p
Fa4/48 Boun FWD 200000 128.240 P2p Bound(STP)
Switch#
Configuring MST Instance Port Parameters
To configure MST instance port parameters, perform this task:
Command Purpose
Step 1 Switch(config-if)# spanning-tree mst x cost y Configures the MST instance port cost.
Step 2 Switch(config-if)# spanning-tree mst x port-priority y Configures the MST instance port priority.
Step 3 Switch(config-if)# Ctrl-Z Exits configuration mode.
Step 4 Switch# show spanning-tree mst x interface y Verifies the configuration.
This example shows how to configure MST instance port parameters:
Switch(config)# interface fastethernet 4/4
Switch(config-if)# spanning-tree mst 1 ?
cost Change the interface spanning tree path cost for an instance
port-priority Change the spanning tree port priority for an instance
Switch(config-if)# spanning-tree mst 1 cost 1234567
Switch(config-if)# spanning-tree mst 1 port-priority 240
Switch(config-if)# ^Z
Switch# show spanning-tree mst 1 interface fastethernet 4/4
FastEthernet4/4 of MST01 is backup blocking
Edge port:no (default) port guard :none (default)
Link type:point-to-point (auto) bpdu filter:disable (default)
Boundary :internal bpdu guard :disable (default)
Bpdus (MRecords) sent 125, received 1782
Instance Role Sts Cost Prio.Nbr Vlans mapped
-------- ---- --- --------- -------- -------------------------------
1 Back BLK 1234567 240.196 1-10
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-32 OL-22250-01
Chapter 16 Configuring STP and MST
Configuring MST
Restarting Protocol Migration
RSTP and MST have built-in compatibility mechanisms that allow them to interact properly with other
regions or other versions of IEEE spanning-tree. For example, an RSTP bridge connected to a legacy
bridge can send 802.1D BPDUs on one of its ports. Similarly, when an MST bridge receives a legacy
BPDU or an MST BPDU associated with a different region, it is also to detect that a port is at the
boundary of a region.
Unfortunately, these mechanisms cannot always revert to the most efficient mode. For example, an RSTP
bridge designated for a legacy 802.1D stays in 802.1D mode even after the legacy bridge has been
removed from the link. Similarly, an MST port still assumes that it is a boundary port when the bridge(s)
to which it is connected have joined the same region. To force a Catalyst 4500 series switch to
renegotiate with the neighbors (that is, to restart protocol migration), you must enter the clear
spanning-tree detected-protocols command, as follows:
Switch# clear spanning-tree detected-protocols fastethernet 4/4
Switch#
Displaying MST Configurations
To display MST configurations, perform this task:
Command Purpose
Step 1 Switch# show spanning-tree mst configuration Displays the active region configuration information.
Step 2 Switch# show spanning-tree mst [detail] Displays detailed MST protocol information.
Step 3 Switch# show spanning-tree mst instance-id [detail] Displays information about a specific MST instance.
Step 4 Switch# show spanning-tree mst interface interface Displays information for a given port.
[detail]
Step 5 Switch# show spanning-tree mst instance-id Displays MST information for a given port and a given
interface interface [detail] instance.
Step 6 Switch# show spanning-tree vlan vlan_ID Displays VLAN information in MST mode.
The following examples show how to display spanning tree VLAN configurations in MST mode:
Switch(config)# spanning-tree mst configuration
Switch(config-mst)# instance 1 vlan 1-10
Switch(config-mst)# name cisco
Switch(config-mst)# revision 1
Switch(config-mst)# Ctrl-D
Switch# show spanning-tree mst configuration
Name [cisco]
Revision 1
Instance Vlans mapped
-------- ---------------------------------------------------------------------
0 11-4094
1 1-10
-------------------------------------------------------------------------------
Switch# show spanning-tree mst
###### MST00 vlans mapped: 11-4094
Bridge address 00d0.00b8.1400 priority 32768 (32768 sysid 0)
Root address 00d0.004a.3c1c priority 32768 (32768 sysid 0)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-33
Chapter 16 Configuring STP and MST
Configuring MST
port Fa4/48 path cost 203100
IST master this switch
Operational hello time 2, forward delay 15, max age 20, max hops 20
Configured hello time 2, forward delay 15, max age 20, max hops 20
Interface Role Sts Cost Prio.Nbr Status
---------------- ---- --- --------- -------- --------------------------------
Fa4/4 Back BLK 1000 240.196 P2p
Fa4/5 Desg FWD 200000 128.197 P2p
Fa4/48 Root FWD 200000 128.240 P2p Bound(STP)
###### MST01 vlans mapped: 1-10
Bridge address 00d0.00b8.1400 priority 32769 (32768 sysid 1)
Root this switch for MST01
Interface Role Sts Cost Prio.Nbr Status
---------------- ---- --- --------- -------- --------------------------------
Fa4/4 Back BLK 1000 240.196 P2p
Fa4/5 Desg FWD 200000 128.197 P2p
Fa4/48 Boun FWD 200000 128.240 P2p Bound(STP)
Switch# show spanning-tree mst 1
###### MST01 vlans mapped: 1-10
Bridge address 00d0.00b8.1400 priority 32769 (32768 sysid 1)
Root this switch for MST01
Interface Role Sts Cost Prio.Nbr Status
---------------- ---- --- --------- -------- --------------------------------
Fa4/4 Back BLK 1000 240.196 P2p
Fa4/5 Desg FWD 200000 128.197 P2p
Fa4/48 Boun FWD 200000 128.240 P2p Bound(STP)
Switch# show spanning-tree mst interface fastethernet 4/4
FastEthernet4/4 of MST00 is backup blocking
Edge port:no (default) port guard :none (default)
Link type:point-to-point (auto) bpdu filter:disable (default)
Boundary :internal bpdu guard :disable (default)
Bpdus sent 2, received 368
Instance Role Sts Cost Prio.Nbr Vlans mapped
-------- ---- --- --------- -------- -------------------------------
0 Back BLK 1000 240.196 11-4094
1 Back BLK 1000 240.196 1-10
Switch# show spanning-tree mst 1 interface fastethernet 4/4
FastEthernet4/4 of MST01 is backup blocking
Edge port:no (default) port guard :none (default)
Link type:point-to-point (auto) bpdu filter:disable (default)
Boundary :internal bpdu guard :disable (default)
Bpdus (MRecords) sent 2, received 364
Instance Role Sts Cost Prio.Nbr Vlans mapped
-------- ---- --- --------- -------- -------------------------------
1 Back BLK 1000 240.196 1-10
Switch# show spanning-tree mst 1 detail
###### MST01 vlans mapped: 1-10
Bridge address 00d0.00b8.1400 priority 32769 (32768 sysid 1)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-34 OL-22250-01
Chapter 16 Configuring STP and MST
Configuring MST
Root this switch for MST01
FastEthernet4/4 of MST01 is backup blocking
Port info port id 240.196 priority 240 cost 1000
Designated root address 00d0.00b8.1400 priority 32769 cost 0
Designated bridge address 00d0.00b8.1400 priority 32769 port id 128.197
Timers:message expires in 5 sec, forward delay 0, forward transitions 0
Bpdus (MRecords) sent 123, received 1188
FastEthernet4/5 of MST01 is designated forwarding
Port info port id 128.197 priority 128 cost 200000
Designated root address 00d0.00b8.1400 priority 32769 cost 0
Designated bridge address 00d0.00b8.1400 priority 32769 port id 128.197
Timers:message expires in 0 sec, forward delay 0, forward transitions 1
Bpdus (MRecords) sent 1188, received 123
FastEthernet4/48 of MST01 is boundary forwarding
Port info port id 128.240 priority 128 cost 200000
Designated root address 00d0.00b8.1400 priority 32769 cost 0
Designated bridge address 00d0.00b8.1400 priority 32769 port id 128.240
Timers:message expires in 0 sec, forward delay 0, forward transitions 1
Bpdus (MRecords) sent 78, received 0
Switch# show spanning-tree vlan 10
MST01
Spanning tree enabled protocol mstp
Root ID Priority 32769
Address 00d0.00b8.1400
This bridge is the root
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Bridge ID Priority 32769 (priority 32768 sys-id-ext 1)
Address 00d0.00b8.1400
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Interface Role Sts Cost Prio.Nbr Status
---------------- ---- --- --------- -------- --------------------------------
Fa4/4 Back BLK 1000 240.196 P2p
Fa4/5 Desg FWD 200000 128.197 P2p
Switch# show spanning-tree summary
Root bridge for:MST01
EtherChannel misconfiguration guard is enabled
Extended system ID is enabled
Portfast is disabled by default
PortFast BPDU Guard is disabled by default
Portfast BPDU Filter is disabled by default
Loopguard is disabled by default
UplinkFast is disabled
BackboneFast is disabled
Pathcost method used is long
Name Blocking Listening Learning Forwarding STP Active
---------------------- -------- --------- -------- ---------- ----------
MST00 1 0 0 2 3
MST01 1 0 0 2 3
---------------------- -------- --------- -------- ---------- ----------
2 msts 2 0 0 4 6
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 16-35
Chapter 16 Configuring STP and MST
Configuring MST
Software Configuration Guide—Release IOS-XE 3.1.0 SG
16-36 OL-22250-01
CH A P T E R 18
Configuring Optional STP Features
This chapter describes the Spanning Tree Protocol (STP) features supported on the Catalyst 4500 series
switch. It also provides guidelines, procedures, and configuration examples.
This chapter includes the following major sections:
• About Root Guard, page 18-2
• Enabling Root Guard, page 18-2
• About Loop Guard, page 18-3
• Enabling Loop Guard, page 18-5
• About EtherChannel Guard, page 18-6
• Enabling EtherChannel Guard (Optional), page 18-6
• About PortFast, page 18-7
• Enabling PortFast, page 18-7
• About BPDU Guard, page 18-8
• Enabling BackboneFast, page 18-16
• About PortFast BPDU Filtering, page 18-9
• Enabling BackboneFast, page 18-16
• About UplinkFast, page 18-11
• Enabling UplinkFast, page 18-12
• About BackboneFast, page 18-14
• Enabling BackboneFast, page 18-16
Note For information on configuring STP, see Chapter 16, “Configuring STP and MST.”
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 18-1
Chapter 18 Configuring Optional STP Features
About Root Guard
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Root Guard
Spanning Tree root guard forces an interface to become a designated port, to protect the current root
status and prevent surrounding switches from becoming the root switch.
When you enable root guard on a per-port basis, it is automatically applied to all of the active VLANs
to which that port belongs. When you disable root guard, it is disabled for the specified port and the port
automatically goes into the listening state.
When a switch that has ports with root guard enabled detects a new root, the ports goes into
root-inconsistent state. Then, when the switch no longer detects a new root, its ports automatically go
into the listening state.
Enabling Root Guard
To enable root guard on a Layer 2 access port (to force it to become a designated port), perform this task:
Command Purpose
Step 1 Switch(config)# interface {{fastethernet | Specifies an interface to configure.
gigabitethernet | tengigabitethernet} slot/port}
Step 2 Switch(config-if)# [no] spanning-tree guard root Enables root guard.
Use the no keyword to disable Root Guard.
Step 3 Switch(config-if)# end Exits configuration mode.
Step 4 Switch# show spanning-tree Verifies the configuration.
This example shows how to enable root guard on Fast Ethernet interface 5/8:
Switch(config)# interface fastethernet 5/8
Switch(config-if)# spanning-tree guard root
Switch(config-if)# end
Switch#
This example shows how to verify the configuration:
Switch# show running-config interface fastethernet 5/8
Building configuration...
Software Configuration Guide—Release IOS-XE 3.1.0 SG
18-2 OL-22250-01
Chapter 18 Configuring Optional STP Features
About Loop Guard
Current configuration: 67 bytes
!
interface FastEthernet5/8
switchport mode access
spanning-tree guard root
end
Switch#
This example shows how to determine whether any ports are in root inconsistent state:
Switch# show spanning-tree inconsistentports
Name Interface Inconsistency
-------------------- ---------------------- ------------------
VLAN0001 FastEthernet3/1 Root Inconsistent
VLAN0001 FastEthernet3/2 Root Inconsistent
VLAN1002 FastEthernet3/1 Root Inconsistent
VLAN1002 FastEthernet3/2 Root Inconsistent
VLAN1003 FastEthernet3/1 Root Inconsistent
VLAN1003 FastEthernet3/2 Root Inconsistent
VLAN1004 FastEthernet3/1 Root Inconsistent
VLAN1004 FastEthernet3/2 Root Inconsistent
VLAN1005 FastEthernet3/1 Root Inconsistent
VLAN1005 FastEthernet3/2 Root Inconsistent
Number of inconsistent ports (segments) in the system :10
About Loop Guard
Loop guard helps prevent bridging loops that could occur because of a unidirectional link failure on a
point-to-point link. When enabled globally, loop guard applies to all point-to-point ports on the system.
Loop guard detects root ports and blocked ports and ensures that they keep receiving BPDUs from their
designated port on the segment. If a loop-guard-enabled root or blocked port stop receiving BPDUs from
its designated port, it transitions to the blocking state, assuming there is a physical link error on this port.
The port recovers from this state as soon as it receives a BPDU.
You can enable loop guard on a per-port basis. When you enable loop guard, it is automatically applied
to all of the active instances or VLANs to which that port belongs. When you disable loop guard, it is
disabled for the specified ports. Disabling loop guard moves all loop-inconsistent ports to the listening
state.
If you enable loop guard on a channel and the first link becomes unidirectional, loop guard blocks the
entire channel until the affected port is removed from the channel. Figure 18-1 shows loop guard in a
triangular switch configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 18-3
Chapter 18 Configuring Optional STP Features
About Loop Guard
Figure 18-1 Triangular Switch Configuration with Loop Guard
A B
3/1 3/1
3/2 3/2
3/1 3/2
Designated port
Root port
55772
Alternate port
Figure 18-1 illustrates the following configuration:
• Switches A and B are distribution switches.
• Switch C is an access switch.
• Loop guard is enabled on ports 3/1 and 3/2 on Switches A, B, and C.
Enabling loop guard on a root switch has no effect but provides protection when a root switch becomes
a nonroot switch.
Follow these guidelines when using loop guard:
• Do not enable loop guard on PortFast-enabled or dynamic VLAN ports.
• Do not enable loop guard if root guard is enabled.
Loop guard interacts with other features as follows:
• Loop guard does not affect the functionality of UplinkFast or BackboneFast.
• Enabling loop guard on ports that are not connected to a point-to-point link does not work.
• Root guard forces a port to always be the root port. Loop guard is effective only if the port is a root
port or an alternate port. You cannot enable loop guard and root guard on a port at the same time.
• Loop guard uses the ports known to spanning tree. Loop guard can take advantage of logical ports
provided by the Port Aggregation Protocol (PAgP). However, to form a channel, all the physical
ports grouped in the channel must have compatible configurations. PAgP enforces uniform
configurations of root guard or loop guard on all the physical ports to form a channel.
These caveats apply to loop guard:
– Spanning tree always chooses the first operational port in the channel to send the BPDUs. If that
link becomes unidirectional, loop guard blocks the channel, even if other links in the channel
are functioning properly.
– If a set of ports that are already blocked by loop guard are grouped together to form a channel,
spanning tree loses all the state information for those ports and the new channel port may obtain
the forwarding state with a designated role.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
18-4 OL-22250-01
Chapter 18 Configuring Optional STP Features
Enabling Loop Guard
– If a channel is blocked by loop guard and the channel breaks, spanning tree loses all the state
information. The individual physical ports may obtain the forwarding state with the designated
role, even if one or more of the links that formed the channel are unidirectional.
Note You can enable UniDirectional Link Detection (UDLD) to help isolate the link failure.
A loop may occur until UDLD detects the failure, but loop guard is not able to detect it.
• Loop guard has no effect on a disabled spanning tree instance or a VLAN.
Enabling Loop Guard
You can enable loop guard globally or per port.
To enable loop guard globally on the switch, perform this task:
Command Purpose
Step 1 Switch(config)# spanning-tree loopguard default Enables loop guard globally on the switch.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show spanning tree interface 4/4 detail Verifies the configuration impact on a port.
This example shows how to enable loop guard globally:
Switch(config)# spanning-tree loopguard default
Switch(config)# Ctrl-Z
This example shows how to verify the previous configuration of port 4/4:
Switch# show spanning-tree interface fastethernet 4/4 detail
Port 196 (FastEthernet4/4) of VLAN0010 is forwarding
Port path cost 1000, Port priority 160, Port Identifier 160.196.
Designated root has priority 32768, address 00d0.00b8.140a
Designated bridge has priority 32768, address 00d0.00b8.140a
Designated port id is 160.196, designated path cost 0
Timers:message age 0, forward delay 0, hold 0
Number of transitions to forwarding state:1
The port is in the portfast mode by portfast trunk configuration
Link type is point-to-point by default
Bpdu filter is enabled
Loop guard is enabled by default on the port
BPDU:sent 0, received 0
To enable loop guard on an interface, perform this task:
Command Purpose
Step 1 Switch(config)# interface {type slot/port} | Selects an interface to configure.
{port-channel port_channel_number}
Step 2 Switch(config-if)# spanning-tree guard loop Configures loop guard.
Step 3 Switch(config)# end Exits configuration mode.
Step 4 Switch# show spanning tree interface 4/4 detail Verifies the configuration impact on that port.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 18-5
Chapter 18 Configuring Optional STP Features
About EtherChannel Guard
This example shows how to enable loop guard on port 4/4:
Switch(config)# interface fastEthernet 4/4
Switch(config-if)# spanning-tree guard loop
Switch(config-if)# ^Z
This example shows how to verify the configuration impact on port 4/4:
Switch# show spanning-tree interface fastEthernet 4/4 detail
Port 196 (FastEthernet4/4) of VLAN0010 is forwarding
Port path cost 1000, Port priority 160, Port Identifier 160.196.
Designated root has priority 32768, address 00d0.00b8.140a
Designated bridge has priority 32768, address 00d0.00b8.140a
Designated port id is 160.196, designated path cost 0
Timers:message age 0, forward delay 0, hold 0
Number of transitions to forwarding state:1
The port is in the portfast mode by portfast trunk configuration
Link type is point-to-point by default
Bpdu filter is enabled
Loop guard is enabled on the port
BPDU:sent 0, received 0
Switch#
About EtherChannel Guard
EtherChannel guard allows you to detect an EtherChannel misconfiguration between the switch and a
connected device. A misconfiguration can occur if the interfaces of a switch are manually configured in
an EtherChannel, and one or more interfaces on the other device are not. For EtherChannel configuration
guidelines, see the “EtherChannel Configuration Guidelines and Restrictions” section on page 19-5.
Note EtherChannel guard applies only to EtherChannels in forced mode (that is, “manually configured”)
rather than through PAgP or LACP.
If the switch detects a misconfiguration on the other device, EtherChannel guard error-disables all
interfaces in the EtherChannel bundle, and displays an error message.
You can enable this feature with the spanning-tree etherchannel guard misconfig global configuration
command.
Enabling EtherChannel Guard (Optional)
You can enable EtherChannel guard to detect an EtherChannel misconfiguration if your switch is
running PVST+, rapid PVST+, or MSTP.
To enable EtherChannel guard, perform this task:
Command Purpose
Step 1 Switch(config)# configure terminal Enters global configuration mode.
Step 2 Switch(config)# spanning-tree Enables EtherChannel guard.
etherchannel guard misconfig
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
18-6 OL-22250-01
Chapter 18 Configuring Optional STP Features
About PortFast
Command Purpose
Step 4 Switch(config)# show spanning-tree Verifies your entries.
summary
Step 5 Switch(config)# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To disable the EtherChannel guard feature, use the no spanning-tree etherchannel guard misconfig
global configuration command.
Use the show interfaces status err-disabled privileged EXEC command to show which switch ports
are disabled because of an EtherChannel misconfiguration. On the remote device, you can enter the show
etherchannel summary privileged EXEC command to verify the EtherChannel configuration.
After the configuration is corrected, enter the shutdown and no shutdown interface configuration
commands on the port-channel interfaces that were misconfigured.
About PortFast
Spanning Tree PortFast causes an interface configured as a Layer 2 access port to enter the forwarding
state immediately, bypassing the listening and learning states. Use PortFast on Layer 2 access ports
connected to a single workstation or server to allow those devices to connect to the network immediately,
rather than waiting for spanning tree to converge. Even if the interface receives a bridge protocol data
unit (BPDU), spanning tree does not place the port into the blocking state. Instead, it sets the port’s
operating state to non-port fast even if the configured state remains port fast and starts participating in
the topology change.
Note Because the purpose of PortFast is to minimize the time that access ports must wait for spanning tree to
converge, it is most effective when used on access ports. If you enable PortFast on a port connecting to
another switch, you risk creating a spanning tree loop.
Enabling PortFast
Caution Use PortFast only when connecting a single end station to a Layer 2 access port. Otherwise, you might
create a network loop.
To enable PortFast on a Layer 2 access port to force it to enter the forwarding state immediately, perform
this task:
Command Purpose
Step 1 Switch(config)# interface {{fastethernet | Specifies an interface to configure.
gigabitethernet | tengigabitethernet} slot/port}
| {port-channel port_channel_number}
Step 2 Switch(config-if)# [no] spanning-tree portfast Enables PortFast on a Layer 2 access port connected to a
single workstation or server.
Use the no keyword to disable PortFast.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 18-7
Chapter 18 Configuring Optional STP Features
About BPDU Guard
Command Purpose
Step 3 Switch(config-if)# end Exits configuration mode.
Step 4 Switch# show running interface {{fastethernet | Verifies the configuration.
gigabitethernet | tengigabitethernet} slot/port}
| {port-channel port_channel_number}
This example shows how to enable PortFast on Fast Ethernet interface 5/8:
Switch(config)# interface fastethernet 5/8
Switch(config-if)# spanning-tree portfast
Switch(config-if)# end
Switch#
This example shows how to verify the configuration:
Switch# show running-config interface fastethernet 5/8
Building configuration...
Current configuration:
!
interface FastEthernet5/8
no ip address
switchport
switchport access vlan 200
switchport mode access
spanning-tree portfast
end
Switch#
About BPDU Guard
Spanning Tree BPDU guard shuts down PortFast-configured interfaces that receive BPDUs, rather than
putting them into the spanning tree blocking state. In a valid configuration, PortFast-configured
interfaces do not receive BPDUs. Reception of a BPDU by a PortFast-configured interface signals an
invalid configuration, such as connection of an unauthorized device. BPDU guard provides a secure
response to invalid configurations, because the administrator must manually put the interface back in
service.
Note When the BPDU guard feature is enabled, spanning tree applies the BPDU guard feature to all
PortFast-configured interfaces.
To prevent the port from shutting down, use errdisable detect cause bpduguard shutdown vlan global
configuration command to shut down just the offending VLAN on the port where the violation occurred.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
18-8 OL-22250-01
Chapter 18 Configuring Optional STP Features
Enabling BPDU Guard
Enabling BPDU Guard
To enable BPDU guard to shut down PortFast-configured interfaces that receive BPDUs, perform this
task:
Command Purpose
Step 1 Switch(config)# [no] spanning-tree portfast Enables BPDU guard on all the switch’s
bpduguard PortFast-configured interfaces.
Use the no keyword to disable BPDU guard.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show spanning-tree summary totals Verifies the BPDU configuration.
This example shows how to enable BPDU guard:
Switch(config)# spanning-tree portfast bpduguard
Switch(config)# end
Switch#
This example shows how to verify the BPDU configuration:
Switch# show spanning-tree summary totals
Root bridge for: none.
PortFast BPDU Guard is enabled
Etherchannel misconfiguration guard is enabled
UplinkFast is disabled
BackboneFast is disabled
Default pathcost method used is short
Name Blocking Listening Learning Forwarding STP Active
-------------------- -------- --------- -------- ---------- ----------
34 VLANs 0 0 0 36 36
Switch#
About PortFast BPDU Filtering
Cisco IOS Release 12.2(25)EW and later support PortFast BPDU filtering, which allows the
administrator to prevent the system from sending or even receiving BPDUs on specified ports.
When configured globally, PortFast BPDU filtering applies to all operational PortFast ports. Ports in an
operational PortFast state should be connected to hosts that typically drop BPDUs. If an operational
PortFast port receives a BPDU, it immediately loses its operational PortFast status. In that case, PortFast
BPDU filtering is disabled on this port and STP resumes sending BPDUs on this port.
PortFast BPDU filtering can also be configured on a per-port basis. When PortFast BPDU filtering is
explicitly configured on a port, it does not send any BPDUs and drops all BPDUs it receives.
Caution Explicitly configuring PortFast BPDU filtering on a port that is not connected to a host can result in
bridging loops, because the port ignores any BPDU it receives and goes to the forwarding state.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 18-9
Chapter 18 Configuring Optional STP Features
Enabling PortFast BPDU Filtering
When you enable PortFast BPDU filtering globally and set the port configuration as the default for
PortFast BPDU filtering (see the “Enabling BackboneFast” section on page 18-16), PortFast enables or
disables PortFast BPDU filtering.
If the port configuration is not set to default, then the PortFast configuration does not affect PortFast
BPDU filtering. Table 18-1 lists all the possible PortFast BPDU filtering combinations. PortFast BPDU
filtering allows access ports to move directly to the forwarding state as soon as the end hosts are
connected.
Table 18-1 PortFast BPDU Filtering Port Configurations
Per-Port Configuration Global Configuration PortFast State PortFast BPDU Filtering State
Default Enable Enable Enable1
Default Enable Disable Disable
Default Disable Not applicable Disable
Disable Not applicable Not applicable Disable
Enable Not applicable Not applicable Enable
1. The port transmits at least 10 BPDUs. If this port receives any BPDUs, then PortFast and PortFast BPDU filtering are
disabled.
Enabling PortFast BPDU Filtering
To enable PortFast BPDU filtering globally, perform this task:
Command Purpose
Step 1 Switch(config)# spanning-tree portfast bpdufilter default Enables BPDU filtering globally on the
switch.
Step 2 Switch# show spanning-tree summary totals Verifies the BPDU configuration.
This example shows how to enable PortFast BPDU filtering on a port:
Switch(config)# spanning-tree portfast bpdufilter default
Switch(config)# Ctrl-Z
This example shows how to verify the BPDU configuration in PVST+ mode:
Switch# show spanning-tree summary totals
Root bridge for:VLAN0010
EtherChannel misconfiguration guard is enabled
Extended system ID is disabled
Portfast is enabled by default
PortFast BPDU Guard is disabled by default
Portfast BPDU Filter is enabled by default
Loopguard is disabled by default
UplinkFast is disabled
BackboneFast is disabled
Pathcost method used is long
Software Configuration Guide—Release IOS-XE 3.1.0 SG
18-10 OL-22250-01
Chapter 18 Configuring Optional STP Features
About UplinkFast
Name Blocking Listening Learning Forwarding STP Active
---------------------- -------- --------- -------- ---------- ----------
2 vlans 0 0 0 3 3
Switch#
Note For PVST+ information, see Chapter 16, “Configuring STP and MST.”
To enable PortFast BPDU filtering, perform this task:
Command Purpose
Step 1 Switch(config)# interface fastEthernet 4/4 Selects the interface to configure.
Step 2 Switch(config-if)# spanning-tree bpdufilter enable Enables BPDU filtering.
Step 3 Switch# show spanning-tree interface fastethernet 4/4 Verifies the configuration.
This example shows how to enable PortFast BPDU filtering on port 4/4:
Switch(config)# interface fastethernet 4/4
Switch(config-if)# spanning-tree bpdufilter enable
Switch(config-if)# ^Z
This example shows how to verify that PortFast BPDU filtering is enabled:
Switch# show spanning-tree interface fastethernet 4/4
Vlan Role Sts Cost Prio.Nbr Status
---------------- ---- --- --------- -------- --------------------------------
VLAN0010 Desg FWD 1000 160.196 Edge P2p
This example shows more detail on the port:
Switch# show spanning-tree interface fastEthernet 4/4 detail
Port 196 (FastEthernet4/4) of VLAN0010 is forwarding
Port path cost 1000, Port priority 160, Port Identifier 160.196.
Designated root has priority 32768, address 00d0.00b8.140a
Designated bridge has priority 32768, address 00d0.00b8.140a
Designated port id is 160.196, designated path cost 0
Timers:message age 0, forward delay 0, hold 0
Number of transitions to forwarding state:1
The port is in the portfast mode by portfast trunk configuration
Link type is point-to-point by default
Bpdu filter is enabled
BPDU:sent 0, received 0
Switch#
About UplinkFast
Note UplinkFast is most useful in wiring-closet switches. This feature might not be useful for other types of
applications.
Spanning Tree UplinkFast provides fast convergence after a direct link failure and uses uplink groups to
achieve load balancing between redundant Layer 2 links. Convergence is the speed and ability of a group
of internetworking devices running a specific routing protocol to agree on the topology of an
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 18-11
Chapter 18 Configuring Optional STP Features
Enabling UplinkFast
internetwork after a change in that topology. An uplink group is a set of Layer 2 interfaces (per VLAN),
only one of which is forwarding at any given time. Specifically, an uplink group consists of the root port
(which is forwarding) and a set of blocked ports, except for self-looping ports. The uplink group
provides an alternate path in case the currently forwarding link fails.
Figure 18-2 shows an example of a topology with no link failures. Switch A, the root switch, is
connected directly to Switch B over link L1 and to Switch C over link L2. The Layer 2 interface on
Switch C that is connected directly to Switch B is in the blocking state.
Figure 18-2 UplinkFast Before Direct Link Failure
Switch A
(Root) Switch B
L1
L2 L3
Blocked port
11241
Switch C
If Switch C detects a link failure on the currently active link L2 on the root port (a direct link failure),
UplinkFast unblocks the blocked port on Switch C and transitions it to the forwarding state without
going through the listening and learning states, as shown in Figure 18-3. This switchover takes
approximately one to five seconds.
Figure 18-3 UplinkFast After Direct Link Failure
Switch A
(Root) Switch B
L1
L2 L3
Link failure
UplinkFast transitions port
directly to forwarding state
11242
Switch C
Enabling UplinkFast
UplinkFast increases the bridge priority to 49,152 and adds 3000 to the spanning tree port cost of all
interfaces on the switch, making it unlikely that the switch becomes the root switch. The
max_update_rate value represents the number of multicast packets transmitted per second (the default
is 150 packets per second [pps]).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
18-12 OL-22250-01
Chapter 18 Configuring Optional STP Features
Enabling UplinkFast
UplinkFast cannot be enabled on VLANs that have been configured for bridge priority. To enable
UplinkFast on a VLAN with bridge priority configured, restore the bridge priority on the VLAN to the
default value by entering a no spanning-tree vlan vlan_ID priority command in global configuration
mode.
Note When you enable UplinkFast, it affects all VLANs on the switch. You cannot configure UplinkFast on
an individual VLAN.
To enable UplinkFast, perform this task:
Command Purpose
Step 1 Switch(config)# [no] spanning-tree uplinkfast Enables UplinkFast.
[max-update-rate max_update_rate]
Use the no keyword to disable UplinkFast and restore the
default rate, use the command
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show spanning-tree vlan vlan_ID Verifies that UplinkFast is enabled on that VLAN.
This example shows how to enable UplinkFast with a maximum update rate of 400 pps:
Switch(config)# spanning-tree uplinkfast max-update-rate 400
Switch(config)# exit
Switch#
This example shows how to verify which VLANS have UplinkFast enabled:
Switch# show spanning-tree uplinkfast
UplinkFast is enabled
Station update rate set to 150 packets/sec.
UplinkFast statistics
-----------------------
Number of transitions via uplinkFast (all VLANs) :14
Number of proxy multicast addresses transmitted (all VLANs) :5308
Name Interface List
-------------------- ------------------------------------
VLAN1 Fa6/9(fwd), Gi5/7
VLAN2 Gi5/7(fwd)
VLAN3 Gi5/7(fwd)
VLAN4
VLAN5
VLAN6
VLAN7
VLAN8
VLAN10
VLAN15
VLAN1002 Gi5/7(fwd)
VLAN1003 Gi5/7(fwd)
VLAN1004 Gi5/7(fwd)
VLAN1005 Gi5/7(fwd)
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 18-13
Chapter 18 Configuring Optional STP Features
About BackboneFast
About BackboneFast
BackboneFast is a complementary technology to UplinkFast. Whereas UplinkFast is designed to quickly
respond to failures on links directly connected to leaf-node switches, it does not help with indirect
failures in the backbone core. BackboneFast optimizes based on the Max Age setting. It allows you to
reduce the default convergence time for indirect failures from 50 seconds to 30 seconds. However, it
never eliminates forward delays and offers no assistance for direct failures.
Note Enable BackboneFast on every switch in your network.
Sometimes a switch receives a BPDU from a designated switch that identifies the root bridge and the
designated bridge as the same switch. Because this shouldn’t happen, the BPDU is considered inferior.
BPDUs are considered inferior when a link from the designated switch has lost its link to the root bridge.
The designated switch transmits the BPDUs with the information that it is now the root bridge as well
as the designated bridge. The receiving switch ignores the inferior BPDU for the time defined by the
Max Age setting.
After receiving inferior BPDUs, the receiving switch tries to determine if there is an alternate path to the
root bridge.
• If the port that the inferior BPDUs are received on is already in blocking mode, then the root port
and other blocked ports on the switch become alternate paths to the root bridge.
• If the inferior BPDUs are received on a root port, then all presently blocking ports become the
alternate paths to the root bridge. Also, if the inferior BPDUs are received on a root port and there
are no other blocking ports on the switch, the receiving switch assumes that the link to the root
bridge is down and the time defined by the Max Age setting expires, which turns the switch into the
root switch.
If the switch finds an alternate path to the root bridge, it uses this new alternate path. This new path, and
any other alternate paths, are used to send a Root Link Query (RLQ) BPDU. When BackboneFast is
enabled, the RLQ BPDUs are sent out as soon as an inferior BPDU is received. This process can enable
faster convergence in the event of a backbone link failure.
Figure 18-4 shows an example of a topology with no link failures. Switch A, the root switch, connects
directly to Switch B over link L1 and to Switch C over link L2. In this example, because switch B has a
lower priority than A but higher than C, switch B becomes the designated bridge for L3. Consequently,
the Layer 2 interface on Switch C that connects directly to Switch B must be in the blocking state.
Figure 18-4 BackboneFast Before Indirect Link Failure
Switch A
(Root) Switch B
L1
Link failure
L2 L3
BackboneFast transitions port
through listening and learning
11244
states to forwarding state
Switch C
Software Configuration Guide—Release IOS-XE 3.1.0 SG
18-14 OL-22250-01
Chapter 18 Configuring Optional STP Features
About BackboneFast
Next, assume that L1 fails. Switch A and Switch B, the switches directly connected to this segment,
instantly know that the link is down. The blocking interface on Switch C must enter the forwarding state
for the network to recover by itself. However, because L1 is not directly connected to Switch C,
Switch C does not start sending any BPDUs on L3 under the normal rules of STP until the time defined
by the Max Age setting has expired.
In an STP environment without BackboneFast, if L1 should fail, Switch C cannot detect this failure
because it is not connected directly to link L1. However, because Switch B is directly connected to the
root switch over L1, Switch B detects the failure and elects itself the root. Then Switch B begins sending
configuration BDPUs to Switch C, listing itself as the root.
Here are additional actions that occur when you use BackboneFast to eliminate the time defined by the
Max Age setting (20-second) delay:
1. When Switch C receives the inferior configuration BPDUs from Switch B, Switch C infers that an
indirect failure has occurred.
2. Switch C then sends out an RLQ.
3. Switch A receives the RLQ. Because Switch A is the root bridge, it replies with an RLQ response,
listing itself as the root bridge.
4. When Switch C receives the RLQ response on its existing root port, it knows that it still has a stable
connection to the root bridge. Because Switch C originated the RLQ request, it does not need to
forward the RLQ response on to other switches.
5. BackboneFast allows the blocked port on Switch C to move immediately to the listening state
without waiting for the time defined by the Max Age setting for the port to expire.
6. BackboneFast transitions the Layer 2 interface on Switch C to the forwarding state, providing a path
from Switch B to Switch A.
This switchover takes approximately 30 seconds, twice the Forward Delay time if the default forward
delay time of 15 seconds is set.
Figure 18-5 shows how BackboneFast reconfigures the topology to account for the failure of link L1.
Figure 18-5 BackboneFast after Indirect Link Failure
Switch A
(Root) Switch B
L1
L2 L3
Blocked port
11241
Switch C
If a new switch is introduced into a shared-medium topology as shown in Figure 18-6, BackboneFast is
not activated, because the inferior BPDUs did not come from the recognized designated bridge
(Switch B). The new switch begins sending inferior BPDUs that say it is the root switch. However, the
other switches ignore these inferior BPDUs, and the new switch learns that Switch B is the designated
bridge to Switch A, the root switch.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 18-15
Chapter 18 Configuring Optional STP Features
Enabling BackboneFast
Figure 18-6 Adding a Switch in a Shared-Medium Topology
Switch A
(Root)
Switch C Switch B
(Designated Bridge)
Blocked port
Added switch
11245
Enabling BackboneFast
Note For BackboneFast to work, you must enable it on all switches in the network. BackboneFast is supported
for use with third-party switches but it is not supported on Token Ring VLANs.
To enable BackboneFast, perform this task:
Command Purpose
Step 1 Switch(config)# [no] spanning-tree backbonefast Enables BackboneFast.
Use the no keyword to disable BackboneFast.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show spanning-tree backbonefast Verifies that BackboneFast is enabled.
This example shows how to enable BackboneFast:
Switch(config)# spanning-tree backbonefast
Switch(config)# end
Switch#
This example shows how to verify that BackboneFast is enabled:
Switch# show spanning-tree backbonefast
BackboneFast is enabled
BackboneFast statistics
-----------------------
Number of transition via backboneFast (all VLANs) : 0
Number of inferior BPDUs received (all VLANs) : 0
Number of RLQ request PDUs received (all VLANs) : 0
Software Configuration Guide—Release IOS-XE 3.1.0 SG
18-16 OL-22250-01
Chapter 18 Configuring Optional STP Features
Enabling BackboneFast
Number of RLQ response PDUs received (all VLANs) : 0
Number of RLQ request PDUs sent (all VLANs) : 0
Number of RLQ response PDUs sent (all VLANs) : 0
Switch#
This example shows how to display a summary of port states:
Switch#show spanning-tree summary
Root bridge for:VLAN0001, VLAN1002-VLAN1005
Extended system ID is disabled
Portfast is enabled by default
PortFast BPDU Guard is disabled by default
Portfast BPDU Filter is enabled by default
Loopguard is disabled by default
EtherChannel misconfiguration guard is enabled
UplinkFast is enabled
BackboneFast is enabled
Pathcost method used is short
Name Blocking Listening Learning Forwarding STP Active
---------------------- -------- --------- -------- ---------- ----------
VLAN0001 0 0 0 3 3
VLAN1002 0 0 0 2 2
VLAN1003 0 0 0 2 2
VLAN1004 0 0 0 2 2
VLAN1005 0 0 0 2 2
---------------------- -------- --------- -------- ---------- ----------
5 vlans 0 0 0 11 11
BackboneFast statistics
-----------------------
Number of transition via backboneFast (all VLANs) :0
Number of inferior BPDUs received (all VLANs) :0
Number of RLQ request PDUs received (all VLANs) :0
Number of RLQ response PDUs received (all VLANs) :0
Number of RLQ request PDUs sent (all VLANs) :0
Number of RLQ response PDUs sent (all VLANs) :0
Switch#
This example shows how to display the total lines of the spanning tree state section:
Switch#show spanning-tree summary totals
Root bridge for:VLAN0001, VLAN1002-VLAN1005
Extended system ID is disabled
Portfast is enabled by default
PortFast BPDU Guard is disabled by default
Portfast BPDU Filter is enabled by default
Loopguard is disabled by default
EtherChannel misconfiguration guard is enabled
UplinkFast is enabled
BackboneFast is enabled
Pathcost method used is short
Name Blocking Listening Learning Forwarding STP Active
---------------------- -------- --------- -------- ---------- ----------
5 vlans 0 0 0 11 11
BackboneFast statistics
-----------------------
Number of transition via backboneFast (all VLANs) :0
Number of inferior BPDUs received (all VLANs) :0
Number of RLQ request PDUs received (all VLANs) :0
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 18-17
Chapter 18 Configuring Optional STP Features
Enabling BackboneFast
Number of RLQ response PDUs received (all VLANs) :0
Number of RLQ request PDUs sent (all VLANs) :0
Number of RLQ response PDUs sent (all VLANs) :0
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
18-18 OL-22250-01
CH A P T E R 19
Configuring EtherChannel
This chapter describes how to use the command-line interface (CLI) to configure EtherChannel on the
Catalyst 4500 series switch Layer 2 or Layer 3 interfaces. It also provides guidelines, procedures, and
configuration examples.
This chapter includes the following major sections:
• EtherChannel Overview, page 19-1
• EtherChannel Configuration Guidelines and Restrictions, page 19-5
• Configuring EtherChannel, page 19-6
• Displaying EtherChannel to a Virtual Switch System, page 19-14
Note The commands in the following sections can be used on all Ethernet interfaces on a Catalyst 4500 series
switch, including the uplink ports on the supervisor engine.
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
EtherChannel Overview
EtherChannel bundles up to eight individual Ethernet links into a single logical ink that provides an
aggregate bandwidth of up to 800 Mbps (Fast EtherChannel), 8 Gbps (Gigabit EtherChannel), or 80
Gbps (10 Gigabit EtherChannel) between a Catalyst 4500 or 4500X series switch and another switch or
host.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 19-1
Chapter 19 Configuring EtherChannel
EtherChannel Overview
EFT Draft - Conf idential
Note Because some linecards have a maximum bandwidth capacity toward the backplane, they can limit the
aggregate bandwidth of an Etherchannel when all the Etherchannel members belong to the same
linecard.
A Catalyst 4500 series switch supports a maximum of 64 EtherChannels. You can form an EtherChannel
with up to eight compatibly configured Ethernet interfaces across modules in a Catalyst 4500 series
switch. All interfaces in each EtherChannel must be the same speed and must be configured as either
Layer 2 or Layer 3 interfaces.
Note The network device to which a Catalyst 4500 series switch is connected may impose its own limits on
the number of interfaces in an EtherChannel.
If a segment within an EtherChannel fails, traffic previously carried over the failed link switches to the
remaining segments within the EtherChannel. When the segment fails, an SNMP trap is sent, identifying
the switch, the EtherChannel, and the failed link. Inbound broadcast and multicast packets on one
segment in an EtherChannel are blocked from returning on any other segment of the EtherChannel.
Note The port channel link failure switchover for the Catalyst 4500 series switch was measured at 50 ms,
giving you SONET-like link failure switchover time.
These subsections describe how EtherChannel works:
• Port-Channel Interfaces, page 19-2
• How EtherChannels Are Configured, page 19-2
• Load Balancing, page 19-5
Port-Channel Interfaces
Each EtherChannel has a numbered port-channel interface. A configuration applied to the port-channel
interface affects all physical interfaces assigned to that interface.
Note QoS does not propagate to members. The defaults, QoS cos = 0 and QoS dscp = 0, apply on the
portchannel. Input or output policies applied on individual interfaces are ignored.
After you configure an EtherChannel, the configuration that you apply to the port-channel interface
affects the EtherChannel; the configuration that you apply to the physical interfaces affects only the
interface where you apply the configuration. To change the parameters of all ports in an EtherChannel,
apply configuration commands to the port-channel interface (such commands can be STP commands or
commands to configure a Layer 2 EtherChannel as a trunk).
How EtherChannels Are Configured
These subsections describe how EtherChannels are configured:
• EtherChannel Configuration Overview, page 19-3
• Manual EtherChannel Configuration, page 19-3
Software Configuration Guide—Release IOS-XE 3.1.0 SG
19-2 OL-22250-01
Chapter 19 Configuring EtherChannel
EtherChannel Overview
• PAgP EtherChannel Configuration, page 19-3
• IEEE 802.3ad LACP EtherChannel Configuration, page 19-4
EtherChannel Configuration Overview
You can configure EtherChannels manually, use the Port Aggregation Control Protocol (PAgP) or, with
Cisco IOS Release 12.2(25)EWA and later, the Link Aggregation Control Protocol (LACP) to form
EtherChannels. The EtherChannel protocols allow ports with similar characteristics to form an
EtherChannel through dynamic negotiation with connected network devices. PAgP is a
Cisco-proprietary protocol and LACP is defined in IEEE 802.3ad.
PAgP and LACP do not interoperate. Ports configured to use PAgP cannot form EtherChannels with
ports configured to use LACP and vice versa.
Table 19-1 lists the user-configurable EtherChannel modes.
Table 19-1 EtherChannel Modes
Mode Description
on Mode that forces the LAN port to channel unconditionally. In the on mode, a usable
EtherChannel exists only when a LAN port group in the on mode is connected to another
LAN port group in the on mode. Because ports configured in the on mode do not negotiate,
there is no negotiation traffic between the ports.
auto PAgP mode that places a LAN port into a passive negotiating state in which the port
responds to PAgP packets it receives but does not initiate PAgP negotiation.
desirable PAgP mode that places a LAN port into an active negotiating state in which the port
initiates negotiations with other LAN ports by sending PAgP packets.
passive LACP mode that places a port into a passive negotiating state in which the port responds
to LACP packets it receives but does not initiate LACP negotiation.
active LACP mode that places a port into an active negotiating state in which the port initiates
negotiations with other ports by sending LACP packets.
Manual EtherChannel Configuration
Manually configured EtherChannel ports do not exchange EtherChannel protocol packets. A manually
configured EtherChannel forms only when you configure all ports in the EtherChannel compatibly.
PAgP EtherChannel Configuration
PAgP supports the automatic creation of EtherChannels by exchanging PAgP packets between LAN
ports. PAgP packets are exchanged only between ports in auto and desirable modes.
The protocol learns the capabilities of LAN port groups dynamically and informs the other LAN ports.
Once PAgP identifies correctly matched Ethernet links, it facilitates grouping the links into an
EtherChannel. The EtherChannel is then added to the spanning tree as a single bridge port.
Both the auto and desirable modes allow PAgP to negotiate between LAN ports to determine if they can
form an EtherChannel, based on criteria such as port speed and trunking state. Layer 2 EtherChannels
also use VLAN numbers.
LAN ports can form an EtherChannel when they are in different PAgP modes if the modes are
compatible. For example:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 19-3
Chapter 19 Configuring EtherChannel
EtherChannel Overview
EFT Draft - Conf idential
• A LAN port in desirable mode can form an EtherChannel successfully with another LAN port that
is in desirable mode.
• A LAN port in desirable mode can form an EtherChannel with another LAN port in auto mode.
• A LAN port in auto mode cannot form an EtherChannel with another LAN port that is also in auto
mode because neither port initiates negotiation.
IEEE 802.3ad LACP EtherChannel Configuration
Cisco IOS Release 12.2(25)EWA and later releases support IEEE 802.3ad LACP EtherChannels. LACP
supports the automatic creation of EtherChannels by exchanging LACP packets between LAN ports.
LACP packets are exchanged only between ports in passive and active modes.
The protocol learns the capabilities of LAN port groups dynamically and informs the other LAN ports.
Once LACP identifies correctly matched Ethernet links, it facilitates grouping the links into an
EtherChannel. The EtherChannel is then added to the spanning tree as a single bridge port.
Both the passive and active modes allow LACP to negotiate between LAN ports to determine if they
can form an EtherChannel, based on criteria such as port speed and trunking state. Layer 2
EtherChannels also use VLAN numbers.
LAN ports can form an EtherChannel when they are in different LACP modes as long as the modes are
compatible. For example:
• A LAN port in active mode can form an EtherChannel successfully with another LAN port that is
in active mode.
• A LAN port in active mode can form an EtherChannel with another LAN port in passive mode.
• A LAN port in passive mode cannot form an EtherChannel with another LAN port that is also in
passive mode, because neither port initiates negotiation.
LACP uses the following parameters:
• LACP system priority—You may configure an LACP system priority on each switch running LACP.
The system priority can be configured automatically or through the CLI. See the “Configuring the
LACP System Priority and System ID” section on page 19-11. LACP uses the system priority with
the switch MAC address to form the system ID and also during negotiation with other systems.
Note The LACP system ID is the combination of the LACP system priority value and the MAC
address of the switch.
• LACP port priority—You must configure an LACP port priority on each port configured to use
LACP. The port priority can be configured automatically or through the CLI. See the “Configuring
Layer 2 EtherChannels” section on page 19-9. LACP uses the port priority with the port number to
form the port identifier.
• LACP administrative key—LACP automatically configures an administrative key value equal to the
channel group identification number on each port configured to use LACP. The administrative key
defines the ability of a port to aggregate with other ports. A port’s ability to aggregate with other
ports is determined by these factors:
– Port physical characteristics, such as data rate, duplex capability, and point-to-point or shared
medium
– Configuration restrictions that you establish
Software Configuration Guide—Release IOS-XE 3.1.0 SG
19-4 OL-22250-01
Chapter 19 Configuring EtherChannel
EtherChannel Configuration Guidelines and Restrictions
LACP tries to configure the maximum number of compatible ports in an EtherChannel up to the
maximum allowed by the hardware (eight ports). If a port cannot be actively included in a channel, it is
not included automatically if a channelled port fails.
Note Standby and “sub-channeling” are not supported in LACP and PAgP.
Load Balancing
EtherChannel can balance the traffic load across the links in the channel by reducing part of the binary
pattern formed from the addresses or ports in the frame to a numerical value that selects one of the links
in the channel. To balance the load, EtherChannel uses MAC addresses, IP addresses, or Layer 4 port
numbers, and either the message source or message destination, or both.
Use the option that provides the greatest variety in your configuration. For example, if the traffic on a
channel is going only to a single MAC address, using the destination MAC address always chooses the
same link in the channel; using source addresses or IP addresses might result in better load balancing.
Note Load balancing can only be configured globally. As a result, all channels (manually configured, PagP,
or LACP) use the same load balancing method.
For additional information on load balancing, see the “Configuring EtherChannel Load Balancing”
section on page 19-12.
EtherChannel Configuration Guidelines and Restrictions
If improperly configured, some EtherChannel interfaces are disabled automatically to avoid network
loops and other problems. Follow these guidelines and restrictions to avoid configuration problems:
• All Ethernet interfaces on all modules support EtherChannel (maximum of eight interfaces) with no
requirement that interfaces be physically contiguous or on the same module.
• Configure all interfaces in an EtherChannel to operate at the same speed and duplex mode.
• Enable all interfaces in an EtherChannel. Putting down an interface in an Ether Channel is treated
as a link failure, and its traffic is transferred to one of the remaining interfaces in the EtherChannel.
• An EtherChannel does not form if one of the interfaces is a Switched Port Analyzer (SPAN)
destination port.
• For Layer 3 EtherChannels:
– Assign Layer 3 addresses to the port-channel logical interface, not to the physical interfaces in
the channel.
• For Layer 2 EtherChannels:
– Assign all interfaces in the EtherChannel to the same VLAN, or configure them as trunks.
– If you configure an EtherChannel from trunk interfaces, verify that the trunking mode and the
native VLAN is the same on all the trunks. Interfaces in an EtherChannel with different trunk
modes or different native VLANs can have unexpected results.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 19-5
Chapter 19 Configuring EtherChannel
Configuring EtherChannel
EFT Draft - Conf idential
– An EtherChannel supports the same allowed range of VLANs on all the interfaces in a trunking
Layer 2 EtherChannel. If the allowed ranges differ for selected interface differ, they do not form
an EtherChannel.
– Interfaces with different Spanning Tree Protocol (STP) port path costs can form an
EtherChannel as long they are otherwise compatibly configured. Setting different STP port path
costs does not, by itself, make interfaces incompatible for the formation of an EtherChannel.
• After you configure an EtherChannel, any configuration that you apply to the port-channel interface
affects the EtherChannel; any configuration that you apply to the physical interfaces affects only the
interface you configure.
Storm Control is an exception to this rule. For example, you cannot configure Storm Control on
some of the members of an EtherChannel; Storm Control must be configured on all or none of the
ports. If you configure Storm Control on only some of the ports, those ports are dropped from the
EtherChannel interface (put in suspended state). Therefore, you should configure Storm Control at
the port-channel interface level, and not at the physical interface level.
• A physical interface with port security enabled can join a Layer 2 EtherChannel only if port security
is also enabled on the EtherChannel; otherwise the command is rejected by the CLI.
• You cannot configure a 802.1X port in an EtherChannel.
Configuring EtherChannel
These sections describe how to configure EtherChannel:
• Configuring Layer 3 EtherChannels, page 19-6
• Configuring Layer 2 EtherChannels, page 19-9
• Configuring the LACP System Priority and System ID, page 19-11
• Configuring EtherChannel Load Balancing, page 19-12
• Removing an Interface from an EtherChannel, page 19-13
• Removing an EtherChannel, page 19-14
Note Ensure that the interfaces are configured correctly. (See the “EtherChannel Configuration Guidelines
and Restrictions” section on page 19-5.)
Configuring Layer 3 EtherChannels
To configure Layer 3 EtherChannels, create the port-channel logical interface and then put the Ethernet
interfaces into the portchannel.
These sections describe Layer 3 EtherChannel configuration:
• Creating Port-Channel Logical Interfaces, page 19-7
• Configuring Physical Interfaces as Layer 3 EtherChannels, page 19-7
Software Configuration Guide—Release IOS-XE 3.1.0 SG
19-6 OL-22250-01
Chapter 19 Configuring EtherChannel
Configuring EtherChannel
Creating Port-Channel Logical Interfaces
Note To move an IP address from a physical interface to an EtherChannel, you must delete the IP address from
the physical interface before configuring it on the port-channel interface.
To create a port-channel interface for a Layer 3 EtherChannel, perform this task:
Command Purpose
Step 1 Switch(config)# interface port-channel Creates the port-channel interface. The value for
port_channel_number port_channel_number can range from 1 to 64.
Step 2 Switch(config-if)# ip address ip_address mask Assigns an IP address and subnet mask to the
EtherChannel.
Step 3 Switch(config-if)# end Exits configuration mode.
Step 4 Switch# show running-config interface Verifies the configuration.
port-channel port_channel_number
This example shows how to create port-channel interface 1:
Switch# configure terminal
Switch(config)# interface port-channel 1
Switch(config-if)# ip address 172.32.52.10 255.255.255.0
Switch(config-if)# end
This example shows how to verify the configuration of port-channel interface 1:
Switch# show running-config interface port-channel 1
Building configuration...
Current configuration:
!
interface Port-channel1
ip address 172.32.52.10 255.255.255.0
no ip directed-broadcast
end
Switch#
Configuring Physical Interfaces as Layer 3 EtherChannels
To configure physical interfaces as Layer 3 EtherChannels, perform this task for each interface:
Command Purpose
Step 1 Switch(config)# interface {fastethernet | Selects a physical interface to configure.
gigabitethernet | tengigabitethernet} slot/port
Step 2 Switch(config-if)# no switchport Makes this a Layer 3 routed port.
Step 3 Switch(config-if)# no ip address Ensures that no IP address is assigned to the physical
interface.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 19-7
Chapter 19 Configuring EtherChannel
Configuring EtherChannel
EFT Draft - Conf idential
Command Purpose
Step 4 Switch(config-if)# channel-group port_channel_number Configures the interface in a portchannel and
mode {active | on | auto | passive | desirable} specifies the PAgP or LACP mode.
If you use PAgP, enter the keywords auto or
desirable.
If you use LACP, enter the keywords active or
passive.
Step 5 Switch(config-if)# end Exits configuration mode.
Step 6 Switch# show running-config interface port-channel Verifies the configuration.
port_channel_number
Switch# show running-config interface {fastethernet
| gigabitethernet | tengigabitethernet} slot/port
Switch# show interfaces {fastethernet |
gigabitethernet | tengigabitethernet} slot/port
etherchannel
Switch# show etherchannel 1 port-channel
This example shows how to configure Fast Ethernet interfaces 5/4 and 5/5 into port-channel 1 with PAgP
mode desirable:
Switch# configure terminal
Switch(config)# interface range fastethernet 5/4 - 5 (Note: Space is mandatory.)
Switch(config-if)# no switchport
Switch(config-if)# no ip address
Switch(config-if)# channel-group 1 mode desirable
Switch(config-if)# end
Note See the “Configuring a Range of Interfaces” section on page 7-4 for information about the range
keyword.
The following two examples show how to verify the configuration of Fast Ethernet interface 5/4:
Switch# show running-config interface fastethernet 5/4
Building configuration...
Current configuration:
!
interface FastEthernet5/4
no ip address
no switchport
no ip directed-broadcast
channel-group 1 mode desirable
end
Switch# show interfaces fastethernet 5/4 etherchannel
Port state = EC-Enbld Up In-Bndl Usr-Config
Channel group = 1 Mode = Desirable Gcchange = 0
Port-channel = Po1 GC = 0x00010001 Pseudo-port-channel = Po1
Port indx = 0 Load = 0x55
Flags: S - Device is sending Slow hello. C - Device is in Consistent state.
A - Device is in Auto mode. P - Device learns on physical port.
Timers: H - Hello timer is running. Q - Quit timer is running.
S - Switching timer is running. I - Interface timer is running.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
19-8 OL-22250-01
Chapter 19 Configuring EtherChannel
Configuring EtherChannel
Local information:
Hello Partner PAgP Learning Group
Port Flags State Timers Interval Count Priority Method Ifindex
Fa5/4 SC U6/S7 30s 1 128 Any 55
Partner's information:
Partner Partner Partner Partner Group
Port Name Device ID Port Age Flags Cap.
Fa5/4 JAB031301 0050.0f10.230c 2/45 1s SAC 2D
Age of the port in the current state: 00h:54m:52s
Switch#
This example shows how to verify the configuration of port-channel interface 1 after the interfaces have
been configured:
Switch# show etherchannel 1 port-channel
Channel-group listing:
----------------------
Group: 1
------------
Port-channels in the group:
----------------------
Port-channel: Po1
------------
Age of the Port-channel = 01h:56m:20s
Logical slot/port = 10/1 Number of ports = 2
GC = 0x00010001 HotStandBy port = null
Port state = Port-channel L3-Ag Ag-Inuse
Ports in the Port-channel:
Index Load Port
-------------------
1 00 Fa5/6
0 00 Fa5/7
Time since last port bundled: 00h:23m:33s Fa5/6
Switch#
Configuring Layer 2 EtherChannels
To configure Layer 2 EtherChannels, configure the Ethernet interfaces with the channel-group
command. This creates the port-channel logical interface.
Note Cisco IOS software creates port-channel interfaces for Layer 2 EtherChannels when you configure
Layer 2 Ethernet interfaces with the channel-group command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 19-9
Chapter 19 Configuring EtherChannel
Configuring EtherChannel
EFT Draft - Conf idential
To configure Layer 2 Ethernet interfaces as Layer 2 EtherChannels, perform this task for each interface:
Command Purpose
Step 1 Switch(config)# interface {fastethernet | gigabitethernet Selects a physical interface to configure.
| tengigabitethernet} slot/port
Step 2 Switch(config-if)# channel-group port_channel_number mode Configures the interface in a portchannel and
{active | on | auto | passive | desirable} specifies the PAgP or LACP mode.
If you use PAgP, enter the keywords auto or
desirable.
If you use LACP, enter the keywords active or
passive.
Step 3 Switch(config-if)# end Exits configuration mode.
Step 4 Switch# show running-config interface {fastethernet | Verifies the configuration.
gigabitethernet} slot/port
Switch# show interface {fastethernet | gigabitethernet |
tengigabitethernet} slot/port etherchannel
This example shows how to configure Fast Ethernet interfaces 5/6 and 5/7 into port-channel 2 with PAgP
mode desirable:
Switch# configure terminal
Switch(config)# interface range fastethernet 5/6 - 7 (Note: Space is mandatory.)
Switch(config-if-range)# channel-group 2 mode desirable
Switch(config-if-range)# end
Switch# end
Note See the “Configuring a Range of Interfaces” section on page 7-4 for information about the range
keyword.
This example shows how to verify the configuration of port-channel interface 2:
Switch# show running-config interface port-channel 2
Building configuration...
Current configuration:
!
interface Port-channel2
switchport access vlan 10
switchport mode access
end
Switch#
The following two examples show how to verify the configuration of Fast Ethernet interface 5/6:
Switch# show running-config interface fastethernet 5/6
Building configuration...
Current configuration:
!
interface FastEthernet5/6
switchport access vlan 10
switchport mode access
channel-group 2 mode desirable
end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
19-10 OL-22250-01
Chapter 19 Configuring EtherChannel
Configuring EtherChannel
Switch# show interfaces fastethernet 5/6 etherchannel
Port state = EC-Enbld Up In-Bndl Usr-Config
Channel group = 1 Mode = Desirable Gcchange = 0
Port-channel = Po1 GC = 0x00010001
Port indx = 0 Load = 0x55
Flags: S - Device is sending Slow hello. C - Device is in Consistent state.
A - Device is in Auto mode. P - Device learns on physical port.
d - PAgP is down.
Timers: H - Hello timer is running. Q - Quit timer is running.
S - Switching timer is running. I - Interface timer is running.
Local information:
Hello Partner PAgP Learning Group
Port Flags State Timers Interval Count Priority Method Ifindex
Fa5/6 SC U6/S7 30s 1 128 Any 56
Partner's information:
Partner Partner Partner Partner Group
Port Name Device ID Port Age Flags Cap.
Fa5/6 JAB031301 0050.0f10.230c 2/47 18s SAC 2F
Age of the port in the current state: 00h:10m:57s
This example shows how to verify the configuration of port-channel interface 2 after the interfaces have
been configured:
Switch# show etherchannel 2 port-channel
Port-channels in the group:
----------------------
Port-channel: Po2
------------
Age of the Port-channel = 00h:23m:33s
Logical slot/port = 10/2 Number of ports in agport = 2
GC = 0x00020001 HotStandBy port = null
Port state = Port-channel Ag-Inuse
Ports in the Port-channel:
Index Load Port
-------------------
1 00 Fa5/6
0 00 Fa5/7
Time since last port bundled: 00h:23m:33s Fa5/6
Switch#
Configuring the LACP System Priority and System ID
The LACP system ID is the LACP system priority value combined with the MAC address of the switch.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 19-11
Chapter 19 Configuring EtherChannel
Configuring EtherChannel
EFT Draft - Conf idential
To configure the LACP system priority and system ID, perform this task:
Command Purpose
Step 1 Switch(config)# lacp system-priority (Optional for LACP) Sets the LACP system priority and
priority_value system ID.
Valid values are 1 through 65535. Higher numbers have
lower priority. The default is 32768.
Switch(config)# no system port-priority Reverts to the default.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show lacp sys-id Verifies the configuration.
This example shows how to configure the LACP system priority:
Switch# configure terminal
Switch(config)# lacp system-priority 23456
Switch(config)# end
Switch# show module
Mod Ports Card Type Model Serial No.
----+-----+--------------------------------------+-----------------+-----------
1 2 1000BaseX (GBIC) Supervisor(active) WS-X4014 JAB063808YZ
2 48 10/100BaseTX (RJ45) WS-X4148-RJ JAB0447072W
3 48 10/100BaseTX (RJ45)V WS-X4148-RJ45V JAE061704J6
4 48 10/100BaseTX (RJ45)V WS-X4148-RJ45V JAE061704ML
M MAC addresses Hw Fw Sw Status
--+--------------------------------+---+------------+----------------+---------
1 0005.9a39.7a80 to 0005.9a39.7a81 2.1 12.1(12r)EW 12.1(13)EW(0.26) Ok
2 0002.fd80.f530 to 0002.fd80.f55f 0.1 Ok
3 0009.7c45.67c0 to 0009.7c45.67ef 1.6 Ok
4 0009.7c45.4a80 to 0009.7c45.4aaf 1.6 Ok
This example shows how to verify the configuration:
Switch# show lacp sys-id
23456,0050.3e8d.6400
Switch#
The system priority is displayed first, followed by the MAC address of the switch.
Configuring EtherChannel Load Balancing
Note Load balancing can only be configured globally. As a result, all channels (manually configured, PagP,
or LACP) use the same load balancing method.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
19-12 OL-22250-01
Chapter 19 Configuring EtherChannel
Configuring EtherChannel
To configure EtherChannel load balancing, perform this task:
Command Purpose
Step 1 Switch(config)# [no] port-channel load-balance Configures EtherChannel load balancing.
{src-mac | dst-mac | src-dst-mac | src-ip |
dst-ip | src-dst-ip | src-port | dst-port | Use the no keyword to return EtherChannel load
src-dst-port} balancing to the default configuration.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show etherchannel load-balance Verifies the configuration.
The load-balancing keywords are:
• src-mac—Source MAC addresses
• dst-mac—Destination MAC addresses
• src-dst-mac—Source and destination MAC addresses
• src-ip—Source IP addresses
• dst-ip—Destination IP addresses
• src-dst-ip—Source and destination IP addresses (Default)
• src-port—Source Layer 4 port
• dst-port—Destination Layer 4 port
• src-dst-port—Source and destination Layer 4 port
This example shows how to configure EtherChannel to use source and destination IP addresses:
Switch# configure terminal
Switch(config)# port-channel load-balance src-dst-ip
Switch(config)# end
Switch#
This example shows how to verify the configuration:
Switch# show etherchannel load-balance
EtherChannel Load-Balancing Configuration:
src-dst-ip
EtherChannel Load-Balancing Addresses Used Per-Protocol:
Non-IP: Source XOR Destination MAC address
IPv4: Source XOR Destination IP address
IPv6: Source XOR Destination IP address
Switch#
Removing an Interface from an EtherChannel
To remove an Ethernet interface from an EtherChannel, perform this task:
Command Purpose
Step 1 Switch(config)# interface {fastethernet | Selects a physical interface to configure.
gigabitethernet | tengigabitethernet} slot/port
Step 2 Switch(config-if)# no channel-group Removes the interface from the port-channel interface.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 19-13
Chapter 19 Configuring EtherChannel
Displaying EtherChannel to a Virtual Switch System
EFT Draft - Conf idential
Command Purpose
Step 3 Switch(config-if)# end Exits configuration mode.
Step 4 Switch# show running-config interface Verifies the configuration.
{fastethernet | gigabitethernet |
tengigabitethernet} slot/port
Switch# show interface {fastethernet |
gigabitethernet | tengigabitethernet} slot/port
etherchannel
This example shows how to remove Fast Ethernet interfaces 5/4 and 5/5 from port-channel 1:
Switch# configure terminal
Switch(config)# interface range fastethernet 5/4 - 5 (Note: Space is mandatory.)
Switch(config-if)# no channel-group 1
Switch(config-if)# end
Removing an EtherChannel
If you remove an EtherChannel, the member ports are shut down and removed from the channel group.
Note If you want to change an EtherChannel from Layer 2 to Layer 3, or Layer 3 to Layer 2, you must remove
the EtherChannel and recreate it in the desired configuration.
To remove an EtherChannel, perform this task:
Command Purpose
Step 1 Switch(config)# no interface port-channel Removes the port-channel interface.
port_channel_number
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show etherchannel summary Verifies the configuration.
This example shows how to remove port-channel 1:
Switch# configure terminal
Switch(config)# no interface port-channel 1
Switch(config)# end
Displaying EtherChannel to a Virtual Switch System
Catalyst 4500 series switches support enhanced PAgP. If a Catalyst 4500 series switch is connected to
a Catalyst 6500 series Virtual Switch System (VSS) via a PAgP EtherChannel, the Catalyst 4500 series
switch automatically serve as a VSS client, using enhanced PAgP on this EtherChannel for dual-active
detection. This VSS client feature has no impact on the performance of Catalyst 4500 series switches
and does not require any user configuration.
Topics include:
• Understanding VSS Client, page 19-15
• Displaying EtherChannel Links to VSS, page 19-17
Software Configuration Guide—Release IOS-XE 3.1.0 SG
19-14 OL-22250-01
Chapter 19 Configuring EtherChannel
Displaying EtherChannel to a Virtual Switch System
Understanding VSS Client
Topics covered include:
• Virtual Switch System, page 19-15
• Dual-Active Scenarios, page 19-15
• Dual-Active Detection Using Enhance PAgP, page 19-15
Virtual Switch System
The Cisco Catalyst 6500 Series VSS 1440 allows for the combination of two Cisco Catalyst 6500 Series
switches into a single, logical network entity from the network control-plane and management
perspectives. Within the Cisco VSS, one chassis is designated as the active virtual switch, acting as the
single management point of the entire system, and the other is designated as the standby virtual switch.
There two chassis are bound together by a special link, called Virtual Switch Link (VSL), which carries
the internal signaling and control information between them.
Dual-Active Scenarios
One of the failure scenarios in a VSS is called dual-active, which occurs when the VSL fails completely.
In this case, neither virtual switch knows of the other's status. From the perspective of the active virtual
switch, the standby chassis is lost. The standby virtual switch also views the active chassis as failed and
transitions to active state via an SSO switchover. So, two active virtual switches exist in the network
with identical configurations, causing duplicate IP addresses and bridge identifiers. This scenario has
adverse effects on the network topology and traffic if it persists.
Dual-Active Detection Using Enhance PAgP
One mechanism for detecting a dual-active scenario is based on enhanced PAgP (PAgP+). Specifically,
the VSS sends regularly scheduled PAgP messages with Type-Length-Values (TLVs) containing the ID
of the current active virtual switch ( Figure 19-1). When the VSL fails completely, the standby virtual
switch immediately sends asynchronous PAgP messages with TLVs containing its own ID on all port
channels enabled for enhanced PAgP dual-active detection (Figure 19-2). The remote switch
(the VSS client) connected to both VSS components via EtherChannel links, compares every received
active ID with its stored active ID. If they match, the remote switch simply sends TLVs containing its
stored active ID back to the VSS in its regularly scheduled PAgP messages. If they do not match, the
remote switch stores the new active ID and immediately transmits asynchronous PAgP messages with
TLVs containing the new active ID. Upon receiving the new active ID from the remote switch, the
original active virtual switch detects the dual-active scenario and takes appropriate actions.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 19-15
Chapter 19 Configuring EtherChannel
Displaying EtherChannel to a Virtual Switch System
EFT Draft - Conf idential
Figure 19-1 Enhanced PAgP in VSS Normal Opertaion
Virtual Virtual
Switch A Switch B
(active) VSL (standby)
Virtual switch TLV Virtual switch TLV
Active_ID = A’s MAC Active_ID = A’s MAC
EtherChannel
Remote switch TLV Remote switch TLV
Active_ID = A’s MAC Active_ID = A’s MAC
204283
Remote switch
(Catalyst 4500 series switch)
Active_ID = A’s MAC
Figure 19-2 Enhanced PAgP in VSS Dual-active Scenario
Virtual Virtual
Switch A Switch B
(active) VSL (standby)
Dual-active detected by A Virtual switch TLV
Active_ID = B’s MAC
EtherChannel
Remote switch TLV Remote switch TLV
Active_ID = B’s MAC Active_ID = B’s MAC
Remote switch 204284
(Catalyst 4500 series switch)
Active_ID = B’s MAC
As a remote switch, the Catalyst 4500 series switch supports stateful VSS client. In particular, the ID of
the current active virtual switch is synchronized from the active supervisor engine to the redundant
supervisor engine of the Catalyst 4500 series switch. This ensures that dual-active detection is not
disrupted even when the active supervisor engine switches over to the redundant supervisor engine.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
19-16 OL-22250-01
Chapter 19 Configuring EtherChannel
Displaying EtherChannel to a Virtual Switch System
Displaying EtherChannel Links to VSS
To display the dual-active detection capability of the configured PAgP portchannel, use the
show pagp port_channel_number dual-active command.
It indicates whether:
• A switch uses enhanced PAgP for dual-active detection.
You should always see “Yes” after “PAgP dual-active diction enabled” on a Catalyst 4500 switch.
• The configured PAgP EtherChannel is connected to a Catalyst 6500 switch VSS.
You see “N/A” below “Partner Version” if this EtherChannel is not connected to a VSS. Otherwise,
user sees the version of enhanced PAgP dual-active detection implemented in the VSS.
• This switch is capable of detecting dual-active scenarios in the connected VSS.
You see “Yes” below “Dual-Active Detect Capable” if and only if the configured EtherChannel is
connected to a Catalyst 6500 series VSS that uses the same version of enhanced PAgP dual-active
detection.
Note You can also see the name of the neighboring switch (Partner Name) and the ports to which this
EtherChannel is connected (Partner Port).
If a Catalyst 4500 switch is connected to a Catalyst 6500 series VSS with the same version of enhanced
PAgP dual-active detection, the switch can detect a dual-active scenario:
Switch# show pagp 1 dual-active
PAgP dual-active detection enabled: Yes
PAgP dual-active version: 1.1
Channel group 1
Dual-Active Partner Partner Partner
Port Detect Capable Name Port Version
Gi6/5 Yes VSS Gi1/8/1 1.1
Gi6/6 Yes VSS Gi2/8/1 1.1
If a Catalyst 4500 switch is not connected to a Catalyst 6500 series VSS, the switch cannot detect a
dual-active scenario:
Switch# show pagp 1 dual-active
PAgP dual-active detection enabled: Yes
PAgP dual-active version: 1.1
Channel group 1
Dual-Active Partner Partner Partner
Port Detect Capable Name Port Version
Gi6/5 No Switch Fa6/5 N/A
Gi6/6 No Switch Fa6/6 N/A
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 19-17
Chapter 19 Configuring EtherChannel
Displaying EtherChannel to a Virtual Switch System
EFT Draft - Conf idential
Software Configuration Guide—Release IOS-XE 3.1.0 SG
19-18 OL-22250-01
CH A P T E R 20
Configuring CDP
This chapter describes how to configure Cisco Discovery Protocol (CDP) on the Catalyst 4500 series
switch. It also provides guidelines, procedures, and configuration examples.
This chapter includes the following major sections:
• About CDP, page 20-1
• Configuring CDP, page 20-2
Note For complete syntax and usage information for the commands used in this chapter, refer to the
Cisco IOS Configuration Fundamentals Configuration Guide, Release 12.4:
http://www.cisco.com/en/US/docs/ios/fundamentals/configuration/guide/12_4/cf_12_4_book.html
and the Cisco IOS Configuration Fundamentals Command Reference, Release 12.2:
http://www.cisco.com/en/US/docs/ios/12_2/configfun/command/reference/ffun_r.html
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About CDP
CDP is a protocol that runs over Layer 2 (the data link layer) on all Cisco routers, bridges, access servers,
and switches. CDP allows network management applications to discover Cisco devices that are
neighbors of already known devices, in particular, neighbors running lower-layer, transparent
protocols.With CDP, network management applications can learn the device type and the SNMP agent
address of neighboring devices. CDP enables applications to send SNMP queries to neighboring devices.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 20-1
Chapter 20 Configuring CDP
Configuring CDP
CDP runs on all LAN and WAN media that support Subnetwork Access Protocol (SNAP).
Each CDP-configured device sends periodic messages to a multicast address. Each device advertises at
least one address at which it can receive SNMP messages. The advertisements also contain the
time-to-live, or holdtime information, which indicates the length of time a receiving device should hold
CDP information before discarding it.
Configuring CDP
The following sections describe how to configure CDP:
• Enabling CDP Globally, page 20-2
• Displaying the CDP Global Configuration, page 20-2
• Enabling CDP on an Interface, page 20-3
• Displaying the CDP Interface Configuration, page 20-3
• Monitoring and Maintaining CDP, page 20-3
Enabling CDP Globally
To enable CDP globally, perform this task:
Command Purpose
Switch(config)# [no] cdp run Enables CDP globally.
Use the no keyword to disable CDP globally.
This example shows how to enable CDP globally:
Switch(config)# cdp run
Displaying the CDP Global Configuration
To display the CDP configuration, perform this task:
Command Purpose
Switch# show cdp Displays global CDP information.
This example shows how to display the CDP configuration:
Switch# show cdp
Global CDP information:
Sending CDP packets every 120 seconds
Sending a holdtime value of 180 seconds
Sending CDPv2 advertisements is enabled
Switch#
For additional CDP show commands, see the “Monitoring and Maintaining CDP” section on page 20-3.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
20-2 OL-22250-01
Chapter 20 Configuring CDP
Configuring CDP
Enabling CDP on an Interface
To enable CDP on an interface, perform this task:
Command Purpose
Switch(config-if)# [no] cdp enable Enables CDP on an interface.
Use the no keyword to disable CDP on an interface.
This example shows how to enable CDP on Fast Ethernet interface 5/1:
Switch(config)# interface fastethernet 5/1
Switch(config-if)# cdp enable
This example shows how to disable CDP on Fast Ethernet interface 5/1:
Switch(config)# interface fastethernet 5/1
Switch(config-if)# no cdp enable
Displaying the CDP Interface Configuration
To display the CDP configuration for an interface, perform this task:
Command Purpose
Switch# show cdp interface [type/number] Displays information about interfaces where CDP is
enabled.
This example shows how to display the CDP configuration of Fast Ethernet interface 5/1:
Switch# show cdp interface fastethernet 5/1
FastEthernet5/1 is up, line protocol is up
Encapsulation ARPA
Sending CDP packets every 120 seconds
Holdtime is 180 seconds
Switch#
Monitoring and Maintaining CDP
To monitor and maintain CDP on your device, perform one or more of these tasks:
Command Purpose
Switch# clear cdp counters Resets the traffic counters to zero.
Switch# clear cdp table Deletes the CDP table of information about neighbors.
Switch# show cdp Displays global information such as frequency of
transmissions and the holdtime for packets being
transmitted.
Switch# show cdp entry entry_name Displays information about a specific neighbor. You
[protocol | version] can limit the display to protocol or version information.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 20-3
Chapter 20 Configuring CDP
Configuring CDP
Command Purpose
Switch# show cdp interface Displays information about interfaces on which CDP is
[type/number] enabled.
Switch# show cdp neighbors Displays information about neighboring equipment.
[type/number] [detail] You can limit the display to neighbors on a specific
interface and expand to provide more detailed
information.
Switch# show cdp traffic Displays CDP counters, including the number of
packets sent and received and checksum errors.
Switch# show debugging Displays information about the types of debugging that
are enabled for your switch.
This example shows how to clear the CDP counter configuration on your switch:
Switch# clear cdp counters
This example shows how to display information about the neighboring equipment:
Switch# show cdp neighbors
Capability Codes: R - Router, T - Trans Bridge, B - Source Route Bridge
S - Switch, H - Host, I - IGMP, r - Repeater
Device ID Local Intrfce Holdtme Capability Platform Port ID
JAB023807H1 Fas 5/3 127 T S WS-C2948 2/46
JAB023807H1 Fas 5/2 127 T S WS-C2948 2/45
JAB023807H1 Fas 5/1 127 T S WS-C2948 2/44
JAB023807H1 Gig 1/2 122 T S WS-C2948 2/50
JAB023807H1 Gig 1/1 122 T S WS-C2948 2/49
JAB03130104 Fas 5/8 167 T S WS-C4003 2/47
JAB03130104 Fas 5/9 152 T S WS-C4003 2/48
Software Configuration Guide—Release IOS-XE 3.1.0 SG
20-4 OL-22250-01
CH A P T E R 21
Configuring IGMP Snooping and Filtering
This chapter describes how to configure Internet Group Management Protocol (IGMP) snooping on the
Catalyst 4500 series switch. It provides guidelines, procedures, and configuration examples.
This chapter consists of the following major sections:
• Overview of IGMP Snooping, page 21-1
• Configuring IGMP Snooping, page 21-5
• Displaying IGMP Snooping Information, page 21-14
• Configuring IGMP Filtering, page 21-20
• Displaying IGMP Filtering Configuration, page 21-24
Note To support Cisco Group Management Protocol (CGMP) client devices, configure the switch as a CGMP
server. For more information, see the chapters “IP Multicast” and “Configuring IP Multicast Routing”
in the Cisco IOS IP and IP Routing Configuration Guide, Cisco IOS Release 12.1 at this location:
http://www.cisco.com/en/US/docs/ios/12_1/iproute/configuration/guide/ip_c.html
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Overview of IGMP Snooping
This section includes the following subsections:
• Immediate-Leave Processing, page 21-3
• IGMP Configurable-Leave Timer, page 21-4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-1
Chapter 21 Configuring IGMP Snooping and Filtering
Overview of IGMP Snooping
• IGMP Snooping Querier, page 21-4
• Explicit Host Tracking, page 21-4
Note Quality of service does not apply to IGMP packets.
IGMP snooping allows a switch to snoop or capture information from IGMP packets transmitted
between hosts and a router. Based on this information, a switch adds or deletes multicast addresses from
its address table, thereby enabling (or disabling) multicast traffic from flowing to individual host ports.
IGMP snooping supports all versions of IGMP: IGMPv1, IGMPv2, and IGMPv3.
In contrast to IGMPv1 and IGMPv2, IGMPv3 snooping provides immediate-leave processing by default.
It provides Explicit Host Tracking (EHT) and allows network administrators to deploy SSM
functionality on Layer 2 devices that truly support IGMPv3. (See the “Explicit Host Tracking” section
on page 21-4.)
In subnets where IGMP is configured, IGMP snooping manages multicast traffic at Layer 2. You can
configure interfaces to dynamically forward multicast traffic only to those interfaces that are interested
in receiving it by using the switchport keyword.
IGMP snooping restricts traffic in MAC multicast groups 0100.5e00.0001 to 01-00-5e-ff-ff-ff. IGMP
snooping does not restrict Layer 2 multicast packets generated by routing protocols.
Note For more information on IP multicast and IGMP, refer to RFC 1112, RFC 2236, RFC 3376 (for
IGMPv3).
IGMP (configured on a router) periodically sends out IGMP general queries. A host responds to these
queries with IGMP membership reports for groups that it is interested in. When IGMP snooping is
enabled, the switch creates one entry per VLAN in the Layer 2 forwarding table for each Layer 2
multicast group from which it receives an IGMP join request. All hosts interested in this multicast traffic
send IGMP membership reports and are added to the forwarding table entry.
Layer 2 multicast groups learned through IGMP snooping are dynamic. However, you can statically
configure Layer 2 multicast groups using the ip igmp snooping static command. If you specify group
membership statically, your setting supersedes any automatic manipulation by IGMP snooping.
Multicast group membership lists can contain both user-defined and IGMP snooping settings.
Groups with IP addresses in the range 224.0.0.0 to 224.0.0.255, which map to the multicast MAC
address range 0100.5E00.0001 to 0100.5E00.00FF, are reserved for routing control packets. These
groups are flooded to all forwarding ports of the VLAN with the exception of 224.0.0.22, which is used
for IGMPv3 membership reports.
Note If a VLAN experiences a spanning-tree topology change, IP multicast traffic floods on all VLAN ports
where PortFast is not enabled, as well as on ports with the no igmp snooping tcn flood command
configured for a period of TCN query count.
For a Layer 2 IGMPv2 host interface to join an IP multicast group, a host sends an IGMP membership
report for the IP multicast group. For a host to leave a multicast group, it can either ignore the periodic
IGMP general queries or it can send an IGMP leave message. When the switch receives an IGMP leave
message from a host, it sends out an IGMP group-specific query to determine whether any devices
connected to that interface are interested in traffic for the specific multicast group. The switch then
updates the table entry for that Layer 2 multicast group so that only those hosts interested in receiving
multicast traffic for the group are listed.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-2 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Overview of IGMP Snooping
In contrast, IGMPv3 hosts send IGMPv3 membership reports (with the allow group record mode) to join
a specific multicast group. When IGMPv3 hosts send membership reports (with the block group record)
to reject traffic from all sources in the previous source list, the last host on the port is removed by
immediate-leave if EHT is enabled.
Immediate-Leave Processing
IGMP snooping immediate-leave processing allows the switch to remove an interface from the
forwarding-table entry without first sending out IGMP group-specific queries to the interface. The
VLAN interface is pruned from the multicast tree for the multicast group specified in the original IGMP
leave message. Immediate-leave processing ensures optimal bandwidth management for all hosts on a
switched network, even when multiple multicast groups are being used simultaneously.
When a switch with IGMP snooping enabled receives an IGMPv2 or IGMPv3 leave message, it sends
an IGMP group-specific query from the interface where the leave message was received to determine
when there are other hosts attached to that interface that are interested in joining the MAC multicast
group. If the switch does not receive an IGMP join message within the query response interval, the
interface is removed from the port list of the (MAC-group, VLAN) entry in the Layer 2 forwarding table.
Note By default all IGMP joins are forwarded to all multicast router ports.
With immediate-leave processing enabled on the VLAN, an interface can be removed immediately from
the port list of the Layer 2 entry when the IGMP leave message is received, unless a multicast router was
learned on the port.
Note When using IGMPv2 snooping, use immediate-leave processing only on VLANs where just one host is
connected to each interface. If immediate-leave processing is enabled on VLANs where multiple hosts
are connected to an interface, some hosts might be dropped inadvertently. When using IGMPv3,
immediate-leave processing is enabled by default, and due to Explicit Host Tracking (see below), the
switch can detect when a port has single or multiple hosts maintained by the switch for IGMPv3 hosts.
As a result, the switch can perform immediate-leave processing when it detects a single host behind a
given port.
Note IGMPv3 is interoperable with older versions of IGMP.
Use the show ip igmp snooping querier vlan command to display the IGMP version on a particular
VLAN.
Use the show ip igmp snooping vlan command to display whether the switch supports IGMPv3
snooping.
Use the ip igmp snooping immediate-leave command to enable immediate-leave for IGMPv2.
Note Immediate-leave processing is enabled by default for IGMPv3.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-3
Chapter 21 Configuring IGMP Snooping and Filtering
Overview of IGMP Snooping
IGMP Configurable-Leave Timer
Immediate-leave processing cannot be used on VLANs where multiple hosts may be connected to a
single interface. To reduce leave latency in such a scenario, IGMPv3 provides a configurable leave
timer.
In Cisco IOS Release 12.2(25)SG and earlier, the IGMP snooping leave time was based on query
response time. If membership reports were not received by the switch before the query response time of
the query expired, a port was removed from the multicast group membership.
In Cisco IOS Release 12.2(31)SG and later, you can configure the length of time that the switch waits
after sending a group-specific query to determine if hosts are still interested in a specific multicast group.
The IGMP leave response time can be configured from 100 to 5000 milliseconds. The timer can be set
either globally or per VLAN. The VLAN configuration of the leave time overrides the global
configuration.
For configuration steps, see the “Configuring the IGMP Leave Timer” section on page 21-9.
IGMP Snooping Querier
IGMP Snooping Querier support was introduced in Cisco IOS Release 12.2(50)SG. This is a Layer 2
feature required to support IGMP snooping in a VLAN where PIM and IGMP are not configured because
the multicast traffic does not require routing.
In a network where IP multicast routing is configured, the IP multicast router acts as the IGMP querier
by sending general queries. If the IP-multicast traffic in a VLAN only needs to be Layer 2-switched, an
IP-multicast router is not required. Without an IP-multicast router on the VLAN, you must configure
another switch as the IGMP querier so that it can send queries.
When enabled, the IGMP snooping querier sends out periodic IGMPv2 queries that trigger IGMP report
messages from the switch that requests IP multicast traffic. IGMP snooping listens to these IGMP
reports to establish appropriate forwarding.
On switches that use IGMP to report interest in IP multicast traffic, configure at least one switch as the
IGMP snooping querier in each supported VLAN.
You can configure a switch to generate IGMP queries on a VLAN regardless of whether IP multicast
routing is enabled.
Explicit Host Tracking
Explicit Host Tracking (EHT) monitors group membership by tracking hosts that are sending IGMPv3
membership reports. This tracking enables a switch to detect host information associated with the groups
of each port. Furthermore, EHT enables the user to track the membership and various statistics.
EHT enables a switch to track membership on a per-port basis. Consequently, a switch is aware of the
hosts residing on each port and can perform immediate-leave processing when there is only one host
behind a port.
To determine whether EHT is enabled on a VLAN, use the show ip igmp snoop vlan command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-4 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Snooping
Configuring IGMP Snooping
Note When configuring IGMP, configure the VLAN in the VLAN database mode. (See Chapter 12,
“Configuring VLANs, VTP, and VMPS”.)
IGMP snooping allows switches to examine IGMP packets and make forwarding decisions based on
their content.
These sections describe how to configure IGMP snooping:
• Default IGMP Snooping Configuration, page 21-5
• Enabling IGMP Snooping Globally, page 21-6
• Enabling IGMP Snooping on a VLAN, page 21-6
• Configuring Learning Methods, page 21-7
• Configuring a Static Connection to a Multicast Router, page 21-8
• Enabling IGMP Immediate-Leave Processing, page 21-8
• Configuring the IGMP Leave Timer, page 21-9
• Configuring IGMP Snooping Querier, page 21-10
• Configuring Explicit Host Tracking, page 21-11
• Configuring a Host Statically, page 21-11
• Suppressing Multicast Flooding, page 21-12
Default IGMP Snooping Configuration
Table 21-1 shows the IGMP snooping default configuration values.
Table 21-1 IGMP Snooping Default Configuration Values
Feature Default Value
IGMP snooping Enabled
Multicast routers None configured
Explicit Host Tracking Enabled for IGMPv3; Not available for IGMPv2
Immediate-leave processing Enabled for IGMPv3; Disabled for IGMPv2
Report Suppression Enabled
IGMP snooping learning method PIM/DVMRP1
1. PIM/DVMRP = Protocol Independent Multicast/Distance Vector Multicast Routing Protocol
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-5
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Snooping
Enabling IGMP Snooping Globally
To enable IGMP snooping globally, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# [no] ip igmp snooping Enables IGMP snooping.
Use the no keyword to disable IGMP snooping.
Step 3 Switch(config)# end Exits configuration mode.
Step 4 Switch# show ip igmp snooping | include Verifies the configuration.
This example shows how to enable IGMP snooping globally and verify the configuration:
Switch# configure terminal
Switch(config)# ip igmp snooping
Switch(config)# end
Switch# show ip igmp snooping
Global IGMP Snooping configuration:
-----------------------------------
IGMP snooping : Enabled
IGMPv3 snooping : Enabled
Report suppression : Enabled
TCN solicit query : Disabled
TCN flood query count : 2
Vlan 1:
--------
IGMP snooping : Enabled
IGMPv2 immediate leave : Disabled
Explicit host tracking : Enabled
Multicast router learning mode : pim-dvmrp
CGMP interoperability mode : IGMP_ONLY
Vlan 2:
--------
IGMP snooping : Enabled
IGMPv2 immediate leave : Disabled
Explicit host tracking : Enabled
Multicast router learning mode : pim-dvmrp
CGMP interoperability mode : IGMP_ONLY
Enabling IGMP Snooping on a VLAN
To enable IGMP snooping on a VLAN, perform this task:
Command Purpose
Step 1 Switch(config)# [no] ip igmp snooping vlan vlan_ID Enables IGMP snooping.
Use the no keyword to disable IGMP snooping.
Step 2 Switch(config)# end Exits configuration mode.
Step 3 Switch# show ip igmp snooping vlan vlan_ID Verifies the configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-6 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Snooping
This example shows how to enable IGMP snooping on VLAN 2 and verify the configuration:
Switch# configure terminal
Switch(config)# ip igmp snooping vlan 2
Switch(config)# end
Switch# show ip igmp snooping vlan 2
Global IGMP Snooping configuration:
-----------------------------------
IGMP snooping : Enabled
IGMPv3 snooping : Enabled
Report suppression : Enabled
TCN solicit query : Disabled
TCN flood query count : 2
Vlan 2:
--------
IGMP snooping : Enabled
IGMPv2 immediate leave : Disabled
Explicit host tracking : Enabled
Multicast router learning mode : pim-dvmrp
CGMP interoperability mode : IGMP_ONLY
Configuring Learning Methods
The following sections describe IGMP snooping learning methods:
• Configuring PIM/DVMRP Learning, page 21-7
• Configuring CGMP Learning, page 21-7
Configuring PIM/DVMRP Learning
To configure IGMP snooping to learn from PIM/DVMRP packets, perform this task:
Command Purpose
Switch(config)# ip igmp snooping vlan Specifies the learning method for the VLAN.
vlan_ID mrouter learn [cgmp | pim-dvmrp]
This example shows how to configure IP IGMP snooping to learn from PIM/DVMRP packets:
Switch# configure terminal
Switch(config)# ip igmp snooping vlan 1 mrouter learn pim-dvmrp
Switch(config)# end
Switch#
Configuring CGMP Learning
To configure IGMP snooping to learn from CGMP self-join packets, perform this task:
Command Purpose
Switch(config)# ip igmp snooping vlan Specifies the learning method for the VLAN.
vlan_ID mrouter learn [cgmp | pim-dvmrp]
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-7
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Snooping
This example shows how to configure IP IGMP snooping to learn from CGMP self-join packets:
Switch# configure terminal
Switch(config)# ip igmp snooping vlan 1 mrouter learn cgmp
Switch(config)# end
Switch#
Configuring a Static Connection to a Multicast Router
To configure a static connection to a multicast router, enter the
ip igmp snooping vlan mrouter interface command on the switch.
To configure a static connection to a multicast router, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ip igmp snooping vlan vlan_ID Specifies a static connection to a multicast router for the
mrouter interface interface_num VLAN.
Note The interface to the router must be in the VLAN
where you are entering the command. The router
and the line protocol must be up.
Step 3 Switch(config)# end Exits configuration mode.
Step 4 Switch# show ip igmp snooping mrouter vlan vlan_ID Verifies the configuration.
This example shows how to configure a static connection to a multicast router:
Switch# configure terminal
Switch(config)# ip igmp snooping vlan 200 mrouter interface fastethernet 2/10
Switch# show ip igmp snooping mrouter vlan 200
vlan ports
-----+----------------------------------------
200 Fa2/10
Switch#
Enabling IGMP Immediate-Leave Processing
When you enable IGMP immediate-leave processing on a VLAN, a switch removes an interface from
the multicast group when it detects an IGMPv2 leave message on that interface.
Note For IGMPv3, immediate-leave processing is enabled by default with EHT.
To enable immediate-leave processing on an IGMPv2 interface, perform this task:
Command Purpose
Switch(config)# ip igmp snooping vlan Enables immediate-leave processing in the
vlan_ID immediate-leave VLAN.
Note This command applies only to IGMPv2
hosts.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-8 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Snooping
This example shows how to enable IGMP immediate-leave processing on interface VLAN 200 and to
verify the configuration:
Switch# configure terminal
Switch(config)# ip igmp snooping vlan 200 immediate-leave
Configuring immediate leave on vlan 200
Switch(config)# end
Switch# show ip igmp interface vlan 200 | include immediate leave
Immediate leave : Disabled
Switch(config)#
Configuring the IGMP Leave Timer
Follows these guidelines when configuring the IGMP leave timer:
• You can configure the leave time globally or per VLAN.
• Configuring the leave time on a VLAN overrides the global setting.
• The default leave time is 1000 milliseconds.
• The IGMP configurable leave time is only supported on hosts running IGMP Version 2.
• The actual leave latency in the network is usually the configured leave time. However, the leave
time might vary around the configured time, depending on real-time CPU load conditions, network
delays and the amount of traffic sent through the interface.
To enable the IGMP configurable-leave timer, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ip igmp snooping Configure the IGMP leave timer globally. The range is 100 to
last-member-query-interval time 5000 milliseconds. The default is 1000 seconds.
To globally reset the IGMP leave timer to the default setting, use
the global configuration command
no ip igmp snooping last-member-query-interval.
Step 3 Switch(config)# ip igmp snooping vlan (Optional) Configure the IGMP leave time on the VLAN
vlan_ID last-member-query-interval time interface. The range is 100 to 5000 milliseconds.
To remove the configured IGMP leave-time setting from the
specified VLAN, use the global configuration command
no ip igmp snooping vlan vlan-id last-member-query-interval
Note Configuring the leave time on a VLAN overrides the
globally configured timer.
Step 4 Switch(config)# end Return to privileged EXEC mode.
Step 5 Switch# show ip igmp snooping (Optional) Display the configured IGMP leave time.
Step 6 Switch# copy running-config (Optional) Save your entries in the configuration file.
startup-config
This example shows how to enable the IGMP configurable-leave timer and to verify the configuration:
Switch# configure terminal
Switch(config)# ip igmp snooping last-member-query-interval 200
Switch(config)# ip igmp snooping vlan 10 last-member-query-interval 500
Switch(config)# end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-9
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Snooping
Switch# show ip igmp snooping show ip igmp snooping
Global IGMP Snooping configuration:
-----------------------------------
IGMP snooping : Enabled
IGMPv3 snooping : Enabled
Report suppression : Enabled
TCN solicit query : Disabled
TCN flood query count : 2
Last Member Query Interval : 200
Vlan 1:
--------
IGMP snooping : Enabled
IGMPv2 immediate leave : Disabled
Explicit host tracking : Enabled
Multicast router learning mode : pim-dvmrp
Last Member Query Interval : 200
CGMP interoperability mode : IGMP_ONLY
Vlan 10:
--------
IGMP snooping : Enabled
IGMPv2 immediate leave : Disabled
Explicit host tracking : Enabled
Multicast router learning mode : pim-dvmrp
Last Member Query Interval : 500
CGMP interoperability mode : IGMP_ONLY
Switch#
Configuring IGMP Snooping Querier
The IGMP Snooping Querier feature can be enabled either globally (i.e. they affect every VLAN) or on
a per-vlan basis.
Note The IGMP snooping querier is disabled by default.
To configure IGMP Snooping Querier, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# [no] ip igmp snooping Enables IGMP Snooping Querier.
[vlan vlan_id] querier
Step 3 Switch(config)# [no] ip igmp snooping Configures the IGMP Snooping Querier source IP address.
[vlan vlan_id] querier address abcd
Step 4 Switch(config)# [no] ip igmp snooping Configures IGMP Snooping Querier IGMP version.
[vlan vlan_id] querier version [1 | 2]
Step 5 Switch(config)# ip igmp snooping Configures IGMP Snooping Querier query interval.
[vlan vlan_id] querier query-interval
interval
Step 6 Switch(config)# ip igmp snooping Configures IGMP Snooping Querier query maximum response
[vlan vlan_id] querier max-response-time time.
value
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-10 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Snooping
Command Purpose
Step 7 Switch(config)# ip igmp snooping Configures IGMP Snooping Querier expiry time out.
[vlan vlan_id] querier timer expiry value
Step 8 Switch(config)# ip igmp snooping Configures IGMP Snooping Querier tcn query count.
[vlan vlan_id] querier tcn query count
value
Step 9 Switch(config)# ip igmp snooping Configures IGMP Snooping Querier tcn query interval.
[vlan vlan_id] querier tcn query interval
value
Step 10 Switch(config)# end Returns to privileged EXEC mode.
For an example of how to display Querier information, refer to the “Displaying IGMP Snooping Querier
Information” section on page 21-19.
Configuring Explicit Host Tracking
For IGMPv3, EHT is enabled by default and can be disabled on a per-VLAN basis.
To disable EHT processing on a VLAN, perform this task:
Command Purpose
Switch(config)# [no] ip igmp snooping vlan Enables EHT on a VLAN.
vlan_ID explicit-tracking
The no keyword disables EHT.
This example shows how to disable IGMP EHT on VLAN 200 and to verify the configuration:
Switch# configure terminal
Switch(config)# no ip igmp snooping vlan 200 explicit-tracking
Switch(config)# end
Switch# show ip igmp snooping vlan 200 | include Explicit host tracking
Explicit host tracking : Disabled
Configuring a Host Statically
Hosts normally join multicast groups dynamically, but you can also configure a host statically on an
interface.
To configure a host statically on an interface, perform this task:
Command Purpose
Switch(config-if)# ip igmp snooping vlan Configures a host statically in the VLAN.
vlan_ID static mac_address interface
interface_num Note This command cannot be configured to
receive traffic for specific source IP
addresses.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-11
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Snooping
This example shows how to configure a host statically in VLAN 200 on interface FastEthernet 2/11:
Switch# configure terminal
Switch(config)# ip igmp snooping vlan 200 static 0100.5e02.0203 interface fastethernet
2/11
Configuring port FastEthernet2/11 on group 0100.5e02.0203 vlan 200
Switch(config)# end
Suppressing Multicast Flooding
An IGMP snooping-enabled switch floods multicast traffic to all ports in a VLAN when a spanning-tree
Topology Change Notification (TCN) is received. Multicast flooding suppression enables a switch to
stop sending such traffic. To support flooding suppression, the following interface and global commands
were introduced in Cisco IOS Release 12.1(11b)EW.
The interface command is as follows:
[no | default] ip igmp snooping tcn flood
The global commands are as follows:
[no | default] ip igmp snooping tcn flood query count [1 - 10]
[no | default] ip igmp snooping tcn query solicit
Prior to Cisco IOS Release 12.1(11b)EW, when a spanning tree topology change notification (TCN) was
received by a switch, the multicast traffic was flooded to all the ports in a VLAN for a period of three
IGMP query intervals. This was necessary for redundant configurations. In Cisco IOS Release
12.1(11b)EW, the default time period the switch waits before multicast flooding stops was changed to
two IGMP query intervals.
This flooding behavior is undesirable if the switch that does the flooding has many ports that are
subscribed to different groups. The traffic could exceed the capacity of the link between the switch and
the end host, resulting in packet loss.
With the no ip igmp snooping tcn flood command, you can disable multicast flooding on a switch
interface following a topology change. Only the multicast groups that have been joined by a port are sent
to that port, even during a topology change.
With the ip igmp snooping tcn flood query count command, you can enable multicast flooding on a
switch interface for a short period of time following a topology change by configuring an IGMP query
threshold.
Typically, if a topology change occurs, the spanning tree root switch issues a global IGMP leave
message (referred to as a “query solicitation”) with the group multicast address 0.0.0.0. When a switch
receives this solicitation, it floods this solicitation on all ports in the VLAN where the spanning tree
change occurred. When the upstream router receives this solicitation, it immediately issues an IGMP
general query.
With the ip igmp snooping tcn query solicit command, you can now direct a non-spanning tree root
switch to issue the same query solicitation.
The following sections provide additional details on the new commands and illustrate how to use them.
IGMP Snooping Interface Configuration
A topology change in a VLAN may invalidate previously learned IGMP snooping information. A host
that was on one port before the topology change may move to another port after the topology change.
When the topology changes, the Catalyst 4500 series switch takes special actions to ensure that multicast
traffic is delivered to all multicast receivers in that VLAN.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-12 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Snooping
When the spanning tree protocol is running in a VLAN, a spanning tree topology change notification
(TCN) is issued by the root switch in the VLAN. A Catalyst 4500 series switch that receives a TCN in
a VLAN for which IGMP snooping has been enabled immediately enters into “multicast flooding mode”
for a period of time until the topology restabilizes and the new locations of all multicast receivers are
learned.
While in “multicast flooding mode,” IP multicast traffic is delivered to all ports in the VLAN, and not
restricted to those ports on which multicast group members have been detected.
Starting with Cisco IOS Release 12.1(11b)EW, you can manually prevent IP multicast traffic from being
flooded to a switchport by using the no ip igmp snooping tcn flood command on that port.
For trunk ports, the configuration applies to all VLANs.
By default, multicast flooding is enabled. Use the no keyword to disable flooding, and use default to
restore the default behavior (flooding is enabled).
To disable multicast flooding on an interface, perform this task:
Command Purpose
Step 1 Switch(config)# interface {fastethernet | Selects the interface to configure.
gigabitethernet | tengigabitethernet} slot/port
Step 2 Switch(config-if)# no ip igmp snooping tcn flood Disables multicast flooding on the interface when TCNs
are received by the switch.
To enable multicast flooding on the interface, enter this
command:
default ip igmp snooping tcn flood
Step 3 Switch(config)# end Exits configuration mode.
Step 4 Switch# show running interface {fastethernet | Verifies the configuration.
gigabitethernet | tengigabitethernet} slot/port
This example shows how to disable multicast flooding on interface FastEthernet 2/11:
Switch(config)# interface fastethernet 2/11
Switch(config-if)# no ip igmp snooping tcn flood
Switch(config-if)# end
Switch#
IGMP Snooping Switch Configuration
By default, “flooding mode” persists until the switch receives two IGMP general queries. You can
change this period of time by using the
ip igmp snooping tcn flood query count n command, where n is a number between 1 and 10.
This command operates at the global configuration level.
The default number of queries is 2. The no and default keywords restore the default.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-13
Chapter 21 Configuring IGMP Snooping and Filtering
Displaying IGMP Snooping Information
To establish an IGMP query threshold, perform this task:
Command Purpose
Step 1 Switch(config)# Modifies the number of IGMP queries the switch waits
ip igmp snooping tcn flood query count <n> for before it stops flooding multicast traffic.
To return the switch to the default number of IGMP
queries, enter this command:
default ip igmp snooping tcn flood query count .
Step 2 Switch(config)# end Exits configuration mode.
This example shows how to modify the switch to stop flooding multicast traffic after four queries:
Switch(config)# ip igmp snooping tcn flood query count 4
Switch(config)# end
Switch#
When a spanning tree root switch receives a topology change in an IGMP snooping-enabled VLAN, the
switch issues a query solicitation that causes an IOS router to send out one or more general queries. The
new command ip igmp snooping tcn query solicit causes the switch to send the query solicitation
whenever it notices a topology change, even if that switch is not the spanning tree root.
This command operates at the global configuration level.
By default, query solicitation is disabled unless the switch is the spanning tree root. The default keyword
restores the default behavior.
To direct a switch to send a query solicitation, perform this task:
Command Purpose
Step 1 Switch(config)# ip igmp snooping tcn query Configures the switch to send a query solicitation when
solicit a TCN is detected.
To stop the switch from sending a query solicitation (if
it’s not a spanning tree root switch), enter this command:
no ip igmp snooping tcn query solicit
Step 2 Switch(config)# end Exits configuration mode.
This example shows how to configure the switch to send a query solicitation upon detecting a TCN:
Switch(config)# ip igmp snooping tcn query solicit
Switch(config)# end
Switch#
Displaying IGMP Snooping Information
The following sections show how to display IGMP snooping information:
• Displaying Querier Information, page 21-15
• Displaying IGMP Host Membership Information, page 21-15
• Displaying Group Information, page 21-16
• Displaying Multicast Router Interfaces, page 21-17
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-14 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Displaying IGMP Snooping Information
• Displaying MAC Address Multicast Entries, page 21-18
• Displaying IGMP Snooping Information on a VLAN Interface, page 21-18
• Configuring IGMP Filtering, page 21-20
Displaying Querier Information
To display querier information, perform this task:
Command Purpose
Switch# show ip igmp snooping querier [vlan Displays multicast router interfaces.
vlan_ID]
This example shows how to display the IGMP snooping querier information for all VLANs on the
switch:
Switch# show ip igmp snooping querier
Vlan IP Address IGMP Version Port
---------------------------------------------------
2 10.10.10.1 v2 Router
3 172.20.50.22 v3 Fa3/15
This example shows how to display the IGMP snooping querier information for VLAN 3:
Switch# show ip igmp snooping querier vlan 3
Vlan IP Address IGMP Version Port
---------------------------------------------------
3 172.20.50.22 v3 Fa3/15
Displaying IGMP Host Membership Information
Note By default, EHT maintains a maximum of 1000 entries in the EHT database. Once this limit is reached,
no additional entries are created. To create additional entries, clear the database with the
clear ip igmp snooping membership vlan command.
To display host membership information, perform this task:
Command Purpose
Switch# show ip igmp snooping membership Displays Explicit Host Tracking information.
[interface interface_num][vlan vlan_ID]
[reporter a.b.c.d] [source a.b.c.d group Note This command is valid only if EHT is
a.b.c.d] enabled on the switch.
This example shows how to display host membership information for VLAN 20 and to delete the EHT
database:
Switch# show ip igmp snooping membership vlan 20
#channels: 5
#hosts : 1
Source/Group Interface Reporter Uptime Last-Join Last-Leave
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-15
Chapter 21 Configuring IGMP Snooping and Filtering
Displaying IGMP Snooping Information
40.40.40.2/224.10.10.10 Gi4/1 20.20.20.20 00:23:37 00:06:50 00:20:30
40.40.40.3/224.10.10.10 Gi4/2 20.20.2020 00:23:37 00:06:50 00:20:30
40.40.40.4/224.10.10.10Gi4/1 20.20.20.20 00:39:42 00:09:17 -
40.40.40.5/224.10.10.10Fa2/1 20.20.20.20 00:39:42 00:09:17 -
40.40.40.6/224.10.10.10 Fa2/1 20.20.20.20 00:09:47 00:09:17 -
Switch# clear ip igmp snooping membership vlan 20
This example shows how to display host membership for interface gi4/1:
Switch# show ip igmp snooping membership interface gi4/1
#channels: 5
#hosts : 1
Source/Group Interface Reporter Uptime Last-Join Last-Leave
40.40.40.2/224.10.10.10 Gi4/1 20.20.20.20 00:23:37 00:06:50 00:20:30
40.40.40.4/224.10.10.10Gi4/1 20.20.20.20 00:39:42 00:09:17 -
This example shows how to display host membership for VLAN 20 and group 224.10.10.10:
Switch# show ip igmp snooping membership vlan 20 source 40.40.40.2 group 224.10.10.10
#channels: 5
#hosts : 1
Source/Group Interface Reporter Uptime Last-Join Last-Leave
40.40.40.2/224.10.10.10 Gi4/1 20.20.20.20 00:23:37 00:06:50 00:20:30
Displaying Group Information
To display detailed IGMPv3 information associated with a group, perform one of the following tasks:
Command Purpose
Switch# show ip igmp snooping groups [vlan Displays groups, the type of reports that were
vlan_ID] received for the group (Host Type), and the list of
ports on which reports were received.
The report list includes neither the multicast router
ports nor the complete forwarding port set for the
group. Rather, it lists the ports on which the
reports have been received.
To display the complete forwarding port set for
the group, display the CLI output for the MAC
address that maps to this group by using the
show mac-address-table multicast command.
Switch# show ip igmp snooping groups [vlan Displays information specific to a group address,
vlan_ID a.b.c.d] [summary|sources|hosts] providing details about the current state of the
group with respect to sources and hosts.
Note This command applies only to full
IGMPv3 snooping support and can be used
for IGMPv1, IGMPv2, or IGMPv3 groups.
Switch# show ip igmp snooping groups [vlan Displays the total number of group addresses
vlan_ID] [count] learned by the system on a global or per-VLAN
basis.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-16 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Displaying IGMP Snooping Information
This example shows how to display the host types and ports of a group in VLAN 1:
Switch# show ip igmp snooping groups vlan 10 226.6.6.7
Vlan Group Version Ports
---------------------------------------------------------
10 226.6.6.7 v3 Fa7/13, Fa7/14
Switch>
This example shows how to display the current state of a group with respect to a source IP address:
Switch# show ip igmp snooping groups vlan 10 226.6.6.7 sources
Source information for group 226.6.6.7:
Timers: Expired sources are deleted on next IGMP General Query
SourceIP Expires Uptime Inc Hosts Exc Hosts
-------------------------------------------------------
2.0.0.1 00:03:04 00:03:48 2 0
2.0.0.2 00:03:04 00:02:07 2 0
Switch>
This example shows how to display the current state of a group with respect to a host MAC address:
Switch# show ip igmp snooping groups vlan 10 226.6.6.7 hosts
IGMPv3 host information for group 226.6.6.7
Timers: Expired hosts are deleted on next IGMP General Query
Host (MAC/IP) Filter mode Expires Uptime # Sources
-------------------------------------------------------------
175.1.0.29 INCLUDE stopped 00:00:51 2
175.2.0.30 INCLUDE stopped 00:04:14 2
This example shows how to display summary information for an IGMPv3 group:
Switch# show ip igmp snooping groups vlan 10 226.6.6.7 summary
Group Address (Vlan 10) : 226.6.6.7
Host type : v3
Member Ports : Fa7/13, Fa7/14
Filter mode : INCLUDE
Expires : stopped
Sources : 2
Reporters (Include/Exclude) : 2/0
This example shows how to display the total number of group addresses learned by the system globally:
Switch# show ip igmp snooping groups count
Total number of groups: 54
This example shows how to display the total number of group addresses learned on VLAN 5:
Switch# show ip igmp snooping groups vlan 5 count
Total number of groups: 30
Displaying Multicast Router Interfaces
When you enable IGMP snooping, the switch automatically learns to which interface the multicast
routers are connected.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-17
Chapter 21 Configuring IGMP Snooping and Filtering
Displaying IGMP Snooping Information
To display multicast router interfaces, perform this task:
Command Purpose
Switch# show ip igmp snooping mrouter vlan Displays multicast router interfaces.
vlan_ID
This example shows how to display the multicast router interfaces in VLAN 1:
Switch# show ip igmp snooping mrouter vlan 1
vlan ports
-----+----------------------------------------
1 Gi1/1,Gi2/1,Fa3/48,Router
Switch#
Displaying MAC Address Multicast Entries
To display MAC address multicast entries for a VLAN, perform this task:
Command Purpose
Switch# show mac-address-table multicast Displays MAC address multicast entries for a
vlan vlan_ID [count] VLAN.
This example shows how to display MAC address multicast entries for VLAN 1:
Switch# show mac-address-table multicast vlan 1
Multicast Entries
vlan mac address type ports
-------+---------------+-------+-------------------------------------------
1 0100.5e01.0101 igmp Switch,Gi6/1
1 0100.5e01.0102 igmp Switch,Gi6/1
1 0100.5e01.0103 igmp Switch,Gi6/1
1 0100.5e01.0104 igmp Switch,Gi6/1
1 0100.5e01.0105 igmp Switch,Gi6/1
1 0100.5e01.0106 igmp Switch,Gi6/1
Switch#
This example shows how to display a total count of MAC address entries for VLAN 1:
Switch# show mac-address-table multicast vlan 1 count
Multicast MAC Entries for vlan 1: 4
Switch#
Displaying IGMP Snooping Information on a VLAN Interface
To display IGMP snooping information on a VLAN, perform this task:
Command Purpose
Switch# show ip igmp snooping vlan vlan_ID Displays IGMP snooping information on a VLAN
interface.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-18 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Displaying IGMP Snooping Information
This example shows how to display IGMP snooping information on VLAN 5:
Switch# show ip igmp snooping vlan 5
Global IGMP Snooping configuration:
-----------------------------------
IGMP snooping :Enabled
IGMPv3 snooping support :Full
Report suppression :Enabled
TCN solicit query :Disabled
TCN flood query count :2
Vlan 5:
--------
IGMP snooping :Enabled
Immediate leave :Disabled
Explicit Host Tracking :Disabled
Multicast router learning mode :pim-dvmrp
CGMP interoperability mode :IGMP_ONLY
Displaying IGMP Snooping Querier Information
To display IGMP Snooping Querier information, perform this task:
Command Purpose
Switch# show ip igmp snooping querier [vlan Displays the IGMP Snooping Querier state.
vlan_ID] [detail]
This example shows how to display Querier information:
switch# show ip igmp snooping querier vlan 2 detail
IP address : 1.2.3.4
IGMP version : v2
Port : Router/Switch
Max response time : 12s
Global IGMP switch querier status
------------------------------------------------
admin state : Enabled
admin version : 2
source IP address : 1.2.3.4
query-interval (sec) : 130
max-response-time (sec) : 10
querier-timeout (sec) : 100
tcn query count : 2
tcn query interval (sec) : 10
Vlan 2: IGMP switch querier status
------------------------------------------------
admin state : Enabled
admin version : 2
source IP address : 1.2.3.4
query-interval (sec) : 55
max-response-time (sec) : 12
querier-timeout (sec) : 70
tcn query count : 10
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-19
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Filtering
tcn query interval (sec) : 8
operational state : Querier
operational version : 2
tcn query pending count : 0
Configuring IGMP Filtering
This section includes the following subsections:
• Default IGMP Filtering Configuration, page 21-20
• Configuring IGMP Profiles, page 21-21
• Applying IGMP Profiles, page 21-22
• Setting the Maximum Number of IGMP Groups, page 21-23
Note The IGMP filtering feature works for IGMPv1 and IGMPv2 only.
In some environments, for example metropolitan or multiple-dwelling unit (MDU) installations, an
administrator might want to control the multicast groups to which a user on a switch port can belong.
This allows the administrator to control the distribution of multicast services, such as IP/TV, based on
some type of subscription or service plan.
With the IGMP filtering feature, an administrator can exert this type of control. With this feature, you
can filter multicast joins on a per-port basis by configuring IP multicast profiles and associating them
with individual switch ports. An IGMP profile can contain one or more multicast groups and specifies
whether access to the group is permitted or denied. If an IGMP profile denying access to a multicast
group is applied to a switch port, the IGMP join report requesting the stream of IP multicast traffic is
dropped, and the port is not allowed to receive IP multicast traffic from that group. If the filtering action
permits access to the multicast group, the IGMP report from the port is forwarded for normal processing.
IGMP filtering controls only IGMP membership join reports and has no relationship to the function that
directs the forwarding of IP multicast traffic.
You can also set the maximum number of IGMP groups that a Layer 2 interface can join with the
ip igmp max-groups <n> command.
Default IGMP Filtering Configuration
Table 21-2 shows the default IGMP filtering configuration.
Table 21-2 Default IGMP Filtering Settings
Feature Default Setting
IGMP filters No filtering
IGMP maximum number of IGMP groups No limit
IGMP profiles None defined
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-20 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Filtering
Configuring IGMP Profiles
To configure an IGMP profile and to enter IGMP profile configuration mode, use the ip igmp profile
global configuration command. From the IGMP profile configuration mode, you can specify the
parameters of the IGMP profile to be used for filtering IGMP join requests from a port. When you are
in IGMP profile configuration mode, you can create the profile using these commands:
• deny: Specifies that matching addresses are denied; this is the default condition.
• exit: Exits from igmp-profile configuration mode.
• no: Negates a command or sets its defaults.
• permit: Specifies that matching addresses are permitted.
• range: Specifies a range of IP addresses for the profile. You can enter a single IP address or a range
with starting and ending addresses.
By default, no IGMP profiles are configured. When a profile is configured with neither the permit nor
the deny keyword, the default is to deny access to the range of IP addresses.
To create an IGMP profile for a port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ip igmp profile profile Enters IGMP profile configuration mode, and assigns a
number number to the profile you are configuring. The range is from
1 to 4,294,967,295.
Step 3 Switch(config-igmp-profile)# permit | deny (Optional) Sets the action to permit or deny access to the IP
multicast address. If no action is configured, the default for
the profile is to deny access.
Step 4 Switch(config-igmp-profile)# range ip Enters the IP multicast address or range of IP multicast
multicast address addresses to which access is being controlled. If entering a
range, enter the low IP multicast address, a space, and the
high IP multicast address.
Use the range command multiple times to enter multiple
addresses or ranges of addresses.
Step 5 Switch(config-igmp-profile)# end Returns to privileged EXEC mode.
Step 6 Switch# show ip igmp profile profile number Verifies the profile configuration.
Step 7 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
To delete a profile, use the no ip igmp profile profile number global configuration command.
To delete an IP multicast address or range of IP multicast addresses, use the no range ip multicast
address IGMP profile configuration command.
This example shows how to create IGMP profile 4 (allowing access to the single IP multicast address)
and how to verify the configuration. If the action were to deny (the default), it would not appear in the
show ip igmp profile command output.
Switch# configure terminal
Switch(config)# ip igmp profile 4
Switch(config-igmp-profile)# permit
Switch(config-igmp-profile)# range 229.9.9.0
Switch(config-igmp-profile)# end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-21
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Filtering
Switch# show ip igmp profile 4
IGMP Profile 4
permit
range 229.9.9.0 229.9.9.0
Applying IGMP Profiles
To control access as defined in an IGMP profile, use the ip igmp filter interface configuration command
to apply the profile to the appropriate interfaces. You can apply a profile to multiple interfaces, but each
interface can only have one profile applied to it.
Note You can apply IGMP profiles to Layer 2 ports only. You cannot apply IGMP profiles to routed ports (or
SVIs) or to ports that belong to an EtherChannel port group.
To apply an IGMP profile to a switch port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Enters interface configuration mode, and enter the physical
interface to configure, for example fastethernet2/3. The interface
must be a Layer 2 port that does not belong to an EtherChannel
port group.
Step 3 Switch(config-if)# ip igmp filter profile Applies the specified IGMP profile to the interface. The profile
number number can be from 1 to 4,294,967,295.
Step 4 Switch(config-if)# end Returns to privileged EXEC mode.
Step 5 Switch# show running configuration Verifies the configuration.
interface interface-id
Step 6 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
To remove a profile from an interface, use the no ip igmp filter command.
This example shows how to apply IGMP profile 4 to an interface and to verify the configuration:
Switch# configure terminal
Switch(config)# interface fastethernet2/12
Switch(config-if)# ip igmp filter 4
Switch(config-if)# end
Switch# show running-config interface fastethernet2/12
Building configuration...
Current configuration : 123 bytes
!
interface FastEthernet2/12
no ip address
shutdown
snmp trap link-status
ip igmp max-groups 25
ip igmp filter 4
end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-22 OL-22250-01
Chapter 21 Configuring IGMP Snooping and Filtering
Configuring IGMP Filtering
Setting the Maximum Number of IGMP Groups
You can set the maximum number of IGMP groups that a Layer 2 interface can join by using the ip igmp
max-groups interface configuration command. Use the no form of this command to set the maximum
back to the default, which is no limit.
Note This restriction applies to Layer 2 ports only. You cannot set a maximum number of IGMP groups on
routed ports (or SVIs) or on ports that belong to an EtherChannel port group.
To apply an IGMP profile on a switch port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Enters interface configuration mode, and enter the physical
interface to configure, for example gigabitethernet1/1. The
interface must be a Layer 2 port that does not belong to an
EtherChannel group.
Step 3 Switch(config-if)# ip igmp max-groups Sets the maximum number of IGMP groups that the interface can
number join. The range is from 0 to 4,294,967,294. By default, no
maximum is set.
To remove the maximum group limitation and return to the
default of no maximum, use the no ip igmp max-groups
command.
Step 4 Switch(config-if)# end Returns to privileged EXEC mode.
Step 5 Switch# show running-configuration Verifies the configuration.
interface interface-id
Step 6 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to limit the number of IGMP groups that an interface can join to 25:
Switch# configure terminal
Switch(config)# interface fastethernet2/12
Switch(config-if)# ip igmp max-groups 25
Switch(config-if)# end
Switch# show running-config interface fastethernet2/12
Building configuration...
Current configuration : 123 bytes
!
interface FastEthernet2/12
no ip address
shutdown
snmp trap link-status
ip igmp max-groups 25
ip igmp filter 4
end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 21-23
Chapter 21 Configuring IGMP Snooping and Filtering
Displaying IGMP Filtering Configuration
Displaying IGMP Filtering Configuration
You can display IGMP profile and maximum group configuration for all interfaces on the switch or for
a specified interface.
To display IGMP profiles, perform this task:
Command Purpose
Switch# show ip igmp profile [profile number] Displays the specified IGMP profile or all IGMP profiles defined
on the switch.
To display interface configuration, perform this task:
Command Purpose
Switch# show running-configuration [interface Displays the configuration of the specified interface or all
interface-id] interfaces on the switch, including (if configured) the maximum
number of IGMP groups to which an interface can belong and the
IGMP profile applied to the interface.
This is an example of the show ip igmp profile privileged EXEC command when no profile number is
entered. All profiles defined on the switch are displayed.
Switch# show ip igmp profile
IGMP Profile 3
range 230.9.9.0 230.9.9.0
IGMP Profile 4
permit
range 229.9.9.0 229.255.255.255
This is an example of the show running-config privileged EXEC command when an interface is
specified with IGMP maximum groups configured and IGMP profile 4 has been applied to the interface:
Switch# show running-config interface fastethernet2/12
Building configuration...
Current configuration : 123 bytes
!
interface FastEthernet2/12
no ip address
shutdown
snmp trap link-status
ip igmp max-groups 25
ip igmp filter 4
end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
21-24 OL-22250-01
CH A P T E R 22
Configuring IPv6 MLD Snooping
Multicast Listener Discovery (MLD) snooping allows you to enable efficient distribution of IP version 6
(IPv6) multicast data to clients and routers in a switched network on the Catalyst 4500 series switch.
This chapter includes these sections:
• About MLD Snooping, page 22-1
• Configuring IPv6 MLD Snooping, page 22-5
• Displaying MLD Snooping Information, page 22-11
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About MLD Snooping
In IP version 4 (IPv4), Layer 2 switches can use Internet Group Management Protocol (IGMP) snooping
to limit the flooding of multicast traffic by dynamically configuring Layer 2 interfaces so that multicast
traffic is forwarded to only those interfaces associated with IP multicast devices. In IPv6, MLD snooping
performs a similar function. With MLD snooping, IPv6 multicast data is selectively forwarded to a list
of ports that want to receive the data, instead of being flooded to all ports in a VLAN. This list is
constructed by snooping IPv6 multicast control packets.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 22-1
Chapter 22 Configuring IPv6 MLD Snooping
About MLD Snooping
MLD is a protocol used by IPv6 multicast routers to discover the presence of multicast listeners (nodes
wishing to receive IPv6 multicast packets) on its directly attached links and to discover which multicast
packets are of interest to neighboring nodes. MLD is derived from IGMP; MLD version 1 (MLDv1) is
equivalent to IGMPv2 and MLD version 2 (MLDv2) is equivalent to IGMPv3. MLD is a subprotocol of
Internet Control Message Protocol version 6 (ICMPv6), and MLD messages are a subset of ICMPv6
messages, identified in IPv6 packets by a preceding Next Header value of 58.
The switch supports two versions of MLD snooping:
• MLDv1 snooping detects MLDv1 control packets and sets up traffic bridging based on IPv6
destination multicast addresses.
• MLDv2 basic snooping (MBSS) uses MLDv2 control packets to set up traffic forwarding based on
IPv6 destination multicast addresses.
The switch can snoop on both MLDv1 and MLDv2 protocol packets and bridge IPv6 multicast data
based on destination IPv6 multicast addresses.
Note The switch does not support MLDv2 enhanced snooping (MESS), which sets up IPv6 source and
destination multicast address-based forwarding.
MLD snooping can be enabled or disabled globally or per VLAN. When MLD snooping is enabled, a
per-VLAN IPv6 multicast MAC address table is constructed in software and a per-VLAN IPv6 multicast
address table is constructed in software and hardware. The switch then performs IPv6 multicast-address
based bridging in hardware.
These sections describe some parameters of IPv6 MLD snooping:
• MLD Messages, page 22-2
• MLD Queries, page 22-3
• Multicast Client Aging Robustness, page 22-3
• Multicast Router Discovery, page 22-3
• MLD Reports, page 22-4
• MLD Done Messages and Immediate-Leave, page 22-4
• Topology Change Notification Processing, page 22-4
MLD Messages
MLDv1 supports three types of messages:
• Listener Queries are the equivalent of IGMPv2 queries and are either General Queries or
Multicast-Address-Specific Queries (MASQs).
• Multicast Listener Reports are the equivalent of IGMPv2 reports
• Multicast Listener Done messages are the equivalent of IGMPv2 leave messages.
MLDv2 supports MLDv2 queries and reports, as well as MLDv1 Report and Done messages.
Message timers and state transitions resulting from messages being sent or received are the same as those
of IGMPv2 messages. MLD messages that do not have valid link-local IPv6 source addresses are ignored
by MLD routers and switches.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
22-2 OL-22250-01
Chapter 22 Configuring IPv6 MLD Snooping
About MLD Snooping
MLD Queries
The switch sends out MLD queries, constructs an IPv6 multicast address database, and generates MLD
group-specific and MLD group-and-source-specific queries in response to MLD Done messages. The
switch also supports report suppression, report proxying, Immediate-Leave functionality, and static IPv6
multicast MAC-address configuration.
When MLD snooping is disabled, all MLD queries are flooded in the ingress VLAN.
When MLD snooping is enabled, received MLD queries are flooded in the ingress VLAN, and a copy of
the query is sent to the CPU for processing. From the received query, MLD snooping builds the IPv6
multicast address database. It detects multicast router ports, maintains timers, sets report response time,
learns the querier IP source address for the VLAN, learns the querier port in the VLAN, and maintains
multicast-address aging.
When a group exists in the MLD snooping database, the switch responds to a group-specific query by
sending an MLDv1 report. When the group is unknown, the group-specific query is flooded to the
ingress VLAN.
When a host wants to leave a multicast group, it can send out an MLD Done message (equivalent to
IGMP Leave message). When the switch receives an MLDv1 Done message, if Immediate- Leave is not
enabled, the switch sends an MASQ to the port from which the message was received to determine if
other devices connected to the port should remain in the multicast group.
Multicast Client Aging Robustness
You can configure port membership removal from addresses based on the number of queries. A port is
removed from membership to an address only when there are no reports to the address on the port for
the configured number of queries. The default number is 2.
Multicast Router Discovery
Like IGMP snooping, MLD snooping performs multicast router discovery, with these characteristics:
• Ports configured by a user never age out.
• Dynamic port learning results from MLDv1 snooping queries and IPv6 PIMv2 packets.
• If there are multiple routers on the same Layer 2 interface, MLD snooping tracks a single multicast
router on the port (the router that most recently sent a router control packet).
• Dynamic multicast router port aging is based on a default timer of 5 minutes; the multicast router is
deleted from the router port list if no control packet is received on the port for 5 minutes.
• IPv6 multicast router discovery only takes place when MLD snooping is enabled on the switch.
• Received IPv6 multicast router control packets are always flooded to the ingress VLAN, whether
MLD snooping is enabled on the switch.
• After the discovery of the first IPv6 multicast router port, unknown IPv6 multicast data is forwarded
only to the discovered router ports (before that time, all IPv6 multicast data is flooded to the ingress
VLAN).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 22-3
Chapter 22 Configuring IPv6 MLD Snooping
About MLD Snooping
MLD Reports
The processing of MLDv1 join messages is essentially the same as with IGMPv2. When no IPv6
multicast routers are detected in a VLAN, reports are not processed or forwarded from the switch. When
IPv6 multicast routers are detected and an MLDv1 report is received, an IPv6 multicast group address
and an IPv6 multicast MAC address are entered in the VLAN MLD database. Then all IPv6 multicast
traffic to the group within the VLAN is forwarded using this address. When MLD snooping is disabled,
reports are flooded in the ingress VLAN.
When MLD snooping is enabled, MLD report suppression, called listener message suppression, is
automatically enabled. With report suppression, the switch forwards the first MLDv1 report received by
a group to IPv6 multicast routers; subsequent reports for the group are not sent to the routers. When
MLD snooping is disabled, report suppression is disabled, and all MLDv1 reports are flooded to the
ingress VLAN.
The switch also supports MLDv1 proxy reporting. When an MLDv1 MASQ is received, the switch
responds with MLDv1 reports for the address on which the query arrived if the group exists in the switch
on another port and if the port on which the query arrived is not the last member port for the address.
MLD Done Messages and Immediate-Leave
When the Immediate-Leave feature is enabled and a host sends an MLDv1 Done message (equivalent to
an IGMP leave message), the port on which the Done message was received is immediately deleted from
the group.You enable Immediate-Leave on VLANs and (as with IGMP snooping), you should only use
the feature on VLANs where a single host is connected to the port. If the port was the last member of a
group, the group is also deleted, and the leave information is forwarded to the detected IPv6 multicast
routers.
When Immediate Leave is not enabled in a VLAN (which would be the case when there are multiple
clients for a group on the same port) and a Done message is received on a port, an MASQ is generated
on that port. The user can control when a port membership is removed for an existing address in terms
of the number of MASQs. A port is removed from membership to an address when there are no MLDv1
reports to the address on the port for the configured number of queries.
The number of MASQs generated is configured by using the ipv6 mld snooping last-listener-query
count global configuration command. The default number is 2.
The MASQ is sent to the IPv6 multicast address for which the Done message was sent. If there are no
reports sent to the IPv6 multicast address specified in the MASQ during the switch maximum response
time, the port on which the MASQ was sent is deleted from the IPv6 multicast address database. The
maximum response time is the time configured by using the ipv6 mld snooping
last-listener-query-interval global configuration command. If the deleted port is the last member of the
multicast address, the multicast address is also deleted, and the switch sends the address leave
information to all detected multicast routers.
Topology Change Notification Processing
When topology change notification (TCN) solicitation is enabled by using the ipv6 mld snooping tcn
query solicit global configuration command, MLDv1 snooping sets the VLAN to flood all IPv6
multicast traffic with a configured number of MLDv1 queries before it begins sending multicast data
only to selected ports. You set this value by using the ipv6 mld snooping tcn flood query count global
Software Configuration Guide—Release IOS-XE 3.1.0 SG
22-4 OL-22250-01
Chapter 22 Configuring IPv6 MLD Snooping
Configuring IPv6 MLD Snooping
configuration command. The default is to send two queries. The switch also generates MLDv1 global
Done messages with valid link-local IPv6 source addresses when the switch becomes the STP root in the
VLAN or when it is configured by the user. This is same as done in IGMP snooping.
Configuring IPv6 MLD Snooping
These sections describe how to configure IPv6 MLD snooping:
• Default MLD Snooping Configuration, page 22-5
• MLD Snooping Configuration Guidelines, page 22-6
• Enabling or Disabling MLD Snooping, page 22-6
• Configuring a Static Multicast Group, page 22-7
• Configuring a Multicast Router Port, page 22-7
• Enabling MLD Immediate Leave, page 22-8
• Configuring MLD Snooping Queries, page 22-9
• Disabling MLD Listener Message Suppression, page 22-10
Default MLD Snooping Configuration
Table 22-1 shows the default MLD snooping configuration.
Table 22-1 Default MLD Snooping Configuration
Feature Default Setting
MLD snooping (Global) Disabled.
MLD snooping (per VLAN) Enabled. MLD snooping must be globally enabled for VLAN
MLD snooping to take place.
IPv6 Multicast addresses None configured.
IPv6 Multicast router ports None configured.
MLD snooping Immediate Leave Disabled.
MLD snooping robustness variable Global: 2; Per VLAN: 0.
Note The VLAN value overrides the global setting. When the
VLAN value is 0, the VLAN uses the global count.
Last listener query count Global: 2; Per VLAN: 0.
Note The VLAN value overrides the global setting. When the
VLAN value is 0, the VLAN uses the global count.
Last listener query interval Global: 1000 (1 second); VLAN: 0.
Note The VLAN value overrides the global setting. When the
VLAN value is 0, the VLAN uses the global interval.
TCN query solicit Disabled.
TCN query count 2.
MLD listener suppression Disabled.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 22-5
Chapter 22 Configuring IPv6 MLD Snooping
Configuring IPv6 MLD Snooping
MLD Snooping Configuration Guidelines
When configuring MLD snooping, consider these guidelines:
• You can configure MLD snooping characteristics at any time, but you must globally enable MLD
snooping by using the ipv6 mld snooping global configuration command for the configuration to
take effect.
• MLD snooping and IGMP snooping act independently of each other. You can enable both features
at the same time on the switch. The total number of IPv4 and IPv6 multicast groups entries that can
coexist on the Catalyst 4500 series switch is limited to 16384.
• The Supervisor Engine 7-E with 512MB of memory supports about 11000 MLD Snooping multicast
groups whereas a Supervisor Engine 6-E with 1GB memory supports 16384 MLD Snooping
multicast groups.
Enabling or Disabling MLD Snooping
By default, IPv6 MLD snooping is globally disabled on the switch and enabled on all VLANs. When
MLD snooping is globally disabled, it is also disabled on all VLANs. When you globally enable MLD
snooping, the VLAN configuration overrides the global configuration. That is, MLD snooping is enabled
only on VLAN interfaces in the default state (enabled).
You can enable and disable MLD snooping on a per-VLAN basis, but if you globally disable MLD
snooping, it is disabled in all VLANs. If global snooping is enabled, you can enable or disable VLAN
snooping.
To globally enable MLD snooping on the switch, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ipv6 mld snooping Globally enables MLD snooping on the switch.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To globally disable MLD snooping on the switch, use the no ipv6 mld snooping global configuration
command.
To enable MLD snooping on a VLAN, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ipv6 mld snooping Globally enables MLD snooping on the switch.
Step 3 Switch(config)# ipv6 mld snooping vlan Enables MLD snooping on the VLAN.The VLAN ID range is 1 to
vlan-id 1001 and 1006 to 4094.
Note MLD snooping must be globally enabled for VLAN snooping
to be enabled.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
22-6 OL-22250-01
Chapter 22 Configuring IPv6 MLD Snooping
Configuring IPv6 MLD Snooping
Command Purpose
Step 4 Switch(config)# end Returns to privileged EXEC mode.
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To disable MLD snooping on a VLAN interface, use the no ipv6 mld snooping vlan vlan-id global
configuration command for the specified VLAN number.
Configuring a Static Multicast Group
Hosts or Layer 2 ports normally join multicast groups dynamically, but you can also statically configure
an IPv6 multicast address and member ports for a VLAN.
To add a Layer 2 port as a member of a multicast group, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode
Step 2 Switch(config)# ipv6 mld snooping vlan Statically configures a multicast group with a Layer 2 port as a
vlan-id static ipv6_multicast_address member of a multicast group:
interface interface-id
• vlan-id is the multicast group VLAN ID. The VLAN ID
range is 1 to 1001 and 1006 to 4094.
• ipv6_multicast_address is the 128-bit group IPv6 address.
The address must be in the form specified in RFC 2373.
• interface-id is the member port. It can be a physical
interface or a port channel (1 to 64).
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show mac-address-table multicast Verifies the static member port and the IPv6 address.
mld-snooping
Step 5 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
To remove a Layer 2 port from the multicast group, use the no ipv6 mld snooping vlan vlan-id static
mac-address interface interface-id global configuration command. If all member ports are removed
from a group, the group is deleted.
This example shows how to statically configure an IPv6 MAC address:
Switch# configure terminal
Switch(config)# ipv6 mld snooping vlan 2 static 3333.0000.0003 interface
gigabitethernet1/1
Switch(config)# end
Configuring a Multicast Router Port
Although MLD snooping learns about router ports through MLD queries and PIMv6 queries, you can
also use the command-line interface (CLI) to add a multicast router port to a VLAN. To add a multicast
router port (add a static connection to a multicast router), use the ipv6 mld snooping vlan mrouter
global configuration command on the switch.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 22-7
Chapter 22 Configuring IPv6 MLD Snooping
Configuring IPv6 MLD Snooping
Note Static connections to multicast routers are supported only on switch ports.
To add a multicast router port to a VLAN, follow these steps:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ipv6 mld snooping vlan Specifies the multicast router VLAN ID, and specify the
vlan-id mrouter interface interface-id interface to the multicast router.
• The VLAN ID range is 1 to 1001 and 1006 to 4094.
• The interface can be a physical interface or a port channel.
The port-channel range is 1 to 64.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show ipv6 mld snooping mrouter Verifies that IPv6 MLD snooping is enabled on the VLAN
[vlan vlan-id] interface.
Step 5 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
To remove a multicast router port from the VLAN, use the no ipv6 mld snooping vlan vlan-id mrouter
interface interface-id global configuration command.
This example shows how to add a multicast router port to VLAN 200:
Switch# configure terminal
Switch(config)# ipv6 mld snooping vlan 200 mrouter interface gigabitethernet1/0/2
Switch(config)# exit
Enabling MLD Immediate Leave
When you enable MLDv1 Immediate Leave, the switch immediately removes a port from a multicast
group when it detects an MLD Done message on that port. You should only use the Immediate-Leave
feature when there is a single receiver present on every port in the VLAN. When there are multiple
clients for a multicast group on the same port, you should not enable Immediate-Leave in a VLAN.
To enable MLDv1 Immediate Leave, follow these steps:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ipv6 mld snooping Enables MLD Immediate Leave on the VLAN interface.
vlan vlan-id immediate-leave
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show ipv6 mld snooping vlan Verifies that Immediate Leave is enabled on the VLAN interface.
vlan-id
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Software Configuration Guide—Release IOS-XE 3.1.0 SG
22-8 OL-22250-01
Chapter 22 Configuring IPv6 MLD Snooping
Configuring IPv6 MLD Snooping
To disable MLD Immediate Leave on a VLAN, use the no ipv6 mld snooping vlan vlan-id
immediate-leave global configuration command.
This example shows how to enable MLD Immediate Leave on VLAN 130:
Switch# configure terminal
Switch(config)# ipv6 mld snooping vlan 130 immediate-leave
Switch(config)# exit
Configuring MLD Snooping Queries
When Immediate Leave is not enabled and a port receives an MLD Done message, the switch generates
MASQs on the port and sends them to the IPv6 multicast address for which the Done message was sent.
You can optionally configure the number of MASQs that are sent and the length of time the switch waits
for a response before deleting the port from the multicast group.
To configure MLD snooping query characteristics for the switch or for a VLAN, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ipv6 mld snooping (Optional) Sets the number of queries that are sent before switch delete
robustness-variable value a listener (port) that does not respond to a general query. The range is
1 to 3; the default is 2.
Step 3 Switch(config)# ipv6 mld snooping (Optional) Sets the robustness variable on a VLAN basis, which
vlan vlan-id robustness-variable value determines the number of general queries that MLD snooping sends
before aging out a multicast address when there is no MLD report
response. The range is 1 to 3; the default is 0. When set to 0, the number
used is the global robustness variable value.
Step 4 Switch(config)# ipv6 mld snooping (Optional) Sets the number of MASQs that the switch sends before
last-listener-query-count count aging out an MLD client. The range is 1 to 7; the default is 2. The
queries are sent 1 second apart.
Step 5 Switch(config)# ipv6 mld snooping (Optional) Sets the last-listener query count on a VLAN basis. This
vlan vlan-id last-listener-query-count value overrides the value configured globally. The range is 1 to 7; the
count
default is 0. When set to 0, the global count value is used. Queries are
sent 1 second apart.
Step 6 Switch(config)# ipv6 mld snooping (Optional) Sets the maximum response time that the switch waits after
last-listener-query-interval interval sending out a MASQ before deleting a port from the multicast group.
The range is 100 to 32,768 thousands of a second. The default is 1000
(1 second).
Step 7 Switch(config)# ipv6 mld snooping (Optional) Sets the last-listener query interval on a VLAN basis. This
vlan vlan-id value overrides the value configured globally. The range is 0 to 32,768
last-listener-query-interval interval
thousands of a second. The default is 0. When set to 0, the global
last-listener query interval is used.
Step 8 Switch(config)# ipv6 mld snooping tcn (Optional) Enables topology change notification (TCN) solicitation,
query solicit which means that VLANs flood all IPv6 multicast traffic for the
configured number of queries before sending multicast data to only
those ports requesting to receive it. The default is for TCN to be
disabled.
Step 9 Switch(config)# ipv6 mld snooping tcn (Optional) When TCN is enabled, specifies the number of TCN queries
flood query count count to be sent. The range is from 1 to 10; the default is 2.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 22-9
Chapter 22 Configuring IPv6 MLD Snooping
Configuring IPv6 MLD Snooping
Command Purpose
Step 10 Switch(config)# end Returns to privileged EXEC mode.
Step 11 Switch# show ipv6 mld snooping (Optional) Verifies that the MLD snooping querier information for the
querier [vlan vlan-id ] switch or for the VLAN.
Step 12 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to set the MLD snooping global robustness variable to 3:
Switch# configure terminal
Switch(config)# ipv6 mld snooping robustness-variable 3
Switch(config)# exit
This example shows how to set the MLD snooping last-listener query count for a VLAN to 3:
Switch# configure terminal
Switch(config)# ipv6 mld snooping vlan 200 last-listener-query-count 3
Switch(config)# exit
This example shows how to set the MLD snooping last-listener query interval (maximum response time)
to 2000 (2 seconds):
Switch# configure terminal
Switch(config)# ipv6 mld snooping last-listener-query-interval 2000
Switch(config)# exit
Disabling MLD Listener Message Suppression
MLD snooping listener message suppression is enabled by default. When it is enabled, the switch
forwards only one MLD report per multicast router query. When message suppression is disabled,
multiple MLD reports could be forwarded to the multicast routers.
To disable MLD listener message suppression, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# no ipv6 mld snooping Disables MLD message suppression.
listener-message-suppression
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show ipv6 mld snooping Verifies that IPv6 MLD snooping report suppression is
disabled.
Step 5 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
To re-enable MLD message suppression, use the ipv6 mld snooping listener-message-suppression
global configuration command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
22-10 OL-22250-01
Chapter 22 Configuring IPv6 MLD Snooping
Displaying MLD Snooping Information
Displaying MLD Snooping Information
You can display MLD snooping information for dynamically learned and statically configured router
ports and VLAN interfaces. You can also display MAC address multicast entries for a VLAN configured
for MLD snooping.
To display MLD snooping information, use one or more of the privileged EXEC commands in
Table 22-2.
Table 22-2 Commands for Displaying MLD Snooping Information
Command Purpose
show ipv6 mld snooping [vlan vlan-id] Displays the MLD snooping configuration information for all VLANs
on the switch or for a specified VLAN.
(Optional) Enter vlan vlan-id to display information for a single VLAN.
The VLAN ID range is 1 to 1001 and 1006 to 4094.
show ipv6 mld snooping mrouter [vlan vlan-id] Displays information on dynamically learned and manually configured
multicast router interfaces. When you enable MLD snooping, the switch
automatically learns the interface to which a multicast router is
connected. These are dynamically learned interfaces.
(Optional) Enter vlan vlan-id to display information for a single VLAN.
The VLAN ID range is 1 to 1001 and 1006 to 4094.
show ipv6 mld snooping querier [vlan Displays information about the IPv6 address and incoming port for the
vlan-id] most-recently received MLD query messages in the VLAN.
(Optional) Enter vlan vlan-id to display information for a single
VLAN.The VLAN ID range is 1 to 1001 and 1006 to 4094.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 22-11
Chapter 22 Configuring IPv6 MLD Snooping
Displaying MLD Snooping Information
Software Configuration Guide—Release IOS-XE 3.1.0 SG
22-12 OL-22250-01
CH A P T E R 23
Configuring LLDP, and LLDP-MED
This chapter describes how to configure the Link Layer Discovery Protocol (LLDP) and LLDP Media
Endpoint Discovery (LLDP-MED) on the Catalyst 4500 series switch.
Note For complete syntax and usage information for the commands used in this chapter, see the command
reference for this release and the “System Management Commands” section in the Cisco IOS
Configuration Fundamentals Command Reference, Release 12.2.
This chapter consists of these sections:
• About LLDP and LLDP-MED, page 23-1
• Configuring LLDP and LLDP-MED, page 23-3
• Cisco IOS Carries Ethernet Features in Cisco IOS XE 3.1.0 SG, page 23-10
About LLDP and LLDP-MED
This section contains this conceptual information:
• Understanding LLDP, page 23-1
• Understanding LLDP-MED, page 23-2
Understanding LLDP
The Cisco Discovery Protocol (CDP) is a device discovery protocol that runs over Layer 2 (the data link
layer) on all Cisco-manufactured devices (routers, bridges, access servers, and switches). CDP allows
network management applications to automatically discover and learn about other Cisco devices
connected to the network.
To support non-Cisco devices and to allow for interoperability between other devices, the switch
supports the IEEE 802.1AB LLDP. LLDP is a neighbor discovery protocol that is used for network
devices to advertise information about themselves to other devices on the network. This protocol runs
over the data-link layer, which allows two systems running different network layer protocols to learn
about each other.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 23-1
Chapter 23 Configuring LLDP, and LLDP-MED
About LLDP and LLDP-MED
LLDP supports a set of attributes that it uses to discover neighbor devices. These attributes contain type,
length, and value descriptions and are referred to as TLVs. LLDP supported devices can use TLVs to receive
and send information to their neighbors. Details such as configuration information, device capabilities,
and device identity can be advertised using this protocol.
The switch supports the following basic management TLVs, which are optional:
• Port description TLV
• System name TLV
• System description TLV
• System capabilities TLV
• Management address TLV
• Power Management TLV
These organizationally specific LLDP TLVs are also advertised to support LLDP-MED.
• Port VLAN ID TLV ((IEEE 802.1 organizationally specific TLVs)
• MAC/PHY configuration/status TLV(IEEE 802.3 organizationally specific TLVs)
Understanding LLDP-MED
LLDP for Media Endpoint Devices (LLDP-MED) is an extension to LLDP that operates between
endpoint devices such as IP phones and network devices such as switches. It specifically provides
support for voice over IP (VoIP) applications and provides additional TLVs for capabilities discovery,
network policy, Power over Ethernet, inventory management, and location information. By default, all
LLDP-MED TLVs are enabled.
LLDP-MED supports these TLVs:
• LLDP-MED capabilities TLV
Allows LLDP-MED endpoints to determine the capabilities that the connected device supports and
what capabilities the device has enabled.
• Network policy TLV
Allows both network connectivity devices and endpoints to advertise VLAN configurations and
associated Layer 2 and Layer 3 attributes for the specific application on that port. For example, the
switch can notify a phone of the VLAN number that it should use. The phone can connect into any
switch, obtain its VLAN number, and then start communicating with the call control
• Power management TLV
Enables advanced power management between LLDP-MED endpoint and network connectivity
devices. Allows switches and phones to convey power information, such as how the device is
powered, power priority, and how much power the device needs.
Note Power Management TLV only exchanges power information; it does not perform power
negotiation, which is handled by CDP.
• Inventory management TLV
Allows an endpoint to send detailed inventory information about itself to the switch, including
information hardware revision, firmware version, software version, serial number, manufacturer
name, model name, and asset ID TLV.
Software Configuration Guide—Release 15.0(1)XO
23-2 OL-22250-01
Chapter 23 Configuring LLDP, and LLDP-MED
Configuring LLDP and LLDP-MED
• Location TLV
Provides location information from the switch to the endpoint device. The location TLV can send
this information:
– Civic location information
Provides the civic address information and postal information. Examples of civic location
information are street address, road name, and postal community name information.
– ELIN location information
Provides the location information for a caller. The location is determined by the Emergency
location identifier number (ELIN), which is a phone number that routes an emergency call to
the local public safety answering point (PSAP) and which the PSAP can use to call back the
emergency caller.
Note A switch cannot send LLDP and LLDP-MED simultaneously to an end-point device. By default, a
network device sends only LLDP packets until it receives LLDP-MED packets from an end-point device.
The network device then sends LLDP-MED packets until it receives only LLDP packets.
Configuring LLDP and LLDP-MED
This section contains this configuration information:
• Default LLDP Configuration, page 23-3
• Configuring LLDP Characteristics, page 23-4
• Disabling and Enabling LLDP Globally, page 23-5
• Disabling and Enabling LLDP on an Interface, page 23-6
• Configuring LLDP-MED TLVs, page 23-7
• Configuring LLDP Power Negotiation, page 23-8
• Configuring LLDP and Location TLV, page 23-9
• Monitoring and Maintaining LLDP and LLDP-MED, page 23-10
Default LLDP Configuration
Table 23-1 shows the default LLDP configuration. To change the default settings, use the LLDP global
configuration and LLDP interface configuration commands.
Table 23-1 Default LLDP Configuration
Feature Default Setting
LLDP global state Disabled
LLDP holdtime (before discarding) 120 seconds
LLDP timer (packet update frequency) 30 seconds
LLDP reinitialization delay 2 seconds
LLDP tlv-select Enabled to send and receive all TLVs.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 23-3
Chapter 23 Configuring LLDP, and LLDP-MED
Configuring LLDP and LLDP-MED
Table 23-1 Default LLDP Configuration
Feature Default Setting
LLDP interface state Enabled
LLDP receive Enabled
LLDP transmit Enabled
LLDP med-tlv-select Enabled to send all LLDP-MED TLVs
Configuring LLDP Characteristics
You can configure the frequency of LLDP updates, the amount of time to hold the information before
discarding it, the initialization delay time. You can also select the LLDP and LLDP-MED TLVs for
sending and receiving. The location service feature is available only when the switch is running the
cryptographic (encrypted) software image.
To configure these characteristics, perform this task:
Note Steps 2 through 5 can be performed in any order.
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# lldp holdtime (Optional) Specifies the amount of time a receiving device should hold the
seconds information sent by your device before discarding it.
The range is 0 to 65535 seconds; the default is 120 seconds.
Step 3 Switch(config)# lldp reinit (Optional) Specific the delay time in seconds for LLDP to initialize on
any interface.
The range is 2 to 5 seconds; the default is 2 seconds.
Step 4 Switch(config)# lldp timer seconds (Optional) Sets the transmission frequency of LLDP updates in seconds.
The range is 5 to 65534 seconds; the default is 30 seconds.
Step 5 Switch(config)# lldp tlv-select (Optional) Specifies the LLDP TLVs to send or receive.
Step 6 Switch(config)# copy running-config Saves your entries in the configuration file.
startup-config
Step 7 Switch(config)# lldp med-tlv-select (Optional) Specifies the LLDP-MED TLVs to send or receive.
Note Use the no form of each of the LLDP commands to return to the default setting.
This example shows how to configure a holdtime of 120 second, a delay time of 2 seconds and an update
frequency of 30:
Switch# configure terminal
Switch(config)# lldp holdtime 120
Switch(config)# lldp reinit 2
Switch(config)# lldp timer 30
Switch(config)# end
Software Configuration Guide—Release 15.0(1)XO
23-4 OL-22250-01
Chapter 23 Configuring LLDP, and LLDP-MED
Configuring LLDP and LLDP-MED
This example shows how to transmit only LLDP packets:
switch# configure terminal
siwtch(config)# no lldp receive
switch(config)# end
If you want to receive LLDP packets again, do the following:
switch# configure terminal
siwtch(config)# lldp receive
switch(config)# end
For additional LLDP show commands, see the “Monitoring and Maintaining LLDP and LLDP-MED”
section on page 23-10.
Disabling and Enabling LLDP Globally
Note LLDP is disabled by default.
To disable LLDP globally, do the following:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# no lldp run Disables LLDP.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
To enable LLDP once it has been disabled, do the following:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# lldp run Enables LLDP.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
This example shows how to globally disable LLDP.
Switch# configure terminal
Switch(config)# no lldp run
Switch(config)# end
This example shows how to globally enable LLDP.
Switch# configure terminal
Switch(config)# lldp run
Switch(config)# end
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 23-5
Chapter 23 Configuring LLDP, and LLDP-MED
Configuring LLDP and LLDP-MED
Disabling and Enabling LLDP on an Interface
LLDP is disabled globally on all supported interfaces. You must enable LLDP globally to allow a device
to send LLDP packets. However, no changes are required at the interface level.
You can configure the interface to selectively not to send and receive LLDP packets with the
no lldp transmit and no lldp receive commands.
Note If the interface is configured as a tunnel port, LLDP is automatically disabled.
To disable LLDP on an interface, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Specifies the interface on which you are disabling LLDP, and enter
interface configuration mode.
Step 3 Switch(config)# no lldp transmit Disallows sending LLDP packets on the interface.
Step 4 Switch(config)# no lldp receive Disallows receiving LLDP packets on the interface.
Step 5 Switch(config)# end Returns to privileged EXEC mode.
Step 6 Switch(config)# copy running-config Saves your entries in the configuration file.
startup-config
To enable LLDP on an interface once it has been disabled, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Specifies the interface on which you are enabling LLDP, and enter
interface configuration mode.
Step 3 Switch(config)# lldp transmit Sends LLDP packets on the interface.
Step 4 Switch(config)# lldp receive Receives LLDP packets on the interface.
Step 5 Switch(config)# end Returns to privileged EXEC mode.
Step 6 Switch# copy running-config Saves your entries in the configuration file.
startup-config
This example shows how to enable LLDP on an interface.
Switch# configure terminal
Switch(config)# interface GigabitEthernet 1/1
Switch(config-if)# lldp transmit
Switch(config-if)# lldp receive
Switch(config-if)# end
Software Configuration Guide—Release 15.0(1)XO
23-6 OL-22250-01
Chapter 23 Configuring LLDP, and LLDP-MED
Configuring LLDP and LLDP-MED
Configuring LLDP-MED TLVs
By default, the switch only sends LLDP packets until it receives LLDP-MED packets from the end
device. The switch continues to send LLDP-MED packets until it only receives LLDP packets.
By using the lldp interface configuration command, you can configure the interface not to send the TLVs
listed in Table 23-2.
Table 23-2 LLDP-MED TLVs
LLDP-MED TLV Description
inventory-management LLDP-MED inventory management TLV
location LLDP-MED location TLV
network-policy LLDP-MED network policy TLV
power-management LLDP-MED power management TLV
To disable a TLV on an interface, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Specifies the interface on which you are configuring a LLDP-MED
TLV, and enter interface configuration mode.
Step 3 Switch(config-if)# no lldp Specifies the TLV to disable.
med-tlv-select tlv
Step 4 Switch(config-if)# end Returns to privileged EXEC mode.
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To enable a TLV on an interface, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Specifies the interface on which you are configuring an LLDP-MED
TLV, and enter interface configuration mode.
Step 3 Switch(config-if)# lldp med-tlv-select Specifies the TLV to enable.
tlv
Step 4 Switch(config-if)# end Returns to privileged EXEC mode.
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to enable a TLV on an interface when it has been disabled.
Switch# configure terminal
Switch(config)# interface GigabitEthernet0/1
Switch(config-if)# lldp med-tlv-select inventory management
Switch(config-if)# end
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 23-7
Chapter 23 Configuring LLDP, and LLDP-MED
Configuring LLDP and LLDP-MED
Configuring LLDP Power Negotiation
Starting with Cisco IOS Release 12.2(54)SG, Catalyst 4500 series switches can perform inline power
negotiation using LLDP as specified in the IEEE 802.3at standard. (The LLDP TLV used is
DTE Power-via-MDI TLV.) With this feature, inline powered devices based on the IEEE standard can be
powered in the PoE+ power range (12.95W to 25.5W at the device end) by the switch on PoE+ supported
modules.
Note To verify inline power utilization negotiated by using LLDP using the LLDP-MED TLV, use the
show lldp neighbors detail command. To verify inline power utilization negotiated by using the IEEE
802.3at TLV, use the show power inline interface detail command. The show power inline interface
detail command does not display power negotiated with LLDP.
Note When an inline powered device that performs power negotiation using multiple protocols (CDP/LLDP
802.3at/LLDP-MED) is connected to a switch, the switch "locks" to the first protocol packet (CDP or
LLDP) that contains the power negotiation TLV. The LLDP 802.3at power negotiation TLV overrides
the LLDP-MED power negotiation TLV if both are received by the switch. If the administrator needs to
use any single protocol for power negotiation each time, he needs to administratively disable the other
power negotiation protocols on the switch interface or the end device.
To enable LLDP power negotiation, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Specifies the interface on which you are configuring LLDP power
negotiation.
Step 3 Switch(config-if)# lldp tlv-select Enables LLDP power negotiation.
power-management
Step 4 Switch(config-if)# end Returns to privileged EXEC mode.
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to enable LLDP power negotiation on interface Gigabit Ethernet 3/1:
Switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# int gi 3/1
Switch(config-if)# lldp tlv-select power-management
Software Configuration Guide—Release 15.0(1)XO
23-8 OL-22250-01
Chapter 23 Configuring LLDP, and LLDP-MED
Configuring LLDP and LLDP-MED
Configuring LLDP and Location TLV
To configure location information for an end-point and to apply it to an interface, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# location {admin-tag Specifies the location information for an endpoint.
string | civic-location identifier id |
elin-location string identifier id} • admin-tag—Specify an administrative tag or site information.
• civic-location—Specify civic location information.
Note The civic location identifier in the LLDP-MED TLV is
limited to 250 bytes or less. To avoid receiving error
messages regarding available buffer space during switch
configuration, never allow the total length of all civic location
information specified for each civic-location identifier to
exceed 250 bytes.
• elin-location—Specify emergency location information (ELIN).
• identifier id—Specify the ID for the civic location.
• string—specify the site or location information in alphanumeric
format.
Step 3 Switch(config-civic)# exit Returns to global configuration mode.
Step 4 Switch(config)# interface interface-id Specifies the interface on which you are configuring the location
information, and enter interface configuration mode.
Step 5 Switch(config-if)# location Enters location information for an interface:
{additional-location-information word |
civic-location-id id | elin-location-id additional-location-information—Specifies additional information
id} for a location or place.
civic-location-id—Specifies global civic location information for an
interface.
elin-location-id—Specifies emergency location information for an
interface.
id—Specifies the ID for the civic location or the ELIN location. The
ID range is 1 to 4095.
word—Specifies a word or phrase that provides additional location
information.
Step 6 Switch(config-if)# end Returns to privileged EXEC mode.
Step 7 Switch# show location Verifies the configuration.
Step 8 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Use the no form of each command to return to the default setting.
This example shows how to configure civic location information on the switch:
Switch# configure terminal
Switch(config)# location civic-location identifier 1
Switch(config-civic)# number 3550
Switch(config-civic)# primary-road-name "Cisco Way"
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 23-9
Chapter 23 Configuring LLDP, and LLDP-MED
Cisco IOS Carries Ethernet Features in Cisco IOS XE 3.1.0 SG
Switch(config-civic)# city "San Jose"
Switch(config-civic)# state CA
Switch(config-civic)# building 19
Switch(config-civic)# room C6
Switch(config-civic)# county "Santa Clara"
Switch(config-civic)# country US
Switch(config-civic)# end
Monitoring and Maintaining LLDP and LLDP-MED
To monitor and maintain LLDP and LLDP-MED on your device, perform one or more of the following
commands in privileged EXEC mode:
Command Description
clear lldp counters Resets the traffic and error counters to zero.
clear lldp table Deletes the LLDP table of information about neighbors.
show lldp Displays global information, such as frequency of transmissions, the holdtime for
packets being sent, and the delay time for LLDP to initialize on an interface.
show lldp entry entry-name Displays information about a specific neighbor.
You can enter an asterisk (*) to display all neighbors, or you can enter the name
of the neighbor about which you want information.
show lldp errors Displays LLDP computational errors and overflows.
show lldp interface [interface-id] Displays information about interfaces where LLDP is enabled.
You can limit the display to the interface about which you want information.
show lldp neighbors [interface-id] Displays information about neighbors, including device type, interface type and
[detail] number, holdtime settings, capabilities, and port ID.
You can limit the display to neighbors of a specific interface or expand the display
to provide more detailed information.
show lldp traffic Displays LLDP counters, including the number of packets sent and received,
number of packets discarded, and number of unrecognized TLVs.
show location Displays the location information for an endpoint.
show power inline interface [detail] Displays detailed information on the PoE status for the interface
show power inline module mod Displays detailed information on the PoE consumption for the specified module.
[detail]
Cisco IOS Carries Ethernet Features in Cisco IOS XE 3.1.0 SG
This section provides a list of High Availability software features that are supported in Cisco IOS XE
3.1.0SG. Links to the feature documentation are included.
Feature guides may contain information about more than one feature. To find information about a
specific feature within a feature guide, see the Feature Information table at the end of the guide.
Software Configuration Guide—Release 15.0(1)XO
23-10 OL-22250-01
Chapter 23 Configuring LLDP, and LLDP-MED
Cisco IOS Carries Ethernet Features in Cisco IOS XE 3.1.0 SG
Feature guides document features that are supported on many different software releases and platforms.
Your Cisco software release or platform may not support all the features documented in a feature guide.
See the Feature Information table at the end of the feature guide for information about which features in
that guide are supported in your software release. Use Cisco Feature Navigator to find information about
platform support and Cisco software image support. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
ANSI TIA-1057 LLDP-MED Support and IEEE 802.1ab LLDP (Link Layer Discovery Protocol)
http://www.cisco.com/en/US/docs/ios/cether/configuration/guide/ce_lldp-med.html
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 23-11
Chapter 23 Configuring LLDP, and LLDP-MED
Cisco IOS Carries Ethernet Features in Cisco IOS XE 3.1.0 SG
Software Configuration Guide—Release 15.0(1)XO
23-12 OL-22250-01
CH A P T E R 24
Configuring UDLD
This chapter describes how to configure the UniDirectional Link Detection (UDLD) and Unidirectional
Ethernet on the Catalyst 4500 series witch. It also provides guidelines, procedures, and configuration
examples.
This chapter includes the following major sections:
• About UDLD, page 24-1
• Default UDLD Configuration, page 24-2
• Configuring UDLD on the Switch, page 24-3
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About UDLD
UDLD is a layer 2 protocol that enables devices connected through fiber-optic or twisted-pair Ethernet
cables. It monitors a physical connection (such as wrong cabling) to detect unidirectional links to avoid
spanning-tree topology loops or silent drop traffic.
All connected devices must support UDLD for the protocol to successfully identify the unidirectional
links. When UDLD detects a unidirectional link, it can administratively shut down the affected port and
send you a warning message.
Modes of Operation
UDLD supports two operation modes: normal and aggressive.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 24-1
Chapter 24 Configuring UDLD
Default UDLD Configuration
normal A UDLD-capable port A periodically sends a UDLD probe to port B. If port B is not UDLD
capable, no unidirectional link detection occurs. If both devices are UDLD capable and
bi-directional connectivity exists, probe messages travel in both direction at a rate of 1 every few
seconds (through the UDLD message time interval global configuration command). Upon
receiving the probe, the UDLD protocol attempts to synchronize the devices by sending echo
messages to the peer port and waiting for answer during the detection window. If the unidirectional
traffic is detected when the port link is still up (port B no longer sends traffic to port A), port B enters
errdisable mode. Port A is marked Undetermined but does not enter errdisable mode. It continues to
operate under its current STP status because this mode is informational only; it is potentially less
disruptive although it does not prevent STP loops.
aggressive If port A loses its neighbor connectivity, it actively tries to re-establish the relationship
by sending a probe to port B. If port B does not respond, it is considered unidirectional and port A
enters errdisable state to avoid silent drop traffic.
UDLD aggressive mode can interoperate with UDLD normal mode. When the unidirectional
condition is detected, only the aggressive mode link shuts down.
By default,
• UDLD is locally disabled on copper LAN ports to avoid sending unnecessary control traffic (BPDU
control packets) on this type of media; this protocol is most often used for access ports.
• UDLD is enabled on a fiber port if global UDLD is activated.
Figure 24-1 illustrates a unidirectional link condition. Each switch can send packets to a neighbor switch
but cannot receive packets from the switch it is sending packets to. UDLD detects and disables these one-way
connections.
Figure 24-1 Unidirectional Link
Switch X Tx Rx
Switch Y
Rx Tx
Switch Z
Tx Rx
144608
Default UDLD Configuration
Table 24-1 shows the UDLD default configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
24-2 OL-22250-01
Chapter 24 Configuring UDLD
Configuring UDLD on the Switch
Table 24-1 UDLD Default Configuration
Feature Default Status
UDLD global enable state Globally disabled
UDLD per-interface enable state for fiber-optic media Enabled on all Ethernet fiber-optic interfaces
UDLD per-interface enable state for twisted-pair (copper) media Disabled on all Ethernet 10/100 and 1000BaseTX
interfaces
Configuring UDLD on the Switch
The following sections describe how to configure UDLD:
• Enabling UDLD Globally, page 24-4
• Enabling UDLD on Individual Interfaces, page 24-4
• Disabling UDLD on Non-Fiber-Optic Interfaces, page 24-5
• Configuring the UDLD Probe Message Interval, page 24-5
• Resetting Disabled LAN Interfaces, page 24-5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 24-3
Chapter 24 Configuring UDLD
Configuring UDLD on the Switch
Enabling UDLD Globally
To enable UDLD in the aggressive or normal mode and to set the configurable message timer on all
fiber-optic interfaces on the switch, follow these steps:
Command Purpose
Step 1 Switch# configure terminal Enters the global configuration mode.
Step 2 Switch(config)# udld {aggressive | enable | Specifies the UDLD mode of operation:
message time message-timer-interval}
• aggressive Enables UDLD in aggressive mode on all
fiber-optic interfaces.
• enable Enables UDLD in normal mode on all
fiber-optic interfaces on the switch. UDLD is
disabled by default.
An individual interface configuration overrides the
setting of the udld enable global configuration
command.
For more information about aggressive and normal
modes, see the Modes of Operation, page 24-1
section.
• message time message-timer-interval-Configures
the period of time between UDLD probe messages
on ports that are in the advertisement phase and are
determined to be bidirectional. The range is from 1
to 90 seconds.
Note Prior to Cisco IOS Release 12.2(31)SGA, the
timer range is 7 to 90 seconds. With
Cisco IOS Release 12.2(31)SGA, the timer range
is 1 to 90 seconds
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show udld Verifies the configuration.
Enabling UDLD on Individual Interfaces
To enable UDLD on individual interfaces, perform this task:
Command Purpose
Step 1 Switch(config-if)# udld enable Enables UDLD on a specific interface. On a fiber-optic
interface, this command overrides the udld enable global
configuration command setting.
Step 2 Switch# show udld interface Verifies the configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
24-4 OL-22250-01
Chapter 24 Configuring UDLD
Configuring UDLD on the Switch
Disabling UDLD on Non-Fiber-Optic Interfaces
To disable UDLD on individual non-fiber-optic interfaces, perform this task:
Command Purpose
Step 1 Switch(config-if)# no udld enable Disables UDLD on a non-fiber-optic interface.
Note On fiber-optic interfaces, the no udld enable
command reverts the interface configuration to
the udld enable global configuration command
setting.
Step 2 Switch# show udld interface Verifies the configuration.
Configuring the UDLD Probe Message Interval
To configure the time between UDLD probe messages on ports that are in advertisement mode and are
currently determined to be bidirectional, perform this task:
Command Purpose
Step 1 Switch(config)# udld message time interval Configures the time between UDLD probe messages on
ports that are in advertisement mode and are currently
determined to be bidirectional; valid values are from 1 to
90 seconds.
Note Prior to Cisco IOS Release 12.2(31)SGA, the
time interval is 7-90 seconds. With
Cisco IOS Release 12.2(31)SGA, the time
interval is 1-90 second.
The no udld message command returns to the default
value (60 seconds).
Step 2 Switch# show udld type-slot/interface Verifies the configuration.
Resetting Disabled LAN Interfaces
To reset all LAN ports that have been shut down by UDLD, perform this task:
Command Purpose
Switch(config)# udld reset Resets all LAN ports that have been shut down by UDLD.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 24-5
Chapter 24 Configuring UDLD
Configuring UDLD on the Switch
Software Configuration Guide—Release IOS-XE 3.1.0 SG
24-6 OL-22250-01
CH A P T E R 25
Configuring Unidirectional Ethernet
Note This feature is not supported on Supervisor Engine 7-E uplinks.
This chapter describes how to configure Unidirectional Ethernet on the Catalyst 4000 family switch and
contains these sections:
• About Unidirectional Ethernet, page 25-1
• Configuring Unidirectional Ethernet, page 25-2
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Unidirectional Ethernet
You can set stubless Gigabit Ethernet ports to unidirectionally transmit or receive traffic. Unidirectional
Ethernet uses only one strand of fiber for either transmitting or receiving one-way traffic for the
GigaPort, instead of two strands of fiber for a full-duplex GigaPort Ethernet. Configuring your
GigaPorts either to transmit or receive traffic effectively doubles the amount of traffic capabilities for
applications, such as video streaming, where most traffic is sent as unacknowledged unidirectional video
broadcast streams.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 25-1
Chapter 25 Configuring Unidirectional Ethernet
Configuring Unidirectional Ethernet
Configuring Unidirectional Ethernet
Note You must configure Unidirectional Ethernet on the non-blocking GigaPort, which automatically disables
UDLD on the port.
To enable Unidirectional Ethernet, perform this task:
Command Purpose
Step 1 Switch(config)# interface {vlan vlan_ID | Selects the interface to configure.
{fastethernet | gigabitethernet |
tengigabitethernet} slot/interface | Port-channel
number}
Step 2 Switch(config-if)# [no] unidirectional {send-only Enables Unidirectional Ethernet.
| receive-only}
Use the no keyword to disable Unidirectional Ethernet.
Step 3 Switch(config-if)# end Exits configuration mode.
Step 4 Switch# show interface {vlan vlan_ID | Verifies the configuration.
{fastethernet | gigabitethernet |
tengigabitethernet} slot/interface}
unidirectional
This example shows how to set Gigabit Ethernet interface 1/1 to unidirectionally send traffic:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface gigabitethernet 1/1
Switch(config-if)# unidirectional send-only
Switch(config-if)# end
Warning!
Enable l2 port unidirectional mode will automatically disable port udld.
You must manually ensure that the unidirectional link does not create
a spanning tree loop in the network.
Enable l3 port unidirectional mode will automatically disable ip routing
on the port. You must manually configure static ip route and arp entry
in order to route ip traffic.
This example shows how to set Gigabit Ethernet interface 1/1 to receive traffic unidirectionally:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface gigabitethernet 1/1
Switch(config-if)# unidirectional receive-only
Switch(config-if)# end
Warning!
Enable l2 port unidirectional mode will automatically disable port udld.
You must manually ensure that the unidirectional link does not create
a spanning tree loop in the network.
Enable l3 port unidirectional mode will automatically disable ip routing
on the port. You must manually configure static ip route and arp entry
in order to route ip traffic.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
25-2 OL-22250-01
Chapter 25 Configuring Unidirectional Ethernet
Configuring Unidirectional Ethernet
This example shows how to verify the configuration
Switch> show interface gigabitethernet 1/1 unidirectional
show interface gigabitethernet 1/1 unidirectional
Unidirectional configuration mode: send only
CDP neighbor unidirectional configuration mode: receive only
This example shows how to disable Unidirectional Ethernet on Gigabit Ethernet interface 1/1:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface gigabitethernet 1/1
Switch(config-if)# no unidirectional
Switch(config-if)# end
This example shows the result of issuing the show interface command for a port that does not support
Unidirectional Ethernet:
Switch#show interface f6/1 unidirectional
Unidirectional Ethernet is not supported on FastEthernet6/1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 25-3
Chapter 25 Configuring Unidirectional Ethernet
Configuring Unidirectional Ethernet
Software Configuration Guide—Release IOS-XE 3.1.0 SG
25-4 OL-22250-01
CH A P T E R 26
Configuring Layer 3 Interfaces
This chapter describes the Layer 3 interfaces on a Catalyst 4500 series switch. It also provides
guidelines, procedures, and configuration examples.
This chapter includes the following major sections:
• Overview of Layer 3 Interfaces, page 26-1
• Configuration Guidelines, page 26-4
• Configuring Logical Layer 3 VLAN Interfaces, page 26-5
• Configuring VLANs as Layer 3 Interfaces, page 26-6
• Configuring Physical Layer 3 Interfaces, page 26-10
• Configuring EIGRP Stub Routing, page 26-11
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Overview of Layer 3 Interfaces
This section contains the following subsections:
• Logical Layer 3 VLAN Interfaces, page 26-2
• Physical Layer 3 Interfaces, page 26-2
• Understanding SVI Autostate Exclude, page 26-3
• Understanding Layer 3 Interface Counters, page 26-3
The Catalyst 4500 family switch supports Layer 3 interfaces with the Cisco IOS IP and IP routing
protocols. Layer 3, the network layer, is primarily responsible for the routing of data in packets across
logical internetwork paths.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 26-1
Chapter 26 Configuring Layer 3 Interfaces
Overview of Layer 3 Interfaces
Layer 2, the data link layer, contains the protocols that control the physical layer (Layer 1) and how data
is framed before being transmitted on the medium. The Layer 2 function of filtering and forwarding data
in frames between two segments on a LAN is known as bridging.
The Catalyst 4500 series switch supports two types of Layer 3 interfaces. The logical Layer 3 VLAN
interfaces integrate the functions of routing and bridging. The physical Layer 3 interfaces allow the
Catalyst 4500 series switch to be configured like a traditional router.
Logical Layer 3 VLAN Interfaces
The logical Layer 3 VLAN interfaces provide logical routing interfaces to VLANs on Layer 2 switches.
A traditional network requires a physical interface from a router to a switch to perform inter-VLAN
routing. The Catalyst 4500 series switch supports inter-VLAN routing by integrating the routing and
bridging functions on a single Catalyst 4500 series switch.
Figure 26-1 shows how the routing and bridging functions in the three physical devices of the traditional
network are performed logically on one Catalyst 4500 series switch.
Figure 26-1 Logical Layer 3 VLAN Interfaces for the Catalyst 4500 Series Switch
Router Routing
Interface Ethernet Interface Ethernet Interface VLAN1 Interface VLAN2
1.1.1.1 2.1.1.1 1.1.1.1 2.1.1.1
L2 Switch L2 Switch VLAN1 VLAN2
VLAN1 VLAN2
Host 1 Host 2 Host 1 Host 2
Traditional network topology for routing Logical Inter-VLAN routing on a single
94169
between VLANS Catalyst 4500 series switch
Physical Layer 3 Interfaces
The physical Layer 3 interfaces support capabilities equivalent to a traditional router. These Layer 3
interfaces provide hosts with physical routing interfaces to a Catalyst 4500 series switch.
Figure 26-2 shows how the Catalyst 4500 series switch functions as a traditional router.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
26-2 OL-22250-01
Chapter 26 Configuring Layer 3 Interfaces
Overview of Layer 3 Interfaces
Figure 26-2 Physical Layer 3 Interfaces for the Catalyst 4500 Series Switch
Router
Interface Ethernet Interface Ethernet
1.1.1.1 2.1.1.1
2/1 2/2
Host 1 Host 2
94168
Physical Inter-VLAN Routing on a Catalyst 4500 series switch
Understanding SVI Autostate Exclude
To be “up/up,” a router VLAN interface must fulfill the following general conditions:
• The VLAN exists and is “active” on the VLAN database of the switch.
• The VLAN interface exists on the router and is not administratively down.
• At least one Layer 2 (access port or trunk) port exists, has a link “up” on this VLAN and is in
spanning-tree forwarding state on the VLAN.
Note The protocol line state for the VLAN interfaces comes up when the first switchport belonging to the
corresponding VLAN link comes up and is in spanning-tree forwarding state.
Ordinarily, when a VLAN interface has multiple ports in the VLAN, the SVI goes down when all the
ports in the VLAN goes down. The SVI Autostate exclude feature provides a knob to mark a port so that
it is not counted in the SVI “up and down” calculation and applies to all VLANs that are enabled on that
port.
A VLAN interface is brought up after the Layer 2 port has had time to converge (that is, transition from
listening-learning to forwarding). This prevents routing protocols and other features from using the
VLAN interface as if it were fully operational. This also prevents other problems from occurring, such
as routing black holes.
Understanding Layer 3 Interface Counters
Note Supervisor Engine 7-E does not support Layer 2 Interface Counters. However, it does support Layer 3
(SVI) Interface Counters.
With Supervisor Engine 6-E, IPv4 and v6 packets are routed in hardware by the forwarding engine. This
engine supports statistics for counting routed packets for up to 4095 interfaces. These statistics include:
• Input unicast
• Input multicast
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 26-3
Chapter 26 Configuring Layer 3 Interfaces
Configuration Guidelines
• Output unicast
• Output multicast
For each type of counter, both the number of packets and the total number of bytes received or
transmitted are counted.
Because the total number of counters supported is lower than the total number of Layer 3 interfaces
supported, it is not always possible for all Layer 3 interfaces to have counters. For this reason, the user
assigns counters to Layer 3 interfaces, and the default configuration for a Layer 3 interface has no
counters.
Note To enable Layer 3 Interface Counters, you need to issue the counter command in interface mode. Refer
to the “Configuring Layer 3 Interface Counters” section on page 26-9 for instructions on how to
configure Layer 3 Interface Counters.
These hardware counters are displayed in the output of the show interface command. For example:
Switch# show interface vlan 1
Vlan1 is up, line protocol is up
Hardware is Ethernet SVI, address is 0005.9a38.6cff (bia 0005.9a38.6cff)
Internet address is 10.0.0.1/8
MTU 1500 bytes, BW 1000000 Kbit, DLY 10 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Keepalive not supported
ARP type: ARPA, ARP Timeout 04:00:00
Last input never, output never, output hang never
Last clearing of "show interface" counters never
Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 0 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
L3 in Switched: ucast: 0 pkt, 0 bytes - mcast: 0 pkt, 0 bytes <====
L3 out Switched: ucast: 0 pkt, 0 bytes - mcast: 0 pkt, 0 bytes <====
0 packets input, 0 bytes, 0 no buffer
Received 0 broadcasts (0 IP multicasts)
0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
1 packets output, 46 bytes, 0 underruns
0 output errors, 0 interface resets
0 output buffer failures, 0 output buffers swapped out
Configuration Guidelines
The Catalyst 4500 series switch supports AppleTalk routing and IPX routing. For AppleTalk routing and
IPX routing information, refer to “Configuring AppleTalk” and “Configuring Novell IPX” in the
Cisco IOS AppleTalk and Novell IPX configuration guides at the following URLs:
http://www.cisco.com/en/US/docs/ios/at/configuration/guide/12_4/atk_12_4_book.html
http://www.cisco.com/en/US/docs/ios/novipx/configuration/guide/config_novellipx_ps6350_TSD_Pro
ducts_Configuration_Guide_Chapter.html
Note Supervisor Engine 7-E does not support AppleTalk and IPX routing.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
26-4 OL-22250-01
Chapter 26 Configuring Layer 3 Interfaces
Configuring Logical Layer 3 VLAN Interfaces
A Catalyst 4500 series switch does not support subinterfaces or the encapsulation keyword on
Layer 3 Fast Ethernet, Gigabit Ethernet, TenGigabitEthernet interfaces.
Note As with any Layer 3 interface running Cisco IOS software, the IP address and network assigned to an
SVI cannot overlap those assigned to any other Layer 3 interface on the switch.
Configuring Logical Layer 3 VLAN Interfaces
Note Before you can configure logical Layer 3 VLAN interfaces, you must create and configure the VLANs
on the switch, assign VLAN membership to the Layer 2 interfaces, enable IP routing if IP routing is
disabled, and specify an IP routing protocol.
To configure logical Layer 3 VLAN interfaces, perform this task:
Command Purpose
Step 1 Switch(config)# vlan vlan_ID Creates the VLAN.
Step 2 Switch(config)# interface vlan vlan_ID Selects an interface to configure.
Step 3 Switch(config-if)# ip address ip_address subnet_mask Configures the IP address and IP subnet.
Step 4 Switch(config-if)# no shutdown Enables the interface.
Step 5 Switch(config-if)# end Exits configuration mode.
Step 6 Switch# copy running-config startup-config Saves your configuration changes to NVRAM.
Step 7 Switch# show interfaces [type slot/interface] Verifies the configuration.
Switch# show ip interfaces [type slot/interface]
Switch# show running-config interfaces [type
slot/interface]
Switch# show running-config interfaces vlan vlan_ID
This example shows how to configure the logical Layer 3 VLAN interface vlan 2 and assign an IP
address:
Switch> enable
Switch# config term
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# vlan 2
Switch(config)# interface vlan 2
Switch(config-if)# ip address 10.1.1.1 255.255.255.248
Switch(config-if)# no shutdown
Switch(config-if)# end
This example uses the show interfaces command to display the interface IP address configuration and
status of Layer 3 VLAN interface vlan 2:
Switch# show interfaces vlan 2
Vlan2 is up, line protocol is down
Hardware is Ethernet SVI, address is 00D.588F.B604 (bia 00D.588F.B604)
Internet address is 172.20.52.106/29
MTU 1500 bytes, BW 1000000 Kbit, DLY 10 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation ARPA, loopback not set
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 26-5
Chapter 26 Configuring Layer 3 Interfaces
Configuring VLANs as Layer 3 Interfaces
ARP type: ARPA, ARP Timeout 04:00:00
Last input never, output never, output hang never
Last clearing of "show interface" counters never
Input queue: 0/75/0/0 (size/max/drops/flushes); Total output drops: 0
Queueing strategy: fifo
Output queue: 0/40 (size/max)
5 minute input rate 0 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
0 packets input, 0 bytes, 0 no buffer
Received 0 broadcasts, 0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored
0 packets output, 0 bytes, 0 underruns
0 output errors, 0 interface resets
0 output buffer failures, 0 output buffers swapped out
Switch#
This example uses the show running-config command to display the interface IP address configuration
of Layer 3 VLAN interface vlan 2:
Switch# show running-config
Building configuration...
Current configuration : !
interface Vlan2
ip address 10.1.1.1 255.255.255.248
!
ip classless
no ip http server
!
!
line con 0
line aux 0
line vty 0 4
!
end
Configuring VLANs as Layer 3 Interfaces
This section consists of the following subsections:
• Configuring SVI Autostate Exclude, page 26-6
• Configuring IP MTU Sizes, page 26-8
• Configuring Layer 3 Interface Counters, page 26-9
Configuring SVI Autostate Exclude
Note The SVI Autostate exclude feature is enabled by default and is synchronized with the STP state.
The SVI Autostate exclude feature shuts down (or brings up) the Layer 3 interfaces of a switch when the
following port configuration changes occur:
• When the last port on a VLAN goes down, the Layer 3 interface on that VLAN is shut down
(SVI- autostated).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
26-6 OL-22250-01
Chapter 26 Configuring Layer 3 Interfaces
Configuring VLANs as Layer 3 Interfaces
• When the first port on the VLAN is brought back up, the Layer 3 interface on the VLAN that was
previously shut down is brought up.
SVI Autostate exclude enables you to exclude the access ports/trunks in defining the status of the SVI
(up or down) even if it belongs to the same VLAN. Moreover, even if the excluded access port/trunk is
in up state and other ports are in down state in the VLAN, the SVI state is changed to down.
At least one port in the VLAN should be up and not excluded to make the SVI state up. This helps to
exclude the monitoring port status when you are determining the status of the SVI.
To apply SVI Autostate exclude, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Enters interface configuration mode.
Step 3 Switch(config-if)# switchport autostate exclude Exclude the access ports/trunks in defining the status of
an SVI (up or down).
Step 4 Switch(config)# end Exits configuration mode.
Step 5 Switch# show run int g3/4 Displays the running configuration.
Step 6 Switch# show int g3/4 switchport Verifies the configuration.
The following example shows how to apply SVI Autostate Exclude on interface g3/1:
Switch# conf terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface g3/1
Switch(config-if)# switchport autostate exclude
Switch(config-if)# end
Switch# show run int g3/4
Building configuration...
Current configuration : 162 bytes
!
interface GigabitEthernet3/4
switchport trunk encapsulation dot1q
switchport trunk allowed vlan 2,3
switchport autostate exclude <=====
switchport mode trunk
end
Switch# show int g3/4 switchport
Name: Gi3/4
Switchport: Enabled
Administrative Mode: trunk
Operational Mode: trunk
Administrative Trunking Encapsulation: dot1q Operational Trunking Encapsulation: dot1q
Negotiation of Trunking: On Access Mode VLAN: 1 (default) Trunking Native Mode VLAN: 1
(default) Administrative Native VLAN tagging: enabled Voice VLAN: none Administrative
private-vlan host-association: none Administrative private-vlan mapping: none
Administrative private-vlan trunk native VLAN: none Administrative private-vlan trunk
Native VLAN tagging: enabled Administrative private-vlan trunk encapsulation: dot1q
Administrative private-vlan trunk normal VLANs: none Administrative private-vlan trunk
associations: none Administrative private-vlan trunk mappings: none Operational
private-vlan: none Trunking VLANs Enabled: 2,3 Pruning VLANs Enabled: 2-1001 Capture Mode
Disabled Capture VLANs Allowed: ALL
Autostate mode exclude <======
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 26-7
Chapter 26 Configuring Layer 3 Interfaces
Configuring VLANs as Layer 3 Interfaces
Unknown unicast blocked: disabled
Unknown multicast blocked: disabled
Appliance trust: none
Switch#
Configuring IP MTU Sizes
You can set the protocol-specific maximum transmission unit (MTU) size of IPv4 or IPv6 packets sent
on an interface.
For information on MTU limitations, refer to Maximum Transmission Units, page 7-17.
Note To set the nonprotocol-specific MTU value for an interface, use the mtu interface configuration
command. Changing the MTU value (with the mtu interface configuration command) can affect the IP
MTU value. If the current IP MTU value matches the MTU value, and you change the MTU value, the
IP MTU value is modified automatically to match the new MTU. However, the reverse is not true;
changing the IP MTU value has no effect on the value for the mtu command.
For information on how to configure MTU size, refer to Configuring MTU Sizes, page 7-19.
To set the protocol-specific maximum transmission unit (MTU) size of IPv4 or IPv6 packets sent on an
interface, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Enters interface configuration mode.
Step 3 Switch(config-if)# [no] ip mtu mtu_size Configures the IPv4 MTU size
or
Switch(config-if)# [no] ipv6 mtu mtu_size
Configures the IPv6 MTU size.
The no form of the command reverts to the default MTU
size (1500 bytes).
Step 4 Switch(config-if)# exit Exits configuration interface mode.
Step 5 Switch(config)# end Exits configuration mode.
Step 6 Switch# show run interface interface-id Displays the running configuration.
The following example shows how to configure IPv4 MTU on an interface:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface vlan 1
Switch(config-if)# ip mtu 68
Switch(config-if)# exit
Switch(config)# end
Switch# show ip interface vlan 1
Vlan1 is up, line protocol is up
Internet address is 10.10.10.1/24
Broadcast address is 255.255.255.255
Address determined by setup command
MTU is 68 bytes
Helper address is not set
Software Configuration Guide—Release IOS-XE 3.1.0 SG
26-8 OL-22250-01
Chapter 26 Configuring Layer 3 Interfaces
Configuring VLANs as Layer 3 Interfaces
.........................(continued)
The following example shows how to configure ipv6 mtu on an interface
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface vlan 1
Switch(config-if)# ipv6 mtu 1280
Switch(config)# end
Switch# show ipv6 nterface vlan 1
This example shows how to verify the configuration
Vlan1 is up, line protocol is up
IPv6 is enabled, link-local address is FE80::214:6AFF:FEBC:DEEA
Global unicast address(es):
1001::1, subnet is 1001::/64
Joined group address(es):
FF02::1
FF02::1:FF00:1
FF02::1:FFBC:DEEA
MTU is 1280 bytes
...................(continued)
Note When ipv6 is enabled on an interface via any CLI, it is possible to see the following message:
% Hardware MTU table exhausted In such a scenario, the ipv6 MTU value programmed in hardware
differs from the ipv6 interface MTU value. This happens if there is no room in the hardware MTU table
to store additional values. You must free up some space in the table by unconfiguring some unused MTU
values and subsequently disable/re-enable ipv6 on the interface or reapply the MTU configuration.
Configuring Layer 3 Interface Counters
Note When a linecard is removed, the Layer 3 counters previously enabled on ports of that line card are
unconfigured. This means that to re-enable Layer 3 counters upon re-insertion of the linecard, you need
to reconfigure the counter CLI for Layer 3 ports of that line card.
To configure Layer 3 Interface Counters (assign counters to a Layer 3 interface), perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Enters interface configuration mode.
Step 3 Switch(config-if)# counter Enables counters.
Step 4 Switch(config)# end Exits configuration mode.
Step 5 Switch# show run interface interface-id Displays the running configuration.
The following example shows how to enable counters on interface VLAN 1
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface vlan 1
Switch(config-if)# counter
Switch(config-if)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 26-9
Chapter 26 Configuring Layer 3 Interfaces
Configuring Physical Layer 3 Interfaces
00:17:15: %SYS-5-CONFIG_I: Configured from console by console
Switch# show run interface vlan 1
Building configuration...
Current configuration : 63 bytes
!
interface Vlan1
ip address 10.0.0.1 255.0.0.0
counter
end
Note To remove the counters, use the "no" form of the counter command.
If the maximum number of counters has already been assigned, the counter command fails and displays
an error message:
Switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fa3/2
Switch(config-if)# no switchport
Switch(config-if)# counter
Counter resource exhausted
Switch(config-if)# end
Switch#
00:24:18: %SYS-5-CONFIG_I: Configured from console by console
In this situation, you must release a counter from another interface for use by the new interface.
Configuring Physical Layer 3 Interfaces
Note Before you can configure physical Layer 3 interfaces, you must enable IP routing if IP routing is
disabled, and specify an IP routing protocol.
To configure physical Layer 3 interfaces, perform this task:
Command Purpose
Step 1 Switch(config)#ip routing Enables IP routing (Required only if disabled.)
Step 2 Switch(config)# interface {fastethernet | Selects an interface to configure.
gigabitethernet | tengigabitethernet} slot/port}
| {port-channel port_channel_number}
Step 3 Switch(config-if)#no switchport Converts this port from physical Layer 2 port to physical
Layer 3 port.
Step 4 Switch(config-if)# ip address ip_address Configures the IP address and IP subnet.
subnet_mask
Step 5 Switch(config-if)# no shutdown Enables the interface.
Step 6 Switch(config-if)# end Exits configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
26-10 OL-22250-01
Chapter 26 Configuring Layer 3 Interfaces
Configuring EIGRP Stub Routing
Command Purpose
Step 7 Switch# copy running-config startup-config Saves your configuration changes to NVRAM.
Step 8 Switch# show interfaces [type slot/interface] Verifies the configuration.
Switch# show ip interfaces [type slot/interface]
Switch# show running-config interfaces [type
slot/interface]
This example shows how to configure an IP address on Fast Ethernet interface 2/1:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# ip routing
Switch(config)# interface fastethernet 2/1
Switch(config-if)# no switchport
Switch(config-if)# ip address 10.1.1.1 255.255.255.248
Switch(config-if)# no shutdown
Switch(config-if)# end
Switch#
This example uses the show running-config command to display the interface IP address configuration
of Fast Ethernet interface 2/1:
Switch# show running-config
Building configuration...
!
interface FastEthernet2/1
no switchport
ip address 10.1.1.1 255.255.255.248
!
…
ip classless
no ip http server
!
!
line con 0
line aux 0
line vty 0 4
!
end
Configuring EIGRP Stub Routing
This section consists of the following subsections:
• Overview, page 26-11
• How to Configure EIGRP Stub Routing, page 26-12
• Monitoring and Maintaining EIGRP, page 26-17
• EIGRP Configuration Examples, page 26-18
Overview
The EIGRP stub routing feature, available in all images, reduces resource utilization by moving routed
traffic closer to the end user.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 26-11
Chapter 26 Configuring Layer 3 Interfaces
Configuring EIGRP Stub Routing
The IP base image contains only EIGRP stub routing. The IP services image contains complete EIGRP
routing.
In a network using EIGRP stub routing, the only route for IP traffic to follow to the user is through a
switch that is configured with EIGRP stub routing. The switch sends the routed traffic to interfaces that
are configured as user interfaces or are connected to other devices.
When using EIGRP stub routing, you need to configure the distribution and remote switches to use
EIGRP, and to configure only the switch as a stub. Only specified routes are propagated from the switch.
The switch responds to all queries for summaries, connected routes, and routing updates.
Any neighbor that receives a packet informing it of the stub status does not query the stub switch for any
routes, and a switch that has a stub peer does not query that peer. The stub switch depends on the
distribution switch to send the proper updates to all peers.
In Figure 26-3, switch B is configured as an EIGRP stub switch. Switches A and C are connected to the
rest of the WAN. Switch B advertises connected, static, redistribution, and summary routes from switch
A and C to Hosts A, B, and C. Switch B does not advertise any routes learned from switch A (and the
reverse).
Figure 26-3 EIGRP Stub Switch Configuration
Routed to WAN
Switch A Switch B Switch C
145776
Host A Host B Host C
For more information about EIGRP stub routing, see “Configuring EIGRP Stub Routing” part of the
Cisco IOS IP Configuration Guide, Volume 2 of 3: Routing Protocols, Release 12.2.
How to Configure EIGRP Stub Routing
The EIGRP Stub Routing feature improves network stability, reduces resource utilization, and simplifies
stub switch configuration.
Stub routing is commonly used in a hub-and-spoke network topology. In a hub-and-spoke network, one
or more end (stub) networks are connected to a remote switch (the spoke) that is connected to one or
more distribution switches (the hub). The remote switch is adjacent only to one or more distribution
switches. The only route for IP traffic to follow into the remote switch is through a distribution switch.
This type of configuration is commonly used in WAN topologies where the distribution switch is
directly connected to a WAN. The distribution switch can be connected to many more remote switches.
Often, the distribution switch is connected to 100 or more remote routers. In a hub-and-spoke topology,
Software Configuration Guide—Release IOS-XE 3.1.0 SG
26-12 OL-22250-01
Chapter 26 Configuring Layer 3 Interfaces
Configuring EIGRP Stub Routing
the remote router must forward all nonlocal traffic to a distribution router, so it becomes unnecessary
for the remote router to hold a complete routing table. Generally, the distribution router need not send
anything more than a default route to the remote router.
When using the EIGRP Stub Routing feature, you need to configure the distribution and remote routers
to use EIGRP, and to configure only the remote router as a stub. Only specified routes are propagated
from the remote (stub) router. The stub router responds to all queries for summaries, connected routes,
redistributed static routes, external routes, and internal routes with the message “inaccessible.” A router
that is configured as a stub sends a special peer information packet to all neighboring routers to report
its status as a stub router.
Any neighbor that receives a packet informing it of the stub status does not query the stub router for any
routes, and a router that has a stub peer does not query that peer. The stub router depends on the
distribution router to send the proper updates to all peers.
Figure 26-4 shows a simple hub-and-spoke configuration.
Figure 26-4 Simple Hub-and-Spoke Network
Internet
10.1.1.0/24
Corporate
network
Distribution Remote
router router
(hub) (spoke)
46094
The stub routing feature by itself does not prevent routes from being advertised to the remote router. In
the example in Figure 26-4, the remote router can access the corporate network and the Internet through
the distribution router only. Having a full route table on the remote router, in this example, would serve
no functional purpose because the path to the corporate network and the Internet would always be
through the distribution router. The larger route table would only reduce the amount of memory required
by the remote router. Bandwidth and memory can be conserved by summarizing and filtering routes in
the distribution router. The remote router need not receive routes that have been learned from other
networks because the remote router must send all nonlocal traffic, regardless of destination, to the
distribution router. If a true stub network is desired, the distribution router should be configured to send
only a default route to the remote router. The EIGRP Stub Routing feature does not automatically enable
summarization on the distribution router. In most cases, the network administrator must configure
summarization on the distribution routers.
Note When configuring the distribution router to send only a default route to the remote router, you must use
the ip classless command on the remote router. By default, the ip classless command is enabled in all
Cisco IOS images that support the EIGRP Stub Routing feature.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 26-13
Chapter 26 Configuring Layer 3 Interfaces
Configuring EIGRP Stub Routing
Without the stub feature, even after the routes that are sent from the distribution router to the remote
router have been filtered or summarized, a problem might occur. If a route is lost somewhere in the
corporate network, EIGRP could send a query to the distribution router, which in turn sends a query to
the remote router even if routes are being summarized. If there is a problem communicating over the
WAN link between the distribution router and the remote router, an EIGRP stuck in active (SIA)
condition could occur and cause instability elsewhere in the network. The EIGRP Stub Routing feature
allows a network administrator to prevent queries from being sent to the remote router.
Dual-Homed Remote Topology
In addition to a simple hub-and-spoke network where a remote router is connected to a single
distribution router, the remote router can be dual-homed to two or more distribution routers. This
configuration adds redundancy and introduces unique issues, and the stub feature helps to address some
of these issues.
A dual-homed remote router has two or more distribution (hub) routers. However, the principles of stub
routing are the same as they are with a hub-and-spoke topology. Figure 26-5 shows a common
dual-homed remote topology with one remote router, but 100 or more routers could be connected on the
same interfaces on distribution router 1 and distribution router 2. The remote router uses the best route
to reach its destination. If distribution router 1 experiences a failure, the remote router can still use
distribution router 2 to reach the corporate network.
Figure 26-5 Simple Dual-Homed Remote Topology
Distribution
router 1
10.1.1.0/24
(hub)
Corporate
network
Remote
router
(spoke)
Distribution
46096
router 2
(hub)
Figure 26-5 shows a simple dual-homed remote with one remote router and two distribution routers.
Both distribution routers maintain routes to the corporate network and stub network 10.1.1.0/24.
Dual-homed routing can introduce instability into an EIGRP network. In Figure 26-6, distribution router
1 is directly connected to network 10.3.1.0/24. If summarization or filtering is applied on distribution
router 1, the router advertises network 10.3.1.0/24 to all of its directly connected EIGRP neighbors
(distribution router 2 and the remote router).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
26-14 OL-22250-01
Chapter 26 Configuring Layer 3 Interfaces
Configuring EIGRP Stub Routing
Figure 26-6 Dual-Homed Remote Topology With Distribution Router 1 Connected to Two
Networks
10.3.1.0/24
Distribution
router 1
10.2.1.0/24
10.1.1.0/24
(hub)
Corporate
network
Remote
router
(spoke)
Distribution
46095
router 2
(hub)
Figure 26-6 shows a simple dual-homed remote router where distribution router 1 is connected to both
network 10.3.1.0/24 and network 10.2.1.0/24.
If the 10.2.1.0/24 link between distribution router 1 and distribution router 2 has failed, the lowest cost
path to network 10.3.1.0/24 from distribution router 2 is through the remote router (see Figure 26-7).
This route is not desirable because the traffic that was previously traveling across the corporate network
10.2.1.0/24 is now sent across a much lower bandwidth connection. The over utilization of the lower
bandwidth WAN connection can cause a number of problems that might affect the entire corporate
network. The use of the lower bandwidth route that passes through the remote router might cause WAN
EIGRP distribution routers to be dropped. Serial lines on distribution and remote routers could also be
dropped, and EIGRP SIA errors on the distribution and core routers could occur.
Figure 26-7 Dual-Homed Remote Topology with a Failed Route to a Distribution Router
10.3.1.0/24
X
Distribution
router 1
10.2.1.0/24
10.1.1.0/24
(hub)
Corporate
network
Remote
router
(spoke)
Distribution
46093
router 2
(hub)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 26-15
Chapter 26 Configuring Layer 3 Interfaces
Configuring EIGRP Stub Routing
It is not desirable for traffic from distribution router 2 to travel through any remote router in order to
reach network 10.3.1.0/24. If the links are sized to handle the load, it would be acceptable to use one of
the backup routes. However, most networks of this type have remote routers located at remote offices
with relatively slow links. This problem can be prevented if proper summarization is configured on the
distribution router and remote router.
It is typically undesirable for traffic from a distribution router to use a remote router as a transit path. A
typical connection from a distribution router to a remote router would have much less bandwidth than a
connection at the network core. Attempting to use a remote router with a limited bandwidth connection
as a transit path would generally produce excessive congestion to the remote router. The EIGRP Stub
Routing feature can prevent this problem by preventing the remote router from advertising core routes
back to distribution routers. Routes learned by the remote router from distribution router 1 is not
advertised to distribution router 2. Because the remote router does not advertise core routes to
distribution router 2, the distribution router does not use the remote router as a transit for traffic destined
for the network core.
The EIGRP Stub Routing feature can help to provide greater network stability. In the event of network
instability, this feature prevents EIGRP queries from being sent over limited bandwidth links to
nontransit routers. Instead, distribution routers to which the stub router is connected answer the query
on behalf of the stub router. This feature greatly reduces the chance of further network instability due to
congested or problematic WAN links. The EIGRP Stub Routing feature also simplifies the configuration
and maintenance of hub-and-spoke networks. When stub routing is enabled in dual-homed remote
configurations, it is no longer necessary to configure filtering on remote routers to prevent those remote
routers from appearing as transit paths to the hub routers.
Caution EIGRP Stub Routing should only be used on stub routers. A stub router is defined as a router connected
to the network core or distribution layer through which core transit traffic should not flow. A stub router
should not have any EIGRP neighbors other than distribution routers. Ignoring this restriction causes
undesirable behavior.
Note Multi-access interfaces, such as ATM, Ethernet, Frame Relay, ISDN PRI, and X.25, are supported by
the EIGRP Stub Routing feature only when all routers on that interface, except the hub, are configured
as stub routers.
EIGRP Stub Routing Configuration Task List
To configure EIGRP Stub Routing, perform the tasks described in the following sections. The tasks in
the first section are required; the task in the last section is optional.
• Configuring EIGRP Stub Routing (required)
• Verifying EIGRP Stub Routing (optional)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
26-16 OL-22250-01
Chapter 26 Configuring Layer 3 Interfaces
Configuring EIGRP Stub Routing
Configuring EIGRP Stub Routing
To configure a remote or spoke router for EIGRP stub routing, use the following commands beginning
in router configuration mode:
Command Purpose
Step 1 Switch(config)# router eigrp 1 Configures a remote or distribution router to run
an EIGRP process.
Step 2 Switch(config-router)# network network-number Specifies the network address of the EIGRP
distribution router.
Step 3 Switch(config-router)# eigrp stub [receive-only | Configures a remote router as an EIGRP stub
connected | static | summary] router.
Verifying EIGRP Stub Routing
To verify that a remote router has been configured as a stub router with EIGRP, use the show ip eigrp
neighbor detail command from the distribution router in privileged EXEC mode. The last line of the
output shows the stub status of the remote or spoke router. The following example shows output is from
the show ip eigrp neighbor detail command:
router# show ip eigrp neighbor detail
IP-EIGRP neighbors for process 1
H Address Interface Hold Uptime SRTT RTO Q Seq Type
(sec) (ms) Cnt Num
0 10.1.1.2 Se3/1 11 00:00:59 1 4500 0 7
Version 12.1/1.2, Retrans: 2, Retries: 0
Stub Peer Advertising ( CONNECTED SUMMARY ) Routes
Monitoring and Maintaining EIGRP
To delete neighbors from the neighbor table, use the following command:
Command Purpose
Switch# clear ip eigrp neighbors [ip-address | Deletes neighbors from the neighbor table.
interface]
To display various routing statistics, use the following commands:
Command Purpose
Switch# show ip eigrp interfaces [interface] [as-number] Displays information about interfaces configured for
EIGRP.
Switch# show ip eigrp neighbors [type|number|static] Displays the EIGRP discovered neighbors.
Switch# show ip eigrp topology [autonomous-system-number | Displays the EIGRP topology table for a given
[[ip-address] mask]] process.
Switch# show ip eigrp traffic [autonomous-system-number] Displays the number of packets sent and received for
all or a specified EIGRP process.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 26-17
Chapter 26 Configuring Layer 3 Interfaces
Configuring EIGRP Stub Routing
EIGRP Configuration Examples
This section contains the following examples:
• Route Summarization Example
• Route Authentication Example
• Stub Routing Example
Route Summarization Example
The following example configures route summarization on the interface and also configures the
autosummary feature. This configuration causes EIGRP to summarize network 10.0.0.0 out Ethernet
interface 0 only. In addition, this example disables autosummarization.
interface Ethernet 0
ip summary-address eigrp 1 10.0.0.0 255.0.0.0
!
router eigrp 1
network 172.16.0.0
no auto-summary
Note You should not use the ip summary-address eigrp summarization command to generate the default
route (0.0.0.0) from an interface. This causes the creation of an EIGRP summary default route to the
null 0 interface with an administrative distance of 5. The low administrative distance of this default route
can cause this route to displace default routes learned from other neighbors from the routing table. If the
default route learned from the neighbors is displaced by the summary default route, or if the summary
route is the only default route present, all traffic destined for the default route does not leave the router,
instead, this traffic is sent to the null 0 interface where it is dropped.
The recommended way to send only the default route out a given interface is to use a distribute-list
command. You can configure this command to filter all outbound route advertisements sent out the
interface with the exception of the default (0.0.0.0).
Route Authentication Example
The following example enables MD5 authentication on EIGRP packets in autonomous system 1.
Router A
interface ethernet 1
ip authentication mode eigrp 1 md5
ip authentication key-chain eigrp 1 holly
key chain holly
key 1
key-string 0987654321
accept-lifetime 04:00:00 Dec 4 1996 infinite
send-lifetime 04:00:00 Dec 4 1996 04:48:00 Dec 4 1996
exit
key 2
key-string 1234567890
accept-lifetime 04:00:00 Dec 4 1996 infinite
send-lifetime 04:45:00 Dec 4 1996 infinite
Software Configuration Guide—Release IOS-XE 3.1.0 SG
26-18 OL-22250-01
Chapter 26 Configuring Layer 3 Interfaces
Configuring EIGRP Stub Routing
Router B
interface ethernet 1
ip authentication mode eigrp 1 md5
ip authentication key-chain eigrp 1 mikel
key chain mikel
key 1
key-string 0987654321
accept-lifetime 04:00:00 Dec 4 1996 infinite
send-lifetime 04:00:00 Dec 4 1996 infinite
exit
key 2
key-string 1234567890
accept-lifetime 04:00:00 Dec 4 1996 infinite
send-lifetime 04:45:00 Dec 4 1996 infinite
Router A accepts and attempts to verify the MD5 digest of any EIGRP packet with a key equal to 1. It
also accepts a packet with a key equal to 2. All other MD5 packets are dropped. Router A send all EIGRP
packets with key 2.
Router B accepts key 1 or key 2, and sends key 1. In this scenario, MD5 authenticates.
Stub Routing Example
A router that is configured as a stub with the eigrp stub command shares connected and summary
routing information with all neighbor routers by default. Four optional keywords can be used with the
eigrp stub command to modify this behavior:
• receive-only
• connected
• static
• summary
This section provides configuration examples for all forms of the eigrp stub command. The eigrp stub
command can be modified with several options, and these options can be used in any combination except
for the receive-only keyword. The receive-only keyword restricts the router from sharing any of its
routes with any other router in that EIGRP autonomous system, and the receive-only keyword does not
permit any other option to be specified because it prevents any type of route from being sent. The three
other optional keywords (connected, static, and summary) can be used in any combination but cannot
be used with the receive-only keyword. If any of these three keywords is used individually with the
eigrp stub command, connected and summary routes are not sent automatically.
The connected keyword permits the EIGRP Stub Routing feature to send connected routes. If the
connected routes are not covered by a network statement, it may be necessary to redistribute connected
routes with the redistribute connected command under the EIGRP process. This option is enabled by
default.
The static keyword permits the EIGRP Stub Routing feature to send static routes. Without this option,
EIGRP does not send any static routes, including internal static routes that normally would be
automatically redistributed. It is still necessary to redistribute static routes with the redistribute static
command.
The summary keyword permits the EIGRP Stub Routing feature to send summary routes. Summary
routes can be created manually with the summary address command or automatically at a major
network border router with the auto-summary command enabled. This option is enabled by default.
In the following example, the eigrp stub command is used to configure the router as a stub that
advertises connected and summary routes:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 26-19
Chapter 26 Configuring Layer 3 Interfaces
Configuring EIGRP Stub Routing
router eigrp 1
network 10.0.0.0
eigrp stub
In the following example, the eigrp stub connected static command is used to configure the router as
a stub that advertises connected and static routes (sending summary routes is not permitted):
router eigrp 1
network 10.0.0.0
eigrp stub connected static
In the following example, the eigrp stub receive-only command is used to configure the router as a stub,
and connected, summary, or static routes is not sent:
router eigrp 1
network 10.0.0.0 eigrp
stub receive-only
Software Configuration Guide—Release IOS-XE 3.1.0 SG
26-20 OL-22250-01
CH A P T E R 27
Configuring Cisco Express Forwarding
This chapter describes Cisco Express Forwarding (CEF) on the Catalyst 4000 family switch. It also
provides guidelines, procedures, and examples to configure this feature.
This chapter includes the following major sections:
• About CEF, page 27-1
• Catalyst 4500 Series Switch Implementation of CEF, page 27-3
• CEF Configuration Restrictions, page 27-6
• Configuring CEF, page 27-6
• Monitoring and Maintaining CEF, page 27-8
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About CEF
This section contains information on the two primary components that comprise the CEF operation:
• Benefits of CEF, page 27-2
• Forwarding Information Base, page 27-2
• Adjacency Tables, page 27-2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 27-1
Chapter 27 Configuring Cisco Express Forwarding
About CEF
Benefits of CEF
CEF is advanced Layer 3 IP switching technology that optimizes performance and scalability for large
networks with dynamic traffic patterns or networks with intensive web-based applications and
interactive sessions.
CEF provides the following benefits:
• Improves performance over the caching schemes of multilayer switches, which often flush the entire
cache when information changes in the routing tables.
• Provides load balancing that distributes packets across multiple links based on Layer 3 routing
information. If a network device discovers multiple paths to a destination, the routing table is
updated with multiple entries for that destination. Traffic to that destination is then distributed
among the various paths.
CEF stores information in several data structures rather than the route cache of multilayer switches. The
data structures optimize lookup for efficient packet forwarding.
Forwarding Information Base
The Forwarding Information Base (FIB) is a table that contains a copy of the forwarding information in
the IP routing table. When routing or topology changes occur in the network, the route processor updates
the IP routing table and CEF updates the FIB. Because there is a one-to-one correlation between FIB
entries and routing table entries, the FIB contains all known routes and eliminates the need for route
cache maintenance that is associated with switching paths, such as fast switching and optimum
switching. CEF uses the FIB to make IP destination-based switching decisions and maintain next-hop
address information based on the information in the IP routing table.
On the Catalyst 4500 series switches, CEF loads the FIB in to the Integrated Switching Engine hardware
to increase the performance of forwarding. The Integrated Switching Engine has a finite number of
forwarding slots for storing routing information. If this limit is exceeded, CEF is automatically disabled
and all packets are forwarded in software. In this situation, you should reduce the number of routes on
the switch and then reenable hardware switching with the ip cef command.
Adjacency Tables
In addition to the FIB, CEF uses adjacency tables to prepend Layer 2 addressing information. Nodes in
the network are said to be adjacent if they are within a single hop from each other. The adjacency table
maintains Layer 2 next-hop addresses for all FIB entries.
Adjacency Discovery
The adjacency table is populated as new adjacent nodes are discovered. Each time an adjacency entry is
created (such as through the Address Resolution Protocol (ARP), a link-layer header for that adjacent
node is stored in the adjacency table. Once a route is determined, the link-layer header points to a next
hop and corresponding adjacency entry. The link-layer header is subsequently used for encapsulation
during CEF switching of packets.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
27-2 OL-22250-01
Chapter 27 Configuring Cisco Express Forwarding
Catalyst 4500 Series Switch Implementation of CEF
Adjacency Resolution
A route might have several paths to a destination prefix, such as when a router is configured for
simultaneous load balancing and redundancy. For each resolved path, a pointer is added for the
adjacency corresponding to the next-hop interface for that path. This mechanism is used for load
balancing across several paths.
Adjacency Types That Require Special Handling
In addition to adjacencies for next-hop interfaces (host-route adjacencies), other types of adjacencies are
used to expedite switching when certain exception conditions exist. When the prefix is defined, prefixes
requiring exception processing are cached with one of the special adjacencies listed in Table 27-1.
Table 27-1 Adjacency Types for Exception Processing
This adjacency type... Receives this processing...
Null adjacency Packets destined for a Null0 interface are dropped. A Null0 interface can
be used as an effective form of access filtering.
Glean adjacency When a router is connected directly to several hosts, the FIB table on the
router maintains a prefix for the subnet rather than for each individual
host. The subnet prefix points to a glean adjacency. When packets must
be forwarded to a specific host, the adjacency database is gleaned for the
specific prefix.
Punt adjacency Features that require special handling or features that are not yet
supported by CEF switching are sent (punted) to the next higher
switching level.
Discard adjacency Packets are discarded.
Drop adjacency Packets are dropped.
Unresolved Adjacency
When a link-layer header is prepended to packets, FIB requires the prepend to point to an adjacency
corresponding to the next hop. If an adjacency was created by FIB and was not discovered through a
mechanism such as ARP, the Layer 2 addressing information is not known and the adjacency is
considered incomplete. When the Layer 2 information is known, the packet is forwarded to the route
processor, and the adjacency is determined through ARP.
Catalyst 4500 Series Switch Implementation of CEF
This section contains the following subsections:
• Hardware and Software Switching, page 27-4
• Load Balancing, page 27-6
• Software Interfaces, page 27-6
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 27-3
Chapter 27 Configuring Cisco Express Forwarding
Catalyst 4500 Series Switch Implementation of CEF
Catalyst 4000 Family switches support an ASIC-based Integrated Switching Engine that provides these
features:
• Ethernet bridging at Layer 2
• IP routing at Layer 3
Because the ASIC is specifically designed to forward packets, the Integrated Switching Engine hardware
can run this process much faster than CPU subsystem software.
Figure 27-1 shows a high-level view of the ASIC-based Layer 2 and Layer 3 switching process on the
Integrated Switching Engine.
Figure 27-1 Logical L2 and L3 Switch Components
Integrated Switching Engine (ASIC)
L3 physical
interface
Gig 1/1 Logical Router
L3 logical
interfaces
VLAN1 VLAN2
L2 switchports
68402
The Integrated Switching Engine performs inter-VLAN routing on logical Layer 3 interfaces with the
ASIC hardware. The ASIC hardware also supports a physical Layer 3 interface that can be configured
to connect with a host, a switch, or a router.
Hardware and Software Switching
For the majority of packets, the Integrated Switching Engine performs the packet forwarding function
in hardware. These packets are hardware-switched at very high rates. Exception packets are forwarded
by the CPU subsystem software. Statistic reports should show that the Integrated Switching Engine is
forwarding the vast majority of packets in hardware. Software forwarding is significantly slower than
hardware forwarding, but packets forwarded by the CPU subsystem do not reduce hardware forwarding
speed.
Figure 27-2 shows a logical view of the Integrated Switching Engine and the CPU subsystem switching
components.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
27-4 OL-22250-01
Chapter 27 Configuring Cisco Express Forwarding
Catalyst 4500 Series Switch Implementation of CEF
Figure 27-2 Hardware and Software Switching Components
Integrated Switching Engine CPU Subsystem
L3 physical
interface
Gig 1/1 Router
L3 interfaces
GRE GRE
VLAN1 VLAN2 tunnel tunnel
L2 switchports
68127
The Integrated Switching Engine performs inter-VLAN routing in hardware. The CPU subsystem
software supports Layer 3 interfaces to VLANs that use Subnetwork Access Protocol (SNAP)
encapsulation. The CPU subsystem software also supports generic routing encapsulation (GRE) tunnel.
Hardware Switching
Hardware switching is the normal operation for the Catalyst 4500 series switch.
Software Switching
Software switching occurs when traffic cannot be processed in hardware. The following types of
exception packets are processed in software at a much slower rate:
• Packets that use IP header options
Note Packets that use TCP header options are switched in hardware because they do not affect the
forwarding decision.
• Packets that have an expiring IP time-to-live (TTL) counter
• Packets that are forwarded to a tunnel interface
• Packets that arrive with non-supported encapsulation types
• Packets that are routed to an interface with non-supported encapsulation types
• Packets that exceed the MTU of an output interface and must be fragmented
• Packets that require an IGMP redirect to be routed
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 27-5
Chapter 27 Configuring Cisco Express Forwarding
CEF Configuration Restrictions
Load Balancing
The Catalyst 4000 family switch supports load balancing for routing packets in the Integrated Switching
Engine hardware. Load balancing is always enabled. It works when multiple routes for the same network
with different next-hop addresses are configured. These routes can be configured either statically or
through a routing protocol such as OSPF or EIGRP.
The hardware makes a forwarding decision by using a hardware load sharing hash function to compute
a value, based on the source and destination IP addresses and the source and destination TCP port
numbers (if available). This load sharing hash value is then used to select which route to use to forward
the packet. All hardware switching within a particular flow (such as a TCP connection) is routed to the
same next hop, thereby reducing the chance that packet reordering occurs. Up to eight different routes
for a particular network are supported.
Software Interfaces
Cisco IOS for the Catalyst 4000 family switch supports GRE and IP tunnel interfaces that are not part
of the hardware forwarding engine. All packets that flow to or from these interfaces must be processed
in software and has a significantly lower forwarding rate than that of hardware-switched interfaces.
Also, Layer 2 features are not supported on these interfaces.
CEF Configuration Restrictions
The Integrated Switching Engine supports only ARPA and ISL/802.1q encapsulation types for Layer 3
switching in hardware. The CPU subsystem supports a number of encapsulations such as SNAP for
Layer 2 switching that you can use for Layer 3 switching in software.
Configuring CEF
These sections describe how to configure CEF:
• Enabling CEF, page 27-6
• Configuring Load Balancing for CEF, page 27-7
Enabling CEF
By default, CEF is enabled globally on the Catalyst 4000 family switch. No configuration is required.
To reenable CEF, perform this task:
Command Purpose
Switch(config)# ip cef distributed Enables standard CEF operation.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
27-6 OL-22250-01
Chapter 27 Configuring Cisco Express Forwarding
Configuring CEF
Configuring Load Balancing for CEF
CEF load balancing is based on a combination of source and destination packet information; it allows
you to optimize resources by distributing traffic over multiple paths for transferring data to a destination.
You can configure load balancing on a per-destination basis. Load-balancing decisions are made on the
outbound interface. You can configure per-destination load balancing for CEF on outbound interfaces.
The following topics are discussed:
• Configuring Per-Destination Load Balancing, page 27-7
• Configuring Load Sharing Hash Function, page 27-7
• Viewing CEF Information, page 27-8
Configuring Per-Destination Load Balancing
Per-destination load balancing is enabled by default when you enable CEF. To use per-destination load
balancing, you do not perform any additional tasks once you enable CEF.
Per-destination load balancing allows the router to use multiple paths to achieve load sharing. Packets
for a given source-destination host pair are guaranteed to take the same path, even if multiple paths are
available. Traffic destined for different pairs tend to take different paths. Per-destination load balancing
is enabled by default when you enable CEF; it is the load balancing method of choice in most situations.
Because per-destination load balancing depends on the statistical distribution of traffic, load sharing
becomes more effective as the number of source-destination pairs increases.
You can use per-destination load balancing to ensure that packets for a given host pair arrive in order.
All packets for a certain host pair are routed over the same link or links.
Configuring Load Sharing Hash Function
When multiple unicast routes exist to a particular destination IP prefix, the hardware sends packets
matching that prefix across all possible routes, thereby sharing the load across all next hop routers. By
default, the route used is chosen by computing a hash of the source and destination IP addresses and
using the resulting value to select the route. This preserves packet ordering for packets within a flow by
ensuring that all packets within a single IP source/destination flow are sent on the same route, but it
provides a near-random distribution of flows to routes.
The load-sharing hash function can be changed, so that in addition to the source and destination IP
addresses, the source TCP/UDP port, the destination TCP/UDP port, or both can also be included in the
hash.
To the configure load sharing hash function to use the source and/or destination ports, perform this task:
Command Purpose
Switch (config)# [no] ip cef load-sharing Enables load sharing hash function to use source
algorithm include-ports source and destination ports.
destination]
Use the no keyword to set the switch to use the
default Cisco IOS load-sharing algorithm.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 27-7
Chapter 27 Configuring Cisco Express Forwarding
Monitoring and Maintaining CEF
Note The include-ports option does not apply to software-switched traffic on the Catalyst 4500 series
switches.
Viewing CEF Information
You can view the collected CEF information. To view CEF information, perform this task:
Command Purpose
Switch# show ip cef Displays the collected CEF information.
Monitoring and Maintaining CEF
To display information about IP traffic, perform this task:
Command Purpose
Switch# show interface type slot/interface Displays a summary of IP unicast traffic.
| begin L3
This example shows how to display information about IP unicast traffic on interface Fast Ethernet 3/3:
Switch# show interface fastethernet 3/3 | begin L3
L3 in Switched: ucast: 0 pkt, 0 bytes - mcast: 12 pkt, 778 bytes mcast
L3 out Switched: ucast: 0 pkt, 0 bytes - mcast: 0 pkt, 0 bytes
4046399 packets input, 349370039 bytes, 0 no buffer
Received 3795255 broadcasts, 2 runts, 0 giants, 0 throttles
<...output truncated...>
Switch#
Note The IP unicast packet count is updated approximately every five seconds.
Displaying IP Statistics
IP unicast statistics are gathered on a per-interface basis. To display IP statistics, perform this task:
Command Purpose
Switch# show interface type number Displays IP statistics.
counters detail
Software Configuration Guide—Release IOS-XE 3.1.0 SG
27-8 OL-22250-01
Chapter 27 Configuring Cisco Express Forwarding
Monitoring and Maintaining CEF
This example shows how to display IP unicast statistics for Part 3/1:
Switch# show interface fastethernet 3/1 counters detail
Port InBytes InUcastPkts InMcastPkts InBcastPkts
Fa3/1 7263539133 5998222 6412307 156
Port OutBytes OutUcastPkts OutMcastPkts OutBcastPkts
Fa3/1 7560137031 5079852 12140475 38
Port InPkts 64 OutPkts 64 InPkts 65-127 OutPkts 65-127
Fa3/1 11274 168536 7650482 12395769
Port InPkts 128-255 OutPkts 128-255 InPkts 256-511 OutPkts 256-511
Fa3/1 31191 55269 26923 65017
Port InPkts 512-1023 OutPkts 512-1023
Fa3/1 133807 151582
Port InPkts 1024-1518 OutPkts 1024-1518 InPkts 1519-1548 OutPkts 1519-1548
Fa3/1 N/A N/A N/A N/A
Port InPkts 1024-1522 OutPkts 1024-1522 InPkts 1523-1548 OutPkts 1523-1548
Fa3/1 4557008 4384192 0 0
Port Tx-Bytes-Queue-1 Tx-Bytes-Queue-2 Tx-Bytes-Queue-3 Tx-Bytes-Queue-4
Fa3/1 64 0 91007 7666686162
Port Tx-Drops-Queue-1 Tx-Drops-Queue-2 Tx-Drops-Queue-3 Tx-Drops-Queue-4
Fa3/1 0 0 0 0
Port Rx-No-Pkt-Buff RxPauseFrames TxPauseFrames PauseFramesDrop
Fa3/1 0 0 0 N/A
Port UnsupOpcodePause
Fa3/1 0
Switch#
To display CEF (software switched) and hardware IP unicast adjacency table information, perform this
task:
Command Purpose
Switch# show adjacency [interface] [detail Displays detailed adjacency information, including
| internal | summary] Layer 2 information, when the optional detail
keyword is used.
This example shows how to display adjacency statistics:
Switch# show adjacency gigabitethernet 3/5 detail
Protocol Interface Address
IP GigabitEthernet9/5 172.20.53.206(11)
504 packets, 6110 bytes
00605C865B82
000164F83FA50800
ARP 03:49:31
Note Adjacency statistics are updated approximately every 10 seconds.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 27-9
Chapter 27 Configuring Cisco Express Forwarding
Monitoring and Maintaining CEF
Software Configuration Guide—Release IOS-XE 3.1.0 SG
27-10 OL-22250-01
CH A P T E R 28
Configuring Unicast Reverse Path Forwarding
This chapter describes the Unicast Reverse Path Forwarding (Unicast RPF) feature. The Unicast RPF
feature helps to mitigate problems that are caused by malformed or forged IP source addresses that are
passing through a switch.
For a complete description of the Unicast RPF commands in this chapter, refer to the chapter “Unicast
Reverse Path Forwarding Commands” of the Cisco IOS Security Command Reference. To locate
documentation of other commands that appear in this chapter, use the command reference master index
or search online.
To identify the hardware platform or software image information associated with a feature, use the
Feature Navigator on Cisco.com to search for information about the feature or refer to the software
release notes for a specific release. For more information, see the “Identifying Supported Platforms”
section in the chapter “Using Cisco IOS Software.”
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
In This Chapter
This chapter has the following sections:
• About Unicast Reverse Path Forwarding
• Unicast RPF Configuration Task List
• Monitoring and Maintaining Unicast RPF
• Monitoring and Maintaining Unicast RPF
• Unicast RPF Configuration Example: Inbound and Outbound Filters
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 28-1
Chapter 28 Configuring Unicast Reverse Path Forwarding
About Unicast Reverse Path Forwarding
About Unicast Reverse Path Forwarding
The Unicast RPF feature helps to mitigate problems that are caused by the introduction of malformed or
forged (spoofed) IP source addresses into a network by discarding IP packets that lack a verifiable IP
source address. For example, a number of common types of denial-of-service (DoS) attacks, including
Smurf and Tribal Flood Network (TFN), can take advantage of forged or rapidly changing source IP
addresses to allow attackers to thwart efforts to locate or filter the attacks. For Internet service providers
(ISPs) that provide public access, Unicast RPF deflects such attacks by forwarding only packets that
have source addresses that are valid and consistent with the IP routing table. This action protects the
network of the ISP, its customer, and the rest of the Internet.
This section covers the following information:
• How Unicast RPF Works
• Implementing Unicast RPF
• Restrictions
• Related Features and Technologies
• Prerequisites to Configuring Unicast RPF
How Unicast RPF Works
When Unicast RPF is enabled on an interface, the switch examines all packets received as input on that
interface to make sure that the source address and source interface appear in the routing table and match
the interface on which the packet was received. This “look backwards” ability is available only when
Cisco express forwarding (CEF) is enabled on the switch, because the lookup relies on the presence of
the Forwarding Information Base (FIB). CEF generates the FIB as part of its operation.
Note Unicast RPF is an input function and is applied only on the input interface of a switch at the upstream
end of a connection.
Unicast RPF checks to see if any packet received at a switch interface arrives on the best return path
(return route) to the source of the packet. Unicast RPF does this by doing a reverse lookup in the CEF
table. If the packet was received from one of the best reverse path routes, the packet is forwarded as
normal. If there is no reverse path route on the same interface from which the packet was received, it
might mean that the source address was modified. If Unicast RPF does not find a reverse path for the
packet, the packet is dropped.
Note With Unicast RPF, all equal-cost “best” return paths are considered valid. This means that Unicast RPF
works in cases where multiple return paths exist, provided that each path is equal to the others in terms
of the routing cost (number of hops, weights, and so on) and as long as the route is in the FIB. Unicast
RPF also functions where EIGRP variants are being used and unequal candidate paths back to the source
IP address exist.
When a packet is received at the interface where Unicast RPF and ACLs have been configured, the
following actions occur:
Step 1 Input ACLs configured on the inbound interface are checked.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
28-2 OL-22250-01
Chapter 28 Configuring Unicast Reverse Path Forwarding
About Unicast Reverse Path Forwarding
Step 2 Unicast RPF checks to see if the packet has arrived on the best return path to the source, which it does
by doing a reverse lookup in the FIB table.
Step 3 CEF table (FIB) lookup is carried out for packet forwarding.
Step 4 Output ACLs are checked on the outbound interface.
Step 5 The packet is forwarded.
This section provides information about Unicast RPF enhancements:
• Access Control Lists and Logging
• Per-Interface Statistics
Figure 28-1 illustrates how Unicast RPF and CEF work together to validate IP source addresses by
verifying packet return paths. In this example, a customer has sent a packet having a source address of
192.168.1.1 from interface Gigabit Ethernet 1/1. Unicast RPF checks the FIB to see if 192.168.1.1 has
a path to Gigabit Ethernet 1/1. If there is a matching path, the packet is forwarded. If there is no matching
path, the packet is dropped.
Figure 28-1 Unicast RPF Validating IP Source Addresses
Routing table:
192.168.0.0 via 172.19.66.7
172.19.0.0 is directly connected, FDDI 2/0/0
CEF table:
192.168.0.0 172.19.66.7 FDDI 2/0/0
172.19.0.0 attached FDDI 2/0/0
Adjacency table:
FDDI 2/0/0 172.19.66.7 50000603E...AAAA03000800
If okay, RPF passes
the packet to be
forwarded by CEF
Data IP header Unicast Data IP header
RPF
In Out
Drop
Destination address x.x.x.x
Source address 192.168.1.1
RPF checks to see if
the reverse path for
the source address
33402
matches the input port
Figure 28-2 illustrates how Unicast RPF drops packets that fail validation. In this example, a customer
has sent a packet having a source address of 209.165.200.225, which is received at interface Gigabit
Ethernet 1/1. Unicast RPF checks the FIB to see if 209.165.200.225 has a return path to Gigabit Ethernet
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 28-3
Chapter 28 Configuring Unicast Reverse Path Forwarding
About Unicast Reverse Path Forwarding
1/1. If there is a matching path, the packet is forwarded. In this case, there is no reverse entry in the
routing table that routes the customer packet back to source address 209.165.200.225 on interface
Gigabit Ethernet 1/1, and so the packet is dropped.
Figure 28-2 Unicast RPF Dropping Packets That Fail Verification
Routing table:
192.168.0.0 via 172.19.66.7
172.19.0.0 is directly connected, FDDI 2/0/0
CEF table:
192.168.0.0 172.19.66.7 FDDI 2/0/0
172.19.0.0 attached FDDI 2/0/0
Adjacency table:
FDDI 2/0/0 172.19.66.7 50000603E...AAAA03000800
Data IP header Unicast
RPF
In Out
Destination address x.x.x.x
Drop
Source address 209.165.200.225
If not okay, RPF
RPF checks to see if Data IP header drops the packet
the reverse path for
the source address
matches the input port
33403
Implementing Unicast RPF
Unicast RPF has several key implementation principles:
• The packet must be received at an interface that has the best return path (route) to the packet source
(a process called symmetric routing). There must be a route in the FIB matching the route to the
receiving interface. Adding a route in the FIB can be done via static route, network statement, or
dynamic routing. (ACLs permit Unicast RPF to be used when packets are known to be arriving by
specific, less optimal asymmetric input paths.)
• IP source addresses at the receiving interface must match the routing entry for the interface.
• Unicast RPF is an input function and is applied only on the input interface of a switch at the
upstream end of a connection.
Given these implementation principles, Unicast RPF becomes a tool that network administrators can use
not only for their customers but also for their downstream network or ISP, even if the downstream
network or ISP has other connections to the Internet.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
28-4 OL-22250-01
Chapter 28 Configuring Unicast Reverse Path Forwarding
About Unicast Reverse Path Forwarding
Caution Using optional BGP attributes such as weight and local preference, the best path back to the source
address can be modified. Modification would affect the operation of Unicast RPF.
This section provides information about the implementation of Unicast RPF:
• Security Policy and Unicast RPF
• Where to Use Unicast RPF
• Routing Table Requirements
• Where Not to Use Unicast RPF
• Unicast RPF with BOOTP and DHCP
Security Policy and Unicast RPF
Consider the following points in determining your policy for deploying Unicast RPF:
• Unicast RPF must be applied at the interface downstream from the larger portion of the network,
preferably at the edges of your network.
• The further downstream you apply Unicast RPF, the finer the granularity you have in mitigating
address spoofing and in identifying the sources of spoofed addresses. For example, applying Unicast
RPF on an aggregation switch helps mitigate attacks from many downstream networks or clients and
is simple to administer, but it does not help identify the source of the attack. Applying Unicast RPF
at the network access server helps limit the scope of the attack and trace the source of the attack;
however, deploying Unicast RPF across many sites does add to the administration cost of operating
the network.
• The more entities that deploy Unicast RPF across Internet, intranet, and extranet resources, the
better the chances of mitigating large-scale network disruptions throughout the Internet community,
and the better the chances of tracing the source of an attack.
• Unicast RPF does not inspect IP packets encapsulated in tunnels, such as GRE, LT2P, or PPTP.
Unicast RPF must be configured at a home gateway so that Unicast RPF processes network traffic
only after the tunneling and encryption layers have been stripped off the packets.
Where to Use Unicast RPF
Unicast RPF can be used in any “single-homed” environment where there is essentially only one access
point out of the network; that is, one upstream connection. Networks having one access point offer the
best example of symmetric routing, which means that the interface where a packet enters the network is
also the best return path to the source of the IP packet. Unicast RPF is best used at the network perimeter
for Internet, intranet, or extranet environments, or in ISP environments for customer network
terminations.
Enterprise Networks with a Single Connection to an ISP
In enterprise networks, one objective of using Unicast RPF for filtering traffic at the input interface (a
process called ingress filtering) is for protection from malformed packets arriving from the Internet.
Traditionally, local networks that have one connection to the Internet would use ACLs at the receiving
interface to prevent spoofed packets from the Internet from entering their local network.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 28-5
Chapter 28 Configuring Unicast Reverse Path Forwarding
About Unicast Reverse Path Forwarding
ACLs work well for many single-homed customers; however, there are trade-offs when ACLs are used
as ingress filters, including two commonly referenced limitations:
• Packet per second (PPS) performance at very high packet rates
Note This restriction applies only to software packet forwarding. Hardware packet forwarding is the
same on both ACL and uRPF.
• Maintenance of the ACL (whenever there are new addresses added to the network)
Unicast RPF is one tool that addresses both of these limitations. With Unicast RPF, ingress filtering is
done at CEF PPS rates. This processing speed makes a difference when the link is more than 1 Mbps.
Additionally, because Unicast RPF uses the FIB, no ACL maintenance is necessary, and thus the
administration overhead of traditional ACLs is reduced. The following figure and example demonstrate
how Unicast RPF is configured for ingress filtering.
Figure 28-3 illustrates an enterprise network that has a single link to an upstream ISP. In this example,
Unicast RPF is applied at interface Gigabit Ethernet 1/1 on the Enterprise switch for protection from
malformed packets arriving from the Internet. Unicast RPF is also applied at interface
Gigabit Ethernet 2/1 on the ISP switch for protection from malformed packets arriving from the
enterprise network.
Figure 28-3 Enterprise Network Using Unicast RPF for Ingress Filtering
G1/2
G1/1 G2/1 Internet
206530
Enterprise Upstream
network ISP
Using the topography in Figure 28-3, a typical configuration (assuming that CEF is turned on) on the
ISP switch would be as follows:
interface Gigabit Ethernet 2/1
description Link to Enterprise Network
ip address 192.168.3.1 255.255.255.255
no switchport
ip address 10.1.1.2 255.255.255.0
ip verify unicast source reachable-via rx allow-default
The gateway switch configuration of the enterprise network (assuming that CEF is turned on) would look
similar to the following:
interface Gigabit Ethernet 1/2
description ExampleCorp LAN
ip address 192.168.10.1 255.255.252.0
no ip redirects
no ip directed-broadcast
no ip proxy-arp
interface Gigabit Ethernet 1/1
description Link to Internet
no switchport
ip address 10.1.1.1 255.255.255.0
ip verify unicast source reachable-via allow-default
no ip proxy-arp
no ip redirects
no ip directed-broadcast
Software Configuration Guide—Release IOS-XE 3.1.0 SG
28-6 OL-22250-01
Chapter 28 Configuring Unicast Reverse Path Forwarding
About Unicast Reverse Path Forwarding
Notice that Unicast RPF works with a single default route. There are no additional routes or routing
protocols. Network 192.168.10.0/22 is a connected network. Hence, packets coming from the Internet
with a source address in the range 192.168.10.0/22 is dropped by Unicast RPF.
Routing Table Requirements
To work correctly, Unicast RPF needs proper information in the CEF tables. This requirement does not
mean that the switch must have the entire Internet routing table. The amount of routing information
needed in the CEF tables depends on where Unicast RPF is configured and what functions the switch
performs in the network. For example, in an ISP environment, a switch that is a leased-line aggregation
switch for customers needs only the information based on the static routes redistributed into the IGP or
IBGP (depending on which technique is used in the network). Unicast RPF would be configured on the
customer interfaces—hence the requirement for minimal routing information. In another scenario, a
single-homed ISP could place Unicast RPF on the gateway link to the Internet. The full Internet routing
table would be required. Requiring the full routing table would help protect the ISP from external DoS
attacks that use addresses that are not in the Internet routing table.
Where Not to Use Unicast RPF
Unicast RPF should not be used on interfaces that are internal to the network. Internal interfaces are
likely to have routing asymmetry (see Figure 28-4), meaning multiple routes to the source of a packet.
Unicast RPF should be applied only where there is natural or configured symmetry. As long as
administrators carefully plan which interfaces they activate Unicast RPF on, routing asymmetry is not a
serious problem.
For example, switches at the edge of the network of an ISP are more likely to have symmetrical reverse
paths than switches that are in the core of the ISP network. Switches that are in the core of the ISP
network have no guarantee that the best forwarding path out of the switch is the path selected for packets
returning to the switch. Hence, it is not recommended that you apply Unicast RPF where there is a
chance of asymmetric routing, unless you use ACLs to allow the switch to accept incoming packets.
ACLs permit Unicast RPF to be used when packets are known to be arriving by specific, less optimal
asymmetric input paths. However, it is simplest to place Unicast RPF only at the edge of a network or,
for an ISP, at the customer edge of the network.
Figure 28-4 illustrates how Unicast RPF can block legitimate traffic in an asymmetrical routing
environment.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 28-7
Chapter 28 Configuring Unicast Reverse Path Forwarding
About Unicast Reverse Path Forwarding
Figure 28-4 Unicast RPF Blocking Traffic in an Asymmetrical Routing Environment
Unicast RPF applied
to S0 would not
Best route to
block traffic to
site A from ISP
site A
ISP S0
33407
The Internet
network
S1
Site A
Unicast RPF applied
Best route to
to S1 would BLOCK
ISP from site A
traffic from site A
Unicast RPF with BOOTP and DHCP
Unicast RPF allows packets with 0.0.0.0 source and 255.255.255.255 destination to pass so that
Bootstrap Protocol (BOOTP) and Dynamic Host Configuration Protocol (DHCP) functions work
properly.
Restrictions
There are some basic restrictions to applying Unicast RPF to multihomed clients:
• Clients should not be multihomed to the same switch because multihoming defeats the purpose of
building a redundant service for the client.
• Customers must ensure that the packets flowing up the link (out to the Internet) match the route
advertised out the link. Otherwise, Unicast RPF filters those packets as malformed packets.
Limitations
There are some basic limitations associated with applying Unicast RPF:
• Unicast loose mode is not supported.
Related Features and Technologies
For more information about Unicast RPF-related features and technologies, review the following:
• Unicast RPF requires Cisco express forwarding (CEF) to function properly on the switch. For more
information about CEF, refer to the Cisco IOS Switching Services Configuration Guide.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
28-8 OL-22250-01
Chapter 28 Configuring Unicast Reverse Path Forwarding
Unicast RPF Configuration Task List
• Unicast RPF can be more effective at mitigating spoofing attacks when combined with a policy of
ingress and egress filtering using Cisco IOS access control lists (ACLs).
– Ingress filtering applies filters to traffic received at a network interface from either internal or
external networks. With ingress filtering, packets that arrive from other networks or the Internet
and that have a source address that matches a local network, private, or broadcast address are
dropped. In ISP environments, for example, ingress filtering can apply to traffic received at the
switch from either the client (customer) or the Internet.
– Egress filtering applies filters to traffic exiting a network interface (the sending interface). By
filtering packets on switches that connect your network to the Internet or to other networks, you
can permit only packets with valid source IP addresses to leave your network.
For more information on network filtering, refer to RFC 2267 and to the Cisco IOS IP Configuration
Guide.
Prerequisites to Configuring Unicast RPF
Prior to configuring Unicast RPF, configure ACLs:
• Configure standard or extended ACLs to mitigate transmission of invalid IP addresses (perform
egress filtering). Permit only valid source addresses to leave your network and get onto the Internet.
Prevent all other source addresses from leaving your network for the Internet.
• Configure standard or extended ACLs entries to drop (deny) packets that have invalid source IP
addresses (perform ingress filtering). Invalid source IP addresses include the following types:
– Reserved addresses
– Loopback addresses
– Private addresses (RFC 1918, Address Allocation for Private Internets)
– Broadcast addresses (including multicast addresses)
– Source addresses that fall outside the range of valid addresses associated with the protected
network
Unicast RPF Configuration Task List
The following sections describe the configuration tasks for Unicast RPF. Each task in the list is
identified as either optional or required.
• Configuring Unicast RPF (Required)
• Verifying Unicast RPF (Optional)
See the section “Unicast RPF Configuration Example: Inbound and Outbound Filters” at the end of this
chapter.
Configuring Unicast RPF
Unicast RPF is an input-side function that is enabled on an interface operates on IP packets received by
the switch.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 28-9
Chapter 28 Configuring Unicast Reverse Path Forwarding
Unicast RPF Configuration Task List
To configure Unicast RPF, perform the following task:
Command Purpose
Step 1 Switch(config-if)# interface type Selects the input interface on which you want to
apply Unicast RPF. This is the receiving interface,
which allows Unicast RPF to verify the best return
path before forwarding the packet on to the next
destination.
The interface type is specific to your switch and the
types of interface cards installed on the switch. To
display a list of available interface types, enter the
interface ? command.
Step 2 Switch(config-if)# ip verify unicast source Enables Unicast RPF on the interface.
reachable-via rx allow-default
Step 3 Switch(config-if)# exit Exits interface configuration mode. Repeat Steps 2
and 3 for each interface on which you want to apply
Unicast RPF.
Verifying Unicast RPF
To verify that Unicast RPF is operational, use the show cef interface command. The following example
shows that Unicast RPF is enabled at interface Gigabit Ethernet 3/1.
Switch# show cef interface gigabitEthernet 3/1
GigabitEthernet3/1 is up (if_number 79)
Corresponding hwidb fast_if_number 79
Corresponding hwidb firstsw->if_number 79
Internet address is 10.1.1.1/24
ICMP redirects are always sent
IP unicast RPF check is enabled <======
Input features: uRPF <=====
Inbound access list is not set
Outbound access list is not set
IP policy routing is disabled
BGP based policy accounting on input is disabled
BGP based policy accounting on output is disabled
Hardware idb is GigabitEthernet3/1
Fast switching type 1, interface type 155
IP CEF switching enabled
IP CEF switching turbo vector
IP Null turbo vector
IP prefix lookup IPv4 mtrie 8-8-8-8 optimized
Input fast flags 0x4000, Output fast flags 0x0
ifindex 78(78)
Slot 3 Slot unit 1 VC -1
Transmit limit accumulator 0x0 (0x0)
IP MTU 1500
Software Configuration Guide—Release IOS-XE 3.1.0 SG
28-10 OL-22250-01
Chapter 28 Configuring Unicast Reverse Path Forwarding
Monitoring and Maintaining Unicast RPF
Monitoring and Maintaining Unicast RPF
This section describes commands used to monitor and maintain Unicast RPF.
Command Purpose
Switch# show ip traffic Displays global switch statistics about Unicast RPF drops
and suppressed drops.
Switch(config-if)# no ip verify unicast Disables Unicast RPF at the interface.
Unicast RPF counts the number of packets dropped or suppressed because of malformed or forged
source addresses. Unicast RPF counts dropped or forwarded packets that include the following global
and per-interface information:
• Global Unicast RPF drops
• Per-interface Unicast RPF drops
• Per-interface Unicast RPF suppressed drops
The show ip traffic command shows the total number (global count) of dropped or suppressed packets
for all interfaces on the switch. The Unicast RPF drop count is included in the IP statistics section.
Switch# show ip traffic
IP statistics:
Rcvd: 1471590 total, 887368 local destination
0 format errors, 0 checksum errors, 301274 bad hop count
0 unknown protocol, 0 not a gateway
0 security failures, 0 bad options, 0 with options
Opts: 0 end, 0 nop, 0 basic security, 0 loose source route
0 timestamp, 0 extended security, 0 record route
0 stream ID, 0 strict source route, 0 alert, 0 other
Frags: 0 reassembled, 0 timeouts, 0 couldn't reassemble
0 fragmented, 0 couldn't fragment
Bcast: 205233 received, 0 sent
Mcast: 463292 received, 462118 sent
Sent: 990158 generated, 282938 forwarded
! The second line below (“0 unicast RPF”) displays Unicast RPF packet dropping
information.
Drop: 3 encapsulation failed, 0 unresolved, 0 no adjacency
0 no route, 0 unicast RPF, 0 forced drop
A nonzero value for the count of dropped or suppressed packets can mean one of two things:
• Unicast RPF is dropping or suppressing packets that have a bad source address (normal operation).
• Unicast RPF is dropping or suppressing legitimate packets because the route is misconfigured to use
Unicast RPF in environments where asymmetric routing exists; that is, where multiple paths can
exist as the best return path for a source address.
The show ip interface command shows the total of dropped or suppressed packets at a specific interface.
If Unicast RPF is configured to use a specific ACL, that ACL information is displayed along with the
drop statistics.
Switch> show ip interface fast 2/1
Unicast RPF ACL 197
1 unicast RPF drop
1 unicast RPF suppressed drop
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 28-11
Chapter 28 Configuring Unicast Reverse Path Forwarding
Unicast RPF Configuration Example: Inbound and Outbound Filters
The show access-lists command displays the number of matches found for a specific entry in a specific
access list.
Switch> show access-lists
Extended IP access list 197
deny ip 192.168.201.0 0.0.0.63 any log-input (1 match)
permit ip 192.168.201.64 0.0.0.63 any log-input (1 match)
deny ip 192.168.201.128 0.0.0.63 any log-input
permit ip 192.168.201.192 0.0.0.63 any log-input
Unicast RPF Configuration Example:
Inbound and Outbound Filters
The following example uses a very simple single-homed ISP to demonstrate the concepts of ingress and
egress filters used in conjunction with Unicast RPF. The example illustrates an ISP-allocated classless
interdomain routing (CIDR) block 209.165.202.128/28 that has both inbound and outbound filters on the
upstream interface. Be aware that ISPs are usually not single-homed. Hence, provisions for
asymmetrical flows (when outbound traffic goes out one link and returns via a different link) need to be
designed into the filters on the border switches of the ISP.
ip cef distributed
!
interface Serial 5/0/0
description Connection to Upstream ISP
ip address 209.165.200.225 255.255.255.252
no ip redirects
no ip directed-broadcast
no ip proxy-arp
ip verify unicast reverse-path rx allow-default
ip access-group 111 in
ip access-group 110 out
!
access-list 110 permit ip 209.165.202.128 0.0.0.31 any
access-list 110 deny ip any any log
access-list 111 deny ip host 0.0.0.0 any log
access-list 111 deny ip 127.0.0.0 0.255.255.255 any log
access-list 111 deny ip 10.0.0.0 0.255.255.255 any log
access-list 111 deny ip 172.16.0.0 0.15.255.255 any log
access-list 111 deny ip 192.168.0.0 0.0.255.255 any log
access-list 111 deny ip 209.165.202.128 0.0.0.31 any log
access-list 111 permit ip any any
Software Configuration Guide—Release IOS-XE 3.1.0 SG
28-12 OL-22250-01
CH A P T E R 29
Configuring IP Multicast
This chapter describes IP multicast routing on the Catalyst 4500 series switch. It also provides
procedures and examples to configure IP multicast routing.
Note For more detailed information on IP Multicast, refer to this URL
http://www.cisco.com/en/US/products/ps6552/products_ios_technology_home.html
Note For complete syntax and usage information for the switch commands used in this chapter, first look at
the Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it will be found in the larger
Cisco IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
This chapter includes the following major sections:
• Overview of IP Multicast, page 29-1
• Configuring IP Multicast Routing, page 29-12
• Monitoring and Maintaining IP Multicast Routing, page 29-21
• Configuration Examples, page 29-26
Overview of IP Multicast
This section includes these subsections:
• IP Multicast Protocols, page 29-2
• IP Multicast on the Catalyst 4500 Series Switch, page 29-5
• Unsupported Feature, page 29-12
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-1
Chapter 29 Configuring IP Multicast
Overview of IP Multicast
At one end of the IP communication spectrum is IP unicast, where a source IP host sends packets to a
specific destination IP host. In IP unicast, the destination address in the IP packet is the address of a
single, unique host in the IP network. These IP packets are forwarded across the network from the source
to the destination host by routers. At each point on the path between source and destination, a router uses
a unicast routing table to make unicast forwarding decisions, based on the IP destination address in the
packet.
At the other end of the IP communication spectrum is an IP broadcast, where a source host sends packets
to all hosts on a network segment. The destination address of an IP broadcast packet has the host portion
of the destination IP address set to all ones and the network portion set to the address of the subnet. IP
hosts, including routers, understand that packets, which contain an IP broadcast address as the
destination address, are addressed to all IP hosts on the subnet. Unless specifically configured otherwise,
routers do not forward IP broadcast packets, so IP broadcast communication is normally limited to a
local subnet.
IP multicasting falls between IP unicast and IP broadcast communication. IP multicast communication
enables a host to send IP packets to a group of hosts anywhere within the IP network. To send
information to a specific group, IP multicast communication uses a special form of IP destination
address called an IP multicast group address. The IP multicast group address is specified in the IP
destination address field of the packet.
To multicast IP information, Layer 3 switches and routers must forward an incoming IP packet to all
output interfaces that lead to members of the IP multicast group. In the multicasting process on the
Catalyst 4500 Series switch, a packet is replicated in the Integrated Switching Engine, forwarded to the
appropriate output interfaces, and sent to each member of the multicast group.
It is not uncommon for people to think of IP multicasting and video conferencing as almost the same
thing. Although the first application in a network to use IP multicast is often video conferencing, video
is only one of many IP multicast applications that can add value to a company’s business model. Other
IP multicast applications that have potential for improving productivity include multimedia
conferencing, data replication, real-time data multicasts, and simulation applications.
This section contains the following subsections:
• IP Multicast Protocols, page 29-2
• IP Multicast on the Catalyst 4500 Series Switch, page 29-5
• Unsupported Feature, page 29-12
IP Multicast Protocols
The Catalyst 4500 Series switch primarily uses these protocols to implement IP multicast routing:
• Internet Group Management Protocol (IGMP)
• Protocol Independent Multicast (PIM)
• Cisco Group Management Protocol (CGMP)
Figure 29-1 shows where these protocols operate within the IP multicast environment.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-2 OL-22250-01
Chapter 29 Configuring IP Multicast
Overview of IP Multicast
Figure 29-1 IP Multicast Routing Protocols
Host A
Catalyst 4500 series switch Router
Internet
Host B IGMP and PIM
IGMP
Snooping
94150
Internet Group Management Protocol
IGMP messages are used by IP multicast hosts to send their local Layer 3 switch or router a request to
join a specific multicast group and begin receiving multicast traffic. With some extensions in IGMPv2,
IP hosts can also send a request to a Layer 3 switch or router to leave an IP multicast group and not
receive the multicast group traffic.
Using the information obtained via IGMP, a Layer 3 switch or router maintains a list of multicast group
memberships on a per-interface basis. A multicast group membership is active on an interface if at least
one host on the interface sends an IGMP request to receive multicast group traffic.
Protocol-Independent Multicast
PIM is protocol independent because it can leverage whichever unicast routing protocol is used to
populate the unicast routing table, including EIGRP, OSPF, BGP, or static route, to support IP multicast.
PIM also uses a unicast routing table to perform the reverse path forwarding (RPF) check function
instead of building a completely independent multicast routing table. PIM does not send and receive
multicast routing updates between routers like other routing protocols do.
PIM Dense Mode
PIM Dense Mode (PIM-DM) uses a push model to flood multicast traffic to every corner of the network.
PIM-DM is intended for networks in which most LANs need to receive the multicast, such as LAN TV
and corporate or financial information broadcasts. It can be an efficient delivery mechanism if there are
active receivers on every subnet in the network.
Note Supervisor Engine 7-E does not increment counters for (*, G) in PIM Dense Mode. (*, G) counters are
incremented only when running Bidirectional PIM Mode.
For more detailed information on PIM Dense Mode, refer to this URL:
http://www.cisco.com/en/US/docs/ios-xml/ios/ipmulti_optim/configuration/12-2sx/imc_pim_dense_rfr
sh.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-3
Chapter 29 Configuring IP Multicast
Overview of IP Multicast
PIM Sparse Mode
PIM Sparse Mode (PIM-SM) uses a pull model to deliver multicast traffic. Only networks with active
receivers that have explicitly requested the data will be forwarded the traffic. PIM-SM is intended for
networks with several different multicasts, such as desktop video conferencing and collaborative
computing, that go to a small number of receivers and are typically in progress simultaneously.
Note Supervisor Engine 7-E does not increment counters for (*, G) in PIM Dense Mode. (*, G) counters are
incremented only when running Bidirectional PIM Mode.
Bidirectional PIM Mode
In bidirectional PIM (Bidir-PIM) mode, traffic is routed only along a bidirectional shared tree that is
rooted at the rendezvous point (RP) for the group. The IP address of the RP functions as a key enabling
all routers to establish a loop-free spanning tree topology rooted in that IP address.
Bidir-PIM is intended for many-to-many applications within individual PIM domains. Multicast groups
in bidirectional mode can scale to an arbitrary number of sources without incurring overhead due to the
number of sources.
Note Supervisor Engine 7-E does not increment counters for (*, G) in PIM Dense or Sparse Mode. (*, G)
counters are incremented only when running Bidirectional PIM Mode.
For more detailed information on Bidirectional Mode, refer to this URL:
http://www.cisco.com/en/US/prod/collateral/iosswrel/ps6537/ps6552/ps6592/prod_white_paper0900ae
cd80310db2.pdf.
Rendezvous Point (RP)
If you configure PIM to operate in sparse mode, you must also choose one or more routers to be
rendezvous points (RPs). Senders to a multicast group use RPs to announce their presence. Receivers of
multicast packets use RPs to learn about new senders. You can configure Cisco IOS software so that
packets for a single multicast group can use one or more RPs.
The RP address is used by first hop routers to send PIM register messages on behalf of a host sending a
packet to the group. The RP address is also used by last hop routers to send PIM join and prune messages
to the RP to inform it about group membership. You must configure the RP address on all routers
(including the RP router).
A PIM router can be an RP for more than one group. Only one RP address can be used at a time within
a PIM domain for the same group. The conditions specified by the access list determine for which groups
the router is an RP (as different groups can have different RPs).
IGMP Snooping
IGMP snooping is used for multicasting in a Layer 2 switching environment. With IGMP snooping, a
Layer 3 switch or router examines Layer 3 information in the IGMP packets in transit between hosts and
a router. When the switch receives the IGMP Host Report from a host for a particular multicast group,
the switch adds the host's port number to the associated multicast table entry. When the switch receives
the IGMP Leave Group message from a host, it removes the host's port from the table entry.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-4 OL-22250-01
Chapter 29 Configuring IP Multicast
Overview of IP Multicast
IP Multicast on the Catalyst 4500 Series Switch
The Catalyst 4500 Series switch supports an ASIC-based Integrated Switching Engine that provides
Ethernet bridging at Layer 2 and IP routing at Layer 3. Because the ASIC is specifically designed to
forward packets, the Integrated Switching Engine hardware provides very high performance with ACLs
and QoS enabled. At wire-speed, forwarding in hardware is significantly faster than the CPU subsystem
software, which is designed to handle exception packets.
The Integrated Switching Engine hardware supports interfaces for inter-VLAN routing and switchports
for Layer 2 bridging. It also provides a physical Layer 3 interface that can be configured to connect with
a host, a switch, or a router.
Figure 29-2 shows a logical view of Layer 2 and Layer 3 forwarding in the Integrated Switching Engine
hardware.
Figure 29-2 Logical View of Layer 2 and Layer 3 Forwarding in Hardware
Integrated Switching Engine (ASIC)
L3 physical
interface
Gig 1/1 Logical Router
L3 logical
interfaces
VLAN1 VLAN2
L2 switchports
68402
This section contains the following subsections:
• CEF, MFIB, and Layer 2 Forwarding, page 29-5
• IP Multicast Tables, page 29-7
• Hardware and Software Forwarding, page 29-8
• Non-Reverse Path Forwarding Traffic, page 29-9
• Multicast Fast Drop, page 29-10
• Multicast Forwarding Information Base, page 29-11
• S/M, 224/4, page 29-12
CEF, MFIB, and Layer 2 Forwarding
The implementation of IP multicast on the Catalyst 4500 Series switch is an extension of centralized
Cisco Express Forwarding (CEF). CEF extracts information from the unicast routing table, which is
created by unicast routing protocols, such as BGP, OSPF, and EIGR and loads it into the hardware
Forwarding Information Base (FIB). With the unicast routes in the FIB, when a route is changed in the
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-5
Chapter 29 Configuring IP Multicast
Overview of IP Multicast
upper-layer routing table, only one route needs to be changed in the hardware routing state. To forward
unicast packets in hardware, the Integrated Switching Engine looks up source and destination routes in
ternary content addressable memory (TCAM), takes the adjacency index from the hardware FIB, and
gets the Layer 2 rewrite information and next-hop address from the hardware adjacency table.
The new Multicast Forwarding Information Base (MFIB) subsystem is the multicast analog of the
unicast CEF. The MFIB subsystem extracts the multicast routes that PIM and IGMP create and refines
them into a protocol-independent format for forwarding in hardware. The MFIB subsystem removes the
protocol-specific information and leaves only the essential forwarding information. Each entry in the
MFIB table consists of an (S,G) or (*,G) route, an input RPF VLAN, and a list of Layer 3 output
interfaces. The MFIB subsystem, together with platform-dependent management software, loads this
multicast routing information into the hardware FIB and hardware replica expansion table (RET).
The Catalyst 4500 Series switch performs Layer 3 routing and Layer 2 bridging at the same time. There
can be multiple Layer 2 switchports on any VLAN interface. To determine the set of output switchports
on which to forward a multicast packet, the supervisor engine combines Layer 3 MFIB information with
Layer 2 forwarding information and stores it in the hardware RET for packet replication.
Figure 29-3 shows a functional overview of how the Catalyst 4500 Series switch combines unicast
routing, multicast routing, and Layer 2 bridging information to forward in hardware.
Figure 29-3 Combining CEF, MFIB, and Layer 2 Forwarding Information in Hardware
OSPF PIM / IGMP IGMP Snooping CPU
Protocols Spanning Tree Subsystem
Unicast Multicast L2 Multicast Software
Software Unicast Routing Multicast Routing Layer 2 Forwarding
Tables Table Table Table
CEF MFIB
CEF – MFIB Subsystem
Integrated
Hardware H/W Adjacency H/W FIB MET Replication Switching
Tables Table Table Table Engine
68614
Like the CEF unicast routes, the MFIB routes are Layer 3 and must be merged with the appropriate
Layer 2 information. The following example shows an MFIB route:
(*,224.1.2.3)
RPF interface is Vlan3
Output Interfaces are:
Vlan 1
Vlan 2
The route (*,224.1.2.3) is loaded in the hardware FIB table and the list of output interfaces is loaded into
the RET. A pointer to the list of output interfaces, the RET index, and the RPF interface are also loaded
in the hardware FIB with the (*,224.1.2.3) route. With this information loaded in hardware, merging of
the Layer 2 information can begin. For the output interfaces on VLAN1, the Integrated Switching Engine
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-6 OL-22250-01
Chapter 29 Configuring IP Multicast
Overview of IP Multicast
must send the packet to all switchports in VLAN1 that are in the spanning tree forwarding state. The
same process applies to VLAN 2. To determine the set of switchports in VLAN 2, the Layer 2
Forwarding Table is used.
When the hardware routes a packet, in addition to sending it to all of the switchports on all output
interfaces, the hardware also sends the packet to all switchports (other than the one it arrived on) in the
input VLAN. For example, assume that VLAN 3 has two switchports in it, Gig 3/1 and Gig 3/2. If a host
on Gig 3/1 sends a multicast packet, the host on Gig 3/2 might also need to receive the packet. To send
a multicast packet to the host on Gig 3/2, all of the switchports in the ingress VLAN must be added to
the portset that is loaded in the RET.
If VLAN 1 contains 1/1 and 1/2, VLAN 2 contains 2/1 and 2/2, and VLAN 3 contains 3/1 and 3/2, the
RET chain for this route would contain these switchports: (1/1,1/2,2/1,2/2,3/1, and 3/2).
If IGMP snooping is on, the packet should not be forwarded to all output switchports on VLAN 2. The
packet should be forwarded only to switchports where IGMP snooping has determined that there is either
a group member or router. For example, if VLAN 1 had IGMP snooping enabled, and IGMP snooping
determined that only port 1/2 had a group member on it, then the RET chain would contain these
switchports: (1/1,1/2, 2/1, 2/2, 3/1, and 3/2).
IP Multicast Tables
Figure 29-4 shows some key data structures that the Catalyst 4500 Series switch uses to forward IP
multicast packets in hardware.
Figure 29-4 IP Multicast Tables and Protocols
Integrated Switching Engine CPU Subsystem
Hardware Tables Software Tables Routing Protocols
Multicast Routing
Table L3 Protocols
Hardware FIB Table
• (S,G), RPF • PIM
(S,G), RPF Vlan, MET Index interface, set of • IGMP
(*,G), Interfaces, MET Index output interfaces
Hardware MET Table L2 Forwarding L2 Protocols
(Replication) Table • IGMP
snooping
Index, set of {Vlan, switchport} Vlan, MAC address
switchports • Spanning tree
S,G rpf interface met index index set of {vlan, switchport}
S1, G1 vlan 3 1219 0 ..
S2, G2 vlan 7 1241 .. ..
.. ..
68135
*, G4 vlan 99 1356 1279 {vlan3, Fa 3/1} {vlan5, Fa 3/2}, …
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-7
Chapter 29 Configuring IP Multicast
Overview of IP Multicast
The Integrated Switching Engine maintains the hardware FIB table to identify individual IP multicast
routes. Each entry consists of a destination group IP address and an optional source IP address. Multicast
traffic flows on primarily two types of routes: (S,G) and (*,G). The (S,G) routes flow from a source to a
group based on the IP address of the multicast source and the IP address of the multicast group
destination. Traffic on a (*,G) route flows from the PIM RP to all receivers of group G. Only
sparse-mode groups use (*,G) routes. The Integrated Switching Engine hardware contains space for a
total of 128,000 routes, which are shared by unicast routes, multicast routes, and multicast fast-drop
entries.
For RET, we can have up to 102K entries (32K used for floodsets, 70,000 used for multicast entries. The
RET resources are shared by both Layer 3 multicast routes and by Layer 2 multicast entries. The actual
number of output interface lists available in hardware depends on the specific configuration. If the total
number of multicast routes exceed 32,000, multicast packets might not be switched by the Integrated
Switching Engine. They would be forwarded by the CPU subsystem at much slower speeds.
Note For RET, a maximum of 102K entries is supported (32K used for floodsets, 70K used for multicast
entries).
Note Partial multicast routing is not supported on Supervisor Engine 7-E; only hardware and software routing
are supported.
Hardware and Software Forwarding
The Integrated Switching Engine forwards the majority of packets in hardware at very high rates of
speed. The CPU subsystem forwards exception packets in software. Statistical reports should show that
the Integrated Switching Engine is forwarding the vast majority of packets in hardware.
Replication is a particular type of forwarding where, instead of sending out one copy of the packet, the
packet is replicated and multiple copies of the packet are sent out. At Layer 3, replication occurs only
for multicast packets; unicast packets are never replicated to multiple Layer 3 interfaces. In IP
multicasting, for each incoming IP multicast packet that is received, many replicas of the packet are sent
out.
IP multicast packets can be transmitted on the following types of routes:
• Hardware routes
• Software routes
• Partial routes
Hardware routes occur when the Integrated Switching Engine hardware forwards all replicas of a packet.
Software routes occur when the CPU subsystem software forwards all replicas of a packet. Partial routes
occur when the Integrated Switching Engine forwards some of the replicas in hardware and the CPU
subsystem forwards some of the replicas in software.
Partial Routes
Note The conditions listed below cause the replicas to be forwarded by the CPU subsystem software, but the
performance of the replicas that are forwarded in hardware is not affected.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-8 OL-22250-01
Chapter 29 Configuring IP Multicast
Overview of IP Multicast
The following conditions cause some replicas of a packet for a route to be forwarded by the CPU
subsystem:
• The switch is configured with the ip igmp join-group command as a member of the IP multicast
group on the RPF interface of the multicast source.
• The switch is the first-hop to the source in PIM sparse mode. In this case, the switch must send
PIM-register messages to the RP.
Software Routes
Note If any one of the following conditions is configured on the RPF interface or the output interface, all
replication of the output is performed in software.
The following conditions cause all replicas of a packet for a route to be forwarded by the CPU subsystem
software:
• The interface is configured with multicast helper.
• The interface is a generic routing encapsulation (GRE) or Distance Vector Multicast Routing
Protocol (DVMRP) tunnel.
• The interface uses non-Advanced Research Products Agency (ARPA) encapsulation.
The following packets are always forwarded in software:
• Packets sent to multicast groups that fall into the range 224.0.0.* (where * is in the range from 0 to
255). This range is used by routing protocols. Layer 3 switching supports all other multicast group
addresses.
• Packets with IP options.
Non-Reverse Path Forwarding Traffic
Traffic that fails an Reverse Path Forwarding (RPF) check is called non-RPF traffic. Non-RPF traffic is
forwarded by the Integrated Switching Engine by filtering (persistently dropping) or rate limiting the
non-RPF traffic.
In a redundant configuration where multiple Layer 3 switches or routers connect to the same LAN
segment, only one device forwards the multicast traffic from the source to the receivers on the outgoing
interfaces. Figure 29-5 shows how Non-RPF traffic can occur in a common network configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-9
Chapter 29 Configuring IP Multicast
Overview of IP Multicast
Figure 29-5 Redundant Multicast Router Configuration in a Stub Network
Router A Router B
Network A
Network B
Multicast Traffic
68331
Non-RPF Traffic
In this kind of topology, only Router A, the PIM designated router (PIM DR), forwards data to the
common VLAN. Router B receives the forwarded multicast traffic, but must drop this traffic because it
has arrived on the wrong interface and fails the RPF check. Traffic that fails the RPF check is called
non-RPF traffic.
Multicast Fast Drop
In IP multicast protocols, such as PIM-SM and PIM-DM, every (S,G) or (*,G) route has an incoming
interface associated with it. This interface is referred to as the reverse path forwarding interface. In some
cases, when a packet arrives on an interface other than the expected RPF interface, the packet must be
forwarded to the CPU subsystem software to allow PIM to perform special protocol processing on the
packet. One example of this special protocol processing that PIM performs is the PIM Assert protocol.
By default, the Integrated Switching Engine hardware sends all packets that arrive on a non-RPF
interface to the CPU subsystem software. However, processing in software is not necessary in many
cases, because these non-RPF packets are often not needed by the multicast routing protocols. The
problem is that if no action is taken, the non-RPF packets that are sent to the software can overwhelm
the CPU.
To prevent this from happening, the CPU subsystem software loads fast-drop entries in the hardware
when it receives an RPF failed packet that is not needed by the PIM protocols running on the switch. A
fast-drop entry is keyed by (S,G, incoming interface). Any packet matching a fast-drop entry is bridged
in the ingress VLAN, but is not sent to the software, so the CPU subsystem software is not overloaded
by processing these RPF failures unnecessarily.
Protocol events, such as a link going down or a change in the unicast routing table, can impact the set of
packets that can safely be fast dropped. A packet that was correctly fast dropped before might, after a
topology change, need to be forwarded to the CPU subsystem software so that PIM can process it. The
CPU subsystem software handles flushing fast-drop entries in response to protocol events so that the
PIM code in IOS can process all the necessary RPF failures.
The use of fast-drop entries in the hardware is critical in some common topologies because it is possible
to have persistent RPF failures. Without the fast-drop entries, the CPU would be exhausted by RPF failed
packets that it did not need to process.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-10 OL-22250-01
Chapter 29 Configuring IP Multicast
Overview of IP Multicast
Multicast Forwarding Information Base
The Multicast Forwarding Information Base (MFIB) subsystem supports IP multicast routing in the
Integrated Switching Engine hardware on the Catalyst 4500 Series switch. The MFIB logically resides
between the IP multicast routing protocols in the CPU subsystem software (PIM, IGMP, MSDP, MBGP,
and DVMRP) and the platform-specific code that manages IP multicast routing in hardware. The MFIB
translates the routing table information created by the multicast routing protocols into a simplified
format that can be efficiently processed and used for forwarding by the Integrated Switching Engine
hardware.
To display the information in the multicast routing table, use the show ip mroute command. To display
the MFIB table information, use the show ip mfib command.
The MFIB table contains a set of IP multicast routes. There are several types of IP multicast routes,
including (S,G) and (*,G) routes. Each route in the MFIB table can have one or more optional flags
associated with it. The route flags indicate how a packet that matches a route should be forwarded. For
example, the Internal Copy (IC) flag on an MFIB route indicates that a process on the switch needs to
receive a copy of the packet. The following flags can be associated with MFIB routes:
• Internal Copy (IC) flag—set on a route when a process on the router needs to receive a copy of all
packets matching the specified route
• Signalling (S) flag—set on a route when a process needs to be notified when a packet matching the
route is received; the expected behavior is that the protocol code updates the MFIB state in response
to receiving a packet on a signalling interface
• Connected (C) flag—–when set on an MFIB route, has the same meaning as the Signalling (S) flag,
except that the C flag indicates that only packets sent by directly connected hosts to the route should
be signalled to a protocol process
A route can also have a set of optional flags associated with one or more interfaces. For example, an
(S,G) route with the flags on VLAN 1 indicates how packets arriving on VLAN 1 should be treated, and
they also indicate whether packets matching the route should be forwarded onto VLAN 1. The
per-interface flags supported in the MFIB include the following:
• Accepting (A)—set on the interface that is known in multicast routing as the RPF interface. A packet
that arrives on an interface that is marked as Accepting (A) is forwarded to all Forwarding (F)
interfaces.
• Forwarding (F)—used in conjunction with the Accepting (A) flag as described above. The set of
Forwarding interfaces that form what is often referred to as the multicast “olist” or output interface
list.
• Signalling (S)—set on an interface when some multicast routing protocol process in IOS needs to
be notified of packets arriving on that interface.
Note When PIM-SM routing is in use, the MFIB route might include an interface like in this example:
PimTunnel [1.2.3.4]. This is a virtual interface that the MFIB subsystem creates to indicate that packets
are being tunnelled to the specified destination address. A PimTunnel interface cannot be displayed with
the normal show interface command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-11
Chapter 29 Configuring IP Multicast
Configuring IP Multicast Routing
S/M, 224/4
An (S/M, 224/4) entry is created in the MFIB for every multicast-enabled interface. This entry ensures
that all packets sent by directly connected neighbors can be Register-encapsulated to the PIM-SM RP.
Typically, only a small number of packets would be forwarded using the (S/M,224/4) route, until the
(S,G) route is established by PIM-SM.
For example, on an interface with IP address 10.0.0.1 and netmask 255.0.0.0, a route would be created
matching all IP multicast packets in which the source address is anything in the class A network 10. This
route can be written in conventional subnet/masklength notation as (10/8,224/4). If an interface has
multiple assigned IP addresses, then one route is created for each such IP address.
Restrictions on using Bidirectional PIM
Restrictions include the following:
• IPv4 Bidirectional (Bidir) PIM is supported on Supervisor Engine 7-E. IPv6 Bidir PIM is not
supported.
• The Catalyst 4500 switch enables you to forward Bidir PIM traffic in hardware up to a maximum of
seven RPs. If you configure more than seven Bidir RPs, only the first seven RPs can forward traffic
in hardware. The traffic directed to the remaining RPs is forwarded in software.
Unsupported Feature
The following IP multicast feature is not supported in this release:
• Controlling the transmission rate to a multicast group
Configuring IP Multicast Routing
The following sections describe IP multicast routing configuration tasks:
• Default Configuration in IP Multicast Routing, page 29-12
• Enabling IP Multicast Routing, page 29-13
• Enabling PIM on an Interface, page 29-13
• Enabling Bidirectional Mode, page 29-15
• Enabling PIM-SSM Mapping, page 29-16
• Configuring a Rendezvous Point, page 29-16
• Configuring a Single Static RP, page 29-19
For more detailed information on IP multicast routing, such as Auto-RP, PIM Version 2, and IP multicast
static routes, refer to the Cisco IOS IP and IP Routing Configuration Guide, Cisco IOS Release 12.3.
Default Configuration in IP Multicast Routing
Table 29-1 shows the IP multicast default configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-12 OL-22250-01
Chapter 29 Configuring IP Multicast
Configuring IP Multicast Routing
Table 29-1 Default IP Multicast Configuration
Feature Default Value
Rate limiting of RPF Enabled globally
IP multicast routing Disabled globally
Note When IP multicast routing is disabled, IP multicast traffic data
packets are not forwarded by the Catalyst 4500 Series switch.
However, IP multicast control traffic will continue to be processed
and forwarded. Therefore, IP multicast routes can remain in the
routing table even if IP multicast routing is disabled.
PIM Disabled on all interfaces
IGMP snooping Enabled on all VLAN interfaces
Note If you disable IGMP snooping on an interface, all output ports are
forwarded by the Integrated Switching Engine. When IGMP
snooping is disabled on an input VLAN interface, multicast packets
related to that interface are sent to all forwarding switchports in the
VLAN.
Note Source-specific multicast and IGMP v3 are supported.
For more information about source-specific multicast with IGMPv3 and IGMP, see the following URL:
http://www.cisco.com/en/US/docs/ios/ipmulti/configuration/guide/imc_cfg_ssm.html
Enabling IP Multicast Routing
Enabling IP multicast routing allows the Catalyst 4500 Series switch to forward multicast packets. To
enable IP multicast routing on the router, perform this task in global configuration mode:
Command Purpose
Switch(config)# ip multicast-routing Enables IP multicast routing.
Enabling PIM on an Interface
Enabling PIM on an interface also enables IGMP operation on that interface. An interface can be
configured to be in dense mode, sparse mode, or sparse-dense mode. The mode determines how the
Layer 3 switch or router populates its multicast routing table and how the Layer 3 switch or router
forwards multicast packets it receives from its directly connected LANs. You must enable PIM in one of
these modes for an interface to perform IP multicast routing.
When the switch populates the multicast routing table, dense-mode interfaces are always added to the
table. Sparse-mode interfaces are added to the table only when periodic join messages are received from
downstream routers, or when there is a directly connected member on the interface. When forwarding
from a LAN, sparse-mode operation occurs if there is an RP known for the group. If so, the packets are
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-13
Chapter 29 Configuring IP Multicast
Configuring IP Multicast Routing
encapsulated and sent toward the RP. When no RP is known, the packet is flooded in a dense-mode
fashion. If the multicast traffic from a specific source is sufficient, the receiver’s first-hop router can send
join messages toward the source to build a source-based distribution tree.
There is no default mode setting. By default, multicast routing is disabled on an interface.
Enabling Dense Mode
To configure PIM on an interface to be in dense mode, perform this task:
Command Purpose
Switch(config-if)# ip pim dense-mode Enables dense-mode PIM on the interface.
See the “PIM Dense Mode: Example” section at the end of this chapter for an example of how to
configure a PIM interface in dense mode.
Enabling Sparse Mode
To configure PIM on an interface to be in sparse mode, perform this task:
Command Purpose
Switch(config-if)# ip pim Enables sparse-mode PIM on the interface.
sparse-mode
See the “PIM Sparse Mode: Example” section at the end of this chapter for an example of how to
configure a PIM interface in sparse mode.
Enabling Sparse-Dense Mode
When you enter either the ip pim sparse-mode or ip pim dense-mode command, sparseness or
denseness is applied to the interface as a whole. However, some environments might require PIM to run
in a single region in sparse mode for some groups and in dense mode for other groups.
An alternative to enabling only dense mode or only sparse mode is to enable sparse-dense mode. In this
case, the interface is treated as dense mode if the group is in dense mode; the interface is treated in sparse
mode if the group is in sparse mode. If you want to treat the group as a sparse group, and the interface
is in sparse-dense mode, you must have an RP.
If you configure sparse-dense mode, the idea of sparseness or denseness is applied to the group on the
switch, and the network manager should apply the same concept throughout the network.
Another benefit of sparse-dense mode is that Auto-RP information can be distributed in a dense-mode
manner; yet, multicast groups for user groups can be used in a sparse-mode manner. Thus, there is no
need to configure a default RP at the leaf routers.
When an interface is treated in dense mode, it is populated in a multicast routing table’s outgoing
interface list when either of the following is true:
• When there are members or DVMRP neighbors on the interface
• When there are PIM neighbors and the group has not been pruned
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-14 OL-22250-01
Chapter 29 Configuring IP Multicast
Configuring IP Multicast Routing
When an interface is treated in sparse mode, it is populated in a multicast routing table’s outgoing
interface list when either of the following is true:
• When there are members or DVMRP neighbors on the interface
• When an explicit join has been received by a PIM neighbor on the interface
To enable PIM to operate in the same mode as the group, perform this task:
Command Purpose
Switch(config-if)# ip pim Enables PIM to operate in sparse or dense mode,
sparse-dense-mode depending on the group.
Enabling Bidirectional Mode
Most of the configuration requirements for Bidir-PIM are the same as those for configuring PIM-SM.
You need not enable or disable an interface for carrying traffic for multicast groups in bidirectional
mode. Instead, you configure which multicast groups you want to operate in bidirectional mode. Similar
to PIM-SM, you can perform this configuration with Auto-RP, static RP configurations, or the PIM
Version 2 bootstrap router (PIMv2 BSR) mechanism.
To enable bidir-PIM, use the following command in global configuration mode:
Command Purpose
Switch(config)# ip pim bidir-enable Enables bidir-PIM on a switch.
To configure Bidir-PIM, use the following commands in global configuration mode, depending on which
method you use to distribute group-to-RP mappings:
Command Purpose
Switch(config)# ip pim rp-address Configures the address of a PIM RP for a particular
rp-address [access-list] [override] group, and specifies bidirectional mode. Use this
bidir
command when you are not distributing group-to-RP
mappings using either Auto-RP or the PIMv2 BSR
mechanism
Switch(config)# ip pim rp-candidate Configures the router to advertise itself as a PIM
type number [group-list access-list] Version 2 candidate RP to the BSR, and specifies
bidir
bidirectional mode. Use this command when you are
using the PIMv2 BSR mechanism to distribute
group-to-RP mappings.
Switch(config)# ip pim send-rp-address Configures the router to use Auto-RP to configure for
type number scope ttl-value which groups the router is willing to act as RP, and
[group-list access-list] [interval
seconds] bidir
specifies bidirectional mode. Use this command when
you are using Auto-RP to distribute group-to-RP
mappings.
For an example of how to configure bidir-PIM, see the Bidirectional PIM Mode: Example, page 29-27
section.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-15
Chapter 29 Configuring IP Multicast
Configuring IP Multicast Routing
Enabling PIM-SSM Mapping
The Catalyst 4500 series switch supports SSM mapping, enabling an SSM transition in cases either
where neither URD nor IGMP v3-lite is available, or when supporting SSM on the end system is
impossible or unwanted due to administrative or technical reasons. With SSM mapping, you can leverage
SSM for video delivery to legacy set-top boxes (STBs) that do not support IGMPv3 or for applications
that do not take advantage of the IGMPv3 host stack.
For more details, refer to this URL:
http://www.cisco.com/en/US/docs/ios/12_3t/12_3t2/feature/guide/gtssmma.html
Configuring a Rendezvous Point
A rendezvous point (RP) is required in networks running Protocol Independent Multicast sparse mode
(PIM-SM). In PIM-SM, traffic will be forwarded only to network segments with active receivers that
have explicitly requested multicast data.
There are different ways to configure a Rendezvous Point. The most commonly used, described here, are
the usage of Static RP and the usage of the Auto-RP protocol. Another way, not described here, are the
use of the Bootstrap Router (BSR) protocol.
Configuring Auto-RP
Auto-rendezvous point (Auto-RP) automates the distribution of group-to-rendezvous point (RP)
mappings in a PIM network. To make Auto-RP work, a router must be designated as an RP mapping
agent, which receives the RP announcement messages from the RPs and arbitrates conflicts. The RP
mapping agent then sends the consistent group-to-RP mappings to all other routers by way of dense
mode flooding.
Thus, all routers automatically discover which RP to use for the groups they support. The Internet
Assigned Numbers Authority (IANA) has assigned two group addresses, 224.0.1.39 and 224.0.1.40, for
Auto-RP.
The mapping agent receives announcements of intention to become the RP from Candidate-RPs. The
mapping agent then announces the winner of the RP election. This announcement is made independently
of the decisions by the other mapping agents.
To configure Auto-RP, perform this task:
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
Step 2 Switch# configure terminal Enters global configuration mode.
Step 3 Switch(config)# ip multicast-routing Enables IP multicast routing.
Step 4 Switch(config)# interface [FastEthernet | Selects an interface that is connected to hosts on which PIM
GigabitEthernet | Loopback | Null | can be enabled.
Port-channel | TenGigabitEthernet | Tunnel |
Vlan] number
Step 5 Switch(config-if)# ip pim [sparse-mode | Enables PIM sparse or sparse-dense mode on an interface.
sparse-dense-mode] When configuring Auto-RP in sparse mode, you must also
configure the Auto-RP listener in the next step.
Step 6 Switch(config-if)# exit Returns to global configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-16 OL-22250-01
Chapter 29 Configuring IP Multicast
Configuring IP Multicast Routing
Command or Action Purpose
Step 7 Repeat Steps 4 and 5 on all PIM interfaces. —
Step 8 Switch(config)# ip pim autorp listener Causes IP multicast traffic for the two Auto-RP groups
224.0.1.39 and 224.0.1.40 to be PIM dense mode flooded
across interfaces operating in PIM sparse mode.
• Skip this step if you are configuring sparse-dense mode
in Step 8.
Step 9 Switch(config)# ip pim send-rp-announce Sends RP announcements out all PIM-enabled interfaces.
{interface-type interface-number | ip-address}
scope ttl-value [group-list access-list] • Perform this step on the RP router only.
[interval seconds] [bidir]
• Use the interface-type and interface-number arguments
to define which IP address is to be used as the RP
address.
• Use the ip-address argument to specify a directly
connected IP address as the RP address.
Note If the ip-address argument is configured for this
command, the RP-announce message will be
sourced by the interface to which this IP address is
connected (that is, the source address in the IP
header of the RP-announce message is the IP
address of that interface).
• This example shows that the interface is enabled with a
maximum of 31 hops. The IP address by which the
router wants to be identified as RP is the IP address
associated with loopback interface 0. Access list 5
describes the groups for which this router serves as RP.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-17
Chapter 29 Configuring IP Multicast
Configuring IP Multicast Routing
Command or Action Purpose
Step 10 Switch(config)# ip pim send-rp-discovery Configures the router to be an RP mapping agent.
[interface-type interface-number] scope
ttl-value [interval seconds] • Perform this step on the RP router only.
• Use the optional interface-type and interface-number
arguments to define which IP address is to be used as
the source address of the RP mapping agent.
• Use the scope keyword and ttl-value argument to
specify the Time-to-Live (TTL) value in the IP header
of Auto-RP discovery messages.
• Use the optional interval keyword and seconds
argument to specify the interval at which Auto-RP
discovery messages are sent.
Note Lowering the interval at which Auto-RP discovery
messages are sent from the default value of 60
seconds results in more frequent floodings of the
group-to-RP mappings. In some network
environments, the disadvantages of lowering the
interval (more control packet overhead) may
outweigh the advantages (more frequent
group-to-RP mapping updates).
• The example shows limiting the Auto-RP discovery
messages to 31 hops on loopback interface 1.
Step 11 Switch(config)# ip pim rp-announce-filter Filters incoming Auto-RP announcement messages coming
rp-list access-list group-list access-list from the RP.
• Perform this step on the RP router only.
• Two example access lists that apply to this step could
be:
access-list 1 permit 10.0.0.1
access-list 1 permit 10.0.0.2
access-list 2 permit 224.0.0.0 15.255.255.255
Step 12 Switch(config)# interface type number Selects an interface that is connected to hosts on which PIM
can be enabled.
Step 13 Switch(config-if)# interface ethernet 1 Configures an administratively scoped boundary.
ip multicast boundary access-list
[filter-autorp] • Perform this step on the interfaces that are boundaries
to other routers.
• The access list is not shown in this task.
• An access list entry that uses the deny keyword creates
a multicast boundary for packets that match that entry.
Step 14 Switch(config-if)# end Returns to EXEC mode.
Step 15 Switch# show ip pim autorp (Optional) Displays the Auto-RP information.
Step 16 Switch# show ip pim rp [mapping] [rp-address] (Optional) Displays RPs known in the network and shows
how the router learned about each RP.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-18 OL-22250-01
Chapter 29 Configuring IP Multicast
Configuring IP Multicast Routing
Command or Action Purpose
Step 17 Switch# show ip igmp groups [group-name | (Optional) Displays the multicast groups having receivers
group-address | interface-type that are directly connected to the router and that were
interface-number] [detail]
learned through Internet Group Management Protocol
(IGMP).
• A receiver must be active on the network at the time
that this command is issued in order for receiver
information to be present on the resulting display.
Step 18 Switch# show ip mroute [group-address | (Optional) Displays the contents of the IP multicast routing
group-name] [source-address | source-name] (mroute) table.
[interface-type interface-number] [summary]
[count] [active kbps]
This example illustrates how to configure Auto-RP:
Switch> enable
Switch# configure terminal
Switch(config)# ip multicast-routing
Switch(config)# interface ethernet 1
Switch(config-if)# ip pim sparse-mode
Switch(config-if)# end
Switch(config)# ip pim autorp listener
Switch(config)# ip pim send-rp-announce loopback0 scope 31 group-list 5
Switch(config)# ip pim send-rp-discovery loopback 1 scope 31
Switch(config)# ip pim rp-announce-filter rp-list 1 group-list 2
Switch(config)# interface ethernet 1
Switch(config-if)# ip multicast boundary 10 filter-autorp
Switch(config-if)# end
Switch# show ip pim autorp
Switch# show ip pim rp mapping
Switch# show ip igmp groups
Switch# show ip mroute cbone-audio
Configuring a Single Static RP
If you are configuring PIM sparse mode, you must configure a PIM RP for a multicast group. An RP can
either be configured statically in each device, or learned through a dynamic mechanism. This task
explains how to statically configure an RP, as opposed to the router learning the RP through a dynamic
mechanism such as Auto-RP.
PIM designated routers (DRs) forward data from directly connected multicast sources to the RP for
distribution down the shared tree. Data is forwarded to the RP in one of two ways. It is encapsulated in
register packets and unicast directly to the RP, or, if the RP has itself joined the source tree, it is multicast
forwarded per the RPF forwarding algorithm. Last hop routers directly connected to receivers may, at
their discretion, join themselves to the source tree and prune themselves from the shared tree.
A single RP can be configured for multiple groups that are defined by an access list. If no RP is
configured for a group, the router treats the group as dense using the PIM dense mode techniques. (You
can prevent this occurrence by configuring the no ip pim dm-fallback command.)
If a conflict exists between the RP configured with the ip pim rp-address command and one learned by
Auto-RP, the Auto-RP information is used, unless the override keyword is configured.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-19
Chapter 29 Configuring IP Multicast
Configuring IP Multicast Routing
To configure a single static RP, perform this step:
Command or Action Purpose
Step 1 Switch> enable Enables privileged EXEC mode.
Step 2 Switch# configure terminal Enters global configuration mode.
Step 3 Switch(config)# ip multicast-routing Enables IP multicast routing.
Step 4 Switch(config)# interface type number Selects an interface that is connected to hosts on which PIM
can be enabled.
Step 5 Switch(config-if)# ip pim [sparse-mode | Enables PIM on an interface. You must use sparse mode.
sparse-dense-mode]
Step 6 Repeat Steps 4 and 5 on every interface that uses IP —
multicast.
Step 7 Switch(config-if)# exit Returns to global configuration mode.
Step 8 Switch(config)# ip pim rp-address rp-address Configures the address of a PIM RP for a particular group.
[access-list] [override]
• Perform this step on any router.
• The access-list argument specifies the number or name
of an access list that defines for which multicast groups
the RP should be used.
• The override keyword specifies that if there is a
conflict between the RP configured with this command
and one learned by Auto-RP, the RP configured with
this command prevails.
Step 9 Switch(config)# end Ends the current configuration session and returns to EXEC
mode.
Step 10 Switch# show ip pim rp [mapping] [rp-address] (Optional) Displays RPs known in the network and shows
how the router learned about each RP.
Step 11 Switch# show ip igmp groups [group-name | (Optional) Displays the multicast groups having receivers
group-address | interface-type that are directly connected to the router and that were
interface-number] [detail]
learned through IGMP.
• A receiver must be active on the network at the time
that this command is issued in order for receiver
information to be present on the resulting display.
Step 12 Switch# show ip mroute [group-address | (Optional) Displays the contents of the IP multicast routing
group-name] [source-address | source-name] (mroute) table.
[interface-type interface-number] [summary]
[count] [active kbps]
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-20 OL-22250-01
Chapter 29 Configuring IP Multicast
Monitoring and Maintaining IP Multicast Routing
This example shows how to configure a single-static RP:
Switch> enable
Switch# configure terminal
Switch(config)# ip multicast-routing
Switch(config)# interface ethernet 1
Switch(config-if)# ip pim sparse-mode
Switch(config-if)# exit
Switch(config)# ip pim rp-address 192.168.0.0
Switch(config)# end
Switch# show ip pim rp mapping
Switch# show ip igmp groups
Switch# show ip mroute cbone-audio
Monitoring and Maintaining IP Multicast Routing
You can remove all contents of a particular cache, table, or database. You also can display specific
statistics. The following sections describe how to monitor and maintain IP multicast:
• Displaying System and Network Statistics, page 29-21
• Displaying the Multicast Routing Table, page 29-22
• Displaying IP MFIB, page 29-24
• Displaying Bidirectional PIM Information, page 29-25
• Displaying PIM Statistics, page 29-25
• Clearing Tables and Databases, page 29-26
Displaying System and Network Statistics
You can display specific statistics, such as the contents of IP routing tables and databases. Information
provided can be used to determine resource utilization and solve network problems. You can also display
information about node reachability and discover the routing path your device’s packets are taking
through the network.
To display various routing statistics, you can perform any of these tasks:
Command Purpose
Switch# ping [group-name | group-address] Sends an ICMP Echo Request to a multicast
group address.
Switch# show ip mroute [hostname | Displays the contents of the IP multicast routing
group_number] table.
Switch# show ip pim interface [type number] Displays information about interfaces configured
[count] for PIM.
Switch# show ip interface Displays PIM information for all interfaces.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-21
Chapter 29 Configuring IP Multicast
Monitoring and Maintaining IP Multicast Routing
Displaying the Multicast Routing Table
The following is sample output from the show ip mroute command for a router operating in dense mode.
This command displays the contents of the IP multicast FIB table for the multicast group named
cbone-audio.
Switch# show ip mroute cbone-audio
IP Multicast Routing Table
Flags: D - Dense, S - Sparse, C - Connected, L - Local, P - Pruned
R - RP-bit set, F - Register flag, T - SPT-bit set
Timers: Uptime/Expires
Interface state: Interface, Next-Hop, State/Mode
(*, 224.0.255.1), uptime 0:57:31, expires 0:02:59, RP is 0.0.0.0, flags: DC
Incoming interface: Null, RPF neighbor 0.0.0.0, Dvmrp
Outgoing interface list:
Ethernet0, Forward/Dense, 0:57:31/0:02:52
Tunnel0, Forward/Dense, 0:56:55/0:01:28
(198.92.37.100/32, 224.0.255.1), uptime 20:20:00, expires 0:02:55, flags: C
Incoming interface: Tunnel0, RPF neighbor 10.20.37.33, Dvmrp
Outgoing interface list:
Ethernet0, Forward/Dense, 20:20:00/0:02:52
The following is sample output from the show ip mroute command for a router operating in sparse
mode:
Switch# show ip mroute
IP Multicast Routing Table
Flags: D - Dense, S - Sparse, C - Connected, L - Local, P - Pruned
R - RP-bit set, F - Register flag, T - SPT-bit set
Timers: Uptime/Expires
Interface state: Interface, Next-Hop, State/Mode
(*, 224.0.255.3), uptime 5:29:15, RP is 198.92.37.2, flags: SC
Incoming interface: Tunnel0, RPF neighbor 10.3.35.1, Dvmrp
Outgoing interface list:
Ethernet0, Forward/Sparse, 5:29:15/0:02:57
(198.92.46.0/24, 224.0.255.3), uptime 5:29:15, expires 0:02:59, flags: C
Incoming interface: Tunnel0, RPF neighbor 10.3.35.1
Outgoing interface list:
Ethernet0, Forward/Sparse, 5:29:15/0:02:57
Note Interface timers are not updated for hardware-forwarded packets. Entry timers are updated
approximately every five seconds.
The following is sample output from the show ip mroute command with the summary keyword:
Switch# show ip mroute summary
IP Multicast Routing Table
Flags: D - Dense, S - Sparse, C - Connected, L - Local, P - Pruned
R - RP-bit set, F - Register flag, T - SPT-bit set, J - Join SPT
Timers: Uptime/Expires
Interface state: Interface, Next-Hop, State/Mode
(*, 224.255.255.255), 2d16h/00:02:30, RP 171.69.10.13, flags: SJPC
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-22 OL-22250-01
Chapter 29 Configuring IP Multicast
Monitoring and Maintaining IP Multicast Routing
(*, 224.2.127.253), 00:58:18/00:02:00, RP 171.69.10.13, flags: SJC
(*, 224.1.127.255), 00:58:21/00:02:03, RP 171.69.10.13, flags: SJC
(*, 224.2.127.254), 2d16h/00:00:00, RP 171.69.10.13, flags: SJCL
(128.9.160.67/32, 224.2.127.254), 00:02:46/00:00:12, flags: CLJT
(129.48.244.217/32, 224.2.127.254), 00:02:15/00:00:40, flags: CLJT
(130.207.8.33/32, 224.2.127.254), 00:00:25/00:02:32, flags: CLJT
(131.243.2.62/32, 224.2.127.254), 00:00:51/00:02:03, flags: CLJT
(140.173.8.3/32, 224.2.127.254), 00:00:26/00:02:33, flags: CLJT
(171.69.60.189/32, 224.2.127.254), 00:03:47/00:00:46, flags: CLJT
The following is sample output from the show ip mroute command with the active keyword:
Switch# show ip mroute active
Active IP Multicast Sources - sending >= 4 kbps
Group: 224.2.127.254, (sdr.cisco.com)
Source: 146.137.28.69 (mbone.ipd.anl.gov)
Rate: 1 pps/4 kbps(1sec), 4 kbps(last 1 secs), 4 kbps(life avg)
Group: 224.2.201.241, ACM 97
Source: 130.129.52.160 (webcast3-e1.acm97.interop.net)
Rate: 9 pps/93 kbps(1sec), 145 kbps(last 20 secs), 85 kbps(life avg)
Group: 224.2.207.215, ACM 97
Source: 130.129.52.160 (webcast3-e1.acm97.interop.net)
Rate: 3 pps/31 kbps(1sec), 63 kbps(last 19 secs), 65 kbps(life avg)
The following is sample output from the show ip mroute command with the count keyword:
Switch# show ip mroute count
IP Multicast Statistics - Group count: 8, Average sources per group: 9.87
Counts: Pkt Count/Pkts per second/Avg Pkt Size/Kilobits per second
Group: 224.255.255.255, Source count: 0, Group pkt count: 0
RP-tree: 0/0/0/0
Group: 224.2.127.253, Source count: 0, Group pkt count: 0
RP-tree: 0/0/0/0
Group: 224.1.127.255, Source count: 0, Group pkt count: 0
RP-tree: 0/0/0/0
Group: 224.2.127.254, Source count: 9, Group pkt count: 14
RP-tree: 0/0/0/0
Source: 128.2.6.9/32, 2/0/796/0
Source: 128.32.131.87/32, 1/0/616/0
Source: 128.125.51.58/32, 1/0/412/0
Source: 130.207.8.33/32, 1/0/936/0
Source: 131.243.2.62/32, 1/0/750/0
Source: 140.173.8.3/32, 1/0/660/0
Source: 146.137.28.69/32, 1/0/584/0
Source: 171.69.60.189/32, 4/0/447/0
Source: 204.162.119.8/32, 2/0/834/0
Group: 224.0.1.40, Source count: 1, Group pkt count: 3606
RP-tree: 0/0/0/0
Source: 171.69.214.50/32, 3606/0/48/0, RPF Failed: 1203
Group: 224.2.201.241, Source count: 36, Group pkt count: 54152
RP-tree: 7/0/108/0
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-23
Chapter 29 Configuring IP Multicast
Monitoring and Maintaining IP Multicast Routing
Source: 13.242.36.83/32, 99/0/123/0
Source: 36.29.1.3/32, 71/0/110/0
Source: 128.9.160.96/32, 505/1/106/0
Source: 128.32.163.170/32, 661/1/88/0
Source: 128.115.31.26/32, 192/0/118/0
Source: 128.146.111.45/32, 500/0/87/0
Source: 128.183.33.134/32, 248/0/119/0
Source: 128.195.7.62/32, 527/0/118/0
Source: 128.223.32.25/32, 554/0/105/0
Source: 128.223.32.151/32, 551/1/125/0
Source: 128.223.156.117/32, 535/1/114/0
Source: 128.223.225.21/32, 582/0/114/0
Source: 129.89.142.50/32, 78/0/127/0
Source: 129.99.50.14/32, 526/0/118/0
Source: 130.129.0.13/32, 522/0/95/0
Source: 130.129.52.160/32, 40839/16/920/161
Source: 130.129.52.161/32, 476/0/97/0
Source: 130.221.224.10/32, 456/0/113/0
Source: 132.146.32.108/32, 9/1/112/0
Note Multicast route byte and packet statistics are supported only for the first 1024 multicast routes. Output
interface statistics are not maintained.
Displaying IP MFIB
You can display all routes in the MFIB, including routes that might not exist directly in the upper-layer
routing protocol database but that are used to accelerate fast switching. These routes appear in the MFIB,
even if dense-mode forwarding is in use.
To display various MFIB routing routes, perform one of these tasks:
Command Purpose
Switch# show ip mfib Displays the (S,G) and (*,G) routes that are used for packet
forwarding. Displays counts for fast, slow, and
partially-switched packets for every multicast route.
Switch# show ip mfib all Displays all routes in the MFIB, including routes that may
not exist directly in the upper-layer routing protocol
database, but that are used to accelerate fast
switching.These routes include the (S/M,224/4) routes.
Switch# show ip mfib log [n] Displays a log of the most recent n MFIB related events,
most recent first.
Switch# show ip mfib counters Displays counts of MFIB related events. Only non-zero
counters are shown.
The following is sample output from the show ip mfib command.
IP Multicast Forwarding Information Base
Entry Flags: C - Directly Connected, S - Signal,
IC - Internal Copy
Interface Flags: A - Accept, F - Forward, S - Signal,
NP - Not platform switched
Packets: Fast/Partial/Slow Bytes: Fast/Partial/Slow:
(171.69.10.13, 224.0.1.40), flags (IC)
Packets: 2292/2292/0, Bytes: 518803/0/518803
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-24 OL-22250-01
Chapter 29 Configuring IP Multicast
Monitoring and Maintaining IP Multicast Routing
Vlan7 (A)
Vlan100 (F NS)
Vlan105 (F NS)
(*, 224.0.1.60), flags ()
Packets: 2292/0/0, Bytes: 518803/0/0
Vlan7 (A NS)
(*, 224.0.1.75), flags ()
Vlan7 (A NS)
(10.34.2.92, 239.192.128.80), flags ()
Packets: 24579/100/0, 2113788/15000/0 bytes
Vlan7 (F NS)
Vlan100 (A)
(*, 239.193.100.70), flags ()
Packets: 1/0/0, 1500/0/0 bytes
Vlan7 (A)
..
The fast-switched packet count represents the number of packets that were switched in hardware on the
corresponding route.
The partially switched packet counter represents the number of times that a fast-switched packet was
also copied to the CPU for software processing or for forwarding to one or more non-platform switched
interfaces (such as a PimTunnel interface).
The slow-switched packet count represents the number of packets that were switched completely in
software on the corresponding route.
Displaying Bidirectional PIM Information
To display Bidir-PIM information, use the following commands, as needed:
Command Purpose
Switch(config)# show ip pim interface Displays information about the elected DF for each RP
[type number] [df | count] of an interface, along with the unicast routing metric
[rp-address]
associated with the DF.
Switch(config)# show ip pim rp Displays information about configured RPs, learned
[mapping | metric] [rp-address] via Auto-RP or BSR, along with their unicast routing
metric.
Displaying PIM Statistics
The following is sample output from the show ip pim interface command:
Switch# show ip pim interface
Address Interface Mode Neighbor Query DR
Count Interval
198.92.37.6 Ethernet0 Dense 2 30 198.92.37.33
198.92.36.129 Ethernet1 Dense 2 30 198.92.36.131
10.1.37.2 Tunnel0 Dense 1 30 0.0.0.0
The following is sample output from the show ip pim interface command with a count:
Switch# show ip pim interface count
Address Interface FS Mpackets In/Out
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-25
Chapter 29 Configuring IP Multicast
Configuration Examples
171.69.121.35 Ethernet0 * 548305239/13744856
171.69.121.35 Serial0.33 * 8256/67052912
198.92.12.73 Serial0.1719 * 219444/862191
The following is sample output from the show ip pim interface command with a count when IP
multicast is enabled. The example lists the PIM interfaces that are fast-switched and process-switched,
and the packet counts for these. The H is added to interfaces where IP multicast is enabled.
Switch# show ip pim interface count
States: FS - Fast Switched, H - Hardware Switched
Address Interface FS Mpackets In/Out
192.1.10.2 Vlan10 * H 40886/0
192.1.11.2 Vlan11 * H 0/40554
192.1.12.2 Vlan12 * H 0/40554
192.1.23.2 Vlan23 * 0/0
192.1.24.2 Vlan24 * 0/0
Clearing Tables and Databases
You can remove all contents of a particular cache, table, or database. Clearing a cache, table, or database
might be necessary when the contents of the particular structure have become, or are suspected to be,
invalid.
To clear IP multicast caches, tables, and databases, perform one of these tasks:
Command Purpose
Switch# clear ip mroute Deletes entries from the IP routing table.
Switch# clear ip mfib counters Deletes all per-route and global MFIB counters.
Note IP multicast routes can be regenerated in response to protocol events and as data packets arrive.
Configuration Examples
The following sections provide IP multicast routing configuration examples:
• PIM Dense Mode: Example, page 29-26
• PIM Sparse Mode: Example, page 29-27
• Bidirectional PIM Mode: Example, page 29-27
• Sparse Mode with a Single Static RP: Example, page 29-27
• Sparse Mode with Auto-RP: Example, page 29-28
PIM Dense Mode: Example
This example is a configuration of dense-mode PIM on an Ethernet interface:
ip multicast-routing
interface ethernet 0
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-26 OL-22250-01
Chapter 29 Configuring IP Multicast
Configuration Examples
ip pim dense-mode
PIM Sparse Mode: Example
This example is a configuration of sparse-mode PIM. The RP router is the router with the address
10.8.0.20.
ip multicast-routing
ip pim rp-address 10.8.0.20 1
interface ethernet 1
ip pim sparse-mode
Bidirectional PIM Mode: Example
By default a bidirectional RP advertises all groups as bidirectional. You can use an access list on the RP
to specify a list of groups to be advertised as bidirectional. Groups with the deny keyword will operate
in dense mode. A different, nonbidirectional RP address, is required for groups that operate in sparse
mode, because a single access list only allows either a permit or deny keyword.
The following example shows how to configure an RP for both sparse and bidirectional mode groups.
224/8 and 227/8 are bidirectional groups, 226/8 is sparse mode, and 225/8 is dense mode. The RP must
be configured to use different IP addresses for sparse and bidirectional mode operations. Two loopback
interfaces are used to allow this configuration and the addresses of these interfaces must be routed
throughout the PIM domain so that the other routers in the PIM domain can receive Auto-RP
announcements and communicate with the RP:
ip multicast-routing !Enable IP multicast routing
ip pim bidir-enable !Enable bidir-PIM
!
interface loopback 0
description One Loopback adddress for this routers Bidir Mode RP function
ip address 10.0.1.1 255.255.255.0
ip pim sparse-dense-mode
!
interface loopback 1
description One Loopback adddress for this routers Sparse Mode RP function
ip address 10.0.2.1 255.255.255.0
ip pim sparse-dense-mode
ip pim send-rp-announce Loopback0 scope 10 group-list 45 bidir
ip pim send-rp-announce Loopback1 scope 10 group-list 46
ip pim send-rp-discovery scope 10
access-list 45 permit 224.0.0.0 0.255.255.255
access-list 45 permit 227.0.0.0 0.255.255.255
access-list 45 deny 225.0.0.0 0.255.255.255
access-list 46 permit 226.0.0.0 0.255.255.255
Sparse Mode with a Single Static RP: Example
The following example sets the PIM RP address to 192.168.1.1 for all multicast groups and defines all
groups to operate in sparse mode:
ip multicast-routing
interface ethernet 1
ip pim sparse-mode
ip pim rp-address 192.168.1.1
no ip pim dm-fallback
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 29-27
Chapter 29 Configuring IP Multicast
Configuration Examples
Note The same RP cannot be used for both bidirectional and sparse mode groups.
The following example sets the PIM RP address to 172.16.1.1 for the multicast group 225.2.2.2 only:
access list 1 225.2.2.2 0.0.0.0
ip pim rp-address 172.17.1.1
Sparse Mode with Auto-RP: Example
The following example configures sparse mode with Auto-RP:
ip multicast-routing
ip pim autorp listener
ip pim send-rp-announce Loopback0 scope 16 group-list 1
ip pim send-rp-discovery Loopback1 scope 16
no ip pim dm-fallback
access-list 1 permit 239.254.2.0 0.0.0.255
access-list 1 permit 239.254.3.0 0.0.0.255
.
.
.
access-list 10 permit 224.0.1.39
access-list 10 permit 224.0.1.40
access-list 10 permit 239.254.2.0 0.0.0.255
access-list 10 permit 239.254.3.0 0.0.0.255
Software Configuration Guide—Release IOS-XE 3.1.0 SG
29-28 OL-22250-01
CH A P T E R 30
Configuring Policy-Based Routing
This chapter describes the tasks for configuring policy-based routing (PBR) on a Catalyst 4500 series
switch and includes these major sections:
• Overview of Policy-Based Routing, page 30-1
• Policy-Based Routing Configuration Task List, page 30-6
• Policy-Based Routing Configuration Examples, page 30-8
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Note To identify the hardware platform or software image information associated with a feature, use the
Feature Navigator on Cisco.com to search for information about the feature or refer to the software
release notes for a specific release.
Overview of Policy-Based Routing
This section contains the following subsections:
• About PBR, page 30-2
• Using Policy-Based Routing, page 30-5
PBR gives you a flexible method of routing packets by allowing you to define policies for traffic flows,
lessening reliance on routes derived from routing protocols. To this end, PBR gives you more control
over routing by extending and complementing the existing mechanisms provided by routing protocols.
PBR allows you to specify paths for certain traffic, such as priority traffic over a high-cost link.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 30-1
Chapter 30 Configuring Policy-Based Routing
Overview of Policy-Based Routing
You can set up PBR as a way to route packets based on configured policies. For example, you can
implement routing policies to allow or deny paths based on the identity of a particular end system, or an
application protocol.
PBR allows you to perform the following tasks:
• Classify traffic based on extended access list criteria.
• Route packets to specific traffic-engineered paths.
Policies can be based on IP address, port numbers, or protocols. For a simple policy, use any one of these
descriptors; for a complicated policy, use all of them.
About PBR
All packets received on an interface with PBR enabled are passed through enhanced packet filters known
as route maps. The route maps used by PBR dictate the policy, determining to where the packets are
forwarded.
Route maps are composed of statements. The route map statements can be marked as permit or deny,
and they are interpreted in the following ways:
• If a statement is marked as deny, the packets meeting the match criteria are sent back through the
normal forwarding channels and destination-based routing is performed.
• If the statement is marked as permit and a packet matches the access-lists, then the first valid set
clause is applied to that packet.
This is explained in more detail in the section Understanding Route-Maps, page 30-2.
You specify PBR on the incoming interface (the interface on which packets are received), not outgoing
interface.
Understanding Route-Maps
PBR is implemented by applying a route-map on an incoming interface. A given interface can have only
one route-map configured.
A route-map is configured at the global configuration parser mode. You can then apply this route-map
on one or more interfaces (in the interface configuration parser sub-mode).
A route-map is comprised of one or more route-map statements. Each statement has a sequence number,
as well as a permit or deny clause.
Each route-map statement contains match and set commands. The match command denotes the match
criteria to be applied on the packet data. The set command denote the PBR action to be taken on the
packet.
The following example shows a single route-map called rm-test and six route-map statements:
route-map rm-test permit 21
match ip address 101
set ip next-hop 21.1.1.1
!
route-map rm-test permit 22
match ip address 102
set ip next-hop 22.2.2.1
!
route-map rm-test permit 23
match ip address 101 2102
set interface vlan23
Software Configuration Guide—Release IOS-XE 3.1.0 SG
30-2 OL-22250-01
Chapter 30 Configuring Policy-Based Routing
Overview of Policy-Based Routing
!
route-map rm-test deny 24
match ip address 104
set ip next-hop 24.4.4.1
!
route-map rm-test deny 25
match ip address 105
set ip next-hop 25.5.5.1
!
route-map rm-test permit 26
match ip address 2104
set ip next-hop 26.6.6.1
The numbers 21, 22, ... 26 are the sequence numbers of the route-map statements.
The following topics are discussed:
• PBR Route-Map Processing Logic, page 30-3
• PBR Route-Map Processing Logic Example, page 30-4
PBR Route-Map Processing Logic
When a packet is received on an interface configured with a route-map, the forwarding logic processes
each route-map statement according to the sequence number.
If the route-map statement encountered is a route-map...permit statement:
• The packet is matched against the criteria in the match command. This command may refer to an
ACL that may itself have one or more permit and/or deny expressions. The packet is matched against
the expressions in the ACL, and a permit/deny decision is reached.
• If the decision reached is permit, then the PBR logic executes the action specified by the set
command on the packet.
• If the decision reached is deny, then the PBR action (specified in the set command) is not applied.
Instead the processing logic moves forward to look at the next route-map statement in the sequence
(the statement with the next higher sequence number). If no next statement exists, PBR processing
terminates, and the packet is routed using the default IP routing table.
If the route-map statement encountered is a route-map... deny statement:
• The packet is matched against the criteria given in the match command. This command may refer
to an ACL that may itself have one or more permit and/or deny expressions. The packet is matched
against the expressions in the ACL, and a permit/deny decision is reached.
• If the criteria decision is permit, then the PBR processing terminates, and the packet is routed using
the default IP routing table.
• If the criteria decision is deny, then the PBR processing logic moves forward to look at the next
route-map statement in the sequence (the statement with the next higher sequence number). If no
next statement exists, PBR processing terminates, and the packet is routed using the default IP
routing table.
Note The set command has no effect inside a route-map... deny statement.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 30-3
Chapter 30 Configuring Policy-Based Routing
Overview of Policy-Based Routing
PBR Route-Map Processing Logic Example
Consider a route-map called rm-test defined as follows:
access-list 101 permit tcp host 61.1.1.1 host 133.3.3.1 eq 101
access-list 102 deny tcp host 61.1.1.1 host 133.3.3.1 eq 102
access-list 2102 permit tcp host 61.1.1.1 host 133.3.3.1 eq 102
access-list 104 deny tcp host 61.1.1.1 host 133.3.3.1 eq 104
access-list 2104 permit tcp host 61.1.1.1 host 133.3.3.1 eq 104
access-list 105 permit tcp host 61.1.1.1 host 133.3.3.1 eq 105
route-map rm-test permit 21
match ip address 101
set ip next-hop 21.1.1.1
!
route-map rm-test permit 22
match ip address 102
set ip next-hop 22.2.2.1
!
route-map rm-test permit 23
match ip address 101 2102
set interface vlan23
!
route-map rm-test deny 24
match ip address 104
set ip next-hop 24.4.4.1
!
route-map rm-test deny 25
match ip address 105
set ip next-hop 25.5.5.1
!
route-map rm-test permit 26
match ip address 2104
set ip next-hop 26.6.6.1
• TCP packet from 61.1.1.1 to 133.3.3.1 with destination port 101
– Matches ACL 101 in sequence #21.
– PBR is switched through next-hop 21.1.1.1.
Note ACL 101 is also matched in sequence #23, but the processing doesn't reach that point
• TCP packet from 61.1.1.1 to 133.3.3.1 with destination port 102
– In sequence #21, the ACL 101 action denies this packet (because all ACLs have an implicit
deny). Processing advances to sequence #22.
– In sequence #22, ACL 102 matches TCP port 102, but the ACL action is deny. Processing
advances to sequence #23.
– In sequence #23, ACL 2102 matches TCP port 102, and the ACL action is permit.
– Packet is switched to output interface VLAN 23.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
30-4 OL-22250-01
Chapter 30 Configuring Policy-Based Routing
Overview of Policy-Based Routing
• TCP packet from 61.1.1.1 to 133.3.3.1 with destination port 105
– Processing moves from sequence #21 to #24, because all ACLs in these sequence numbers have
a deny action for port 105.
– In sequence #25, ACL 105 has a permit action for TCP port 105.
– The route-map deny takes effect, and the packet is routed using the default IP routing table.
Understanding PBR
The Catalyst 4500 Supervisor Engine 7-E supports matching route-map actions with a packet by
installing entries in the TCAM that match the set of packets described by the ACLs in the match criteria
of the route map. These TCAM entries point at adjacencies that either perform the necessary output
actions or forward the packet to software if either hardware does not support the action or its resources
are exhausted.
If the route-map specifies a set interface … action, packets that match the match statement are routed
in software. Similarly, if the route-map specifies a set default interface… action and there is no
matching IP route for the packet, the packet is routed in software.
The Catalyst 4500 Supervisor Engine 7-E supports hardware PBR switching only for set ip next-hop…
and set ip default next-hop actions.
Note The scale of hardware-based PBR is determined by TCAM size and the time required for the CPU to
flatten the ACL before programming into hardware. The latter will noticeably increase if a PBR policy
requires a considerable number of class-maps. For example, a PBR policy of 1,200 class-maps may
require 60-90 minutes of "flatten" time before programming into hardware. This process may repeat if
an adjacency change requires PBR reprogramming.
Using Policy-Based Routing
You can enable PBR to change the routing path of certain packets from the default path that would be
chosen by IP routing. For example, PBR can be used to provide the following functionality:
• equal access
• protocol-sensitive routing
• source-sensitive routing
• routing based on interactive versus batch traffic
• routing based on dedicated links
Some applications or traffic can benefit from source-specific routing; for example, you can transfer stock
records to a corporate office on a higher-bandwidth, higher-cost link for a short time while sending
routine application data, such as e-mail, over a lower-bandwidth, lower-cost link.
Note PBR configuration is only allowed on interfaces belonging to the global routing table. PBR is not
supported on interfaces that belong to VRFs.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 30-5
Chapter 30 Configuring Policy-Based Routing
Policy-Based Routing Configuration Task List
Policy-Based Routing Configuration Task List
To configure PBR, perform the tasks described in the following sections. The task in the first section is
required; the tasks in the remaining sections are optional. See the end of this chapter for the section
“Policy-Based Routing Configuration Examples.”
• Enabling PBR (Required)
• Enabling Local PBR (Optional)
Enabling PBR
To enable PBR, you must create a route map that specifies the match criteria and the resulting action if
all of the match clauses are met. Then you must apply that route-map on a particular interface. All
packets arriving on the specified interface matching the match clauses are subject to PBR.
To enable PBR on an interface, perform this task:
Command Purpose
Step 1 Switch(config)# route-map map-tag [permit | Defines a route map to control where packets are sent. This
deny] [sequence-number] command puts the switch into route-map configuration mode.
Step 2 Switch(config-route-map)# match ip address Specifies the match criteria. The match criteria take the form
{access-list-number | name} of one or more Standard or Extended IP access-lists. The
[...access-list-number | name]
access-lists can specify the source and destination IP
addresses, protocol types, and port numbers. See Chapter 42,
“Configuring Network Security with ACLs” for more
information on Standard and Extended IP access-lists.
Perform Step 3, 4, 5, or 6
Step 3 Switch(config-route-map)# set ip next-hop Specifies the next-hop IP address to which matching packets
ip-address [... ip-address] are sent. The next-hop IP address specified here must belong
to a subnet that is directly connected to this switch.
If more than one next-hop IP address is specified, the first
usable next-hop is chosen for routing matching packets. If the
Or next-hop is (or becomes) unavailable for some reason, the
next one in the list is chosen.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
30-6 OL-22250-01
Chapter 30 Configuring Policy-Based Routing
Policy-Based Routing Configuration Task List
Command Purpose
Step 4 Switch(config-route-map)# set interface Specifies the output interface from which the packet will be
interface-type interface-number sent. This action specifies that the packet is forwarded out of
[... type number]
the local interface. The interface must be a Layer 3 interface
(not a switchport).
Packets are forwarded on the specified interface only if one
Or of the following conditions is met:
• The destination IP address in the packet lies within the IP
subnet to which the specified interface belongs.
• The destination IP address in the packet is reachable
through the specified interface (as per the IP routing
table).
If the destination IP address on the packet does not meet
either of these conditions, the packet is dropped. This action
forces matching packets to be switched in software.
Step 5 Switch(config-route-map)# set ip default Sets next hop to which to route the packet if there is no
next-hop ip-address [... ip-address] explicit route for the destination IP address in the packet.
Before forwarding the packet to the next hop, the switch looks
up the packet’s destination address in the unicast routing
table. If a match is found, the packet is forwarded by way of
the routing table. If no match is found, the packet is forwarded
Or to the specified next hop.
Step 6 Switch(config-route-map)# set default Specifies the output interface from which the packet will be
interface interface-type interface-number sent if there is no explicit route for this destination. Before
[...type ...number]
forwarding the packet to the next hop, the switch looks up the
packet’s destination address in the unicast routing table. If a
match is found, the packet is forwarded via the routing table.
If no match is found, the packet is forwarded to the specified
output interface.
Packets are forwarded on the specified interface only if one
of the following conditions is met:
• The destination IP address in the packet lies within the IP
subnet to which the specified interface belongs.
• The destination IP address in the packet is reachable
through the specified interface (as per the IP routing
table).
If the destination IP address on the packet does not meet
either of these conditions, the packet is dropped. This action
forces matching packets to be switched in software.
Step 7 Switch(config-route-map)# interface Specifies the interface. This command puts the switch into
interface-type interface-number interface configuration mode.
Step 8 Switch(config-if)# ip policy route-map map-tag Identifies the route map to use for PBR. One interface can
only have one route map tag, but you can have multiple route
map entries with different sequence numbers. These entries
are evaluated in sequence number order until the first match.
If there is no match, packets are routed as usual.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 30-7
Chapter 30 Configuring Policy-Based Routing
Policy-Based Routing Configuration Examples
The set commands can be used in conjunction with each other. These commands are evaluated in the
order shown in Step 3 in the previous task table. A usable next hop implies an interface. Once the local
switch finds a next hop and a usable interface, it routes the packet.
Enabling Local PBR
Packets that are generated by the switch are not normally policy-routed. To enable local PBR for such
packets, indicate which route map the switch should use by performing this task:
Command Purpose
Switch(config)# ip local policy route-map map-tag Identifies the route map to use for local PBR.
All packets originating on the switch are then be subject to local PBR.
Use the show ip local policy command to display the route map used for local PBR, if one exists.
Unsupported Commands
The following PBR commands in config-route-map mode are in the CLI but not supported in Cisco IOS
for the switches. If you attempt to use these commands, an error message displays.
• match-length
• set ip qos
• set ip tos
• set ip precedence
Policy-Based Routing Configuration Examples
The following sections provide PBR configuration examples:
• Equal Access, page 30-8
• Differing Next Hops, page 30-9
• Deny ACE, page 30-9
For information on how to configure policy-based routing, see the section “Policy-Based Routing
Configuration Task List” in this chapter.
Equal Access
The following example provides two sources with equal access to two different service providers.
Packets arriving on interface fastethernet 3/1 from the source 1.1.1.1 are sent to the switch at 6.6.6.6 if
the switch has no explicit route for the destination of the packet. Packets arriving from the source 2.2.2.2
are sent to the switch at 7.7.7.7 if the switch has no explicit route for the destination of the packet. All
other packets for which the switch has no explicit route to the destination are discarded.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
30-8 OL-22250-01
Chapter 30 Configuring Policy-Based Routing
Policy-Based Routing Configuration Examples
Switch (config)# access-list 1 permit ip 1.1.1.1
access-list 1 permit ip 1.1.1.1
!
interface fastethernet 3/1
ip policy route-map equal-access
!
route-map equal-access permit 10
match ip address 1
set ip default next-hop 6.6.6.6
route-map equal-access permit 20
match ip address 2
set ip default next-hop 7.7.7.7
route-map equal-access permit 30
set default interface null0
Note If the packets you want to drop do not match either of the first two route-map clauses, then change |
set default interface null0 to set interface null0.
Differing Next Hops
The following example illustrates how to route traffic from different sources to different places (next
hops). Packets arriving from source 1.1.1.1 are sent to the next hop at 3.3.3.3; packets arriving from
source 2.2.2.2 are sent to the next hop at 3.3.3.5.
access-list 1 permit ip 1.1.1.1
access-list 2 permit ip 2.2.2.2
!
interface fastethernet 3/1
ip policy route-map Texas
!route-map Texas permit 10
match ip address 1
set ip next-hop 3.3.3.3
!route-map Texas permit 20
match ip address 2
set ip next-hop 3.3.3.5
Deny ACE
The following example illustrates how to stop processing a given route map sequence, and to jump to
the next sequence. Packets arriving from source 1.1.1.1 skip sequence 10 and jump to sequence 20. All
other packets from subnet 1.1.1.0 follow the set statement in sequence 10.
access-list 1 deny ip 1.1.1.1
access-list 1 permit ip 1.1.1.0 0.0.0.255
access-list 2 permit ip 1.1.1.1
access-list 2 permit ip 2.2.2.2
!
interface fastethernet 3/1
ip policy route-map Texas
!
route-map Texas permit 10
match ip address 1
set ip next-hop 3.3.3.3
!
route-map Texas permit 20
match ip address 2
set ip next-hop 3.3.3.5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 30-9
Chapter 30 Configuring Policy-Based Routing
Policy-Based Routing Configuration Examples
Software Configuration Guide—Release IOS-XE 3.1.0 SG
30-10 OL-22250-01
CH A P T E R 31
Configuring VRF-lite
Virtual Private Networks (VPNs) provide a secure way for customers to share bandwidth over an ISP
backbone network. A VPN is a collection of sites sharing a common routing table. A customer site is
connected to the service provider network by one or more interfaces, and the service provider associates
each interface with a VPN routing table. A VPN routing table is called a VPN routing/forwarding (VRF)
table.
With the VRF-lite feature, the Catalyst 4500 series switch supports multiple VPN routing/forwarding
instances in customer edge devices. (VRF-lite is also termed multi-VRF CE, or multi-VRF Customer
Edge Device). VRF-lite allows a service provider to support two or more VPNs with overlapping IP
addresses using one interface.
Note Starting with Cisco IOS Release 12.2(52)SG, the Catalyst 4500 switch supports VRF lite NSF support
with routing protocols OSPF/EIGRP/BGP.
Note The switch does not use Multiprotocol Label Switching (MPLS) to support VPNs. For information about
MPLS VRF, refer to the Cisco IOS Switching Services Configuration Guide at:
http://www.cisco.com/en/US/docs/ios/mpls/configuration/guide/mp_vpn_ipv4_ipv6_ps6922_TSD_Pro
ducts_Configuration_Guide_Chapter.html
This chapter includes these topics:
• VRF-lite Overview, page 31-2
• Default VRF-lite Configuration, page 31-3
• VRF-lite Configuration Guidelines, page 31-4
• Configuring VRFs, page 31-5
• Configuring VRF-Aware Services, page 31-6
• Configuring Multicast VRFs, page 31-10
• Configuring a VPN Routing Session, page 31-11
• Configuring BGP PE to CE Routing Sessions, page 31-11
• VRF-lite Configuration Example, page 31-12
• Displaying VRF-lite Status, page 31-17
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 31-1
Chapter 31 Configuring VRF-lite
VRF-lite Overview
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
VRF-lite Overview
VRF-lite is a feature that enables a service provider to support two or more VPNs, where IP addresses
can be overlapped among the VPNs. VRF-lite uses input interfaces to distinguish routes for different
VPNs and forms virtual packet-forwarding tables by associating one or more Layer 3 interfaces with
each VRF. Interfaces in a VRF can be either physical, such as Ethernet ports, or logical, such as VLAN
SVIs, but a Layer 3 interface cannot belong to more than one VRF at any time.
Note VRF-lite interfaces must be Layer 3 interfaces.
VRF-lite includes these devices:
• Customer edge (CE) devices provide customer access to the service provider network over a data
link to one or more provider edge routers. The CE device advertises the site’s local routes to the
provider edge router and learns the remote VPN routes from it. A Catalyst 4500 series switch can
be a CE.
• Provider edge (PE) routers exchange routing information with CE devices by using static routing or
a routing protocol such as BGP, RIPv1, or RIPv2.
• The PE is only required to maintain VPN routes for those VPNs to which it is directly attached,
eliminating the need for the PE to maintain all of the service provider VPN routes. Each PE router
maintains a VRF for each of its directly connected sites. Multiple interfaces on a PE router can be
associated with a single VRF if all of these sites participate in the same VPN. Each VPN is mapped
to a specified VRF. After learning local VPN routes from CEs, a PE router exchanges VPN routing
information with other PE routers by using internal BGP (iBPG).
• Provider routers (or core routers) are any routers in the service provider network that do not attach
to CE devices.
With VRF-lite, multiple customers can share one CE, and only one physical link is used between the CE
and the PE. The shared CE maintains separate VRF tables for each customer and switches or routes
packets for each customer based on its own routing table. VRF-lite extends limited PE functionality to
a CE device, giving it the ability to maintain separate VRF tables to extend the privacy and security of
a VPN to the branch office.
Figure 31-1 shows a configuration where each Catalyst 4500 series switch acts as multiple virtual CEs.
Because VRF-lite is a Layer 3 feature, each interface in a VRF must be a Layer 3 interface.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
31-2 OL-22250-01
Chapter 31 Configuring VRF-lite
Default VRF-lite Configuration
Figure 31-1 Catalyst 4500 Series Switches Acting as Multiple Virtual CEs
VPN 1 VPN 1
CE PE PE CE
Catalyst 4500 MPLS Catalyst 4500
Si Si
switch network switch
MPLS-VRF MPLS-VRF
router router
VPN 2 VPN 2
99721
CE = Customer edge device
PE = Provider edge router
This is the packet-forwarding process in a VRF-lite CE-enabled network as shown in Figure 31-1:
• When the CE receives a packet from a VPN, it looks up the routing table based on the input interface.
When a route is found, the CE forwards the packet to the PE.
• When the ingress PE receives a packet from the CE, it performs a VRF lookup. When a route is
found, the router adds a corresponding MPLS label to the packet and sends it to the MPLS network.
• When an egress PE receives a packet from the network, it strips the label and uses the label to
identify the correct VPN routing table. Then the egress PE performs the normal route lookup. When
a route is found, it forwards the packet to the correct adjacency.
• When a CE receives a packet from an egress PE, it uses the input interface to look up the correct
VPN routing table. If a route is found, the CE forwards the packet within the VPN.
To configure VRF, create a VRF table and specify the Layer 3 interface associated with the VRF. Then
configure the routing protocols in the VPN and between the CE and the PE. BGP is the preferred routing
protocol used to distribute VPN routing information across the provider’s backbone. The VRF-lite
network has three major components:
• VPN route target communities—Lists of all other members of a VPN community. You need to
configure VPN route targets for each VPN community member.
• Multiprotocol BGP peering of VPN community PE routers—Propagates VRF reachability
information to all members of a VPN community. You need to configure BGP peering in all PE
routers within a VPN community.
• VPN forwarding—Transports all traffic between all VPN community members across a VPN
service-provider network.
Default VRF-lite Configuration
Table 31-1 shows the default VRF configuration.
Table 31-1 Default VRF Configuration
Feature Default Setting
VRF Disabled. No VRFs are defined.
Maps No import maps, export maps, or route maps are defined.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 31-3
Chapter 31 Configuring VRF-lite
VRF-lite Configuration Guidelines
Table 31-1 Default VRF Configuration (continued)
Feature Default Setting
VRF maximum routes None.
Forwarding table The default for an interface is the global routing table.
VRF-lite Configuration Guidelines
Consider these points when configuring VRF in your network:
• A switch with VRF-lite is shared by multiple customers, and all customers have their own routing
tables.
• Because customers use different VRF tables, the same IP addresses can be reused. Overlapped IP
addresses are allowed in different VPNs.
• VRF-lite lets multiple customers share the same physical link between the PE and the CE. Trunk
ports with multiple VLANs separate packets among customers. All customers have their own
VLANs.
• VRF-lite does not support all MPLS-VRF functionality: label exchange, LDP adjacency, or labeled
packets.
• For the PE router, there is no difference between using VRF-lite or using multiple CEs. In
Figure 31-1, multiple virtual Layer 3 interfaces are connected to the VRF-lite device.
• The Catalyst 4500 series switch supports configuring VRF by using physical ports, VLAN SVIs, or
a combination of both. The SVIs can be connected through an access port or a trunk port.
• A customer can use multiple VLANs as long as they do not overlap with those of other customers.
A customer’s VLANs are mapped to a specific routing table ID that is used to identify the
appropriate routing tables stored on the switch.
• The Layer 3 TCAM resource is shared between all VRFs. To ensure that any one VRF has sufficient
CAM space, use the maximum routes command.
• A Catalyst 4500 series switch using VRF can support one global network and up to 64 VRFs. The
total number of routes supported is limited by the size of the TCAM.
• Most routing protocols (BGP, OSPF, EIGRP, RIP and static routing) can be used between the CE
and the PE. However, we recommend using external BGP (EBGP) for these reasons:
– BGP does not require multiple algorithms to communicate with multiple CEs.
– BGP is designed for passing routing information between systems run by different
administrations.
– BGP makes it easy to pass attributes of the routes to the CE.
• VRF-lite does not support IGRP and ISIS.
• VRF-lite does not affect the packet switching rate.
• Starting with Cisco IOS Release 12.2(50)SG, Multicast and VRF can be configured together on a
Layer 3 interface.
• The Catalyst 4500 series switch supports all the PIM protocols (PIM-SM, PIM-DM, PIM-SSM, PIM
BiDIR).
• IPv4 Multicast VRF, not IPv6 Multicast VRF, is supported on Supervisor Engine 7-E.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
31-4 OL-22250-01
Chapter 31 Configuring VRF-lite
Configuring VRFs
• The capability vrf-lite subcommand under router ospf should be used when configuring OSPF as
the routing protocol between the PE and the CE.
Configuring VRFs
To configure one or more VRFs, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ip routing Enables IP routing.
Step 3 Switch(config)# ip vrf vrf-name Names the VRF, and enter VRF configuration mode.
Step 4 Switch(config-vrf)# rd Creates a VRF table by specifying a route distinguisher.
route-distinguisher
Enter either an AS number and an arbitrary number
(xxx:y) or an IP address and arbitrary number
(A.B.C.D:y).
Step 5 Switch(config-vrf)# route-target Creates a list of import, export, or import and export route
{export | import | both}
route-target-ext-community
target communities for the specified VRF. Enter either an
AS system number and an arbitrary number (xxx:y) or an
IP address and an arbitrary number (A.B.C.D:y).
Note This command is effective only if BGP is running.
Step 6 Switch(config-vrf)# import map (Optional) Associates a route map with the VRF.
route-map
Step 7 Switch(config-vrf)# interface Enters interface configuration mode and specify the Layer
interface-id
3 interface to be associated with the VRF. The interface
can be a routed port or SVI.
Step 8 Switch(config-if)# ip vrf forwarding Associates the VRF with the Layer 3 interface.
vrf-name
Step 9 Switch(config-if)# end Returns to privileged EXEC mode.
Step 10 Switch# show ip vrf [brief | detail | Verifies the configuration. Display information about the
interfaces] [vrf-name]
configured VRFs.
Step 11 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Note For complete syntax and usage information for the following commands, see the switch command
reference for this release and see the Cisco IOS Switching Services Command Reference at:
http://www.cisco.com/en/US/docs/ios/ipswitch/command/reference/isw_book.html
Use the no ip vrf vrf-name global configuration command to delete a VRF and to remove all interfaces
from it. Use the no ip vrf forwarding interface configuration command to remove an interface from the
VRF.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 31-5
Chapter 31 Configuring VRF-lite
Configuring VRF-Aware Services
Configuring VRF-Aware Services
IP services can be configured on global interfaces, and these services run within the global routing
instance. IP services are enhanced to run on multiple routing instances; they are VRF-aware. Any
configured VRF in the system can be specified for a VRF-aware service.
VRF-Aware services are implemented in platform-independent modules. VRF means multiple routing
instances in Cisco IOS. Each platform has its own limit on the number of VRFs it supports.
VRF-aware services have the following characteristics:
• The user can ping a host in a user-specified VRF.
• ARP entries are learned in separate VRFs. The user can display Address Resolution Protocol (ARP)
entries for specific VRFs.
These services are VRF-Aware:
• ARP
• Ping
• Simple Network Management Protocol (SNMP)
• Unicast Reverse Path Forwarding (uRPF)
• Syslog
• Traceroute
• FTP and TFTP
• Telnet and SSH
• NTP
Note For complete syntax and usage information for the following commands, see the switch command
reference for this release and see the Cisco IOS Switching Services Command Reference at:
http://www.cisco.com/en/US/docs/ios/ipswitch/command/reference/isw_book.html
User Interface for ARP
To configure VRF-aware ARP, follow these steps.
Command Purpose
Switch(config)# arp vrf vrf-name Create a static arp entry in the specified VRF.
<ip-address> mac-address> ARPA
Switch# show ip arp vrf vrf-name Displays the ARP table (static and dynamic entries) in the specified
VRF.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
31-6 OL-22250-01
Chapter 31 Configuring VRF-lite
Configuring VRF-Aware Services
User Interface for PING
To perform a VRF-aware ping, enter the following command:
Command Purpose
Switch# ping vrf vrf-name ip-host Ping an IP host or address in the specified VRF.
User Interface for SNMP
To configure VRF-aware services for SNMP, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# snmp-server trap Enables SNMP traps for packets on a VRF.
authentication vrf
Step 3 Switch(config)# snmp-server engineID Configures a name for the remote SNMP engine on a switch.
remote host vrf vpn-instance
engine-id string
Step 4 Switch(config)# snmp-server host Specifies the recipient of an SNMP trap operation and specify the VRF
host vrf vpn-instance traps table to be used for sending SNMP traps.
community
Step 5 Switch(config)# snmp-server host Specifies the recipient of an SNMP inform operation and specify the
host vrf vpn-instance informs VRF table to be used for sending SNMP informs.
community
Step 6 Switch(config)# snmp-server user Adds a user to an SNMP group for a remote host on a VRF for SNMP
user group remote host vrf vpn- access.
instance security model
Step 7 Switch(config)# end Returns to privileged EXEC mode.
User Interface for uRPF
You can configure uRPF on an interface assigned to a VRF. Source lookup is performed in the VRF table.
To configure VRF-aware services for uRPF, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode, and specify the Layer 3 interface
interface-id to configure.
Step 3 Switch(config-if)# no switchport Removes the interface from Layer 2 configuration mode if it is a
physical interface.
Step 4 Switch(config-if)# ip vrf forwarding Configures VRF on the interface.
vrf-name
Step 5 Switch(config-if-vrf)# ip address Enters the IP address for the interface.
ip-address subnet-mask
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 31-7
Chapter 31 Configuring VRF-lite
Configuring VRF-Aware Services
Command Purpose
Step 6 Switch(config-if-vrf)# ip verify Enables uRPF on the interface.
unicast source reachable-via
rx allow-default
Step 7 Switch(config-if-vrf)# end Returns to privileged EXEC mode.
User Interface for Syslog
To configure VRF-aware services for Syslog, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# logging on Enables or temporarily disable logging of storage router event message.
Step 3 Switch(config)# logging host Specifies the host address of the syslog server where logging messages
ip-address vrf vrf-name are to be sent.
Step 4 Switch(config)# logging buffered Logs messages to an internal buffer.
logging buffered size debugging
Step 5 Switch(config)# logging trap Limits the logging messages sent to the syslog server.
debugging
Step 6 Switch(config)# logging facility Sends system logging messages to a logging facility.
facility
Step 7 Switch(config)# end Returns to privileged EXEC mode.
User Interface for Traceroute
To configure VRF-aware services for traceroute, perform this task.
Command Purpose
traceroute vrf vrf-name ipaddress Specifies the name of a VPN VRF in which to find the destination
address.
User Interface for FTP and TFTP
So that FTP and TFTP are VRF-aware, you must configure some FTP/TFTP CLIs. For example, if you
want to use a VRF table that is attached to an interface, say E1/0, you need to configure the CLI ip [t]ftp
source-interface E1/0 to inform [t]ftp to use a specific routing table. In this example, the VRF table is
used to look up the destination IP address. These changes are backward-compatible and do not affect
existing behavior. That is, you can use the source-interface CLI to send packets out a particular interface
even if no VRF is configured on that interface.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
31-8 OL-22250-01
Chapter 31 Configuring VRF-lite
Configuring VRF-Aware Services
To specify the source IP address for FTP connections, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# [no] ip ftp Specifies the source IP address for FTP connections.
source-interface interface-type
interface-number To use the address of the interface where the connection is made, use
the no form of this command
Step 3 Switch(config)# end Returns to privileged EXEC mode.
To specify the IP address of an interface as the source address for TFTP connections, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# [no] ip tftp Specifies the source IP address for TFTP connections.
source-interface interface-type
interface-number To return to the default, use the no form of this command.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
User Interface for Telnet and SSH
To configure VRF-aware Telnet and SSH, enter these commands:
Command Purpose
Switch# telnet <ip-address>/vrf Telnet to an ip host or address in the specified VRF.
vrf-name
Switch# ssh -l <username> -vrf SSH to an ip host or address in the specified VRF.
vrf-name ip-host
User Interface for NTP
To configure VRF-aware NTP, enter these commands:
Command Purpose
Switch# ntp server vrf vrf-name Configure NTP server in the specified VRF.
ip-host
Switch# ntp peer vrf vrf-name Configure NTP peer in the specified VRF.
ip-host
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 31-9
Chapter 31 Configuring VRF-lite
Configuring Multicast VRFs
Configuring Multicast VRFs
To configure multicast within a VRF table, follow these steps.
Note For complete syntax and usage information for the following commands, see the switch command
reference for this release and see the Cisco IOS Switching Services Command Reference at:
http://www.cisco.com/en/US/docs/ios/ipswitch/command/reference/isw_book.html
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ip routing Enables IP routing.
Step 3 Switch(config)# ip vrf vrf-name Names the VRF, and enter VRF configuration mode.
Step 4 Switch(config-vrf)# ip (Optional) Enables global multicast routing for VRF table.
multicast-routing vrf vrf-name
Step 5 Switch(config-vrf)# rd Creates a VRF table by specifying a route distinguisher.
route-distinguisher
Enter either an AS number and an arbitrary number
(xxx:y) or an IP address and arbitrary number
(A.B.C.D:y).
Step 6 Switch(config-vrf)# route-target Creates a list of import, export, or import and export route
{export | import | both}
route-target-ext-community
target communities for the specified VRF. Enter either an
AS system number and an arbitrary number (xxx:y) or an
IP address and an arbitrary number (A.B.C.D:y).
The route-target-ext-community should be the same as the
route-distinguisher entered in Step 4.
Step 7 Switch(config-vrf)# import map (Optional) Associates a route map with the VRF.
route-map
Step 8 Switch(config-vrf)# interface Enters interface configuration mode and specifies the
interface-id
Layer 3 interface to be associated with the VRF. The
interface can be a routed port or a SVI.
Step 9 Switch(config-if)# ip vrf forwarding Associates the VRF with the Layer 3 interface.
vrf-name
Step 10 Switch(config-if)# ip address Configures IP address for the Layer 3 interface.
ip-address mask
Step 11 Switch(config-if)# ip pim Enables PIM on the VRF-associated Layer 3 interface.
[sparse-dense mode | dense-mode |
sparse-mode]
Step 12 Switch(config-if)# end Returns to privileged EXEC mode.
Step 13 Switch# show ip vrf [brief | detail | Verifies the configuration. Display information about the
interfaces] [vrf-name]
configured VRFs.
Step 14 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
For more information about configuring a multicast within a Multi-VRF CE, see the
Cisco IOS IP Multicast Configuration Guide, Release 12.4.
Use the no ip vrf vrf-name global configuration command to delete a VRF and to remove all interfaces
from it. Use the no ip vrf forwarding interface configuration command to remove an interface from the
VRF.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
31-10 OL-22250-01
Chapter 31 Configuring VRF-lite
Configuring a VPN Routing Session
Configuring a VPN Routing Session
Routing within the VPN can be configured with any supported routing protocol (RIP, OSPF, or BGP) or
with static routing. The configuration shown here is for OSPF, but the process is the same for other
protocols.
To configure OSPF in the VPN, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# router ospf Enables OSPF routing, specifies a VPN forwarding table,
process-id vrf vrf-name and enters router configuration mode.
Step 3 Switch(config-router)# (Optional) Logs changes in the adjacency state. This is the
log-adjacency-changes default state.
Step 4 Switch(config-router)# redistribute Sets the switch to redistribute information from the BGP
bgp autonomous-system-number subnets network to the OSPF network.
Step 5 Switch(config-router)# network Defines a network address and mask on which OSPF runs
network-number area area-id and the area ID for that network address.
Step 6 Switch(config-router)# end Returns to privileged EXEC mode.
Step 7 Switch# show ip ospf process-id Verifies the configuration of the OSPF network.
Step 8 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Use the no router ospf process-id vrf vrf-name global configuration command to disassociate the VPN
forwarding table from the OSPF routing process.
The following examples configure a single VRF named VRF-RED:
Switch(config)# ip vrf VRF-RED
Switch(config-vrf)# rd 1:1
Switch(config-vrf)# exit
Switch(config)# router eigrp virtual-name
Switch(config-router)# address-family ipv4 vrf VRF-RED autonomous-system 1
Switch(config-router-af)# network 10.0.0.0 0.0.0.255
Switch(config-router-af)# topology base
Switch(config-router-topology)# default-metric 10000 100 255 1 1500
Switch(config-router-topology)# exit-af-topology
Switch(config-router-af)# exit-address-family
Configuring BGP PE to CE Routing Sessions
To configure a BGP PE to CE routing session, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# router bgp Configures the BGP routing process with the AS number
autonomous-system-number passed to other BGP routers and enters router
configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 31-11
Chapter 31 Configuring VRF-lite
VRF-lite Configuration Example
Command Purpose
Step 3 Switch(config-router)# network Specifies a network and mask to announce using BGP.
network-number mask network-mask
Step 4 Switch(config-router)# redistribute Sets the switch to redistribute OSPF internal routes.
ospf process-id match internal
Step 5 Switch(config-router)# network Defines a network address and mask on which OSPF runs
network-number area area-id and the area ID for that network address.
Step 6 Switch(config-router-af)# Defines BGP parameters for PE to CE routing sessions and
address-family ipv4 vrf vrf-name enters VRF address-family mode.
Step 7 Switch(config-router-af)# neighbor Defines a BGP session between PE and CE routers.
address remote-as as-number
Step 8 Switch(config-router-af)# neighbor Activates the advertisement of the IPv4 address family.
address activate
Step 9 Switch(config-router-af)# end Returns to privileged EXEC mode.
Step 10 Switch# show ip bgp [ipv4] [neighbors] Verifies BGP configuration.
Step 11 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Use the no router bgp autonomous-system-number global configuration command to delete the BGP
routing process. Use the command with keywords to delete routing characteristics.
VRF-lite Configuration Example
Figure 31-2 is a simplified example of the physical connections in a network similar to that in
Figure 31-1. OSPF is the protocol used in VPN1, VPN2, and the global network. BGP is used in the CE
to PE connections. The example commands show how to configure the CE switch S8 and include the
VRF configuration for switches S20 and S11 and the PE router commands related to traffic with switch
S8. Commands for configuring the other switches are not included but would be similar.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
31-12 OL-22250-01
Chapter 31 Configuring VRF-lite
VRF-lite Configuration Example
Figure 31-2 VRF-lite Configuration Example
Catalyst 4500 Catalyst 4500
Switch S8 Router Switch S9
VPN1 Si Si
Switch S20 VPN1
208.0.0.0
Fast Switch S13
Ethernet
3/8
Switch S10
108.0.0.0
Fast
Ethernet VPN2
3/7
Switch S14
CE PE CE
VPN2
Fast
Switch S11 Ethernet
118.0.0.0 3/5
Fast
Ethernet Global network
3/11
Switch S15
Global network
Switch S16
168.0.0.0
Fast
Ethernet
CE = Customer edge device
99722
3/3
PE = Provider edge router
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 31-13
Chapter 31 Configuring VRF-lite
VRF-lite Configuration Example
Configuring Switch S8
On switch S8, enable routing and configure VRF.
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# ip routing
Switch(config)# ip vrf v11
Switch(config-vrf)# rd 800:1
Switch(config-vrf)# route-target export 800:1
Switch(config-vrf)# route-target import 800:1
Switch(config-vrf)# exit
Switch(config)# ip vrf v12
Switch(config-vrf)# rd 800:2
Switch(config-vrf)# route-target export 800:2
Switch(config-vrf)# route-target import 800:2
Switch(config-vrf)# exit
Configure the loopback and physical interfaces on switch S8. Fast Ethernet interface 3/5 is a trunk
connection to the PE. Interfaces 3/7 and 3/11 connect to VPNs:
Switch(config)# interface loopback1
Switch(config-if)# ip vrf forwarding v11
Switch(config-if)# ip address 8.8.1.8 255.255.255.0
Switch(config-if)# exit
Switch(config)# interface loopback2
Switch(config-if)# ip vrf forwarding v12
Switch(config-if)# ip address 8.8.2.8 255.255.255.0
Switch(config-if)# exit
Switch(config)# interface FastEthernet3/5
Switch(config-if)# switchport trunk encapsulation dot1q
Switch(config-if)# switchport mode trunk
Switch(config-if)# no ip address
Switch(config-if)# exit
Switch(config)# interface FastEthernet3/8
Switch(config-if)# switchport access vlan 208
Switch(config-if)# no ip address
Switch(config-if)# exit
Switch(config)# interface FastEthernet3/11
Switch(config-if)# switchport trunk encapsulation dot1q
Switch(config-if)# switchport mode trunk
Switch(config-if)# no ip address
Switch(config-if)# exit
Configure the VLANs used on switch S8. VLAN 10 is used by VRF 11 between the CE and the PE.
VLAN 20 is used by VRF 12 between the CE and the PE. VLANs 118 and 208 are used for VRF for the
VPNs that include switch S11 and switch S20, respectively:
Switch(config)# interface Vlan10
Switch(config-if)# ip vrf forwarding v11
Switch(config-if)# ip address 38.0.0.8 255.255.255.0
Switch(config-if)# exit
Software Configuration Guide—Release IOS-XE 3.1.0 SG
31-14 OL-22250-01
Chapter 31 Configuring VRF-lite
VRF-lite Configuration Example
Switch(config)# interface Vlan20
Switch(config-if)# ip vrf forwarding v12
Switch(config-if)# ip address 83.0.0.8 255.255.255.0
Switch(config-if)# exit
Switch(config)# interface Vlan118
Switch(config-if)# ip vrf forwarding v12
Switch(config-if)# ip address 118.0.0.8 255.255.255.0
Switch(config-if)# exit
Switch(config)# interface Vlan208
Switch(config-if)# ip vrf forwarding v11
Switch(config-if)# ip address 208.0.0.8 255.255.255.0
Switch(config-if)# exit
Configure OSPF routing in VPN1 and VPN2:
Switch(config)# router ospf 1 vrf vl1
Switch(config-router)# redistribute bgp 800 subnets
Switch(config-router)# network 208.0.0.0 0.0.0.255 area 0
Switch(config-router)# exit
Switch(config)# router ospf 2 vrf vl2
Switch(config-router)# redistribute bgp 800 subnets
Switch(config-router)# network 118.0.0.0 0.0.0.255 area 0
Switch(config-router)# exit
Configure BGP for CE to PE routing:
Switch(config)# router bgp 800
Switch(config-router)# address-family ipv4 vrf vl2
Switch(config-router-af)# redistribute ospf 2 match internal
Switch(config-router-af)# neighbor 83.0.0.3 remote-as 100
Switch(config-router-af)# neighbor 83.0.0.3 activate
Switch(config-router-af)# network 8.8.2.0 mask 255.255.255.0
Switch(config-router-af)# exit
Switch(config-router)# address-family ipv4 vrf vl1
Switch(config-router-af)# redistribute ospf 1 match internal
Switch(config-router-af)# neighbor 38.0.0.3 remote-as 100
Switch(config-router-af)# neighbor 38.0.0.3 activate
Switch(config-router-af)# network 8.8.1.0 mask 255.255.255.0
Switch(config-router-af)# end
Configuring Switch S20
Configure S20 to connect to CE:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# ip routing
Switch(config)# interface Fast Ethernet 0/7
Switch(config-if)# no switchport
Switch(config-if)# ip address 208.0.0.20 255.255.255.0
Switch(config-if)# exit
Switch(config)# router ospf 101
Switch(config-router)# network 208.0.0.0 0.0.0.255 area 0
Switch(config-router)# end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 31-15
Chapter 31 Configuring VRF-lite
VRF-lite Configuration Example
Configuring Switch S11
Configure S11 to connect to CE:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# ip routing
Switch(config)# interface Gigabit Ethernet 0/3
Switch(config-if)# switchport trunk encapsulation dot1q
Switch(config-if)# switchport mode trunk
Switch(config-if)# no ip address
Switch(config-if)# exit
Switch(config)# interface Vlan118
Switch(config-if)# ip address 118.0.0.11 255.255.255.0
Switch(config-if)# exit
Switch(config)# router ospf 101
Switch(config-router)# network 118.0.0.0 0.0.0.255 area 0
Switch(config-router)# end
Configuring the PE Switch S3
On switch S3 (the router), these commands configure only the connections to switch S8:
Router# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Router(config)# ip vrf v1
Router(config-vrf)# rd 100:1
Router(config-vrf)# route-target export 100:1
Router(config-vrf)# route-target import 100:1
Router(config-vrf)# exit
Router(config)# ip vrf v2
Router(config-vrf)# rd 100:2
Router(config-vrf)# route-target export 100:2
Router(config-vrf)# route-target import 100:2
Router(config-vrf)# exit
Router(config)# ip cef
Router(config)# interface Loopback1
Router(config-if)# ip vrf forwarding v1
Router(config-if)# ip address 3.3.1.3 255.255.255.0
Router(config-if)# exit
Router(config)# interface Loopback2
Router(config-if)# ip vrf forwarding v2
Router(config-if)# ip address 3.3.2.3 255.255.255.0
Router(config-if)# exit
Router(config)# interface Fast Ethernet3/0.10
Router(config-if)# encapsulation dot1q 10
Router(config-if)# ip vrf forwarding v1
Router(config-if)# ip address 38.0.0.3 255.255.255.0
Router(config-if)# exit
Router(config)# interface Fast Ethernet3/0.20
Router(config-if)# encapsulation dot1q 20
Router(config-if)# ip vrf forwarding v2
Router(config-if)# ip address 83.0.0.3 255.255.255.0
Router(config-if)# exit
Software Configuration Guide—Release IOS-XE 3.1.0 SG
31-16 OL-22250-01
Chapter 31 Configuring VRF-lite
Displaying VRF-lite Status
Router(config)# router bgp 100
Router(config-router)# address-family ipv4 vrf v2
Router(config-router-af)# neighbor 83.0.0.8 remote-as 800
Router(config-router-af)# neighbor 83.0.0.8 activate
Router(config-router-af)# network 3.3.2.0 mask 255.255.255.0
Router(config-router-af)# exit
Router(config-router)# address-family ipv4 vrf vl
Router(config-router-af)# neighbor 83.0.0.8 remote-as 800
Router(config-router-af)# neighbor 83.0.0.8 activate
Router(config-router-af)# network 3.3.1.0 mask 255.255.255.0
Router(config-router-af)# end
Displaying VRF-lite Status
To display information about VRF-lite configuration and status, enter one of the following commands:
Command Purpose
Switch# show ip protocols vrf vrf-name Displays routing protocol information associated
with a VRF.
Switch# show ip route vrf vrf-name [connected] [protocol Displays IP routing table information associated
[as-number]] [list] [mobile] [odr] [profile] [static] [summary] with a VRF.
[supernets-only]
Switch# show ip vrf [brief | detail | interfaces] [vrf-name] Displays information about the defined VRF
instances.
Switch# show ip mroute vrf instance-name <a.b.c.d | active | Displays information about the defined VRF
bidriectional| count | dense| interface | proxy | pruned | instances.
sparse | ssm | static | summary>
This example shows how to display multicast route table information within a VRF instance:
Switch# show ip mroute vrf mcast2 234.34.10.18
IP Multicast Routing Table
Flags: D - Dense, S - Sparse, B - Bidir Group, s - SSM Group, C - Connected,
L - Local, P - Pruned, R - RP-bit set, F - Register flag,
T - SPT-bit set, J - Join SPT, M - MSDP created entry,
X - Proxy Join Timer Running, A - Candidate for MSDP Advertisement,
U - URD, I - Received Source Specific Host Report,
Z - Multicast Tunnel, z - MDT-data group sender,
Y - Joined MDT-data group, y - Sending to MDT-data group
V - RD & Vector, v - Vector
Outgoing interface flags: H - Hardware switched, A - Assert winner
Timers: Uptime/Expires
Interface state: Interface, Next-Hop or VCD, State/Mode
(*, 234.34.10.18), 13:39:21/00:02:58, RP 1.1.1.1, flags: BC
Bidir-Upstream: Vlan134, RPF nbr 172.16.34.1
Outgoing interface list:
Vlan45, Forward/Sparse-Dense, 00:00:02/00:02:57, H
Vlan134, Bidir-Upstream/Sparse-Dense, 13:35:54/00:00:00, H
Note For more information about the information in the displays, refer to the Cisco IOS Switching Services
Command Reference at:
http://www.cisco.com/en/US/docs/ios/ipswitch/command/reference/isw_book.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 31-17
Chapter 31 Configuring VRF-lite
Displaying VRF-lite Status
Software Configuration Guide—Release IOS-XE 3.1.0 SG
31-18 OL-22250-01
CH A P T E R 32
Configuring Flexible NetFlow
Flow is defined as a unique set of key fields attributes, which might include fields of packet, packet
routing attributes, and input and output interface information. A NetFlow feature defines a flow as a
sequence of packets that have the same values for the feature key fields. Flexible Netflow (FNF) allows
you to collect and optionally export a flow record that specifies various flow attributes. Netflow
collection supports IP, IPv6 and Layer 2 traffic.
Note This chapter provides Catalyst 4500 switch specific information. For platform independent
configuration and command information refer to the following links
Cisco IOS Flexible NetFlow Configuration Guide:
http://www.cisco.com/en/US/partner/docs/ios/fnetflow/configuration/guide/12_4t/fnf_12_4t_book.htm
l
Cisco IOS Flexible NetFlow Command Reference:
http://www.cisco.com/en/US/partner/docs/ios/fnetflow/command/reference/fnf_book.html
The following items apply to the Catalyst 4500 series switch:
1. The Catalyst 4500 series switch supports ingress flow statistics collection for switched and routed
packets; it does not support Flexible Netflow on egress traffic.
2. Supervisor Engine 7-E supports a 100,000 entry hardware flow table, which is shared across all the
ports and VLANs on the switch. To limit the number of table entries on a given interface or VLAN,
enter the cache entries number command.
The following example illustrates how to configure the flow monitor m1 cache to hold 1000 entries.
With this configuration, interface gig 3/1 can create a maximum of 1000 flows and interface gig 3/2
can create a maximum of 1000 flows:
flow exporter e1
! exporter specifies where the flow records are send to
destination 20.1.20.4
!
flow record r1
! record specifies packet fields to collect
match ipv4 source address
match ipv4 destination address
collect counter bytes long
collect counter packets long
collect timestamp sys-uptime first
collect timestamp sys-uptime last
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 32-1
Chapter 32 Configuring Flexible NetFlow
!
flow monitor m1
! monitor refers record configuration and optionally exporter
! configuration. It specifies the cache size i.e. how many unique flow
! records to collect
record r1
exporter e1
cache timeout active 60
cache timeout inactive 30
cache entries 1000
!interface GigabitEthernet 3/1
! layer2-switched allows collection of flow records even when the packet is
! bridged
ip flow monitor m1 layer2-switched input
!
interface GigabitEthernet 3/2
ip flow monitor m1 input
!
3. Flow collection is supported on multiple targets (Port, VLAN, per-port per-VLAN (FNF can be
enabled on a specific VLAN on a given port)) and on a port-channel (FNF is configured on the
port-channel interface, rather than individual member ports).
4. 64 unique flow record configurations are supported.
5. Flow QoS/UBRL and FNF cannot be configured on the same target. (For information on Flow-based
QoS, see the section Flow-based QoS, page 33-10.)
6. 14,000 unique IPv6 addresses can be monitored.
7. On a given target, one monitor per traffic type is allowed. However, you can configure multiple
monitors on the same target for different traffic types.
For example, the following configuration is allowed:
! vlan config 10
ip flow monitor <name> input
ipv6 flow monitor <name> input
!
The following configuration is not allowed:
!
interface GigabitEthernet 3/1
ip flow monitor m1 input
ip flow monitor m2 input
8. On a given target monitoring Layer 2 and Layer 3, simultaneous traffic is not supported:
interface channel-group 1
datalink flow monitor m1 input
ip flow monitor m2 input
!
9. Selection of Layer 2 and Layer 3 packet fields in a single flow record definition is not allowed.
However, packet COS and Layer 3 packet field selection is allowed.
10. Only permanent and normal flow cache types are supported.
11. Supervisor 7-E does not support predefined records like traditional routers (record neflow ipv4
original-input).
12. Interface option not supported with Cos,Tos, TTL or Packet length options.
13. The configuration of the flow exporter does not support the option output features.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
32-2 OL-22250-01
Chapter 32 Configuring Flexible NetFlow
14. Flow aging in flow cache is controlled through active and in-active timer configuration. The
minimum for active and in-active aging timers is 5 seconds. The timers must be in units of 5 seconds.
Note Flows in the hardware table are deleted after 5 seconds of in-activity irrespective of the active
or in-active timer configuration values. This allows you to create new hardware flows quickly.
15. First and Last-seen flow timestamp accuracy is within 3 seconds.
16. 2048 Flow monitors and records are supported.
• When TTL is configured as a flow field, the following values are reported for a given packet TTL
value. Table 32-1 lists the packet TTL and reported values.
Table 32-1 TTL Map: TTL Configured
Packet TT Value Reported Value
0 0
1 1
2-10 10
11-25 25
26-50 50
51-100 100
100-150 150
150-255 255
• When packet length is configured as a flow field, the following values are reported for a given packet
length value. Table 32-2 lists the packet length and reported values.
l
Table 32-2 Packet Length Map: Packet Length Configured
Packet Length Reported Value
0-64 64
65-128 128
129-256 256
257-512 512
513-756 756
757-1500 1500
1500-4000 4000
4000+ 8192
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 32-3
Chapter 32 Configuring Flexible NetFlow
The following table lists the options available through FNF and the supported fields.
Table 32-3 Options Available through FNF and the Supported Fields
Field Description Comments
Data Link Fields (Layer 2 Flow Label + A94)
dot1q priority 802 1Q user
dot1q vid 802.1Q VLAN ID Only output VLAN as
collect option is
supported.
mac Upstream destination
destination-address MAC address
mac source-address Down stream source
MAC address
IPv4 Fields
destination address IPv4 destination address Yes
DSCP IPv4 DSCP (part of
TOS)
fragmentation flags IPv4 fragmentation flags Supported as non key.
DF flag is not
supported
is-multicast Indicator of an IPv4 Supported as non-key
multicast packet (0 - if
it's not, 1 - if it is)
Precedence IPv4 precedence
Protocol IPv4 protocol
source address IPv4 source address
total length IPv4 datagram Values are reported
based on Table 32-2.
Total length Minimum packet size
minimum seen
Total length Maximum packet size
maximum seen
Tos IPv4 Type of Service
(TOS)
ttl Pv4 Time to Live (TTL) Values are reported
based on Table 32-1.
ttl minimum FNF supports this field
only in mon-key mode
ttl maximum FNF supports this field
only in mon-key mode
IPv6 Fields
destination address IPv6 destination address
Software Configuration Guide—Release IOS-XE 3.1.0 SG
32-4 OL-22250-01
Chapter 32 Configuring Flexible NetFlow
Table 32-3 Options Available through FNF and the Supported Fields
Field Description Comments
dscp IPv6 DSCP (part of IPv6
traffic class)
flow-label IPv6 flow label
is-multicast Indicator of an IPv6 Supported as a
multicast packet (0 - if non-key field
it's not, 1 - if it is)
hop-limit IPv6 hop limit (replaces Values are reported
IPv4 ttl) based on Table 32-1.
hop-limit minimum IPv6 minimum hop limit
value seen in the flow. It
can be used as a non-key
field only.
hop-limit maximum IPv6 maximum hop limit
value seen in the flow. It
can be used as a non-key
field only.
next-header IPv5 next header type Only first next header
is reported
total length IPv6 total packet length Values are based on
Table 32-2.
Total length Minimum packet size
minimum seen
Total length Maximum packet size
maximim seen
protocol IPv6 next header type in
the last IPv6 extension
header
source address IPv6 source address
traffic-class IPv6 traffic class Yes
Routing Attributes
forwarding-status Forwarding status for the Supported as a
packet (forwarded, non-key field
terminated in the router,
dropped by ACL, RPF,
CAR)
Layer 4 Header Fields
Field Description Comments
TCP Header Fields
destination-port TCP destination port
TCP destination
number
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 32-5
Chapter 32 Configuring Flexible NetFlow
Table 32-3 Options Available through FNF and the Supported Fields
Field Description Comments
flags [ack] [fin] TCP flags. Supported as non-key
[psh] [rst] [syn] fields.
[urg]
source-port TCP source port
UDP Header Fields
destination-port UDP destination port
source-port UDP source port
ICMP Header Fields
code ICMP code
type ICMP type
IGMP Header Fields
type IGMP
Interface Fields
input Input interface index
output Input interface index Output interface can be
supported only as
non-key.
Flexible NetFlow feature related fields
direction: input
Counter Fields
bytes 32 bit counters
bytes long 64 bit counter
packets 32 bit counters
packets long 64 bit counter of the
packets in the flow
Timestamp
first seen Time-stamp of the first 3 sec accuracy
packet that is accounted
in the flow (in
milliseconds, starting
from the router boot-up)
last seen Time-stamp of the last 3 sec accuracy
packet that is accounted
in the flow (in
milliseconds, starting
from the router boot-up)
Configuring Flow Monitor Cache Values
Setting active cache timeout to a small value may cause the flows to be exported more frequently to the
remote collector. This also causes software to delete flows from the local cache after exporting. So, cache
statistics reported by switch may not display the actual flows being monitored.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
32-6 OL-22250-01
CH A P T E R 33
Configuring Quality of Service
This chapter describes how to configure quality of service (QoS) with either automatic QoS (auto-QoS)
commands or standard QoS commands on a switch running Supervisor Engine 7-E. It describes how to
specify QoS configuration on different types of interfaces (access, Layer 2 trunk, Layer 3 routed,
Etherchannel) as well as VLANs. It also describes how to specify different QoS configurations on
different VLANs on a given interface (per-port per-VLAN QoS).
Supervisor Engine 7-E supports a QoS configuration model known as MQC (Modular QoS CLI). Please
refer to the appropriate configuration section for the supervisor engine on which QoS will be configured.
For more information about MQC, see the “Modular Quality of Service Command-Line Interface"
section of the Cisco IOS Quality of Service Solutions Configuration Guide, Release 12.3.
This chapter consists of these sections:
• Overview of QoS on the Catalyst 4500 Series Switch, page 33-1
• Configuring QoS, page 33-11
• Configuring Auto-QoS, page 33-43
Note For complete syntax and usage information for the switch commands used in this chapter, first look at
the Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products//hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it will be found in the larger
Cisco IOS library. Refer to the Cisco IOS Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Overview of QoS on the Catalyst 4500 Series Switch
Typically, networks operate on a best-effort delivery basis, which means that all traffic has equal priority
and an equal chance of being delivered in a timely manner. When congestion occurs, all traffic has an
equal chance of being dropped.
QoS selects network traffic (both unicast and multicast), prioritizes it according to its relative
importance, and uses congestion avoidance to provide priority-indexed treatment; QoS can also limit the
bandwidth used by network traffic. QoS can make network performance more predictable and bandwidth
utilization more effective.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-1
Chapter 33 Configuring Quality of Service
Overview of QoS on the Catalyst 4500 Series Switch
This section contains the following subsections:
• Prioritization, page 33-2
• QoS Terminology, page 33-3
• Basic QoS Model, page 33-5
• Classification, page 33-6
• Policing and Marking, page 33-8
• Queueing and Scheduling, page 33-8
• Packet Modification, page 33-9
• Per Port Per VLAN QoS, page 33-10
• Flow-based QoS, page 33-10
Prioritization
QoS implementation is based on the DiffServ architecture. This architecture specifies that each packet
is classified upon entry into the network. The classification is carried in the IP packet header, using 6
bits from the deprecated IP type of service (TOS) field to carry the classification (class) information.
Classification can also be carried in the Layer 2 frame. These special bits in the Layer 2 frame or
a Layer 3 packet are described here and shown in Figure 33-1:
• Prioritization values in Layer 2 frames:
Layer 2 Inter-Switch Link (ISL) frame headers have a 1-byte User field that carries an IEEE 802.1p
class of service (CoS) value in the three least-significant bits. On interfaces configured as Layer 2
ISL trunks, all traffic is in ISL frames.
Layer 2 802.1Q frame headers have a 2-byte Tag Control Information field that carries the CoS
value in the three most-significant bits, which are called the User Priority bits. On interfaces
configured as Layer 2 802.1Q trunks, all traffic is in 802.1Q frames except for traffic in the native
VLAN.
Other frame types cannot carry Layer 2 CoS values.
Layer 2 CoS values range from 0 for low priority to 7 for high priority.
• Prioritization bits in Layer 3 packets:
Layer 3 IP packets can carry either an IP precedence value or a Differentiated Services Code Point
(DSCP) value. QoS supports the use of either value because DSCP values are backward-compatible
with IP precedence values.
IP precedence values range from 0 to 7.
DSCP values range from 0 to 63.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-2 OL-22250-01
Chapter 33 Configuring Quality of Service
Overview of QoS on the Catalyst 4500 Series Switch
Figure 33-1 QoS Classification Layers in Frames and Packets
Encapsulated Packet
Layer 2
IP header Data
header
Layer 2 ISL Frame
ISL header FCS
Encapsulated frame ...
(26 bytes) (4 bytes)
3 bits used for CoS
Layer 2 802.1Q/P Frame
Start frame
Preamble DA SA Tag PT Data FCS
delimiter
3 bits used for CoS (user priority)
Layer 3 IPv4 Packet
Version ToS
Len ID Offset TTL Proto FCS IP-SA IP-DA Data
68140
length (1 byte)
IP precedence or DSCP
All switches and routers across the Internet rely on the class information to provide the same forwarding
treatment to packets with the same class information and different treatment to packets with different
class information. The class information in the packet can be assigned by end hosts or by switches or
routers along the way, based on a configured policy, detailed examination of the packet, or both.
Detailed examination of the packet is expected to happen closer to the edge of the network so that the
core switches and routers are not overloaded.
Switches and routers along the path can use the class information to limit the amount of resources
allocated per traffic class. The behavior of an individual device when handling traffic in the DiffServ
architecture is called per-hop behavior. If all devices along a path provide a consistent per-hop behavior,
you can construct an end-to-end QoS solution.
Implementing QoS in your network can be a simple or complex task and depends on the QoS features
offered by your internetworking devices, the traffic types and patterns in your network, and the
granularity of control you need over incoming and outgoing traffic.
QoS Terminology
The following terms are used when discussing QoS features:
• Packets carry traffic at Layer 3.
• Frames carry traffic at Layer 2. Layer 2 frames carry Layer 3 packets.
• Labels are prioritization values carried in Layer 3 packets and Layer 2 frames:
– Layer 2 class of service (CoS) values, which range between zero for low priority and seven for
high priority:
Layer 2 Inter-Switch Link (ISL) frame headers have a 1-byte User field that carries an IEEE
802.1p CoS value in the three least significant bits.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-3
Chapter 33 Configuring Quality of Service
Overview of QoS on the Catalyst 4500 Series Switch
Layer 2 802.1Q frame headers have a 2-byte Tag Control Information field that carries the CoS
value in the three most significant bits, which are called the User Priority bits.
Other frame types cannot carry Layer 2 CoS values.
Note On interfaces configured as Layer 2 ISL trunks, all traffic is in ISL frames. On interfaces
configured as Layer 2 802.1Q trunks, all traffic is in 802.1Q frames except for traffic in the
native VLAN.
– Layer 3 IP precedence values—The IP version 4 specification defines the three most significant
bits of the 1-byte ToS field as IP precedence. IP precedence values range between zero for low
priority and seven for high priority.
– Layer 3 differentiated services code point (DSCP) values—The Internet Engineering Task
Force (IETF) has defined the six most significant bits of the 1-byte IP ToS field as the DSCP.
The per-hop behavior represented by a particular DSCP value is configurable. DSCP values
range between 0 and 63.
Note Layer 3 IP packets can carry either an IP precedence value or a DSCP value. QoS supports
the use of either value, since DSCP values are backwards compatible with IP precedence
values. See Table 33-1.
Table 33-1 IP Precedence and DSCP Values
3-bit IP 6 MSb1 of ToS 6-bit 3-bit IP 6 MSb1 of ToS 6-bit
Precedence
5 4 3 DSCP Precedence
8 7 6 8 7 6 5 4 3 DSCP
0 0 0 0 0 0 0 0 4 1 0 0 0 0 0 32
0 0 0 0 0 1 1 1 0 0 0 0 1 33
0 0 0 0 1 0 2 1 0 0 0 1 0 34
0 0 0 0 1 1 3 1 0 0 0 1 1 35
0 0 0 1 0 0 4 1 0 0 1 0 0 36
0 0 0 1 0 1 5 1 0 0 1 0 1 37
0 0 0 1 1 0 6 1 0 0 1 1 0 38
0 0 0 1 1 1 7 1 0 0 1 1 1 39
1 0 0 1 0 0 0 8 5 1 0 1 0 0 0 40
0 0 1 0 0 1 9 1 0 1 0 0 1 41
0 0 1 0 1 0 10 1 0 1 0 1 0 42
0 0 1 0 1 1 11 1 0 1 0 1 1 43
0 0 1 1 0 0 12 1 0 1 1 0 0 44
0 0 1 1 0 1 13 1 0 1 1 0 1 45
0 0 1 1 1 0 14 1 0 1 1 1 0 46
0 0 1 1 1 1 15 1 0 1 1 1 1 47
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-4 OL-22250-01
Chapter 33 Configuring Quality of Service
Overview of QoS on the Catalyst 4500 Series Switch
Table 33-1 IP Precedence and DSCP Values (continued)
3-bit IP 6 MSb1 of ToS 6-bit 3-bit IP 6 MSb1 of ToS 6-bit
Precedence DSCP Precedence DSCP
8 7 6 5 4 3 8 7 6 5 4 3
2 0 1 0 0 0 0 16 6 1 1 0 0 0 0 48
0 1 0 0 0 1 17 1 1 0 0 0 1 49
0 1 0 0 1 0 18 1 1 0 0 1 0 50
0 1 0 0 1 1 19 1 1 0 0 1 1 51
0 1 0 1 0 0 20 1 1 0 1 0 0 52
0 1 0 1 0 1 21 1 1 0 1 0 1 53
0 1 0 1 1 0 22 1 1 0 1 1 0 54
0 1 0 1 1 1 23 1 1 0 1 1 1 55
3 0 1 1 0 0 0 24 7 1 1 1 0 0 0 56
0 1 1 0 0 1 25 1 1 1 0 0 1 57
0 1 1 0 1 0 26 1 1 1 0 1 0 58
0 1 1 0 1 1 27 1 1 1 0 1 1 59
0 1 1 1 0 0 28 1 1 1 1 0 0 60
0 1 1 1 0 1 29 1 1 1 1 0 1 61
0 1 1 1 1 0 30 1 1 1 1 1 0 62
0 1 1 1 1 1 31 1 1 1 1 1 1 63
1. MSb = most significant bit
• Classification is the selection of traffic to be marked.
• Marking, according to RFC 2475, is the process of setting a Layer 3 DSCP value in a packet; in this
publication, the definition of marking is extended to include setting Layer 2 CoS values.
• Policing is limiting bandwidth used by a flow of traffic. Policing can mark or drop traffic.
Basic QoS Model
Figure 33-2 illustrates a high-level flow of Supervisor Engine 7-E QoS function.
Figure 33-2 QoS Packet Processing
Packet Input QoS Input Forwarding
Input Reception Classification Policing Lookup
and Marking
Port/Queue
Output QoS Output Active Queue Scheduling
Output Policing Packet
203973
Classification Management (Sharing/ Transmission
and Marking Shaping)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-5
Chapter 33 Configuring Quality of Service
Overview of QoS on the Catalyst 4500 Series Switch
The QoS model proceeds as follows:
Step 1 The incoming packet is classified (based on different packet fields, receive port and/or VLAN) to belong
to a traffic class.
Step 2 Depending on the traffic class, the packet is rate-limited/policed and its priority is optionally marked
(typically at the edge of the network) so that lower priority packets are dropped or marked with lower
priority in the packet fields (DSCP and CoS).
Step 3 After the packet has been marked, it is looked up for forwarding. This action obtains the transmit port
and VLAN to transmit the packet.
Step 4 The packet is classified in the output direction based on the transmit port and/or VLAN. The
classification takes into account any marking of the packet by input QoS.
Step 5 Depending on the output classification, the packet is policed, its priority is optionally (re-)marked, and
the transmit queue for the packet is determined depending on the traffic class.
Step 6 The transmit queue state is dynamically monitored via the AQM (Active Queue Management) algorithm
and drop threshold configuration to determine whether the packet should be dropped or enqueued for
transmission.
Step 7 If eligible for transmission, the packet is enqueued to a transmit queue. The transmit queue is selected
based on output QoS classification criteria. The selected queue provides the desired behavior in terms
of latency and bandwidth.
Classification
Classification is the process of distinguishing one kind of traffic from another by examining the fields
in the packet. Classification is enabled when a QoS policy-map is attached to an interface.
You specify which fields in the frame or packet that you want to use to classify incoming traffic.
For non-IP traffic, you have the following classification options:
• CoS value in the VLAN tag of the incoming frame is used to classify the packet.
• If the frame does not contain a CoS value, the port's default CoS value ("0") is used for the
classification.
Perform the classification based on a configured MAC ACL, which examines the fields in the Layer
2 header.
For IP traffic, you have the following classification options:
• IP DSCP or IP Precedence in the incoming packet is used for classification. DSCP values range from
0 to 63.
• Perform the classification based on a configured IP standard or extended ACL, which examines
various fields in the IP header.
Classification Based on QoS ACLs
A packet can be classified for QoS using multiple match criteria, and the classification can specify
whether the packet should match all of the specified match criteria or at least one of the match criteria.
To define a QoS classifier, you can provide the match criteria using the match statements in a class map.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-6 OL-22250-01
Chapter 33 Configuring Quality of Service
Overview of QoS on the Catalyst 4500 Series Switch
In the 'match' statements, you can specify the fields in the packet to match on, or you can use IP standard
or IP extended ACLs or MAC ACLs. For more information, see the “Classification Based on Class Maps
and Policy Maps” section on page 33-7.
If the class map is configured to match all the match criteria, then a packet must satisfy all the match
statements in the class map before the QoS action is taken. The QoS action for the packet is not taken if
the packet does not match even one match criterion in the class map.
If the class map is configured to match at least one match criterion, then a packet must satisfy at least
one of the match statements in the class map before the QoS action is taken. The QoS action for the
packet is not taken if the packet does not match any match criteria in the class map.
Note When you use the IP standard and IP extended ACLs, the permit and deny ACEs in the ACL have a
slightly different meaning in the QoS context.
• If a packet encounters (and satisfies) an ACE with a “permit,” then the packet “matches” the match
criterion in the QoS classification.
• If a packet encounters (and satisfies) an ACE with a “deny,” then the packet “does not match” the
match criterion in the QoS classification.
• If no match with a permit action is encountered and all the ACEs have been examined, then the
packet “does not match” the criterion in the QoS classification.
Note When creating an access list, remember that, by default, the end of the access list contains an implicit
deny statement for everything if it did not find a match before reaching the end.
After a traffic class has been defined with the class map, you can create a policy that defines the QoS
actions for a traffic class. A policy might contain multiple classes with actions specified for each one of
them. A policy might include commands to classify the class as a particular aggregate (for example,
assign a DSCP) or rate limit the class. This policy is then attached to a particular port on which it
becomes effective.
You implement IP ACLs to classify IP traffic by using the access-list global configuration command.
When a class-map is created with the match-all keyword, you cannot include both IP and MAC ACLs
as match criteria.
Classification Based on Class Maps and Policy Maps
A class map is a mechanism that you use to isolate and name a specific traffic flow (or class) from all
other traffic. The class map defines the criterion used to match against a specific traffic flow to further
classify it; the criteria can include matching the access group defined by the ACL or matching a specific
list of DSCP, IP precedence, or L2 CoS values. If you have more than one type of traffic that you want
to classify, you can create another class map and use a different name. After a packet is matched against
the class-map criteria, you can specify the QoS actions via a policy map.
A policy map specifies the QoS actions for the traffic classes. Actions can include setting a specific CoS,
DSCP, or IP precedence value; policing the traffic to a specified rate; specifying the traffic bandwidth
limitations; shaping the traffic to a specified rate. Before a policy map can be effective, you must attach
it to an interface.
You create a class map by using the class-map global configuration command. When you enter the
class-map command, the switch enters the class-map configuration mode. In this mode, you define the
match criteria for the traffic by using the match class-map configuration command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-7
Chapter 33 Configuring Quality of Service
Overview of QoS on the Catalyst 4500 Series Switch
You create and name a policy map by using the policy-map global configuration command. When you
enter this command, the switch enters the policy-map configuration mode. In this mode, you specify the
actions to take on a specific traffic class by using the set, police, bandwidth, or shape policy-map
configuration and policy-map class configuration commands. To make the policy map effective, you
attach it to an interface by using the service-policy interface configuration command.
The policy map can also contain commands that define the policer, (the bandwidth limitations of the
traffic) and the action to take if the limits are exceeded. For more information, see the “Policing and
Marking” section on page 33-8.
A policy map also has these characteristics:
• A policy map can contain up to 254 class statements.
• You can have different classes within a policy map.
Policing and Marking
Policing involves creating a policer that specifies the bandwidth limits for the traffic. Packets that exceed
the limits are out of profile or nonconforming. Each policer specifies the action to take for packets that
are in or out of profile. These actions, carried out by the marker, include passing through the packet
without modification, dropping the packet, or marking down the packet with a new DSCP value that is
obtained from the configurable policed-DSCP map. You can configure policer within a policy map with
the police command in policy-map class configuration mode. For information on the policed-DSCP
map, see the “Queueing and Scheduling” section on page 33-8.
When configuring policing and policers, keep these items in mind:
• On Supervisor Engine 7-E, policers account only for the Layer 2 header length when calculating
policer rates. In contrast, shapers account for header length as well as IPG in rate calculations.
• By default, no policers are configured.
• Only the average rate and committed burst parameters are configurable.
• After you configure the policy map and policing actions, attach the policy to an ingress or egress
interface by using the service-policy interface configuration command.
• For 2 rate 3 colors (2r3c) policers, if no explicit violation-action is specified, the exceed-action is
used as the violate-action.
Queueing and Scheduling
Supervisor Engine 7-E hardware supports 8 transmit queues per port. Once the decision has been made
to forward a packet out a port, the output QoS classification determines the transmit queue into which
the packet must be enqueued.
Queues are assigned when an output policy attached to a port with one or more queuing related actions
for one or more classes of traffic. Because there are only eight queues per port, there are at most eight
traffic classes (including class-default, the reserved class) with queuing action(s). Classes of traffic that
do not have any queuing action are referred to as non-queuing classes. Non-queuing class traffic use the
queue corresponding to class-default.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-8 OL-22250-01
Chapter 33 Configuring Quality of Service
Overview of QoS on the Catalyst 4500 Series Switch
Active Queue Management
Active queue management (AQM) is the pro-active approach of informing you about congestion before
a buffer overflow occurs. AQM is done using Dynamic buffer limiting (DBL). DBL tracks the queue
length for each traffic flow in the switch. When the queue length of a flow exceeds its limit, DBL drop
packets.
Sharing Link Bandwidth Among Transmit Queues
The eight transmit queues for a transmit port share the available link bandwidth of that transmit port.
You can set the link bandwidth to be shared differently among the transmit queues using the
bandwidth command in the policy-map class configuration command in class mode.
With this command, you assign the minimum guaranteed bandwidth for each transmit queue.
By default, all queues are scheduled in a round robin manner.
Strict Priority / Low Latency Queueing
On Supervisor Engine 7-E, you can only configure one transmit queue on a port as strict priority (termed
Low Latency Queue, or LLQ).
LLQ provides strict-priority queuing for a traffic class. It enables delay-sensitive data, such as voice, to
be sent before packets in other queues. The priority queue is serviced first until it is empty or until it falls
under r its shape rate. Only one traffic stream can be destined for the priority queue per class-level
policy. You enable the priority queue for a traffic class with the priority policy-map class configuration
command in class mode.
Traffic Shaping
Traffic Shaping provides the ability to control the rate of outgoing traffic in order to make sure that the
traffic conforms to the maximum rate of transmission contracted for it. Traffic that meets certain profile
can be shaped to meet the downstream traffic rate requirements to handle any data rate mismatches.
Each transmit queue can be configured to transmit a maximum rate using the shape command in the
policy-map class configuration command in class mode
The configuration allows you to specify the maximum rate of traffic. Any traffic that exceeds the
configured shape rate is queued and transmitted at the configured rate. If the burst of traffic exceeds the
size of the queue, packets are dropped to maintain transmission at the configured shape rate.
Packet Modification
A packet is classified, policed, and queued to provide QoS. Packet modifications can occur during this
process:
• For IP packets, classification involves assigning a DSCP to the packet. However, the packet is not
modified at this stage; only an indication of the assigned DSCP is carried along. The reason for this
is that QoS classification and ACL lookup occur in parallel, and it is possible that the ACL specifies
that the packet should be denied and logged. In this situation, the packet is forwarded with its
original DSCP to the CPU, where it is again processed through ACL software.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-9
Chapter 33 Configuring Quality of Service
Overview of QoS on the Catalyst 4500 Series Switch
• For non-IP packets, classification involves assigning an internal DSCP to the packet, but because
there is no DSCP in the non-IP packet, no overwrite occurs. Instead, the internal DSCP is used both
for queueing and scheduling decisions and for writing the CoS priority value in the tag if the packet
is being transmitted on either an ISL or 802.1Q trunk port.
• During policing, IP and non-IP packets can have another DSCP assigned to them (if they are out of
profile and the policer specifies a markdown DSCP). Once again, the DSCP in the packet is not
modified, but an indication of the marked-down value is carried along. For IP packets, the packet
modification occurs at a later stage.
Per Port Per VLAN QoS
Per-port per-VLAN QoS (PVQoS) offers differentiated quality-of-services to individual VLANs on a
trunk port. It enables service providers to rate limit individual VLAN-based services on each trunk port
to a business or a residence. In an enterprise Voice-over-IP environment, it can be used to rate limit voice
VLAN even if an attacker impersonates an IP phone. A per-port per-VLAN service policy can be
separately applied to either ingress or egress traffic. For configuration details see “Enabling Per-Port
Per-VLAN QoS” section on page 33-33.
Flow-based QoS
Note Before reading this section, you should be familiar with implementing Flexible Netflow (Chapter 32,
“Configuring Flexible NetFlow”) and QoS implementation in this chapter.
Flow based QoS enables microflow policing and marking capability to dynamically learn traffic flows,
It also rate limits each unique flow to an individual rate. Flow based QoS is available on Supervisor
Engine 7-E with the built-in NetFlow hardware support. It can be applied to ingress traffic on both
switched and routed interfaces with flow masks defined using Flexible Netflow (FNF). It supports up to
100,000 individual flows in hardware and up to 512 unique policer configuration. Flow based QoS is
typically used in environments where per-user, granular rate-limiting required. For example, per-flow
outbound and inbound traffic rate might differ. Flow based QoS is also referred to as User Based Rate
Limiting (UBRL).
A flow is defined as a stream of packets having the same properties as those defined by the key fields in
the FNF flow record. A new flow is created when the value of data in packet’s key fields is unique with
respect to the flow that already exist.
A flow based QoS policy is possesses one or more classmaps matching on a FNF flow record. Such a
classmap must be configured as match-all to match all the match criteria specified in the classmap.
When a flow based QoS policy is attached to a QoS target, ingress traffic on the target is first classified
based on the classification rules specified in the class-map. If the classifier has FNF flow record, the
key fields specified in the FNF flow record are applied on the classified traffic to create flows provided
the flow does not already exist. The corresponding policy actions (policing and marking) are then
applied to these individual flows. Flow-based policers (termed microflow policers) rate limit each
unique flow. Flows are dynamically created and inactive flows are periodically aged out.
Flow based QoS policy can be attached to QoS targets such as port (P), vlan (V), per-port-per-vlan (PV),
and EtherChannel but only in the ingress direction.
For details on now to enable FNF, refer to the “Applying Flow-based QoS Policy” section on page 33-39.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-10 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
Configuring QoS
Note HQoS is not supported on Supervisor Engine 7-E.
Topics include:
• MQC-based QoS Configuration, page 33-11
• Platform-supported Classification Criteria and QoS Features, page 33-11
• Platform Hardware Capabilities, page 33-12
• Prerequisites for Applying a QoS Service Policy, page 33-13
• Restrictions for Applying a QoS Service Policy, page 33-13
• Classification, page 33-13
• Policing, page 33-14
• Marking Network Traffic, page 33-16
• Shaping, Sharing (Bandwidth), Priority Queuing, Queue-limiting and DBL, page 33-23
• Enabling Per-Port Per-VLAN QoS, page 33-33
• Applying Flow-based QoS Policy, page 33-39
MQC-based QoS Configuration
Starting with Cisco IOS Release 15.0(1)XO, a switch using Supervisor Engine 7-E employs the MQC
model of QoS. To apply QoS, you use the Modular QoS Command-Line Interface (MQC), which is a
CLI structure that allows you to complete the following tasks:
• Specify the matching criteria used to define a traffic class.
• Create a traffic policy (policy map). The traffic policy defines the QoS policy actions to be taken
for each traffic class.
• Apply the policy actions specified in the policy map to an interface, VLAN, or port and VLAN.
For more information about the MQC, see the “Modular Quality of Service Command-Line Interface”
section of the Cisco IOS Quality of Service Solutions Configuration Guide, Release 12.3.
Note The incoming traffic is considered trusted by default. Only when the trusted boundary feature is enabled
on an interface can the port enter untrusted mode. In this mode, the switch marks the DSCP value of an
IP packet and the CoS value of the VLAN tag on the Ethernet frame as “0”.
Platform-supported Classification Criteria and QoS Features
The following table provides a summary of various classification criteria and actions supported on the
Supervisor Engine 7-E. For details, refer to the Catalyst 4500 Series Switch Command Reference.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-11
Chapter 33 Configuring Quality of Service
Configuring QoS
Supported classification actions Descriptions
match access-group Configures the match criteria for a class map on the basis of the specified ACL.
match any Configures the match criteria for a class map to be successful match criteria for all
packets.
match cos Matches a packet based on a Layer 2 class of service (CoS) marking.
match [ip] dscp Identifies a specific IP differentiated service code point (DSCP) value as a match
criterion. Up to eight DSCP values can be included in one match statement.
match [ip] precedence Identifies IP precedence values as match criteria.
match protocol Configures the match criteria for a class map on the basis of the specified protocol.
match qos-group Identifies a specific QoS group value as a match criterion. Applies only on the egress
direction.
Supported Qos Features Descriptions
police Configures traffic policing.
police (percent) Configures traffic policing on the basis of a percentage of bandwidth available on an
interface.
police (two rates) Configures traffic policing using two rates, the committed information rate (CIR) and
the peak information rate (PIR).
set cos Sets the Layer 2 class of service (CoS) value of an outgoing packet.
set dscp Marks a packet by setting the differentiated services code point (DSCP) value in the
type of service (ToS) byte of IPv4 or traffic class byte of IPv6 packet.
set precedence Sets the precedence value in the packet header.
set qos-group Sets a QoS group identifier (ID) that can be used later to classify packets.
table map support Unconditional marking of one packet field based on another packet field.
priority Gives priority to a class of traffic belonging to a policy map.
shape Shapes traffic to the indicated bit rate according to the algorithm specified.
bandwidth Provides a guaranteed minimum bandwidth to each of the eight queues.
dbl Dynamic buffer limit.
queue-limit Specifies the maximum number of packets a transmit queue can hold.
Platform Hardware Capabilities
Qos Actions Numbers of entries supported
Classification 64k input and 64k output classification entries are supported.
A given policy can use at most 24k ACLs
Policing 16K policers are supported. Policers are allocated to given direction in blocks of 2k.
For example, 2k policers can be used in for input and 14k policers can be used for
output. Single rate policers uses one policer entry. Single Rate Three Color Marker
(srTCM) (RFC 2697) and Two Rate Three Color Marker (trTCM) (RFC 2698) uses
two policer entries
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-12 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
Qos Actions Numbers of entries supported
Marking Marking of Cos and DSCP/Precedence is supported through two marking tables, each
capable of supporting 512 entries. There are separate tables for each direction.
Queuing The queue size is Configurable with the maximum number of entries configurable per
port depending on the chassis and line card type.
DBL You can enable DBL action on all configured class-maps.
Prerequisites for Applying a QoS Service Policy
Unlike the Switch QoS model, there is no prerequisite for enabling QoS on various targets. Just the
attachment of a service policy enables QoS and detachment of that policy disables QoS on that target.
Restrictions for Applying a QoS Service Policy
Traffic marking can be configured on an interface, a VLAN, or a port and VLAN. An interface can be a
Layer 2 access port, a Layer 2 switch trunk, a Layer 3 routed port, or an EtherChannel. A policy is
attached to a VLAN using the vlan configuration mode.
Attaching QoS service policy to VLANs and EtherChannel is described in the “Policy Associations”
section on page 33-37.
Classification
Supervisor Engine 7-E supports classification of Layer 2, IP, IPv6 packets, and ARP packets marking
performed on input can be matched in the output direction. The previous table lists the full set of
capabilities. By default, the Supervisor Engine 7-E also supports classification resources sharing.
By default, when the same policy is attached to a port or a VLAN or on per-port per-vlan targets, ACL
entries are shared on the Supervisor Engine 7-E. Even though CAM entries are shared, QoS actions is
unique on each target.
For example:
class-map c1
match ip dscp 50
Policy Map p1
class c1
police rate 1 m burst 200000
If policy-map p1 is applied to interfaces Gig 1/1 and Gig 1/2, 1 CAM entry is used (one ACE that
matches IP packets), but 2 policers are allocated (one per target). So, all IP packets with dscp 50 are
policed to 1 mbps on interface Gig 1/1 and packets on interface Gig 1/2 are policed to 1 mbps.
Note With Cisco IOS Release 12.2(46)SG, you can issue the match protocol arp command. For details, see
the Catalyst 4500 Series Switch Cisco IOS Command Reference.
Classification Statistics
Supervisor 7-E supports only packet based classification statistics.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-13
Chapter 33 Configuring Quality of Service
Configuring QoS
Supervisor 7-E supports TCAM resource sharing. When a policy-map is applied on multiple targets, the
command show policy-map interface displays the aggregate classification statistics, not those specific
to an interface.
Note To obtain per interface policy-map stats, you should configure a unique policy-map name on each
interface.
When a policy-map is attached to a port-channel member ports, classification statistics are not displayed.
Configuring a Policy Map
You can attach only one policy map to an interface. Policy maps can contain one or more policy-map
classes, each with different match criteria and actions.
Configure a separate policy-map class in the policy map for each type of traffic that an interface receives.
Put all commands for each type of traffic in the same policy-map class. QoS does not attempt to apply
commands from more than one policy-map class to matched traffic.
Creating a Policy Map
To create a policy map, enter this command:
Command Purpose
Switch(config)# [no] policy-map policy_name Creates a policy map with a user-specified name.
Use the no keyword to delete the policy map.
Attaching a Policy Map to an Interface
To create a policy map, enter this command:
Command Purpose
Switch(config)# interface {vlan vlan_ID | Selects the interface to configure.
{fastethernet | gigabitethernet}
slot/interface | Port-channel number}
Switch(config-if)# [no] service-policy Attaches a policy map to the input direction of the
input policy_map_name interface. Use the no keyword to detach a policy
map from an interface.
Switch(config-if)# end Exits configuration mode.
Switch# show policy-map interface {vlan Verifies the configuration.
vlan_ID | {fastethernet | gigabitethernet}
slot/interface}
Policing
Supervisor Engine 7-E supports policers in the following operation modes:
• Single Rate Policer Two Color Marker
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-14 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
This kind of policer is configured with just the committed rate (CIR) and normal burst and it has
only conform and exceed actions.
This is the only form supported in the Supervisor Engine II-Plus to V-10GE based systems.
• Single Rate Three Color Marker (srTCM) (RFC 2697)
• Two Rate Three Color Marker (trTCM) (RFC 2698)
• Color Blind Mode
Policing accuracy of 0.75% of configured policer rate.
Supervisor Engine 7-E supports 16384 (16 x 1024, 16K) single rate, single burst policers. 16K
policers are organized as 8 banks of 2K policers. The policer banks are dynamically assigned (input
or output policer bank) by the software depending on the QoS configuration. So, the 16K policers
are dynamically partitioned by software as follows:
– 0 Input Policers and 16K Output Policers
– 2K Input Policers and 14K Output Policers
– 4K Input Policers and 12K Output Policers
– 6K Input Policers and 10K Output Policers
– 8K Input Policers and 8K Output Policers
– 10K Input Policers and 6K Output Policers
– 12K Input Policers and 4K Output Policers
– 14K Input Policers and 2K Output Policers
– 16K Input Policers and 0 Output Policers
These numbers represent individual policer entries in the hardware that support a single rate and burst
parameter. Based on this, Supervisor Engines 7-E supports the following number of policers:
• 16K Single Rate Policer with Single Burst (Two Color Marker)
• 8K Single Rate Three Color Marker (srTCM)
• 8K Two Rate Three Color Marker (trTCM)
These policers are partitioned between Input and Output in chunks of 2K policer banks. The different
types of policers can all co-exist in the system. However, a given type of policer (srTCM, trTCM etc.)
is configurable as a block of 128 policers.
Note Two policers are reserved for internal use.
How to Implement Policing
For details on how to implement the policing features on a Catalyst 4500 series switch, refer to the
Cisco IOS documentation at the following link:
http://www.cisco.com/en/US/docs/ios/12_2/qos/configuration/guide/qcfpolsh.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-15
Chapter 33 Configuring Quality of Service
Configuring QoS
Platform Restrictions
Platform restrictions include the following:
• Multi-policer actions can be specified (setting CoS and IP DSCP is supported).
• When unconditional marking and policer based marking exists on the same field(cos or dscp or
precedence), policer-based marking is preferred.
• If policer based service-policy is attached to both a port and a VLAN, port-based policed is preferred
by default. To over-ride a specific VLAN policy on a given port, then you must configure a per-port
per-vlan policy.
• You should not delete a port-channel with a per-port, per-VLAN QoS policy.
Workaround: Before deleting the port-channel, do the following:
1. Remove any per-port per-VLAN QoS policies, if any.
2. Remove the VLAN configuration on the port-channel with the no vlan-range command.
Marking Network Traffic
Marking network traffic allows you to set or modify the attributes of traffic (that is, packets) belonging
to a specific class or category. When used in conjunction with network traffic classification, marking
network traffic is the foundation for enabling many quality of service (QoS) features on your network
This module contains conceptual information and the configuration tasks for marking network traffic.
Contents
• “Information About Marking Network Traffic” section on page 33-16
• “Marking Action Drivers” section on page 33-19
• “Traffic Marking Procedure Flowchart” section on page 33-19
• “Restrictions for Marking Network Traffic” section on page 33-20
• “Multi-attribute Marking Support” section on page 33-20
• “Hardware Capabilities for Marking” section on page 33-21
• “Configuring the Policy Map Marking Action” section on page 33-21
• “Marking Statistics” section on page 33-22
Information About Marking Network Traffic
To mark network traffic, you should understand the following concepts:
• “Purpose of Marking Network Traffic” section on page 33-16
• “Benefits of Marking Network Traffic” section on page 33-17
• “Two Methods for Marking Traffic Attributes” section on page 33-17
Purpose of Marking Network Traffic
Traffic marking is used to identify certain traffic types for unique handling, effectively partitioning
network traffic into different categories.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-16 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
After the network traffic is organized into classes by traffic classification, traffic marking allows you to
mark (that is, set or change) a value (attribute) for the traffic belonging to a specific class. For instance,
you may want to change the class of service (CoS) value from 2 to 1 in one class, or you may want to
change the differentiated services code point (DSCP) value from 3 to 2 in another class. In this module,
these values are referred to as attributes or marking fields.
Attributes that can be set and modified include the following:
• CoS value of a tagged Ethernet frame
• DSCP/Precedence value in the Type of Service (ToS) byte of IPv4.
• QoS group identifier (ID)
• DSCP /Precedence value in the traffic class byte of IPv6
Benefits of Marking Network Traffic
Traffic marking allows you to fine-tune the attributes for traffic on your network. This increased
granularity helps isolate traffic that requires special handling, and thus, helps to achieve optimal
application performance.
Traffic marking allows you to determine how traffic will be treated, based on how the attributes for the
network traffic are set. It allows you to segment network traffic into multiple priority levels or classes
of service based on those attributes, as follows:
• Traffic marking is often used to set the IP precedence or IP DSCP values for traffic entering a
network. Networking devices within your network can then use the newly marked IP precedence
values to determine how traffic should be treated. For example, voice traffic can be marked with a
particular IP precedence or DSCP and strict priority can then be configured to put all packets of that
marking into that queue. In this case, the marking was used to identify traffic for strict priority
queue.
• Traffic marking can be used to identify traffic for any class-based QoS feature (any feature available
in policy map class configuration mode, although some restrictions exist).
• Traffic marking can be used to assign traffic to a QoS group within a switch. The switch can use the
QoS groups to determine how to prioritize traffic for transmission. The QoS group value is usually
used for one of the two following reasons:
– To leverage a large range of traffic classes. The QoS group value has 64 different individual
markings, similar to DSCP.
– If changing the Precedence or DSCP value is undesirable.
Two Methods for Marking Traffic Attributes
Note This section describes Unconditional marking, which differs from Policer-based marking.
Unconditional marking is based solely on classification.
Method One: Unconditional Explicit Marking (using the set command)
You specify the traffic attribute you want to change with a set command configured in a policy map. The
following table lists the available set commands and the corresponding attribute. For details on the set
command, refer to the Catalyst 4500 Series Switch Command Reference.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-17
Chapter 33 Configuring Quality of Service
Configuring QoS
Table 33-2 set Commands and Applicable Packet Types
set Commands Traffic Attribute Packet Type
set cos Layer 2 CoS value of the outgoing traffic Ethernet IPv4, IPv6
set dscp DSCP value in the ToS byte IPv4, IPv6
set precedence precedence value in the packet header IPv4, IPv6
set qos-group QoS group ID Ethernet, IPv4, IPv6
If you are using individual set commands, those set commands are specified in a policy map. The
following is a sample of a policy map configured with one of the set commands listed in Table 33-2.
In this sample configuration, the set cos command has been configured in the policy map (policy1) to
mark the CoS attribute:
enable
configure terminal
policy map p1
class class1
set cos 3
end
For information on configuring a policy map, see the “Creating a Policy Map” section on page 33-14.
The final task is to attach the policy map to the interface. For information on attaching the policy map
to the interface, see the “Attaching a Policy Map to an Interface” section on page 33-14.
Method Two: Unconditional Tablemap-based Marking
You can create a table map that can be used to mark traffic attributes. A table map is a kind of two-way
conversion chart that lists and maps one traffic attribute to another. A table map supports a many-to-one
type of conversion and mapping scheme. The table map establishes a to-from relationship for the traffic
attributes and defines the change to be made to the attribute. That is, an attribute is set to one value that
is taken from another value. The values are based on the specific attribute being changed. For instance,
the Precedence attribute can be a number from 0 to 7, while the DSCP attribute can be a number from 0
to 63.
The following is a sample table map configuration:
table-map table-map1
map from 0 to 1
map from 2 to 3
exit
The following table lists the traffic attributes for which a to-from relationship can be established using
the table map.
Table 33-3 Traffic Attributes for Which a To-From Relationship Can Be Established
The “To” Attribute The “From” Attribute
Precedence CoS, QoS group, DSCP, Precedence
DSCP COS, QoS group, DSCP, Precedence
CoS DSCP, QoS group, CoS, Precedence
The following is an example of a policy map (policy2) configured to use the table map (table-map1)
created earlier:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-18 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
Policy map policy
class class-default
set cos dscp table table-map
exit
In this example, a mapping relationship was created between the CoS attribute and the DSCP attribute
as defined in the table map.
For information on configuring a policy map to use a table map, “Configuring a Policy Map” section on
page 33-14.
The final task is to attach the policy map to the interface. For information on attaching the policy map
to the interface, see the “Attaching a Policy Map to an Interface” section on page 33-14.
Marking Action Drivers
A marking action can be triggered based on one of the two QoS processing steps.
Classification based: In this case, all the traffic matching a class is marked using either explicit or
tablemap based method. This method is referred to as unconditional marking.
Policer result-based: In this case, a class of traffic is marked differently based on the policer result
(conform/exceed/violate) applicable to that packet. This method is referred to as conditional
marking.
Traffic Marking Procedure Flowchart
Figure 33-3 illustrates the order of the procedures for configuring traffic marking.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-19
Chapter 33 Configuring Quality of Service
Configuring QoS
Figure 33-3 Traffic marking Procedure Flowchart
Start
Create a class map
No Using a Yes
table map? Create a table map
Create a policy map
Create
No additional Yes
policy
maps?
Attach policy map(s)
to interface
127073
Finish
Restrictions for Marking Network Traffic
The following restrictions apply to packet marking actions:
• QoS-group can be marked only in the input direction and can only support unconditional explicit
marking.
• Only explicit marking is supported for policer-based marking.
Multi-attribute Marking Support
Supervisor Engine 7-E can mark more than one QoS attribute of a packet matching a class of traffic. For
example, DSCP, CoS, and QoS-group can all be set together, using either explicit or tablemap-based
marking.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-20 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
Note When using unconditional explicit marking of multiple fields or policer-based multi-field, multi-region
(conform/exceed/violate) marking the number of tablemaps that can be setup in TOS or COS marking
tables will be less than the maximum supported.
Hardware Capabilities for Marking
Supervisor Engine 7-E provides a 256 entry marking action table where each entry specifies the type of
marking actions on COS and DSCP/precedence fields as well as policer action to
transmit/markdown/drop a packet. One such table is supported for each direction, input and output. This
table is used for both unconditional marking as well as policer-based marking. It can be used to support
256 unique marking actions or 64 unique policer-based actions or a combinations of the two.
For each of the marking fields (COS and DSCP), the Supervisor Engine 7-E provides 512 entry marking
tables for each direction. These are similar to mapping tables available on supervisor engines that
support the switch QoS model. However, these provide an ability to have multiple unique mapping tables
that are setup by the user.
For example, the TOS marking table provides marking of DSCP/Precedence fields and can be used as
one of the following:
• 8 different tablemaps with each mapping the 64 DSCP or qos-group values to another DSCP
• 64 (32) different tablemaps with each one mapping 8 CoS (16 CoS and CFi) values to DSCP in input
(output) direction
• a combination of above two types of tablemaps
Similar mappings are available on the 512 entry COS marking table.
Configuring the Policy Map Marking Action
This section describes how to establish unconditional marking action for network traffic.
As a prerequisites, create class map (ipp5) and a policy map. (Refer to the“Configuring a Policy Map”
section on page 33-14).
Note On the Supervisor Engine 7-E, the marking action command options have been extended (refer
to Table 33-2 on page 33-18 andTable 33-3 on page 33-18).
Configuring Tablemap-based Unconditional Marking
To configure table-map based unconditional marking, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# table-map name Configures a tablemap.
Step 3 Switch(config-tablemap)# map from Creates a map from a from_value to a to_value
from_value to to_value
Step 4 Switch(config-tablemap)# exit Exits table-map configuration mode.
Step 5 Switch(config)# policy-map name Enters policy-map configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-21
Chapter 33 Configuring Quality of Service
Configuring QoS
Command Purpose
Step 6 Switch(config-p)# class name Selects the class for QoS actions.
Step 7 Switch(config-p-c)# set cos | dscp | Selects the marking action based on an implicit or explicit
prec cos | dscp | prec | qos-group table-map.
[table name]
Step 8 Switch(config-p-c)# end Exits configuration mode.
Step 9 Switch# show policy-map name Verifies the configuration of the policy-map.
Step 10 Switch# show table-map name Verifies the configuration of the table-map.
The following example shows how to enable marking action using table-map.
Switch(config)# table-map dscp2Cos
Switch(config-tablemap)# map from 8 to 1
Switch(config-tablemap)# exit
Switch(config)# policy-map p1
Switch(config-pmap)# class ipp5
Switch(config-pmap-c)# set cos dscp table dscp2Cos
Switch(config-pmap-c)# end
Switch# show policy-map p1
Policy Map p1
Class ipp5
set cos dscp table dscp2Qos
Switch# show table-map dscp2Cos
Table Map dscp2Cos
from 8 to 1
default copy
Configuring Policer Result-based Conditional Marking
To configure policer result-based conditional marking, setup a single rate or dual rate policer. Refer to
the “How to Implement Policing” section on page 33-15.
This example shows how to configure a two rate three-color policer with explicit actions for each policer
region:
Switch# configure terminal
Switch(config-pmap-c)# policer cir percent 20 pir percent 30
Switch(config-pmap-c-policer)# conform-action set-cos-transmit 3 set-dscp-transmit 10
Switch(config-pmap-c-policer)# exceed-action set-cos-transmit 4 set-dscp-transmit 20
Switch(config-pmap-c-policer)# violate action drop
Switch# show policy-map p1
Policy Map police
Class ipp5
police cir percent 20 pir percent 30
conform-action set-cos-transmit 3
conform-action set-dscp-transmit af11
exceed-action set-cos-transmit 4
exceed-action set-dscp-transmit af22
violate-action drop
Marking Statistics
The marking statistics indicate the number of packets that are marked.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-22 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
For unconditional marking, the classification entry points to an entry in the marking action table that in
turn indicates the fields in the packet that are marked. Therefore, the classification statistics by itself
indicates the unconditional marking statistics.
For a conditional marking using policer, provided the policer is a packet rate policer, you cannot
determine the number packets marked because the policer only provides byte statistics for different
policing results.
Shaping, Sharing (Bandwidth), Priority Queuing, Queue-limiting and DBL
Supervisor Engine 7-E supports the Classification-based (class-based) mode for transmit queue
selection. In this mode, the transmit queue selection is based on the Output QoS classification lookup.
Note Only output (egress) queuing is supported.
The Supervisor Engine 7-E hardware supports 8 transmit queues per port. Once the forwarding decision
has been made to forward a packet out a port, the output QoS classification determines the transmit
queue into which the packet needs to be enqueued.
By default, in Supervisor Engine 7-E, without any service policies associated with a port, there are two
queues (a control packet queue and a default queue) with no guarantee as to the bandwidth or kind of
prioritization. The only exception is that system generated control packets are enqueued into control
packet queue so that control traffic receives some minimum link bandwidth.
Queues are assigned when an output policy attached to a port with one or more queuing related actions
for one or more classes of traffic. Because there are only eight queues per port, there can be at most eight
classes of traffic (including the reserved class, class-default) with queuing action(s). Classes of traffic
that do not have any queuing action are referred to as non-queuing classes. Non-queuing class traffic
ends up using the queue corresponding to class class-default.
When a queuing policy (a policy with queuing action) is attached, the control packet queue is deleted
and the control packets are enqueued into respective queue per their classification. Note that this differs
from the way control-traffic was prioritized in the Catalyst 4924, Catalyst 4948, Catalyst 4948-10GE,
and the Supervisor Engines II+, II+10GE, VI, V, and V-10GE. On these platforms, by default, control
traffic was guaranteed 25 per cent of the link bandwidth whether QoS was configured. If this same
behavior is required on Supervisor Engine 7-E, an egress QoS class must be configured to match
IP Precedence 6 and 7 traffic, and a bandwidth guarantee must be configured.
Dynamic resizing of queues (queue limit class-map action) is supported through the use of the
queue-limit command. Based on the chassis and line card type, all eight queues on a port are configured
with equal queue size.
Shaping
Shaping enables you to delay out-of-profile packets in queues so that they conform to a specified profile.
Shaping is distinct from policing. Policing drops packets that exceed a configured threshold, whereas
shaping buffers packets so that traffic remains within a given threshold. Shaping offers greater
smoothness in handling traffic than policing. You enable average-rate traffic shaping on a traffic class
with the policy-map class configuration command.
Supervisor Engine 7-E supports a range of 32kbps to 10 gbps for shaping, with a precision of
approximately +/- 0.75 per cent.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-23
Chapter 33 Configuring Quality of Service
Configuring QoS
When a queuing class is configured without any explicit shape configuration, the queue shape is set to
the link rate.
To configure class-level shaping in a service policy, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# policy-map Creates a policy map by entering the policy-map name, and enter
policy-map-name policy-map configuration mode.
By default, no policy maps are defined.
Step 3 Switch(config-pmap)# class class-name Specifies the name of the class whose traffic policy you want to
create or change, and enter policy-map class configuration mode.
By default, no traffic classes are defined.
Step 4 Switch(config-pmap-class)# shape Enables average-rate traffic shaping.
average {cir-bps [optional_postfix] |
percent percent} You can specify the shaping rate in absolute value or as a
percentage:
• For cir-bps [optional_postfix], specify the shaping rate in bps.
Range is 32000 to 10000000000 bps. Supply an optional postfix
(K, M, G).
• For percent, specify the percentage of link rate to shape the
class of traffic. The range is 1 to 100.
By default, average-rate traffic shaping is disabled.
Step 5 Switch(config-pmap-class)# exit Returns to policy-map configuration mode.
Step 6 Switch(config-pmap)# exit Returns to global configuration mode.
Step 7 Switch(config)# interface interface-id Specifies a physical port and enter interface configuration mode.
Step 8 Switch(config-interface)# Specifies the policy-map name, and apply it a physical interface.
service-policy output policy-map-name
Step 9 Switch(config-interface)# end Returns to privileged EXEC mode.
Step 10 Switch# show policy-map Verifies your entries.
[policy-map-name [class
class-map-name]]
or
Switch# show policy-map interface
interface-id
Step 11 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To delete an existing policy map, use the no policy-map policy-map-name global configuration
command. To delete an existing class, use the no class class-name policy-map configuration command.
To disable the average-rate traffic shaping, use the no shape average policy-map class configuration
command.
This example shows how to configure class-level, average-rate shaping. It limits traffic class class1 to a
data transmission rate of 256 kbps:
Switch# configure terminal
Switch(config)# policy-map policy1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-24 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
Switch(config-pmap)# class class1
Switch(config-pmap-c)# shape average 256000
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface gigabitethernet1/1
Switch(config-if)# service-policy output policy1
Switch(config-if)# end
Switch#
Switch# show policy-map policy1
Policy Map policy1
Class class1
shape average 256000
This example shows how to configure class-level, average shape percentage to 32% of link bandwidth
for queuing-class traffic:
Switch# configure terminal
Switch(config)# policy-map queuing-policy
Switch(config-pmap)# class queuing-class
Switch(config-pmap-c)# shape average percent 32
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface gigabitethernet1/1
Switch(config-if)# service-policy output queuing-policy1
Switch(config-if)# end
Switch #
Switch# show policy-map queuing-policy
Policy Map queuing-policy
Class queuing-class
Average Rate Traffic Shaping
cir 32%
Sharing(bandwidth)
The bandwidth assigned to a class of traffic is the minimum bandwidth that is guaranteed to the class
during congestion. Transmit Queue Sharing is the process by which output link bandwidth is shared
among multiple queues of a given port.
Supervisor Engine 7-E supports a range of 32 kbps to 10 gbps for sharing, with a precision of
approximately +/- 0.75 per cent. The sum of configured bandwidth across all queuing classes should not
exceed the link bandwidth.
To configure class-level bandwidth action in a service policy, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# policy-map Creates a policy map by entering the policy-map name, and enter
policy-map-name policy-map configuration mode.
By default, no policy maps are defined.
Step 3 Switch(config-pmap)# class class-name Specifies the name of the class whose traffic policy you want to
create or change, and enter policy-map class configuration mode.
By default, no traffic classes are defined.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-25
Chapter 33 Configuring Quality of Service
Configuring QoS
Command Purpose
Step 4 Switch(config-pmap-class)# bandwidth Specifies the minimum bandwidth provided to a class belonging to
{bandwidth-kbps | percent percent} the policy map when there is traffic congestion in the switch. If the
switch is not congested, the class receives more bandwidth than you
specify with the bandwidth command.
By default, no bandwidth is specified.
You can specify the bandwidth in kbps or as a percentage:
o For bandwidth-kbps, specify the bandwidth amount in kbps
assigned to the class. The range is 32 to 10000000.
o For percent, specify the percentage of available bandwidth
assigned to the class. The range is 1 to 100.
Specify all the class bandwidths in either kbps or in percentages, but
not a mix of both.
Step 5 Switch(config-pmap-class)# exit Returns to policy-map configuration mode.
Step 6 Switch(config-pmap)# exit Returns to global configuration mode.
Step 7 Switch(config)# interface interface-id Specifies a physical port and enter interface configuration mode.
Step 8 Switch(config-interface)# Specifies the policy-map name, and apply it a physical interface.
service-policy output policy-map-name
Step 9 Switch(config-interface)# end Returns to privileged EXEC mode.
Step 10 Switch# show policy-map Verifies your entries.
[policy-map-name [class
class-map-name]]
or
Switch# show policy-map interface
interface-id
Step 11 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To delete an existing policy map, use the no policy-map policy-map-name global configuration
command. To delete an existing class, use the no class class-name policy-map configuration command.
To return to the default bandwidth, use the no bandwidth policy-map class configuration command.
This example shows how to create a class-level policy map called policy11 for three classes called prec1,
prec2, and prec3. In the policy for these classes, 30 percent of the available bandwidth is assigned to the
queue for the first class, 20 percent is assigned to the queue for the second class, and 10 percent is
assigned to the queue for the third class.
Switch # configure terminal
Switch(config)# policy-map policy11
Switch(config-pmap)# class prec1
Switch(config-pmap-c)# bandwidth percent 30
Switch(config-pmap-c)# exit
Switch(config-pmap)# class prec2
Switch(config-pmap-c)# bandwidth percent 20
Switch(config-pmap-c)# exit
Switch(config-pmap)# class prec3
Switch(config-pmap-c)# bandwidth percent 10
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface gigabitethernet1/1
Switch(config-if)# service-policy output policy11
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-26 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
Switch(config-if)# end
Switch #
Switch# show policy-map policy11
Policy Map policy11
Class prec1
bandwidth percent 30
Class prec2
bandwidth percent 20
Class prec3
bandwidth percent 10
This example shows how to create a class-level policy map called policy11 for three classes called prec1,
prec2, and prec3. In the policy for these classes, 300 mbps of the available bandwidth is assigned to the
queue for the first class, 200 mbps is assigned to the queue for the second class, and 100 mbps is assigned
to the queue for the third class.
Switch # configure terminal
Switch(config)# policy-map policy11
Switch(config-pmap)# class prec1
Switch(config-pmap-c)# bandwidth 300000
Switch(config-pmap-c)# exit
Switch(config-pmap)# class prec2
Switch(config-pmap-c)# bandwidth 200000
Switch(config-pmap-c)# exit
Switch(config-pmap)# class prec3
Switch(config-pmap-c)# bandwidth 100000
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface gigabitethernet1/1
Switch(config-if)# service-policy output policy11
Switch(config-if)# end
Switch #
Switch# show policy-map policy11
Policy Map policy11
Class prec1
bandwidth 300000 (kbps)
Class prec2
bandwidth 200000 (kbps)
Class prec3
bandwidth 100000 (kbps)
When a queuing class is configured without any explicit share/bandwidth configuration, because the
queue is not guaranteed any minimum bandwidth, the hardware queue is programmed to get a share of
any unallocated bandwidth on the port as shown in the following example.
If there is no bandwidth remaining for the new queue or if the unallocated bandwidth is not sufficient to
meet the minimum configurable rate (32kbps) for all queues which do not have any explicit
share/bandwidth configuration, then the policy association is rejected.
For example, if there are two queues as given below
policy-map queue-policy
class q1
bandwidth percent 10
class q2
bandwidth percent 20
then the bandwidth allocation for the queues is as follows
q1 = 10%
q2 = 20%
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-27
Chapter 33 Configuring Quality of Service
Configuring QoS
class-default = 70%
Similarly, when another queuing class (say q3) is added without any explicit bandwidth (say, just a shape
command), then the bandwidth allocation is
q1 = 10%
q2 = 20%
q3 = min(35%, q3-shape-rate)
class-default = max(35%, (100 - (q1 + q2 + q3 )))
Priority queuing
On Supervisor Engine 7-E only one transmit queue on a port can be configured as strict priority (termed
Low Latency Queue, or LLQ).
LLQ provides strict-priority queuing for a traffic class. It enables delay-sensitive data, such as voice, to
be sent before packets in other queues. The priority queue is serviced first until it is empty or until it is
under its shape rate. Only one traffic stream can be destined for the priority queue per class-level policy.
You enable the priority queue for a traffic class with the priority policy-map class configuration
command at the class mode.
A LLQ can starve other queues unless it is rate limited. Supervisor Engine 7-E does not support
conditional policing where a 2-parameter policer (rate, burst) becomes effective when the queue is
congested (based on queue length). However, it supports application of an unconditional policer to rate
limit packets enqueued to the strict priority queue.
When a priority queue is configured on one class of a policy map, only bandwidth remaining is accepted
on other classes, guaranteeing a minimum bandwidth for other classes from the remaining bandwidth of
what is left after using the priority queue. When a priority queue is configured with a policer, then either
bandwidth or bandwidth remaining is accepted on other classes.
Note Use bandwidth or bandwidth remaining on all classes. You cannot apply bandwidth on one class and
bandwidth remaining on another class within a policy map.
To enable class-level priority queuing in a service policy, follow these steps:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# policy-map Creates a policy map by entering the policy-map name, and enter
policy-map-name policy-map configuration mode.
By default, no policy maps are defined.
Step 3 Switch(config-pmap)# class class-name Specifies the name of the class whose traffic policy you want to
create or change, and enter policy-map class configuration mode.
By default, no traffic classes are defined.
Step 4 Switch(config-pmap-class)# priority Enables the strict-priority queue, and give priority to a class of
traffic.
By default, strict-priority queueing is disabled.
Step 5 Switch(config-pmap-class)# exit Returns to policy-map configuration mode.
Step 6 Switch(config-pmap)# exit Returns to global configuration mode.
Step 7 Switch(config)# interface interface-id Specifies a physical port and enter interface configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-28 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
Command Purpose
Step 8 Switch(config-interface)# Specifies the policy-map name, and apply it a physical interface.
service-policy output policy-map-name
Step 9 Switch(config-interface)# end Returns to privileged EXEC mode.
Step 10 Switch# show policy-map Verifies your entries.
[policy-map-name [class
class-map-name]]
or
Switch# show policy-map interface
interface-id
Step 11 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To delete an existing policy map, use the no policy-map policy-map-name global configuration
command. To delete an existing class, use the no class class-name policy-map configuration command.
To disable the priority queue, use the no priority policy-map class configuration command.
This example shows how to configure a class-level policy called policy1. Class 1 is configured as the
priority queue, which is serviced first until it is empty.
Switch# configure terminal
Switch(config)# policy-map policy1
Switch(config-pmap)# class class1
Switch(config-pmap-c)# priority
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface gigabitethernet1/1
Switch(config-if)# service-policy output policy1
Switch(config-if)# end
Switch #
Switch# show policy-map policy1
Policy Map policy1
Class class1
priority
Queue-limiting
When a class-based queue is instantiated on a physical port, it is set up with a default size. This size
represents the number of queue entries in which packets belonging to that class of traffic can be queued.
The scheduler moves packets from the queue that are ready for transmission, based on the queue shape,
bandwidth, and priority configuration.
The queue-limit provides the maximum number of packets that can be in the queue at any given time.
When the queue is full, an attempt to enqueue any further packets results in tail drop. However, if
dynamic buffer limiting (DBL) is enabled on the queue, packets get a probabilistic drop based on the
DBL algorithm, even when the queue is not full.
The queue-limit command can be configured under a class only when queue scheduling, such as
bandwidth, shape, or priority is already configured. The only exception to this requirement is the support
of the stand-alone queue-limit command on the class-default class.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-29
Chapter 33 Configuring Quality of Service
Configuring QoS
Queue Memory
The number of queue entries that can be allocated has to be a multiple of 8 and can range from 16 to
8184. When a class-based queue is instantiated on a physical port, it is given a default number of entries.
This default queue size is based on the number of slots in the chassis and the number of front-panel ports
in each slot.
Supervisor Engine 7-E has 1M (1,048,576) queue entries of which the system sets aside 100K (102,400)
queue entries in a free reserve pool. Of the remaining queue entries, the drop port is provided 8184
entries, 24576 entries for recirculation ports and the CPU ports are assigned 8656 entries. The remaining
entries are divided equally among the slots in the chassis. In a redundant chassis the two supervisor slots
are treated as one for the purpose of this entries distribution. Within each slot the number of queue entries
are equally divided among the front-panel ports present on the line card in that slot.
When the user configuration for queue entries on an interface exceeds its dedicated quota, the system
attempts to satisfy the configuration from the free reserve pool. The entries from the free reserve pool
are allocated to interfaces on a first-come first-served basis.
Service Policy Association
When a QoS service-policy with queuing actions is configured, but no explicit queue-limit command is
attached in the egress direction on a physical interface, each of the class-based queues gets the same
number of queue entries from within the dedicated quota for that physical port. When a queue is
explicitly given a size using the queue-limit command, the switch tries to allocate all the entries from
within the dedicated quota for the interface. If the required number of entries is greater than the
dedicated quota for the interface, the switch tries to allocate the entries from the free reserve.
The queue entries associated with a queue always have to be consecutive. This requirement can result in
fragmentation of the 512K of the queue entries that are shared across the switch. For example, an
interface may not have enough entries for a queue in its dedicated quota and thus have to use the free
reserve to set up that queue. In this case, the queue entries from the dedicated quota remain unused
because they cannot be shared with any other port or slot.
When the QoS service-policy associated with an interface is removed, any queue entries taken from the
free reserve are returned to the free reserve pool. The interface queuing configuration reverts to two
queues — class-default and the control-packet queue with default shape, bandwidth, and size. The
control-packet queue is set up with size 16 whereas the default queue is set up with the maximum size
possible based on the dedicated quota for that interface.
Queue Allocation Failure
The switch might not be able to satisfy the explicit queue size required on one or more queues on an
interface because of fragmentation of queue memory or lack of enough free reserve entries. In this
scenario, the switch logs an error message to notify you of the failure. The QoS service-policy is left
configured on the interface. You can fix the error by removing the QoS service-policy and examining
the current usage of the queue entries from the free reserve by other ports on the switch.
To configure class-level queue-limit in a service policy, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# policy-map Creates a policy map by entering the policy-map name, and enter
policy-map-name policy-map configuration mode.
By default, no policy maps are defined.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-30 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
Command Purpose
Step 3 Switch(config-pmap)# class class-name Specifies the name of the class whose traffic policy you want to
create or change, and enter policy-map class configuration mode.
By default, no traffic classes are defined.
Step 4 Switch(config-pmap-class)# shape Enables average-rate traffic shaping.
average {cir-bps [optional_postfix] |
percent percent} You can specify the shaping rate in absolute value or as a
percentage:
• For cir-bps [optional_postfix], specify the shaping rate in bps.
Range is 32000 to 10000000000 bps. Supply an optional postfix
(K, M, G).
• For percent, specify the percentage of link rate to shape the
class of traffic. The range is 1 to 100.
By default, average-rate traffic shaping is disabled.
Step 5 Switch(config-pmap-class)# queue-limit Provides an explicit queue size in packets. The size must be a
number-of-packets multiple of 8 and ranging from 16 to 8184.
Step 6 Switch(config-pmap-class)# exit Returns to policy-map configuration mode.
Step 7 Switch(config-pmap)# exit Returns to global configuration mode.
Step 8 Switch(config)# interface interface-id Specifies a physical port and enter interface configuration mode.
Step 9 Switch(config-interface)# Specifies the policy-map name, and apply it a physical interface.
service-policy output policy-map-name
Step 10 Switch(config-interface)# end Returns to privileged EXEC mode.
Step 11 Switch# show policy-map Verifies your entries.
[policy-map-name [class
class-map-name]]
or
Switch# show policy-map interface
interface-id
Step 12 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To remove the explicit queue size use the no queue-limit command under the class in a policy-map.
This example shows how to configure a class-based queue with an explicit queue-limit command. It
limits traffic class class1 to a queue of size 4048:
Switch# configure terminal
Switch(config)# policy-map policy1
Switch(config-pmap)# class class1
Switch(config-pmap-c)# shape average 256000
Switch(config-pmap-c)# queue-limit 4048
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface gigabitethernet1/1
Switch(config-if)# service-policy output policy1
Switch(config-if)# end
Switch#
Switch# show policy-map policy1
Policy Map policy1
Class class1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-31
Chapter 33 Configuring Quality of Service
Configuring QoS
shape average 256000
queue-limit 4048
Switch#
Active Queue Management (AQM) via Dynamic Buffer Limiting (DBL)
AQM provides buffering control of traffic flows prior to queuing a packet into a transmit queue of a port.
This is of significant interest in a shared memory switch, ensuring that certain flows do not hog the
switch packet memory.
Note Supervisor Engine 7-E supports active switch buffer management via DBL.
Except for the default class of traffic (class class-default), you can configure DBL action only when at
least one of the other queuing action is configured.
To configure class-level dbl action along with shaping in a service policy, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# policy-map Creates a policy map by entering the policy-map name, and enter
policy-map-name policy-map configuration mode.
By default, no policy maps are defined.
Step 3 Switch(config-pmap)# class class-name Specifies the name of the class whose traffic policy you want to
create or change, and enter policy-map class configuration mode.
By default, no traffic classes are defined.
Step 4 Switch(config-pmap-class)# shape Enables average-rate traffic shaping.
average cir-bps
Specify the committed information rate, the bit rate that traffic is
shaped to, in bps. The range is 32000 to 10000000000 bps.
By default, average-rate traffic shaping is disabled.
Step 5 Switch(config-pmap-class)# dbl Enables DBL on the queue associated with this class of traffic
Step 6 Switch(config-pmap-class)# exit Returns to policy-map configuration mode.
Step 7 Switch(config-pmap)# exit Returns to global configuration mode.
Step 8 Switch(config)# interface interface-id Specifies a physical port and enter interface configuration mode.
Step 9 Switch(config-interface)# Specifies the policy-map name, and apply it a physical interface.
service-policy output policy-map-name
Step 10 Switch(config-interface)# end Returns to privileged EXEC mode.
Step 11 Switch# show policy-map Verifies your entries.
[policy-map-name [class
class-map-name]]
or
Switch# show policy-map interface
interface-id
Step 12 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-32 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
To delete an existing policy map, use the no policy-map policy-map-name global configuration
command. To delete an existing class, use the no class class-name policy-map configuration command.
To disable DBL on the associated queue, use the no dbl policy-map class configuration command.
The following example shows how to configure class-level, DBL action along with average-rate
shaping. It enables DBL on the queue associated with traffic-class class1.
Switch# configure terminal
Switch(config)# policy-map policy1
Switch(config-pmap)# class class1
Switch(config-pmap-c)# shape average 256000
Switch(config-pmap-c)# dbl
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface gigabitethernet1/1
Switch(config-if)# service-policy output policy1
Switch(config-if)# end
Switch#
Switch# show policy-map policy1
Policy Map policy1
Class class1
shape average 256000
dbl
Transmit Queue Statistics
Transmit queue statistics are visible by entering the show policy-map interface command:
Switch# show policy-map interface gigabitEthernet 1/1
GigabitEthernet1/1
Service-policy output: queuing-policy
Class-map: queuing-class (match-all)
1833956 packets
Match: cos 1
Queueing
(total drops) 1006239
(bytes output) 56284756
shape (average) cir 320000000, bc 1280000, be 1280000
target shape rate 320000000
Class-map: class-default (match-any)
1 packets
Match: any
(total drops) 0
(bytes output) 2104
Enabling Per-Port Per-VLAN QoS
The per-port per-VLAN QoS feature enables you to specify different QoS configurations on different
VLANs on a given interface. Typically, you use this feature on trunk or voice VLANs (Cisco IP Phone)
ports, as they belong to multiple VLANs.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-33
Chapter 33 Configuring Quality of Service
Configuring QoS
To configure per-port per-VLAN QoS, perform this task:
Command Purpose
Step 1 Switch(config)# interface {fastethernet | gigabitethernet | Selects the interface to configure.
tengigabitethernet} slot/interface | Port-channel number
Step 2 Switch(config-if)# vlan-range vlan_range Specifies the VLANs involved.
Step 3 Switch(config-if-vlan-range)# service-policy Specifies the policy-map and direction.
{input | output} policy-map
Step 4 Switch(config-if-vlan-range)# exit Exits class-map configuration mode.
Step 5 Switch(config-if)# end Exits configuration interface mode.
Step 6 Switch# show policy-map interface interface_name Verifies the configuration.
Example 1
Figure 33-4 displays a sample topology for configuring PVQoS. The trunk port gi3/1 is comprised of
multiple VLANs (101 and 102). Within a port, you can create your own service policy per VLAN. This
policy, performed in hardware, might consist of ingress and egress Policing or giving precedence to
voice packet over data.
Figure 33-4 Per-Port Per-VLAN Topology
Port gi3/1
L2 trunk
VLAN Police1
Police1
101
101 Dscp
Dscp
VLAN
VLAN DSCP
DSCP
102
102 DSCP
DSCP
Port gi3/2
VLAN CoS
103 CoS
VLAN DSCP
104 DSCP
130602
Service Policy/VLAN
Within a port
The following configuration file shows how to perform ingress and egress policing per VLAN using the
policy-map P31_QOS applied to port Gigabit Ethernet 3/1:
ip access-list 101 permit ip host 1.2.2.2 any
ip access-list 103 permit ip any any
Class-map match-all RT
match ip access-group 101
Class-map Match all PD
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-34 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
match ip access-group 103
Policy-map P31_QoS
Class RT
Police 200m 16k conform transmit exceed drop
Class PD
Police 100m 16k conform transmit exceed drop
Interface Gigabit 3/1
Switchport
Switchport trunk encapsulation dot1q
Switchport trunk allowed vlan 101-102
Vlan range 101
Service-policy input P31_QoS
Service-policy output P31_QoS
Vlan range 102
Service-policy input P32_QoS
Service-policy output P32_QoS
Example 2
Let us assume that interface Gigabit Ethernet 6/1 is a trunk port and belongs to VLANs 20, 300-301, and
400. The following example shows how to apply policy-map p1 for traffic in VLANs 20 and 400 and
policy map p2 to traffic in VLANs 300 through 301:
Switch# configure terminal
Switch(config)# interface gigabitethernet 6/1
Switch(config-if)# vlan-range 20,400
Switch(config-if-vlan-range)# service-policy input p1
Switch(config-if-vlan-range)# exit
Switch(config-if)# vlan-range 300-301
Switch(config-if-vlan-range)# service-policy output p2
Switch(config-if-vlan-range)# end
Switch#
Example 3
The following command shows how to display policy-map statistics on VLAN 20 configured on Gigabit
Ethernet interface 6/1:
Switch# show policy-map interface gigabitEthernet 6/1 vlan 20
GigabitEthernet6/1 vlan 20
Service-policy input: p1
Class-map: c1 (match-all)
0 packets
Match: cos 1
Match: access-group 100
police:
cir 100000000 bps, bc 3125000 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
drop
conformed 0000 bps, exceed 0000 bps
Class-map: class-default (match-any)
0 packets
Match: any
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-35
Chapter 33 Configuring Quality of Service
Configuring QoS
Example 4
The following command shows how to display policy-map statistics on all VLANs configured on
Gigabit Ethernet interface 6/1:
Switch# show policy-map interface gigabitEthernet 6/1
GigabitEthernet6/1 vlan 20
Service-policy input: p1
Class-map: c1 (match-all)
0 packets
Match: cos 1
Match: access-group 100
police:
cir 100000000 bps, bc 3125000 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
drop
conformed 0000 bps, exceed 0000 bps
Class-map: class-default (match-any)
0 packets
Match: any
GigabitEthernet6/1 vlan 300
Service-policy output: p2
Class-map: c1 (match-all)
0 packets
Match: cos 1
Match: access-group 100
QoS Set
dscp 50
police:
cir 200000000 bps, bc 6250000 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
drop
conformed 0000 bps, exceed 0000 bps
Class-map: class-default (match-any)
0 packets
Match: any
GigabitEthernet6/1 vlan 301
Service-policy output: p2
Class-map: c1 (match-all)
0 packets
Match: cos 1
Match: access-group 100
QoS Set
dscp 50
police:
cir 200000000 bps, bc 6250000 bytes
conformed 0 bytes; actions:
transmit
exceeded 0 bytes; actions:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-36 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
drop
conformed 0000 bps, exceed 0000 bps
Policy Associations
Supervisor Engine 7-E supports per-port, per-VLAN policies. The associated policies are attached to the
interface, VLAN, and a specific VLAN on a given port, respectively.
A policy can be associated with a variety of objects. The following table lists the objects and the actions
allowed.
Table 33-1 Table QoS Policy Associations
Object Action
Physical port Policing, marking, and queuing
VLAN Policing and marking
Port and VLAN (PV) Policing and marking
EtherChannel Policing and marking
EtherChannel member port Queuing
Qos Action Restrictions
• The same actions cannot be performed multiple times in a given direction on different targets. In
other words, it is not possible to police the packets both on port and VLAN in the input direction.
However, the user can police on the input port and on the output VLAN.
• Queuing actions are only allowed in the egress direction and only on the physical port.
• Percentage-based actions like policer cannot be configured on a VLAN, Port and VLAN (PV) and
EtherChannel.
• Port channel or VLAN configuration can only have a policing or a marking action, not a queueing
action.
Qos Policy priorities
• If a policy on a port and a VLAN are configured with conflicting actions (such as policing or
marking actions on both a port and VLAN), the port policy is picked.
• If policy on a VLAN on a given port must be over-written, the user can configure PV policy.
Qos Policy merging
Applicable policies are applied to a given packet in given direction. For example, if you configure egress
VLAN-based police and marking, followed by selective queuing on the port, then actions from both
policies will be applied for this packet.
The following policy-map configuration restrictions are imposed on an EtherChannel:
• only policing and marking actions are supported at the EtherChannel level
• only queuing actions are supported at the physical member port level
A packet can be marked (dscp or cos fields) by the EtherChannel policy. If the physical member port
policy uses a classification based on dscp or cos fields, it must be based on the marked (modified) value.
To ensure proper operation, the following restriction is placed on the EtherChannel.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-37
Chapter 33 Configuring Quality of Service
Configuring QoS
The classification criteria for the policy-map on the physical member ports has to based only on one type
of field:
• dscp
• precedence
• cos
• any non marking field (no dscp or cos based classification)
Classification criteria for the policy-map on the physical member ports cannot be based on a
combination of fields. This restriction ensures that if the EtherChannel policy is marking down dscp or
cos, the marked (modified) value-based classification can be implemented in hardware.
Note Classification criteria for the policy-map on the physical member ports cannot be modified to add a new
type of field.
Auto-QoS is not supported on EtherChannel or its member ports. A physical port configured with
Auto-QoS is not allowed to become a member of a physical port.
Software QoS
At the highest level, there are two types of locally sourced traffic (such as control protocol packets,
pings, and telnets) from the switch: high priority traffic (typically the control protocol packets like OSPF
Hellos and STP) and low priority packets (all other packet types).
The QoS treatment for locally-sourced packets differs for the two types.
Supervisor Engine 7-E provides a way to apply QoS to packets processed in the software path. The
packets that get this QoS treatment in software can be classified into two types: software switched
packets and software generated packets.
On reception, software switched packets are sent to the CPU that in turn sends them out of another
interface. For such packets, input software QoS provides input marking and output software QoS
provides output marking and queue selection.
The software generated packets are the ones locally sourced by the switch. The type of output software
QoS processing applied to these packets is the same as the one applied to software switched packets. The
only difference in the two is that the software switched packets take input marking of the packet into
account for output classification purpose.
High Priority Packets
High priority packets are marked as one of the following:
• internally with PAK_PRIORITY
• with IP Precedence of 6 (for IP packets)
• with CoS of 6 (for VLAN Tagged packets)
These packets behave as follows:
• They are not dropped because of any policing, AQM, drop thresholds (or any feature that can drop
a packet) configured as per the egress service policy. However, they might be dropped because of
hardware resource constraints (packet buffers, queue full, etc.).
• They are classified and marked as per the marking configuration of the egress service policy that
could be a port or VLAN (refer to the “Policy Associations” section on page 33-37.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-38 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
• These high priority packets are enqueued to queue on the egress port based on the following criteria:
– If there is no egress queuing policy on the port, the packet is queued to a control packet queue
that is setup separately from the default queue and has 5 percent of the link bandwidth reserved
for it.
– If there is an egress queuing policy on the port, the queue is selected based on the classification
criteria applicable to the packet.
Low Priority Packets
Packets that are not considered high priority (as described previously) are considered unimportant.
These include locally sourced pings, telnet, and other protocol packets. They undergo the same treatment
as any other packet that is transiting the given transmit port including egress classification, marking and
queuing.
Applying Flow-based QoS Policy
Flow based QoS enables microflow policing and marking capability to dynamically learn traffic flows,
It also rate limits each unique flow to an individual rate. Flow based QoS is available on Supervisor
Engine 7-E with the built-in NetFlow hardware support.
For more overview information, refer to the “Flow-based QoS” section on page 33-10.
The following steps show how to apply Flow based QoS policy to QoS targets:
Step 1 Create a FNF flow record by specifying the key fields that identify unique flows. You can use any FNF
flow records that are associated with the FNF monitor.
Step 2 Create a class-map to specify the set of match criteria. Include the FNF flow record from Step 1 in the
class-map match criteria using the match flow record command. Then, configure the class-map to
match all the match criteria with class-map match-all class_name.
Step 3 Create a policy-map and define actions associated with class-map from Step 2.
Step 4 Attach the policy to one or more QoS targets.
Examples
The following examples illustrate how to configure Flow based QoS policy and apply microflow
policers on individual flows.
Example 1
This example assumes there are multiple users (identified by source IP address) on the subnet
192.168.10.*. The configuration below shows how to configure a flow based QoS policy that uses micro
policing to limit the per-user traffic with the source address in the range of 192.168.10.*. The microflow
policer is configured with a CIR of 1Mbps, “conform action” as transmit, and “exceed action” as drop.
Step 1: Define an ACL to match traffic with specified source address.
Switch(config)# ip access-list extended UserGroup1
Switch(config-ext-nacl)# permit ip 192.168.10.0 0.0.0.255 any
Switch(config-ext-nacl)# exit
Switch(config)#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-39
Chapter 33 Configuring Quality of Service
Configuring QoS
Step 2: Define a flow record to create flows with source address as key.
Switch(config)# flow record r1
Switch(config-flow-record)# match ipv4 source address
Switch(config-flow-record)# exit
Switch(config)#
Step 3: Configure classmap to match on the UserGroup1 and specify flow record definition for flow
creation.
Switch(config)# class-map match-all c1
Switch(config-cmap)# match access-group name UserGroup1
Switch(config-cmap)# match flow record r1
Switch(config-cmap)# exit
Switch(config)#
Step 4: Configure flow based QoS policy-map with microflow policing action for the matching traffic.
Switch(config)# policy-map p1
Switch(config-pmap)# class c1
Switch(config-pmap-c)# police cir 1m
Switch(config-pmap-c-police)# conform-action transmit
Switch(config-pmap-c-police)# exceed-action drop
Switch(config-pmap-c-police)# exit
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Step 5: Attach flow QoS policy to the interface.
Switch(config)# interface gigabitEthernet3/1
Switch(config-if)# service-policy input p1
Switch(config-if)#
Use the show commands (described in the policy and marking sections of this chapter) to display the
policy-map configuration and interface specific policy-map statistics.
Example 2.
This example assumes there are multiple users (identified by source IP address) on subnets 192.168.10.*
and 172.20.55.*. The first requirement is to police with a CIR of 500Kbps and a PIR of 650Kbps on any
TCP traffic originating from 192 network to any destination at any given time. The exceed action
keyword marks down the dscp value to 32. The second requirement is to police per-user traffic
originating from 172 network to CIR of 2Mbps and unconditionally mark the traffic with dscp 10.
Step 1: Define an ACL to match traffic with specified source address.
Switch(config)# ip access-list extended UserGroup1
Switch(config-ext-nacl)# permit ip 19 2.168.10.0 0.0.0.255 any
Switch(config-ext-nacl)# exit
Switch(config)# ip access-list extended UserGroup2
Switch(config-ext-nacl)# permit ip 172.20.55.0 0.0.0.255 any
Switch(config-ext-nacl)# exit
Switch(config)#
Step 2: Define a flow record to create flows with source address as key.
Switch(config)# flow record r1
Switch(config-flow-record)# match ipv4 source address
Switch(config-flow-record)# match ipv4 destination address
Switch(config-flow-record)# match transport tcp source-port
Switch(config-flow-record)# match transport tcp destination-port
Switch(config-flow-record)# exit
Switch(config)# flow record r2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-40 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring QoS
Switch(config-flow-record)# match ipv4 source address
Switch(config-flow-record)# exit
Switch(config)#
Step 3: Configure classmap to match on the UserGroup1 and specify flow record definition for flow
creation.
Switch(config)# class-map match-all c1
Switch(config-cmap)# match access-group name UserGroup1
Switch(config-cmap)# match flow record r1
Switch(config-cmap)# exit
Switch(config)# class-map match-all c2
Switch(config-cmap)# match access-group name UserGroup2
Switch(config-cmap)# match flow record r2
Switch(config-cmap)# exit
Switch(config)#
Step 4: Configure flow based QoS policy-map with microflow policing action for the matching traffic.
Switch(config)# policy-map p1
Switch(config-pmap)# class c1
Switch(config-pmap-c)# police cir 500k pir 650k
Switch(config-pmap-c-police)# conform-action transmit
Switch(config-pmap-c-police)# exceed-action set-dscp-transmit 32
Switch(config-pmap-c-police)# violate-action drop
Switch(config-pmap-c-police)# exit
Switch(config-pmap-c)# exit
Switch(config-pmap)# class c2
Switch(config-pmap-c)# set dscp 10
Switch(config-pmap-c)# police cir 2m
Switch(config-pmap-c-police)# conform-action transmit
Switch(config-pmap-c-police)# exceed-action drop
Switch(config-pmap-c-police)# exit
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Step 5: Attach flow QoS policy to the interface.
Switch(config)# interface gigabitEthernet3/1
Switch(config-if)# service-policy input p1
Switch(config-if)# exit
Use the show commands described in the QoS section to display the policy-map configuration and
interface specific policy-map statistics.
Example 3
Assume that there are two active flows on FastEthernet interface 6/1:
Table 33-2
SrcIp DStIp IPProt SrcL4Port DstL4Port
192.168.10.10 192.168.20.20 20 6789 81
192.168.10.10 192.168.20.20 20 6789 21
With the following configuration, each flow is policed to 1000000 bps with an allowed 9000 burst value.
Switch(config)# flow record r1
Switch(config-flow-record)# match ipv4 source address
Switch(config-flow-record)# match ipv4 destination address
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-41
Chapter 33 Configuring Quality of Service
Configuring QoS
Switch(config-flow-record)# match transport tcp source-port
Switch(config-flow-record)# match transport tcp destination-port
Switch(config-flow-record)# match transport udp source-port
Switch(config-flow-record)# match transport udp destination-port
Switch(config-flow-record)# exit
Switch(config)# class-map match-all c1
Switch(config-cmap)# match flow record r1
Switch(config-cmap)# exit
Switch(config)# policy-map p1
Switch(config-pmap)# class c1
Switch(config-pmap-c)# police 1000000 9000
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface fastEthernet 6/1
Switch(config-if)# service-policy input p1
Switch(config-if)# end
Configuration Guidelines
The general guidelines for creating, configuring, modifying, deleting a flow based QoS policy and
attaching (and detaching) a flow based QoS policy to a supported target is the same as described in the
QoS section. The following description and restriction applies to Flow based QoS policy:
• A classmap can have multiple match statements but only one FNF flow record can be specified in a
class-map.
• A flow record must have at least one key field before it can be used in a classmap. Non-key fields
can be present in the flow record. However, all the non-key fields are ignored by microflow QoS.
Only key-fields are used for flow creation.
• If a FNF flow record is referenced in any class-map, the flow record cannot be modified. Remove
the flow record from all classmaps before modifying it.
• A classmap with a FNF flow record must be configured as match-all; traffic hitting the class-map
must satisfy all match criteria in the class-map.
• A policy can contain multiple classes and each class-map may contain the same or different FNF
flow record.
• Flow based QoS policy and FNF monitor both cannot be applied on the same target at the same time.
• When the interface mode changes from switchport to routed port and vice versa, any Flow QoS
policy attached to the port remains applied after the mode change.
• There are 3 types of FNF flow records: ipv4, ipv6, and datalink. The datalink flow record is mutually
exclusive with the ipv4 and ipv6 flow records; a classmap with the datalink flow record cannot
co-exist with classmap having a ipv4 or ipv6 flow record in the same policy and vice-versa.
• Classmap class-default is not editable; it cannot be configured with the match flow record. Instead,
you can configure the policy with a class-map that uses a match any filter and the flow record.
• Traffic is classified in the same order in which class-map is defined in a policy. Hence, if a FNF
flow record is the only match statement in a class-map, the classifier matches all packets of the type
identified by the flow record. This means that any subsequent class-map in the same policy matching
on the same traffic type will be redundant and will never be hit.
• Policers associated with classmap having flow record are called microflow policers. The CIR and
PIR rates for microflow policers cannot be configured using the percent keyword.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-42 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring Auto-QoS
• Flow records within the same policy must include appropriate key fields to ensure flows created
from different classmaps are unique and distinct. Otherwise, the resulting flows from different
classmap cannot be distinguished. In such cases, policy actions corresponding to the classmap which
created the first flow in hardware will apply and results will not be always be as expected.
• Flows from traffic received on different QoS targets are distinct even if the same policy is applied
to those targets.
• A flow is aged out if the it is inactive for more than 5 seconds; there is no traffic matching the flow
for a period longer than 5 sec.
• When a flow is aged out, policer state information associated with the flow is also deleted. When a
new flow is created, the policer instance for the flow is re-initialized.
• Flows created by flow based QoS policy exist in hardware only and cannot be exported (as with FNF
monitor).
• Per-flow statistics are not available for flows created by flow based QoS policy.
• Class-map statistics indicate the number of packets matching the classifier. It does not represent
individual flow stats.
• Policer statistics show the aggregate policer statistics of individual flow.
• Information about the flows created by hardware are not available and not displayed in the show
commands associated with QoS policy-map. Only class-map and policer statistics are displayed in
the output of the show policy-map commands.
Configuring Auto-QoS
Note Auto-QoS cannot be applied to EtherChannel interfaces or VLANs.
Unlike auto-QoS on Supervisor Engines II-Plus to V-10GE, auto-QoS on Supervisor Engine 7-E
employs the MQC model. This means that instead of using certain global configurations (like qos and
qos dbl), auto-QoS applied to any interface on a switch with Supervisor Engine 7-E configures several
global class-maps and policy-maps.
Auto-QoS matches traffic and assigns each matched packet to qos-groups. This allows the output policy
map to put specific qos-groups into specific queues, including into the priority queue.
We need QoS in both directions, both on inbound and outbound. Inbound, the switch port needs to trust
the DSCP in the packet (done by default). Outbound, the switch port needs to give voice packets "front
of line" priority. If voice is delayed too long by waiting behind other packets in the outbound queue, the
end host drops the packet because it arrives outside of the receive window for that packet.
Note QoS is a two way street. So, it might work in one direction and not in the other.
There are three policy maps that must be defined (2 inbound and 1 outbound):
• One the trusts COS inbound
• One that trusts DSCP inbound
• A generalized one that puts voice packets in the priority queue outbound
You only want to use the following:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-43
Chapter 33 Configuring Quality of Service
Configuring Auto-QoS
• Trust DSCP policy-map inbound
• General policy-map for voice outbound
On all ports. The problem with COS is that packets on the native VLAN is marked as zero.
The class maps used for input matching are as follows:
! for control traffic between the phone and the callmanager
! and phone to phone [Bearer] DSCP matching
! Note: Control traffic can be either AF31 or CS3. So, we match to both values and assign
them to different qos-groups when matching DSCP and only a single group when matching COS.
class-map match-all AutoQos-VoIP-Control-Dscp26
match dscp af31
class-map match-all AutoQos-VoIP-Control-Dscp24
match dscp cs3
class-map match-all AutoQos-VoIP-Bearer-Dscp
match dscp ef
! for control traffic and phone to phone [Bearer] COS matching
! Note: Both CS3 and AF31 control traffic maps to COS 3
class-map match-all AutoQos-VoIP-Control-Cos
match cos 3
class-map match-all AutoQos-VoIP-Bearer-Cos
match cos 5
The class maps are intended to identify control and data (bearer) voice traffic for either an Layer 2 or
Layer 3 interface.
The 2 Input policy maps, one for matching DSCP and one for matching COS, where DSCP and COS are
set to an assigned qos-group used in outbound policy-maps are as follows:
policy-map AutoQos-VoIP-Input-Dscp-Policy
class AutoQos-VoIP-Bearer-Dscp
set qos-group 46
class AutoQos-VoIP-Control-Dscp26
set qos-group 26
class AutoQos-VoIP-Control-Dscp24
set qos-group 24
! Note: For COS, Control traffic only has a single COS value of 3 (versus DSCP which has 2
values to match). So, only 2 class-maps instead of 3 like above.
policy-map AutoQos-VoIP-Input-Cos-Policy
class AutoQos-VoIP-Bearer-Cos
set qos-group 46
class AutoQos-VoIP-Control-Cos
set qos-group 24
The class maps used for Output matching are as follows:
! Since we assigned matched traffic to a qos-group on input,
! we only need to match the qos-group on output
! Note: Any other traffic not matched on input and assigned to a qos-group goes into the
class-default queue
! for control traffic (CS3 and AF31)
class-map match-all AutoQos-VoIP-Control-QosGroup24
match qos-group 24
class-map match-all AutoQos-VoIP-Control-QosGroup26
match qos-group 26
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-44 OL-22250-01
Chapter 33 Configuring Quality of Service
Configuring Auto-QoS
! For phone to phone (Bearer EF) traffic
class-map match-all AutoQos-VoIP-Bearer-QosGroup
match qos-group 46
The output policy maps are as follows:
! Each class maps to a different qos-group with
! class-default taking any traffic not assigned to a qos-group
! Note: in this example, the outbound policy map drops voice packets when the priority
queue exceeds 33% utilization of the link. Each deployment must establish their own upper
bound for voice packets.
policy-map AutoQos-VoIP-Output-Policy
class AutoQos-VoIP-Bearer-QosGroup
set dscp ef
set cos 5
priority
police cir percent 33
class AutoQos-VoIP-Control-QosGroup26
set dscp af31
set cos 3
bandwidth remaining percent 5
class AutoQos-VoIP-Control-QosGroup24
set dscp cs3
set cos 3
bandwidth remaining percent 5
class class-default
dbl
Note There are no default cos-to-dscp or dscp-to-cos mappings on the. Values must be explicitly set
for trunks.
The three policy maps are defined as follows:
• policy-map AutoQos-VoIP-Input-Dscp-Policy
This policy map is applied as an input service policy on an Layer 3 interface (such as an uplink
connection to a neighboring switch) when auto-QoS is configured on the port.
• policy-map AutoQos-VoIP-Input-Cos-Policy
This policy map is applied as an input service policy on an Layer 2 interface that could be either an
uplink connection or a port hooked to a Cisco IP Phone.
• policy-map AutoQos-VoIP-Output-Policy
This policy map is applied as an output policy for any port on which auto-QoS is configured,
establishing policy governing egress traffic on the port based on whether it is voice data or control
traffic.
The purpose of the input policy maps is to identify voice data or control traffic and mark it as such as it
traverses the switch. The output policy map matches the packets on the marking occurring on ingress
and then applies egress parameters such as bandwidth, policing and/or priority queuing.
The invocation of auto-QoS on a switch employing Supervisor Engine 7-E uses the same config
commands used on Supervisor Engines II-Plus to V-10GE.
For switch-to-switch connections, the [no] auto qos voip trust command is used to apply an input and
output service policy on the interface:
service-policy input AutoQos-VoIP-Input-Cos-Policy
OR
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 33-45
Chapter 33 Configuring Quality of Service
Configuring Auto-QoS
service-policy input AutoQos-VoIP-Input-Dscp-Policy
AND
service-policy output AutoQos-VoIP-Output-Policy
The selection of the input policy depends on whether the port is Layer 2 or Layer 3. For Layer 2, the
policy trusts the Cos setting in the received packets. For Layer 3 ports, it relies on the DSCP value
contained in the packets.
For phone connected ports, the [no] auto qos voice cisco-phone command is used to apply the following
service policy to the port:
qos trust device cisco-phone
service-policy input AutoQos-VoIP-Input-Cos-Policy
AND
service-policy output AutoQos-VoIP-Output-Policy
It establishes a trusted boundary that recognizes Cisco IP Phones and trusts the Cos setting of the packets
from the phone. If a Cisco IP Phone is not detected, the Cos field is ignored and the packets are not
classified as voice traffic. Upon detecting a Cisco phone, the ingress packets are marked based on the
Cos value in the packets. This marking is used on egress for proper traffic classification and handling.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
33-46 OL-22250-01
CH A P T E R 34
Configuring Voice Interfaces
This chapter describes how to configure voice interfaces for the Catalyst 4500 series switches.
This chapter includes the following major sections:
• About Voice Interfaces, page 34-1
• Configuring a Port to Connect to a Cisco 7960 IP Phone, page 34-3
• Configuring Voice Ports for Voice and Data Traffic, page 34-3
• Overriding the CoS Priority of Incoming Frames, page 34-5
• Configuring Power, page 34-5
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Voice Interfaces
Catalyst 4500 series switches can connect to a Cisco 7960 IP phone and carry IP voice traffic. If
necessary, the switch can supply electrical power to the circuit connecting it to the Cisco 7960 IP phone.
Because the sound quality of an IP telephone call can deteriorate if the data is unevenly sent, the switch
uses quality of service (QoS) based on IEEE 802.1p class of service (CoS). QoS uses classification and
scheduling to transmit network traffic from the switch in a predictable manner. See Chapter 33,
“Configuring Quality of Service,” for more information on QoS.
You can configure the Cisco 7960 IP phone to forward traffic with an 802.1p priority. Use the CLI to
configure a Catalyst 4500 series switch to honor or ignore a traffic priority assigned by a Cisco 7960 IP
phone.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 34-1
Chapter 34 Configuring Voice Interfaces
About Voice Interfaces
The Cisco 7960 IP phone contains an integrated three-port 10/100 switch. The ports are dedicated
connections as described below:
• Port 1 connects to the Catalyst 4500 series switch or other device that supports voice-over-IP.
• Port 2 is an internal 10/100 interface that carries the phone traffic.
• Port 3 connects to a PC or other device.
Figure 34-1 shows one way to configure a Cisco 7960 IP phone.
Figure 34-1 Cisco 7960 IP Phone Connected to a Catalyst 4500 Series Switch
PC
Catalyst 4500 Series Switch IP Phone
105247
IP
Cisco IP Phone Voice Traffic
You can configure an access port with an attached Cisco IP Phone to use one VLAN for voice traffic
and another VLAN for data traffic from a device attached to the phone. You can configure access ports
on the switch to send Cisco Discovery Protocol (CDP) packets that instruct an attached phone to send
voice traffic to the switch in any of these ways:
• In the voice VLAN tagged with a Layer 2 CoS priority value
• In the access VLAN tagged with a Layer 2 CoS priority value
• In the access VLAN, untagged (no Layer 2 CoS priority value)
Note In all configurations, the voice traffic carries a Layer 3 IP precedence value (the default is 5 for voice
traffic and 3 for voice control traffic).
Cisco IP Phone Data Traffic
The switch can also process tagged data traffic (traffic in IEEE 802.1Q or IEEE 802.1p frame types)
from the device attached to the access port on the Cisco IP Phone (see Figure 34-1). You can configure
Layer 2 access ports on the switch to send CDP packets that instruct the attached phone to configure the
phone access port in one of these modes:
• In trusted mode, all traffic received through the access port on the Cisco IP Phone passes through
the phone unchanged.
• In untrusted mode, all traffic in IEEE 802.1Q or IEEE 802.1p frames received through the access
port on the Cisco IP Phone receive a configured Layer 2 CoS value. The default Layer 2 CoS value
is 0. Untrusted mode is the default.
Note Untagged traffic from the device attached to the Cisco IP Phone passes through the phone unchanged,
regardless of the trust state of the access port on the phone.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
34-2 OL-22250-01
Chapter 34 Configuring Voice Interfaces
Configuring a Port to Connect to a Cisco 7960 IP Phone
Configuring a Port to Connect to a Cisco 7960 IP Phone
Because a Cisco 7960 IP phone also supports connection to a PC or another device, an interface
connecting a Catalyst 4500 series switch to a Cisco 7960 IP phone can carry a mix of voice and data
traffic.
There are three configurations for a port connected to a Cisco 7960 IP phone:
• All traffic is transmitted according to the default CoS priority of the port. This is the default.
• Voice traffic is given a higher priority by the phone (CoS priority is always 5), and all traffic is in
the same VLAN.
• Voice and data traffic are carried on separate VLANs.
To configure a port to instruct the phone to give voice traffic a higher priority and to forward all traffic
through the 802.1Q native VLAN, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# interface {fastethernet | Specifies the interface to configure.
gigabitethernet} slot/port
Step 3 Switch(config-if)# switchport voice vlan dot1p Instructs the switch to use 802.1p priority tagging for voice
traffic and to use VLAN 1 (default native VLAN) to carry
all traffic.
Step 4 Switch(config-if)# end Returns to privileged EXEC mode.
Step 5 Switch# show interface {fastethernet | Verifies the port configuration.
gigabitethernet} slot/port switchport
Configuring Voice Ports for Voice and Data Traffic
Because voice and data traffic can travel through the same voice port, you should specify a different
VLAN for each type of traffic. You can configure a switch port to forward voice and data traffic on
different VLANs.
Note For information on configuring sticky port security on voice VLANs, see the Configuring Port Security
on Voice Ports, page 38-22.
Note For information on using 802.1X with voice VLANs, see the “Using 802.1X with Voice VLAN Ports”
section on page 36-19.
To configure a port to receive voice and data traffic from a Cisco IP Phone on different VLANs, perform
this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# interface {fastethernet | Specifies the interface to configure.
gigabitethernet} slot/port
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 34-3
Chapter 34 Configuring Voice Interfaces
Configuring Voice Ports for Voice and Data Traffic
Command Purpose
Step 3 Switch(config-if)# switchport mode access Configures the interface as an access port.
The voice VLAN is active only on access ports.
Step 4 Switch(config-if)# switchport voice vlan Instructs the Cisco IP phone to forward all voice traffic
vlan_num through a specified VLAN. The Cisco IP phone forwards
the traffic with an 802.1p priority of 5.
Step 5 Switch(config-if)# switchport access vlan Configures the access VLAN (the data VLAN) on the port
data_vlan_num
Step 6 Switch(config-if)# end Returns to privileged EXEC mode.
Step 7 Switch# show interface {fastethernet | Verifies the configuration.
gigabitethernet} slot/port switchport
In the following example, VLAN 1 carries data traffic, and VLAN 2 carries voice traffic. In this
configuration, you must connect all Cisco IP phones and other voice-related devices to switch ports that
belong to VLAN 2.
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastEthernet 3/1
Switch(config-if)# switchport mode access
Switch(config-if)# switchport voice vlan 2
Switch(config-if)# switchport access vlan 3
Switch(config-if)# end
Switch# show interfaces fastEthernet 3/1 switchport
Name: Fa3/1
Switchport: Enabled
Administrative Mode: static access
Operational Mode: static access
Administrative Trunking Encapsulation: negotiate
Operational Trunking Encapsulation: native
Negotiation of Trunking: Off
Access Mode VLAN: 3 (VLAN0003)
Trunking Native Mode VLAN: 1 (default)
Administrative Native VLAN tagging: enabled
Voice VLAN: 2 (VLAN0002)
Administrative private-vlan host-association: none
Administrative private-vlan mapping: none
Administrative private-vlan trunk native VLAN: none
Administrative private-vlan trunk Native VLAN tagging: enabled
Administrative private-vlan trunk encapsulation: dot1q
Administrative private-vlan trunk normal VLANs: none
Administrative private-vlan trunk private VLANs: none
Operational private-vlan: none
Trunking VLANs Enabled: ALL
Pruning VLANs Enabled: 2-1001
Capture Mode Disabled
Capture VLANs Allowed: ALL
Unknown unicast blocked: disabled
Unknown multicast blocked: disabled
Appliance trust: none
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
34-4 OL-22250-01
Chapter 34 Configuring Voice Interfaces
Overriding the CoS Priority of Incoming Frames
Overriding the CoS Priority of Incoming Frames
A PC or another data device can connect to a Cisco 7960 IP phone port. The PC can generate packets
with an assigned CoS value. You can also use the switch CLI to override the priority of frames arriving
on the phone port from connected devices, and you can set the phone port to accept (trust) the priority
of frames arriving on the port.
To override the CoS priority setting received from the non-voice port on the Cisco 7960 IP phone,
perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# interface {fastethernet | Specifies the interface to configure.
gigabitethernet} slot/port
Step 3 Switch(config-if)# [no] qos trust extend cos 3 Sets the phone port to override the priority received from
the PC or the attached device and forward the received data
with a priority of 3.
Use the no keyword to return the port to its default setting.
Step 4 Switch(config-if)# end Returns to privileged EXEC mode.
Step 5 Switch# show interface {fastethernet | Verifies the change.
gigabitethernet} slot/port switchport
Configuring Power
The Catalyst 4500 series switch senses if it is connected to a Cisco 7960 IP phone. The Catalyst 4500
series switch can supply Power over Ethernet (PoE) to the Cisco 7960 IP phone if there is no power on
the circuit. The Cisco 7960 IP phone can also be connected to an AC power source and supply its own
power to the voice circuit. If there is power on the circuit, the switch does not supply it.
You can configure the switch not to supply power to the Cisco 7960 IP phone and to disable the detection
mechanism. For information on the CLI commands that you can use to supply PoE to a Cisco 7960 IP
phone, see Chapter 11, “Configuring Power over Ethernet.”
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 34-5
Chapter 34 Configuring Voice Interfaces
Configuring Power
Software Configuration Guide—Release IOS-XE 3.1.0 SG
34-6 OL-22250-01
CH A P T E R 35
Configuring Private VLANs
This chapter describes how to implement private VLANs (PVLANs) on Catalyst 4500 series switches.
It also provides restrictions, procedures, and configuration examples.
This chapter includes the following major sections:
• Command List, page 35-1
• Private VLANs, page 35-2
• Configuring PVLANs, page 35-10
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Command List
This table lists the commands most commonly used with PVLANs.
Command Purpose Location
private-vlan {community | isolated | Configures a VLAN as a PVLAN. Configuring a VLAN as a PVLAN,
primary} page 35-13
private-vlan association Associates the secondary VLAN Associating a Secondary VLAN with
{secondary_vlan_list | add with the primary VLAN. a Primary VLAN, page 35-14
secondary_vlan_list | remove
The list can contain only one isolated
secondary_vlan_list}
VLAN ID; it can also contain
multiple community VLAN IDs.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-1
Chapter 35 Configuring Private VLANs
Private VLANs
Command Purpose Location
show vlan private-vlan [type] Verifies the configuration. Configuring a VLAN as a PVLAN,
page 35-13
Associating a Secondary VLAN with
a Primary VLAN, page 35-14
show interface private-vlan mapping Verifies the configuration. Permitting Routing of Secondary
VLAN Ingress Traffic, page 35-21
switchport mode private-vlan {host | Configures a Layer 2 interface as a Configuring PVLANs, page 35-10
promiscuous | trunk promiscuous | PVLAN port.
trunk [secondary]}
switchport private-vlan mapping Maps the PVLAN promiscuous port Configuring a Layer 2 Interface as a
[trunk] primary_vlan_ID to a primary VLAN and to selected PVLAN Promiscuous Port,
{secondary_vlan_list | add secondary VLANs. page 35-16
secondary_vlan_list | remove Configuring a Layer 2 Interface as a
secondary_vlan_list} Promiscuous PVLAN Trunk Port,
page 35-19
Switch(config-if)# switchport Associates the Layer 2 interface with Configuring a Layer 2 Interface as a
private-vlan host-association a PVLAN. PVLAN Host Port, page 35-17
primary_vlan_ID secondary_vlan_ID
Note You can associate only one
primay-secondary VLAN
pair to the isolated port.
switchport private-vlan association Configures association between Configuring a Layer 2 Interface as an
trunk primary_vlan_ID primary VLANs and secondary Isolated PVLAN Trunk Port,
secondary_vlan_ID VLANs the PVLAN trunk port with a page 35-18
PVLAN.
Note You can configure the
isolated trunk port with
multiple primary-secondary
pair.
switchport private-vlan trunk allowed Configures a list of allowed normal Configuring a Layer 2 Interface as an
vlan vlan_list all | none | [add | remove VLANs on a PVLAN trunk port. Isolated PVLAN Trunk Port,
| except] vlan_atom[,vlan_atom...] page 35-18
switchport private-vlan trunk native Configures a VLAN to which Configuring a Layer 2 Interface as an
vlan vlan_id untagged packets (as in IEEE 802.1Q Isolated PVLAN Trunk Port,
tagging) are assigned on a PVLAN page 35-18
trunk port.
Private VLANs
The private VLAN feature addresses two problems that service providers face when using VLANs:
• The switch supports up to 1005 active VLANs. If a service provider assigns one VLAN per
customer, this limits the numbers of customers the service provider can support.
• To enable IP routing, each VLAN is assigned a subnet address space or a block of addresses, which
can result in wasting the unused IP addresses, and cause IP address management problems.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-2 OL-22250-01
Chapter 35 Configuring Private VLANs
Private VLANs
Using private VLANs provides scalability and IP address management benefits for service providers and
Layer 2 security for customers. Private VLANs partition a regular VLAN domain into subdomains. A
subdomain is represented by a pair of VLANs: a primary VLAN and a secondary VLAN. A private
VLAN can have multiple VLAN pairs, one pair for each subdomain. All VLAN pairs in a private VLAN
share the same primary VLAN. The secondary VLAN ID differentiates one subdomain from another.
See Figure 35-1.
Figure 35-1 Private-VLAN Domain
Primary
VLAN
Private
VLAN
domain
Subdomain Subdomain
Secondary Secondary
community VLAN isolated VLAN
116083
There are two types of secondary VLANs:
• Isolated VLANs—Ports within an isolated VLAN cannot communicate with each other at the
Layer 2 level.
• Community VLANs—Ports within a community VLAN can communicate with each other but
cannot communicate with ports in other communities at the Layer 2 level.
A promiscuous port can serve only one primary VLAN, one isolated VLAN, and multiple community
VLANs. Layer 3 gateways are typically connected to the switch through a promiscuous port.
In a switched environment, you can assign an individual private VLAN and associated IP subnet to each
individual or common group of end stations. The end stations need to communicate only with a default
gateway to communicate outside the private VLAN.
You can use private VLANs to control access to end stations in these ways:
• Configure selected interfaces connected to end stations as isolated ports to prevent any
communication at Layer 2. For example, if the end stations are servers, this configuration prevents
Layer 2 communication between the servers.
• Configure interfaces connected to default gateways and selected end stations (such as, backup
servers) as promiscuous ports to allow all end stations access to a default gateway.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-3
Chapter 35 Configuring Private VLANs
Private VLANs
• Reduce VLAN and IP subnet consumption; you can prevent traffic between end stations even
though they are in the same VLAN and IP subnet.
With a promiscuous port, you can connect a wide range of devices as access points to a PVLAN.
For example, you can connect a promiscuous port to the server port of a LocalDirector to connect
an isolated VLAN or a number of community VLANs to the server. LocalDirector can load balance
the servers present in the isolated or community VLANs, or use a promiscuous port to monitor or
back up all the PVLAN servers from an administration workstation.
This section includes the following topics:
• Definition Table, page 35-4
• Private VLANs across Multiple Switches, page 35-5
• Private-VLAN Interaction with Other Features, page 35-8
Definition Table
Term Definition
Private VLANs Private VLANs are sets of VLAN pairs that share a common
primary identifier and provide a mechanism for achieving
layer-2 separation between ports while sharing a single
layer-3 router port and IP subnet.
Secondary VLAN A type of VLAN used to implement private VLANs.
Secondary VLANs are associated with a primary VLAN,
and are used to carry traffic from hosts to other allowed
hosts or to routers.
Community Port A community port is a host port that belongs to a community
secondary VLAN. Community ports communicate with
other ports in the same community VLAN and with
promiscuous ports. These interfaces are isolated at Layer 2
from all other interfaces in other communities and from
isolated ports within their private VLAN.
Community VLAN Community VLAN—A community VLAN is a secondary
VLAN that carries upstream traffic from the community
ports to the promiscuous port gateways and to other host
ports in the same community. You can configure multiple
community VLANs in a private VLAN.
Isolated Port An isolated port is a host port that belongs to an isolated
secondary VLAN. It has complete Layer 2 separation from
other ports within the same private VLAN, except for the
promiscuous ports. Private VLANs block all traffic to
isolated ports except traffic from promiscuous ports. Traffic
received from an isolated port is forwarded only to
promiscuous ports.
Isolated VLAN Isolated VLAN —A private VLAN has only one isolated
VLAN. An isolated VLAN is a secondary VLAN that
carries unidirectional traffic upstream from the hosts toward
the promiscuous ports and the gateway.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-4 OL-22250-01
Chapter 35 Configuring Private VLANs
Private VLANs
Term Definition
Primary VLAN Primary VLAN—A private VLAN has only one primary
VLAN. Every port in a private VLAN is a member of the
primary VLAN. The primary VLAN carries unidirectional
traffic downstream from the promiscuous ports to the
(isolated and community) host ports and to other
promiscuous ports.
Private VLAN Trunk Port A PVLAN trunk port can carry multiple secondary (isolated
only) and non-PVLANs. Packets are received and
transmitted with secondary or regular VLAN tags on the
PVLAN trunk ports.
Note Only IEEE 802.1q encapsulation is supported.
Promiscuous Port A promiscuous port belongs to the primary VLAN and can
communicate with all interfaces, including the community
and isolated host ports and private VLAN trunk ports that
belong to the secondary VLANs associated with the primary
VLAN.
Promiscuous Trunk Port A promiscuous trunk port can carry multiple primary and
normal VLANs. Packets are received and transmitted with
primary or regular VLAN tags. Other than that, the port
behaves just like a promiscuous access port.
Note Only IEEE 802.1q encapsulation is supported.
Private VLANs across Multiple Switches
This section discusses the following topics:
• Standard Trunk Ports, page 35-5
• Isolated Private VLAN Trunk Ports, page 35-6
• Promiscuous Private VLAN Trunk Ports, page 35-8
Standard Trunk Ports
As with regular VLANs, private VLANs can span multiple switches. A trunk port carries the primary
VLAN and secondary VLANs to a neighboring switch. The trunk port treats the private VLAN as any
other VLAN. A feature of private VLANs across multiple switches is that traffic from an isolated port
in switch A does not reach an isolated port on Switch B. See Figure 35-2.
To maintain the security of your private-VLAN configuration and to avoid other use of the VLANs
configured as private VLANs, configure private VLANs on all intermediate devices, including devices
that have no private-VLAN ports.
Note Trunk ports carry traffic from regular VLANs and also from primary, isolated, and community VLANs.
Note You should use standard trunk ports if both switches undergoing trunking support PVLANs.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-5
Chapter 35 Configuring Private VLANs
Private VLANs
Figure 35-2 Private VLANs across Switches
Trunk ports
VLAN 100 VLAN 100
Switch B
Switch A
VLAN 201 VLAN 202 VLAN 201 VLAN 202
116084
Carries VLAN 100,
201, and 202 traffic
VLAN 100 = Primary VLAN
VLAN 201 = Secondary isolated VLAN
VLAN 202 = Secondary community VLAN
Because VTP does not support private VLANs, you must manually configure private VLANs on all
switches in the Layer 2 network. If you do not configure the primary and secondary VLAN association
in some switches in the network, the Layer 2 databases in these switches are not merged. This can result
in unnecessary flooding of private-VLAN traffic on those switches.
Isolated Private VLAN Trunk Ports
You would use a isolated PVLAN trunk ports when you would anticipate using PVLAN isolated host
ports to carry multiple VLANs, either normal VLANs or for multiple PVLAN domains. This makes it
useful for connecting a downstream switch that does not support PVLANs (like Catalyst 2950).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-6 OL-22250-01
Chapter 35 Configuring Private VLANs
Private VLANs
Figure 35-3 Isolated PVLAN Trunk Ports
Catalyst 7200
router
Primary VLAN = VLAN10
Isolated VLAN = VLAN11
Catalyst
4500 switch
Isolated port Isolated PVLAN
trunk port
Non-PVLAN
switch (2950)
Access ports
on VLAN11
204202
In this illustration, a Catalyst 4500 switch is being used to connect a downstream switch that does not
support PVLANs.
Traffic being sent in the downstream direction towards host1 from the router is received by the
Catalyst 4500 series switch on the promiscuous port and in the primary VLAN (VLAN 10). The packets
are then switched out of the isolated PVLAN trunk, but rather than being tagged with the primary VLAN
(VLAN 10) they are instead transmitted with the isolated VLAN’s tag (VLAN 11). In this way, when
the packets arrive on the non-PVLAN switch, they can be bridged to the destination host's access port.
Traffic in the upstream direction is sent by host1 to the non-PVLAN switch, arriving in VLAN 11. The
packets are then transmitted to the Catalyst 4500 series switch tagged with that VLAN’s tag (VLAN 11)
over the trunk port. On the Catalyst 4500 series switch, VLAN 11 is configured as the isolated vlan, and
the traffic is forwarded as if it came from an isolated host port.
Note When an isolated trunk is used in this fashion, the Catalyst 4500 series switch provides isolation between
the isolated trunk and directly connected hosts (such as host3), but not between hosts connected to the
non-PVLAN switch (such as host1 and host2). Isolation between these hosts must be provided by the
non-PVLAN switch, using a feature such as protected ports on a Catalyst 2950.
For details on protected ports, see the URL:
http://www.cisco.com/en/US/docs/switches/lan/catalyst2950/software/release/12.1_22_ea11x/configur
ation/guide/swtrafc.html#wp1158863
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-7
Chapter 35 Configuring Private VLANs
Private VLANs
Promiscuous Private VLAN Trunk Ports
PVLAN Promiscuous Trunks are used in situations where one would normally use a PVLAN
promiscuous host port but where it is necessary to carry multiple vlans, either normal vlans or for
multiple PVLAN domains. This makes it useful for connecting an upstream router that does not support
Private VLANs, such as a Cisco 7200.
Figure 35-4 Promiscuous PVLAN Trunk Ports
Catalyst
7200 router
Primary VLAN = VLAN10
Isolated VLAN = VLAN11
Community VLAN = VLAN12
Catalyst
4500 switch
Community Isolated
port, VLAN12 port, VLAN11
204201
In this illustration, a Catalyst 4500 series switch is being used to connect a PVLAN domain to an
upstream router which does not support PVLANs. Traffic being sent upstream by host1 arrives on the
Catalyst 4500 series switch in the community VLAN (VLAN 12). When this traffic is bridged onto the
promiscuous PVLAN trunk towards the router, it is tagged with the primary VLAN (VLAN 10), so that
it can be routed via the correct subinterface configured on the router.
Traffic in the downstream direction is received on the promiscuous PVLAN trunk port by the
Catalyst 4500 switch in the primary VLAN (VLAN 10), just as if it had been received on a promiscous
host port. It can then be bridged to the destination host as in any PVLAN domain.
PVLAN promiscuous trunks interact with VLAN QoS. Refer to the section “PVLANs and VLAN
ACL/QoS” section on page 35-9.
Private-VLAN Interaction with Other Features
Private VLANs have specific interaction with some other features, described in these sections:
• PVLANs and VLAN ACL/QoS, page 35-9
• Private VLANs and Unicast, Broadcast, and Multicast Traffic, page 35-9
• Private VLANs and SVIs, page 35-10
• Per-Virtual-Port Error Disable on Private Vlans, page 35-10
For details, see the section “PVLAN Configuration Guidelines and Restrictions” on page 11.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-8 OL-22250-01
Chapter 35 Configuring Private VLANs
Private VLANs
PVLANs and VLAN ACL/QoS
PVLAN ports use primary and secondary VLANs, as follows:
• A packet received on a PVLAN host port belongs to the secondary VLAN.
• A packet received on a PVLAN trunk port belongs to the secondary VLAN if the packet is tagged
with a secondary VLAN or if the packet is untagged and the native VLAN on the port is a secondary
VLAN.
A packet received on a PVLAN host or trunk port and assigned to a secondary VLAN is bridged on the
secondary VLAN. Because of this bridging, the secondary VLAN ACL as well as the secondary VLAN
QoS (on input direction) apply.
When a packet is transmitted out of a PVLAN host or trunk port, the packet logically belongs to the
primary VLAN. This relationship applies even though the packet may be transmitted with the secondary
VLAN tagging for PVLAN trunk ports. In this situation, the primary VLAN ACL and the primary VLAN
QoS on output apply to the packet.
• Similarly, a packet received on a PVLAN promiscuous access port belongs to primary VLAN.
• A packet received on a PVLAN promiscuous trunk port could belong to the primary VLAN or
normal VLAN depending on incoming VLAN.
For traffic flowing in normal VLAN on promiscuous trunk ports, normal VLAN ACL and QoS policies
apply. For traffic flowing in a private VLAN domain, a packet received on a promiscuous port is bridged
in primary VLAN. Therefore, the primary VLAN ACL and QoS policies apply on input.
When a packet is transmitted out of a promiscuous trunk port, the packet could logically belong to
secondary VLAN if received from a secondary port, or in primary VLAN if bridged from another
promiscuous port. Because we cannot differentiate between both packets, all VLAN QoS policies are
ignored on packets egressing promiscuous trunk ports.
Private VLANs and Unicast, Broadcast, and Multicast Traffic
In regular VLANs, devices in the same VLAN can communicate with each other at the Layer 2 level,
but devices connected to interfaces in different VLANs must communicate at the Layer 3 level. In
private VLANs, the promiscuous ports are members of the primary VLAN, while the host ports belong
to secondary VLANs. Because the secondary VLAN is associated to the primary VLAN, members of the
these VLANs can communicate with each other at the Layer 2 level.
In a regular VLAN, broadcasts are forwarded to all ports in that VLAN. Private VLAN broadcast
forwarding depends on the port sending the broadcast:
• An isolated port sends a broadcast only to the promiscuous ports or trunk ports.
• A community port sends a broadcast to all promiscuous ports, trunk ports, and ports in the same
community VLAN.
• A promiscuous port sends a broadcast to all ports in the private VLAN (other promiscuous ports,
trunk ports, isolated ports, and community ports).
Multicast traffic is routed or bridged across private-VLAN boundaries and within a single community
VLAN. Multicast traffic is not forwarded between ports in the same isolated VLAN or between ports in
different secondary VLANs.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-9
Chapter 35 Configuring Private VLANs
Configuring PVLANs
Private VLANs and SVIs
In a Layer 3 switch, a switch virtual interface (SVI) represents the Layer 3 interface of a VLAN. Layer 3
devices communicate with a private VLAN only through the primary VLAN and not through secondary
VLANs. Configure Layer 3 VLAN interfaces (SVIs) only for primary VLANs. You cannot configure
Layer 3 VLAN interfaces for secondary VLANs. SVIs for secondary VLANs are inactive while the
VLAN is configured as a secondary VLAN.
• If you try to configure a VLAN with an active SVI as a secondary VLAN, the configuration is not
allowed until you disable the SVI.
• If you try to create an SVI on a VLAN that is configured as a secondary VLAN and the secondary
VLAN is already mapped at Layer 3, the SVI is not created, and an error is returned. If the SVI is
not mapped at Layer 3, the SVI is created, but it is automatically shut down.
When the primary VLAN is associated with and mapped to the secondary VLAN, any configuration on
the primary VLAN is propagated to the secondary VLAN SVIs. For example, if you assign an IP subnet
to the primary VLAN SVI, this subnet is the IP subnet address of the entire private VLAN.
Per-Virtual-Port Error Disable on Private Vlans
For private VLANs, per-vp error disable behavior is defined as follows:
• On a PVLAN promiscuous or promiscuous trunk ports, if a violation occurs on the primary VLAN,
it is error disabled.
• On a PVLAN host or trunk port, if a violation occurs on the secondary VLAN, the associated
primary VLAN is error disabled.
• On a standard trunk port that carries both primary and secondary VLANs, if a violation occurs on
the primary VLAN, this VLAN and all its associated secondary VLANs are error disabled. If a
violation occurs on a secondary VLAN, the associated primary VLAN and all its associated
secondary VLANs are error disabled.
Configuring PVLANs
These sections describe how to configure PVLANs:
• Tasks for Configuring Private VLANs, page 35-11
• Default Private-VLAN Configuration, page 35-11
• PVLAN Configuration Guidelines and Restrictions, page 35-11
• Configuring a VLAN as a PVLAN, page 35-13
• Associating a Secondary VLAN with a Primary VLAN, page 35-14
• Configuring a Layer 2 Interface as a PVLAN Promiscuous Port, page 35-16
• Configuring a Layer 2 Interface as a PVLAN Host Port, page 35-17
• Configuring a Layer 2 Interface as an Isolated PVLAN Trunk Port, page 35-18
• Configuring a Layer 2 Interface as a Promiscuous PVLAN Trunk Port, page 35-19
• Permitting Routing of Secondary VLAN Ingress Traffic, page 35-21
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-10 OL-22250-01
Chapter 35 Configuring Private VLANs
Configuring PVLANs
Tasks for Configuring Private VLANs
To configure a PVLAN, follow these steps:
Step 1 Set VTP mode to transparent. See the “VLAN Trunking Protocol” section on page 12-7.
Step 2 Create the secondary VLANs. See the “Configuring a VLAN as a PVLAN” section on page 35-13.
Step 3 Create the primary VLAN. See the “Configuring a VLAN as a PVLAN” section on page 35-13.
Step 4 Associate the secondary VLAN to the primary VLAN. See the “Associating a Secondary VLAN with a
Primary VLAN” section on page 35-14.
Note Only one isolated VLAN can be mapped to a primary VLAN, but more than one community
VLAN can be mapped to a primary VLAN.
Step 5 Configure an interface as an isolated or community host or trunk port. See the “Configuring a Layer 2
Interface as a PVLAN Host Port” section on page 35-17 and “Configuring a Layer 2 Interface as an
Isolated PVLAN Trunk Port” section on page 35-18.
Step 6 Associate the isolated port or community port to the primary-secondary VLAN pair. See the
“Associating a Secondary VLAN with a Primary VLAN” section on page 35-14.
Step 7 Configure an interface as a promiscuous port. See the “Configuring a Layer 2 Interface as a PVLAN
Promiscuous Port” section on page 35-16.
Step 8 Map the promiscuous port to the primary-secondary VLAN pair. See the “Configuring a Layer 2
Interface as a PVLAN Promiscuous Port” section on page 35-16.
Step 9 If you plan to use inter-VLAN routing, configure the primary SVI, and map secondary VLANs to the
primary. See the “Permitting Routing of Secondary VLAN Ingress Traffic” section on page 35-21.
Step 10 Verify private-VLAN configuration. See the “Switch#” section on page 35-22.
Default Private-VLAN Configuration
No private VLANs are configured.
PVLAN Configuration Guidelines and Restrictions
Follow these guidelines when configuring PVLANs:
• To configure a PVLAN correctly, enable VTP in transparent mode in VTP version 1 and
VTP version 2. (VTP version 3 enables you to create it in server mode).
You cannot change the VTP mode to client or server for PVLANs.
• Do not include VLAN 1 or VLANs 1002 through 1005 in PVLANs.
• Use only PVLAN commands to assign ports to primary, isolated, or community VLANs.
Layer 2 interfaces on primary, isolated, or community VLANs are inactive in PVLANs. Layer 2
trunk interfaces remain in the STP forwarding state.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-11
Chapter 35 Configuring Private VLANs
Configuring PVLANs
• You cannot configure Layer 3 VLAN interfaces for secondary VLANs.
Layer 3 VLAN interfaces for isolated and community (secondary) VLANs are inactive while the
VLAN is configured as an isolated or community VLAN.
• Do not configure private VLAN ports as EtherChannels. While a port is part of the private VLAN
configuration, its associated EtherChannel configuration is inactive.
• Do not apply dynamic access control entries (ACEs) to primary VLANs.
Cisco IOS dynamic ACL configuration applied to a primary VLAN is inactive while the VLAN is
part of the PVLAN configuration.
• To prevent spanning tree loops due to misconfigurations, enable PortFast on the PVLAN trunk ports
with the spanning-tree portfast trunk command.
• Any VLAN ACL configured on a secondary VLAN is effective in the input direction, and any
VLAN ACL configured on the primary VLAN associated with the secondary VLAN is effective in
the output direction.
• You can stop Layer 3 switching on an isolated or community VLAN by deleting the mapping of that
VLAN with its primary VLAN.
• PVLAN ports can be on different network devices as long as the devices are trunk-connected and
the primary and secondary VLANs remain associated with the trunk
• Isolated ports on two different devices cannot communicate with each other, but community VLAN
ports can.
• Private VLANs support the following SPAN features:
– You can configure a private VLAN port as a SPAN source port.
– You can use VLAN-based SPAN (VSPAN) on primary, isolated, and community VLANs or use
SPAN on only one VLAN to monitor egress or ingress traffic separately.
For more information about SPAN, see Chapter 46, “Configuring SPAN and RSPAN.”
• A primary VLAN can be associated with multiple community VLANs, but only one isolated VLAN.
• An isolated or community VLAN can be associated with only one primary VLAN.
• If you delete a VLAN used in a private VLAN configuration, the private VLAN ports associated
with the VLAN become inactive.
• VTP does not support private VLANs. You must configure private VLANs on each device in which
you plan to use private VLAN ports.
• To maintain the security of your PVLAN configuration and avoid other use of VLANs configured
as PVLANs, configure PVLANs on all intermediate devices, even if the devices have no PVLAN
ports.
• Prune the PVLANs from trunks on devices that carry no traffic in the PVLANs.
• With port ACLS functionality available, you can apply Cisco IOS ACLS to secondary VLAN ports
and Cisco IOS ACLS to PVLANS (VACLs). For more information on VACLs, see Chapter 42,
“Configuring Network Security with ACLs.”
• You can apply different quality of service (QoS) configurations to primary, isolated, and community
VLANs. (See Chapter 33, “Configuring Quality of Service.”) Cisco IOS ACLs applied to the
Layer 3 VLAN interface of a primary VLAN automatically apply to the associated isolated and
community VLANs.
• On a PVLAN trunk port a secondary VLAN ACL is applied on ingress traffic and a primary VLAN
ACL is applied on egress traffic.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-12 OL-22250-01
Chapter 35 Configuring Private VLANs
Configuring PVLANs
• On a promiscuous port the primary VLAN ACL is applied on ingress traffic.
• Both PVLAN secondary and promiscuous trunk ports support only IEEE 802.1q encapsulation.
• Community VLANs cannot be propagated or carried over private VLAN trunks.
• ARP entries learned on Layer 3 PVLAN interfaces are termed “sticky” ARP entries (we recommend
that you display and verify PVLAN interface ARP entries).
• For security reasons, PVLAN port sticky ARP entries do not age out. Connecting a device with a
different MAC address but with the same IP address generates an error message and the ARP entry
is not created.
• Because PVLAN port sticky ARP entries do not age out, you must manually remove the entries if
you change the MAC address. To overwrite a sticky ARP entry, first delete the entry with the no
arp command, then overwrite the entry with the arp command.
• In a DHCP environment, if you shut down your PC, it is not possible to give your IP address to
someone else. To solve this problem, the Catalyst 4500 series switch supports the no ip sticky-arp
command. This command promotes IP address overwriting and reuse in a DHCP environment.
• Normal VLANs can be carried on a promiscuous or isolated trunk port.
• The default native VLAN for promiscuous trunk port is VLAN 1, the management VLAN. All
untagged packets are forwarded in the native VLAN. Either the primary VLANs or a regular VLAN
can be configured as native VLAN.
• Promiscuous trunks cannot be configured to carry secondary VLANs. If a secondary VLAN is
specified in the allowed VLAN list, the configuration is accepted but the port is not
operational/forwarding in the secondary VLAN. This includes even those VLANs that are of
scondary but not associated with any primary VLAN on given port.
• On a promiscuous trunk port, the primary VLAN ACL and QoS are applied on ingress traffic coming
in primary VLANs.
• On a promiscuous trunk port, no VLAN ACL or QoS is applied to the egress traffic. This is because
for upstream direction, traffic in private VLAN logically flows in the secondary VLAN. Due to
VLAN translation in hardware, information about received secondary VLANs has been lost. Hence,
no policies are applied. This restriction also applies to traffic bridged from other ports in the same
primary VLANs.
• Do not configure port security on PVLAN promiscuous trunk port and vice versa.
If port security is enabled on a promiscuous trunk port, that port may behave in an unpredictable
manner because this functionality is not supported.
• Do not configure IEEE 802.1X on a PVLAN promiscuous trunk port.
Note Community private VLAN trunk ports are not supported.
Configuring a VLAN as a PVLAN
To configure a VLAN as a PVLAN, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# vlan vlan_ID Enters VLAN configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-13
Chapter 35 Configuring Private VLANs
Configuring PVLANs
Command Purpose
Step 3 Switch(config-vlan)# private-vlan {community | Configures a VLAN as a PVLAN.
isolated | primary}
• This command does not take effect until you exit
VLAN configuration submode.
You can use the no keyword to clear PVLAN status.
Step 4 Switch(config-vlan)# end Exits VLAN configuration mode.
Step 5 Switch# show vlan private-vlan [type] Verifies the configuration.
This example shows how to configure VLAN 202 as a primary VLAN and verify the configuration:
Switch# configure terminal
Switch(config)# vlan 202
Switch(config-vlan)# private-vlan primary
Switch(config-vlan)# end
Switch# show vlan private-vlan
Primary Secondary Type Interfaces
------- --------- ----------------- ------------------------------------------
202 primary
This example shows how to configure VLAN 303 as a community VLAN and verify the configuration:
Switch# configure terminal
Switch(config)# vlan 303
Switch(config-vlan)# private-vlan community
Switch(config-vlan)# end
Switch# show vlan private-vlan
Primary Secondary Type Interfaces
------- --------- ----------------- ------------------------------------------
202 primary
303 community
This example shows how to configure VLAN 440 as an isolated VLAN and verify the configuration:
Switch# configure terminal
Switch(config)# vlan 440
Switch(config-vlan)# private-vlan isolated
Switch(config-vlan)# end
Switch# show vlan private-vlan
Primary Secondary Type Interfaces
------- --------- ----------------- ------------------------------------------
202 primary
303 community
440 isolated
Associating a Secondary VLAN with a Primary VLAN
To associate secondary VLANs with a primary VLAN, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# vlan primary_vlan_ID Enters VLAN configuration mode for the primary
VLAN.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-14 OL-22250-01
Chapter 35 Configuring Private VLANs
Configuring PVLANs
Command Purpose
Step 3 Switch(config-vlan)# private-vlan association Associates the secondary VLAN with the primary
{secondary_vlan_list | add secondary_vlan_list | VLAN. The list can contain only one isolated VLAN ID;
remove secondary_vlan_list}
it can also contain multiple community VLAN IDs.
You can use the no keyword to clear all secondary
associations.
Step 4 Switch(config-vlan)# end Exits VLAN configuration mode.
Step 5 Switch# show vlan private-vlan [type] Verifies the configuration.
When you associate secondary VLANs with a primary VLAN, note the following:
• The secondary_vlan_list parameter cannot contain spaces. It can contain multiple comma-separated
items. Each item can be a single private VLAN ID or a hyphenated range of private VLAN IDs.
• The secondary_vlan_list parameter can contain multiple community VLAN IDs.
• The secondary_vlan_list parameter can contain only one isolated VLAN ID.
• Enter a secondary_vlan_list or use the add keyword with a secondary_vlan_list to associate
secondary VLANs with a primary VLAN.
• Use the remove keyword with a secondary_vlan_list to clear the association between secondary
VLANs and a primary VLAN.
• The command does not take effect until you exit VLAN configuration submode.
This example shows how to associate community VLANs 303 through 307 and 309 and isolated VLAN
440 with primary VLAN 202 and verify the configuration:
Switch# configure terminal
Switch(config)# vlan 202
Switch(config-vlan)# private-vlan association 303-307,309,440
Switch(config-vlan)# end
Switch# show vlan private-vlan
Primary Secondary Type Interfaces
------- --------- ----------------- ------------------------------------------
202 303 community
202 304 community
202 305 community
202 306 community
202 307 community
202 309 community
202 440 isolated
308 community
Note The secondary VLAN 308 has no associated primary VLAN.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-15
Chapter 35 Configuring Private VLANs
Configuring PVLANs
Configuring a Layer 2 Interface as a PVLAN Promiscuous Port
To configure a Layer 2 interface as a PVLAN promiscuous port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface {fastethernet | Specifies the LAN interface to configure.
gigabitethernet | tengigabitethernet} slot/port
Step 3 Switch(config-if)# switchport mode private-vlan Configures a Layer 2 interface as a PVLAN promiscuous
{host | promiscuous | trunk promiscuous | trunk port.
[secondary]}
Step 4 Switch(config-if)# [no] switchport private-vlan Maps the PVLAN promiscuous port to a primary VLAN
mapping [trunk] primary_vlan_ID and to selected secondary VLANs.
{secondary_vlan_list | add secondary_vlan_list |
remove secondary_vlan_list}
Step 5 Switch(config-if)# end Exits configuration mode.
Step 6 Switch# show interfaces {fastethernet | Verifies the configuration.
gigabitethernet | tengigabitethernet} slot/port
switchport
Note The maximum number of unique PVLAN pairs supported by the switchport private-vlan mapping
command is 1000.
When you configure a Layer 2 interface as a PVLAN promiscuous port, note the following:
• The secondary_vlan_list parameter cannot contain spaces. It can contain multiple comma-separated
items. Each item can be a single PVLAN ID or a hyphenated range of PVLAN IDs.
• Enter a secondary_vlan_list or use the add keyword with a secondary_vlan_list to map the
secondary VLANs to the PVLAN promiscuous port.
• Use the remove keyword with a secondary_vlan_list to clear the mapping between secondary
VLANs and the PVLAN promiscuous port.
This example shows how to configure interface FastEthernet 5/2 as a PVLAN promiscuous port, map it
to a PVLAN, and verify the configuration:
Switch# configure terminal
Switch(config)# interface fastethernet 5/2
Switch(config-if)# switchport mode private-vlan promiscuous
Switch(config-if)# switchport private-vlan mapping 200 2
Switch(config-if)# end
Switch# show interfaces fastethernet 5/2 switchport
Name:Fa5/2
Switchport:Enabled
Administrative Mode:private-vlan promiscuous
Operational Mode:private-vlan promiscuous
Administrative Trunking Encapsulation:negotiate
Operational Trunking Encapsulation:native
Negotiation of Trunking:Off
Access Mode VLAN:1 (default)
Trunking Native Mode VLAN:1 (default)
Voice VLAN:none
Administrative Private VLAN Host Association:none
Administrative Private VLAN Promiscuous Mapping:200 (VLAN0200) 2 (VLAN0002)
Private VLAN Trunk Native VLAN:none
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-16 OL-22250-01
Chapter 35 Configuring Private VLANs
Configuring PVLANs
Administrative Private VLAN Trunk Encapsulation:dot1q
Administrative Private VLAN Trunk Normal VLANs:none
Administrative Private VLAN Trunk Private VLANs:none
Operational Private VLANs:
200 (VLAN0200) 2 (VLAN0002)
Trunking VLANs Enabled:ALL
Pruning VLANs Enabled:2-1001
Capture Mode Disabled
Capture VLANs Allowed:ALL
Configuring a Layer 2 Interface as a PVLAN Host Port
To configure a Layer 2 interface as a PVLAN host port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# interface {fastethernet | Specifies the LAN port to configure.
gigabitethernet | tengigabitethernet} slot/port
Step 3 Switch(config-if)# switchport mode private-vlan Configures a Layer 2 interface as a PVLAN host port.
{host | promiscuous | trunk promiscuous | trunk
[secondary]}
Step 4 Switch(config-if)# [no] switchport private-vlan Associates the Layer 2 interface with a PVLAN.
host-association primary_vlan_ID
secondary_vlan_ID You can use the no keyword to delete all associations
from the primary VLAN.
Step 5 Switch(config-if)# end Exits configuration mode.
Step 6 Switch# show interfaces {fastethernet | Verifies the configuration.
gigabitethernet | tengigabitethernet} slot/port
switchport
This example shows how to configure interface FastEthernet 5/1 as a PVLAN host port and verify the
configuration:
Switch# configure terminal
Switch(config)# interface fastethernet 5/1
Switch(config-if)# switchport mode private-vlan host
Switch(config-if)# switchport private-vlan host-association 202 440
Switch(config-if)# end
Switch# show interfaces fastethernet 5/1 switchport
Name: Fa5/1
Switchport: Enabled
Administrative Mode: private-vlan host
Operational Mode: private-vlan host
Administrative Trunking Encapsulation: negotiate
Operational Trunking Encapsulation: native
Negotiation of Trunking: Off
Access Mode VLAN: 1 (default)
Trunking Native Mode VLAN: 1 (default)
Voice VLAN: none
Appliance trust: none
Administrative Private Vlan
Host Association: 202 (VLAN0202) 440 (VLAN0440)
Promiscuous Mapping: none
Trunk encapsulation : dot1q
Trunk vlans:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-17
Chapter 35 Configuring Private VLANs
Configuring PVLANs
Operational private-vlan(s):
202 (VLAN0202) 440 (VLAN0440)
Trunking VLANs Enabled: ALL
Pruning VLANs Enabled: 2-1001
Capture Mode Disabled
Capture VLANs Allowed: ALL
Configuring a Layer 2 Interface as an Isolated PVLAN Trunk Port
To configure a Layer 2 interface as an isolated PVLAN trunk port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface {fastethernet | Specifies the LAN port to configure.
gigabitethernet | tengigabitethernet} slot/port
Step 3 Switch(config-if)# switchport mode private-vlan Configures a Layer 2 interface as a PVLAN trunk port.
{host | promiscuous | trunk promiscuous | trunk
[secondary]}
Step 4 Switch(config-if)# [no] switchport private-vlan Configures association between primary VLANs and
association trunk primary_vlan_ID secondary VLANs the PVLAN trunk port with a
secondary_vlan_ID
PVLAN.
Note Multiple PVLAN pairs can be specified using
this command so that a PVLAN trunk port can
carry multiple secondary VLANs. If an
association is specified for the existing primary
VLAN, the existing association is replaced. If
there is no trunk association, any packets
received on secondary VLANs are dropped.
You can use the no keyword to delete all associations
from the primary VLAN.
Step 5 Switch(config-if)# [no] switchport private-vlan Configures a list of allowed normal VLANs on a PVLAN
trunk allowed vlan vlan_list all | none | [add | trunk port.
remove | except] vlan_atom[,vlan_atom...]
You can use the no keyword to remove all allowed
normal VLANs on a PVLAN trunk port.
Step 6 Switch(config-if)# switchport private-vlan trunk Configures a VLAN to which untagged packets (as in
native vlan vlan_id IEEE 802.1Q tagging) are assigned on a PVLAN trunk
port.
If there is no native VLAN configured, all untagged
packets are dropped.
If the native VLAN is a secondary VLAN and the port
does not have the association for the secondary VLAN,
the untagged packets are dropped.
You can use the no keyword to remove all native
VLANs on a PVLAN trunk port.
Step 7 Switch(config-if)# end Exits configuration mode.
Step 8 Switch# show interfaces {fastethernet | Verifies the configuration.
gigabitethernet | tengigabitethernet} slot/port
switchport
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-18 OL-22250-01
Chapter 35 Configuring Private VLANs
Configuring PVLANs
This example shows how to configure interface FastEthernet 5/2 as a secondary trunk port, and verify
the configuration:
Switch# configure terminal
Switch(config)# interface fastethernet 5/2
Switch(config-if)# switchport mode private-vlan trunk secondary
Switch(config-if)# switchport private-vlan trunk native vlan 10
Switch(config-if)# switchport private-vlan trunk allowed vlan 10. 3-4
Switch(config-if)# switchport private-vlan association trunk 3 301
Switch(config-if)# end
Switch# show interfaces fastethernet 5/2 switchport
Name: Fa5/2
Switchport: Enabled
Administrative Mode: private-vlan trunk secondary
Operational Mode: private-vlan trunk secondary
Administrative Trunking Encapsulation: negotiate
Operational Trunking Encapsulation: dot1q
Negotiation of Trunking: On
Access Mode VLAN: 1 (default)
Trunking Native Mode VLAN: 1 (default)
Administrative Native VLAN tagging: enabled
Voice VLAN: none
Administrative private-vlan host-association: none A
dministrative private-vlan mapping: none
Administrative private-vlan trunk native VLAN: 10
Administrative private-vlan trunk Native VLAN tagging: enabled
Administrative private-vlan trunk encapsulation: dot1q
Administrative private-vlan trunk normal VLANs: none
Administrative private-vlan trunk associations:
3 (VLAN0003) 301 (VLAN0301)
Administrative private-vlan trunk mappings: none
Operational private-vlan: none
Operational Normal VLANs: none
Trunking VLANs Enabled: ALL
Pruning VLANs Enabled: 2-1001
Capture Mode Disabled Capture VLANs Allowed: ALL
Unknown unicast blocked: disabled
Unknown multicast blocked: disabled
Appliance trust: none
Configuring a Layer 2 Interface as a Promiscuous PVLAN Trunk Port
To configure a Layer 2 interface as a promiscuous PVLAN trunk port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface {fastethernet | Specifies the LAN interface to configure.
gigabitethernet | tengigabitethernet} slot/port
Step 3 Switch(config-if)# switchport mode private-vlan {host Configures a Layer 2 interface as a PVLAN
| promiscuous | trunk promiscuous | trunk [secondary]} promiscuous trunk port.
Step 4 Switch(config-if)# [no] switchport private-vlan Maps the promiscuous PVLAN port to a primary
mapping [trunk] primary_vlan_ID {secondary_vlan_list | VLAN and to selected secondary VLANs.
add secondary_vlan_list | remove secondary_vlan_list}
This command offers 3 levels of removal. See the
examples that follow this table.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-19
Chapter 35 Configuring Private VLANs
Configuring PVLANs
Command Purpose
Step 5 Switch(config-if)# end Exits configuration mode.
Step 6 Switch# show interfaces {fastethernet | Verifies the configuration.
gigabitethernet | tengigabitethernet} slot/port
switchport
Note The maximum number of unique PVLAN pairs supported by the
switchport private-vlan mapping trunk command is 500. For example, 500 isolated secondary
VLANs could map to 500 primary VLANs, because only one isolated VLAN association per primary
VLAN is supported. Or, 500 community secondary VLANs could map to one primary VLAN. Or, 250
community secondary VLANs could map to 1 primary VLAN, and another 250 community secondary
VLANs could map to another primary VLAN for a total of 500 pairs.
Note By default, when you configure the mode to private VLAN trunk promiscuous, the native VLAN is set
to 1.
The [no] switchport private-vlan mapping command provides the following three levels of removal:
• Remove one or more secondary VLANs from the list. For example:
Switch(config-if)# switchport private-vlan mapping trunk 2 remove 222
• Remove the entire mapping of PVLAN promiscuous trunk port to the specified primary VLAN (and
all of its selected secondary VLANs). For example:
Switch(config-if)# no switchport private-vlan mapping trunk 2
• Remove the mapping of a PVLAN promiscuous trunk port to all previously configured primary
VLANs (and all of their selected secondary VLANs). For example:
Switch(config-if)# no switchport private-vlan mapping trunk
When you configure a Layer 2 interface as a PVLAN promiscuous port, note the following:
• Multiple private VLAN pairs can be specified using the switchport private-vlan mapping trunk
command so that a promiscuous trunk port can carry multiple primary VLANs.
• The secondary_vlan_list parameter cannot contain spaces. It can contain multiple comma-separated
items. Each item can be a single PVLAN ID or a hyphenated range of PVLAN IDs.
• Enter a secondary_vlan_list or use the add keyword with a secondary_vlan_list to map the
secondary VLANs to the PVLAN promiscuous port.
• Use the remove keyword with a secondary_vlan_list to clear the mapping between secondary
VLANs and the PVLAN promiscuous port.
This example shows how to configure interface FastEthernet 5/2 as a promiscuous trunk port and to
verify the configuration:
Switch# configure terminal
Switch(config)# interface fastethernet 5/2
Switch(config-if)# switchport mode private-vlan trunk promiscuous
Switch(config-if)# switchport private-vlan trunk native vlan 10
Switch(config-if)# switchport private-vlan trunk allowed vlan 10, 3-4
Switch(config-if)# switchport private-vlan mapping trunk 3 301, 302
Switch(config-if)# end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-20 OL-22250-01
Chapter 35 Configuring Private VLANs
Configuring PVLANs
Switch# show interfaces fastethernet 5/2 switchport
Name: Fa5/2
Switchport: Enabled
Administrative Mode: private-vlan trunk promiscuous
Operational Mode: private-vlan trunk promiscuous
Administrative Trunking Encapsulation: negotiate
Operational Trunking Encapsulation: dot1q
Negotiation of Trunking: On
Access Mode VLAN: 1 (default)
Trunking Native Mode VLAN: 1 (default)
Administrative Native VLAN tagging: enabled
Voice VLAN: none
Administrative private-vlan host-association: none
Administrative private-vlan mapping: none
Administrative private-vlan trunk native VLAN: 10
Administrative private-vlan trunk Native VLAN tagging: enabled
Administrative private-vlan trunk encapsulation: dot1q
Administrative private-vlan trunk normal VLANs: 3-4,10
Administrative private-vlan trunk associations: none
Administrative private-vlan trunk mappings:
3 (VLAN0003) 301 (VLAN0301) 302 (VLAN0302)
Operational private-vlan:
3 (VLAN0003) 301 (VLAN0301) 302 (VLAN0302)
Trunking VLANs Enabled: ALL
Pruning VLANs Enabled: 2-1001
Capture Mode Disabled
Capture VLANs Allowed: ALL
Unknown unicast blocked: disabled
Unknown multicast blocked: disabled
Appliance trust: none
Permitting Routing of Secondary VLAN Ingress Traffic
Note Isolated and community VLANs are both called secondary VLANs.
To permit routing of secondary VLAN ingress traffic, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface vlan primary_vlan_ID Enters interface configuration mode for the primary
VLAN.
Step 3 Switch(config-if)# [no] private-vlan mapping To permit routing on the secondary VLAN ingress traffic,
primary_vlan_ID {secondary_vlan_list | add map the secondary VLAN to the primary VLAN.
secondary_vlan_list | remove secondary_vlan_list}
You can use the no keyword to delete all associations
from the primary VLAN.
Step 4 Switch(config-if)# end Exits configuration mode.
Step 5 Switch# show interface private-vlan mapping Verifies the configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 35-21
Chapter 35 Configuring Private VLANs
Configuring PVLANs
When you permit routing on the secondary VLAN ingress traffic, note the following:
• The private-vlan mapping interface configuration command only affects private VLAN ingress
traffic that is Layer 3 switched.
• The secondary_vlan_list parameter cannot contain spaces. It can contain multiple comma-separated
items. Each item can be a single private VLAN ID or a hyphenated range of private VLAN IDs.
• Enter a secondary_vlan_list parameter or use the add keyword with a secondary_vlan_list
parameter to map the secondary VLANs to the primary VLAN.
• Use the remove keyword with a secondary_vlan_list parameter to clear the mapping between
secondary VLANs and the primary VLAN.
This example shows how to permit routing of secondary VLAN ingress traffic from private VLANs 303
through 307, 309, and 440 and verify the configuration:
Switch# configure terminal
Switch(config)# interface vlan 202
Switch(config-if)# private-vlan mapping add 303-307,309,440
Switch(config-if)# end
Switch# show interfaces private-vlan mapping
Interface Secondary VLAN Type
--------- -------------- -----------------
vlan202 303 community
vlan202 304 community
vlan202 305 community
vlan202 306 community
vlan202 307 community
vlan202 309 community
vlan202 440 isolated
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
35-22 OL-22250-01
CH A P T E R 36
Configuring 802.1X Port-Based Authentication
This chapter describes how to configure IEEE 802.1X port-based authentication on the Catalyst 4500
series switch to prevent unauthorized client devices from gaining access to the network.
This chapter includes the following major sections:
• About 802.1X Port-Based Authentication, page 36-1
• Configuring 802.1X Port-Based Authentication, page 36-22
• Displaying 802.1X Statistics and Status, page 36-67
• Displaying Authentication Details, page 36-67
• -Cisco IOS Security Features in Cisco IOS XE 3.1.0 SG Release, page 36-71
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About 802.1X Port-Based Authentication
802.1X defines 802.1X port-based authentication as a client-server based access control and
authentication protocol that restricts unauthorized clients from connecting to a LAN through publicly
accessible ports. An authentication server validates each supplicant (client) connected to an
authenticator (network access switch) port before making available any services offered by the switch or
the LAN.
Note 802.1X support requires an authentication server that is configured for Remote Authentication Dial-In
User Service (RADIUS). 802.1X authentication does not work unless the network access switch can
route packets to the configured RADIUS server. To verify that the switch can route packets, you must
ping the server from the switch.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-1
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
Until a client is authenticated, only Extensible Authentication Protocol over LAN (EAPOL) traffic is
allowed through the port to which the client is connected. After authentication succeeds, normal traffic
can pass through the port.
To configure 802.1X port-based authentication, you need to understand the concepts in these sections:
• Device Roles, page 36-2
• 802.1X and Network Access Control, page 36-3
• Authentication Initiation and Message Exchange, page 36-3
• Ports in Authorized and Unauthorized States, page 36-4
• 802.1X Host Mode, page 36-6
• Using 802.1X with VLAN Assignment, page 36-9
• Using 802.1X for Guest VLANs, page 36-10
• Using 802.1X with MAC Authentication Bypass, page 36-11
• Using 802.1X with Web-Based Authentication, page 36-13
• Using 802.1X with Inaccessible Authentication Bypass, page 36-13
• Using 802.1X with Unidirectional Controlled Port, page 36-14
• Using 802.1X with Authentication Failed VLAN Assignment, page 36-14
• Using 802.1X with Port Security, page 36-16
• Using 802.1X Authentication with ACL Assignments and Redirect URLs, page 36-17
• Using 802.1X with RADIUS-Provided Session Timeouts, page 36-18
• Using 802.1X with Voice VLAN Ports, page 36-19
• Using Multiple Domain Authentication and Multiple Authentication, page 36-20
• How 802.1X Fails on a Port, page 36-21
• Supported Topologies, page 36-21
Device Roles
With 802.1X port-based authentication, network devices have specific roles. Figure 36-1 shows the role
of each device, which is described below.
Figure 36-1 802.1X Device Roles
Client
Workstations Catalyst 4500 Network
Access Switch RADIUS
Supplicants Authenticator Authentication
94158
server
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-2 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
• Client—The workstation that requests access to the LAN, and responds to requests from the switch.
The workstation must be running 802.1X-compliant client software.
• Authenticator—Controls physical access to the network based on the authentication status of the
client. The Catalyst 4500 series switch acts as an intermediary between the client and the
authentication server, requesting identity information from the client, verifying that information
with the authentication server, and relaying a response to the client. The switch encapsulates and
decapsulates the Extensible Authentication Protocol (EAP) frames and interacts with the RADIUS
authentication server.
When the switch receives EAPOL frames and relays them to the authentication server, the Ethernet
header is stripped and the remaining EAP frame is reencapsulated in the RADIUS format. The EAP
frames are not modified or examined during encapsulation, and the authentication server must
support EAP within the native frame format. When the switch receives frames from the
authentication server, the frame header is removed from the server, leaving the EAP frame, which
is then encapsulated for Ethernet and sent to the client.
Note The Catalyst 4500 series switches must be running software that supports the RADIUS client
and 802.1X.
• Authentication server—Performs the actual authentication of the client. The authentication server
validates the identity of the client and notifies the switch that the client is authorized to access the
LAN and switch services. (The only supported authentication server is the RADIUS authentication
server with EAP extensions; it is available in Cisco Secure Access Control Server version 3.2 and
later.)
802.1X and Network Access Control
Network Access Control is a feature that allows port access policies to be influenced by the anti-virus
posture of the authenticating device.
Anti-virus posture includes such elements as the operating system running on the device, the operating
system version, whether anti-virus software is installed, what version of anti-virus signatures is
available, etc. If the authenticating device has a NAC-aware 802.1X supplicant and the authentication
server is configured to support NAC via 802.1X, anti-virus posture information is automatically included
as part of the 802.1X authentication exchange.
For information on NAC, refer to the URL:
http://www.cisco.com/en/US/products/ps6128/index.html
Authentication Initiation and Message Exchange
The switch or the client can initiate authentication. If you enable authentication on a port with the
authentication port-control auto interface configuration command (dot1x port-control auto
command in Cisco IOS Release 12.2(46)SG and earlier releases), the switch must initiate authentication
when it determines that the port link state has changed. It then sends an EAP-request/identity frame to
the client to request its identity (typically, the switch sends an initial identity/request frame followed by
one or more requests for authentication information). Upon receipt of the frame, the client responds with
an EAP-response/identity frame.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-3
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
However, if during bootup, the client does not receive an EAP-request/identity frame from the switch,
the client can initiate authentication by sending an EAPOL-start frame, which prompts the switch to
request the client’s identity.
If 802.1X is not enabled or supported on the network access switch, any EAPOL frames from the client
are dropped. If the client does not receive an EAP-request/identity frame after three attempts to start
authentication, the client transmits frames as if the port is in the authorized state. A port in the authorized
state means that the client has been successfully authenticated. When the client supplies its identity, the
switch begins its role as the intermediary, passing EAP frames between the client and the authentication
server until authentication succeeds or fails. If the authentication succeeds, the switch port becomes
authorized.
The specific exchange of EAP frames depends on the authentication method being used. Figure 36-2
shows a message exchange that is initiated by the client using the One-Time Password (OTP)
authentication method with an authentication server.
Figure 36-2 Message Exchange
Client
Workstation Catalyst 4500 Network
Access Switch RADIUS
EAPOL-Start
EAP-Request/Identity
EAP-Response/Identity RADIUS Access-Request
EAP-Request/OTP RADIUS Access-Challenge
EAP-Response/OTP RADIUS Access-Request
EAP-Success RADIUS Access-Accept
Port Authorized
EAPOL-Logoff
Port Unauthorized
94159
Supplicant Authenticator Authentication
server
Ports in Authorized and Unauthorized States
The switch port state determines whether the client is granted access to the network. The port starts in
the unauthorized state. While in this state, the port disallows all ingress and egress traffic except for
802.1X protocol packets. When a client is successfully authenticated, the port transitions to the
authorized state, allowing all traffic for the client to flow normally.
If a non-802.1X capable client is connected to an unauthorized 802.1X port, the switch requests the
client’s identity. In this situation, the client does not respond to the request, the port remains in the
unauthorized state, and the client is not granted access to the network. If a guest VLAN is configured on
a port that connects to a client that does not support 802.1X, the port is placed in the configured guest
VLAN and in the authorized state. For more information, see the “Using 802.1X for Guest VLANs”
section on page 36-10.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-4 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
In contrast, when an 802.1X-enabled client connects to a port that is not running the 802.1X protocol,
the client initiates the authentication process by sending the EAPOL-start frame. When no response is
received, the client sends the request a fixed number of times. Because no response is received, the client
begins sending frames as if the port is in the authorized state.
You can control the port authorization state with the authentication port-control interface
configuration command and these keywords:
• force-authorized—Disables 802.1X authentication and causes the port to transition to the
authorized state without requiring authentication exchange. The port transmits and receives normal
traffic without 802.1X-based authentication of the client. This setting is the default.
• force-unauthorized—Causes the port to remain in the unauthorized state, ignoring all attempts by
the client to authenticate. The switch cannot provide authentication services to the client through the
interface.
• auto—Enables 802.1X authentication and causes the port to begin in the unauthorized state,
allowing only EAPOL frames to be sent and received through the port. The authentication process
begins when the link state of the port transitions from down to up or when an EAPOL-start frame is
received. The switch requests the identity of the client and begins relaying authentication messages
between the client and the authentication server. The switch can uniquely identify each client
attempting to access the network by the client’s MAC address.
If the client is successfully authenticated (receives an Accept frame from the authentication server), the
port state changes to authorized, and all frames from the authenticated client are allowed through the
port. If authentication fails, the port remains in the unauthorized state, but authentication can be retried.
If the authentication server cannot be reached, the switch can retransmit the request. If no response is
received from the server after the specified number of attempts, authentication fails and network access
is not granted.
If the link state of a port transitions from up to down, or if an EAPOL-logoff frame is received by the
port, the port returns to the unauthorized state.
Figure 36-3 shows the authentication process.
If Multidomain Authentication (MDA) is enabled on a port, this flow can be used with some exceptions
that are applicable to voice authorization. For more information on MDA, see the
“Using Multiple Domain Authentication and Multiple Authentication” section on page 36-20.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-5
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
Figure 36-3 Authentication Flowchart
Start
Client IEEE No IEEE 802.1x authentication Is MAC authentication
802.1x capable? process times out bypass enabled? 1
Yes Yes No
The switch gets an
EAPOL message,
and the EAPOL
message exchange
begins.
Start IEEE 802.1x port-based Use MAC authentication
authentication bypass 1
Client Client Client MAC Client MAC
identity is identity is address address
invalid valid identity identity
is valid. is invalid.
Assign port to Assign port to Assign port to Assign port to
restricted VLAN VLAN VLAN guest VLAN 1
Done Done Done Done
133835
Authentication All authentication All authentication
servers are up. servers are down. servers are down.
Assign port to
critically authorized
VLAN
Done
1 = This occurs if the switch does not detect EAPOL packets from the client.
802.1X Host Mode
The 802.1X port’s host mode determines whether more than one client can be authenticated on the port
and how authentication is enforced. You can configure an 802.1X port to use any of the five host modes
described in the following sections. In addition, each mode may be modified to allow pre-authentication
open access:
• Single-Host Mode, page 36-7
• Multiple-Hosts Mode, page 36-7
• Multidomain Authentication Mode, page 36-7
• Multiauthentication Mode, page 36-8
• Pre-Authentication Open Access, page 36-8
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-6 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
Single-Host Mode
You can configure an 802.1X port for single-host or multiple-hosts mode. In single-host mode (see
Figure 36-1 on page 36-2), only one client can be connected to the 802.1X-enabled switch port. The
switch detects the client by sending an EAPOL frame when the port link state changes to the up state. If
a client leaves or is replaced with another client, the switch changes the port link state to down, and the
port returns to the unauthorized state.
Multiple-Hosts Mode
In multiple-hosts mode, you can attach multiple hosts to a single 802.1X-enabled port. Figure 36-4 on
page 36-7 shows 802.1X port-based authentication in a wireless LAN. In this mode, only one of the
attached clients must be authorized for all clients to be granted network access. If the port becomes
unauthorized (re-authentication fails or an EAPOL-logoff message is received), the switch denies
network access to all of the attached clients. In this topology, the wireless access point is responsible for
authenticating the clients attached to it, and it also acts as a client to the switch.
With multiple-hosts mode enabled, use 802.1X authentication to authenticate the port and port security
to manage network access for all MAC addresses, including that of the client.
Figure 36-4 Multiple Host Mode Example
Authentication
server
Access point (RADIUS)
Wireless clients
101227
Multidomain Authentication Mode
Multidomain Authentication (MDA), which allows an IP phone (Cisco or third-party) and a single host
behind the IP phone to authenticate independently, using 802.1X, MAC authentication bypass (MAB) or
(for the host only) web-based authentication. In this application, multidomain refers to two domains —
data and voice — and only two MAC addresses are allowed per port. A switch can place the host in the
data VLAN and the IP phone in the voice VLAN, even though they appear on the same switch port. The
data VLAN and the voice VLAN can be specified in the CLI configuration. The devices are identified
as either data or voice depending on the vendor-specific-atributes (VSAs) received from the
authentication, authorization, and accounting (AAA) server. The data and voice VLANs can also be
obtained from the VSAs received from the (AAA) server during authentication.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-7
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
Figure 36-5 Multidomain Authentication Mode Example
Authentication
server
Client IP phone Switch (RADIUS)
187640
IP
Figure 36-5 shows a typical MDA application with a single host behind an IP phone connected to the
802.1X-enabled port. Because the client is not directly connected to the switch, the switch cannot detect
a loss of port link if the client is disconnected. To prevent another device from using the established
authentication of the disconnected client later, Cisco IP phones send a Cisco Discovery Protocol (CDP)
host presence type length value (TLV) to notify the switch of changes in the attached client’s port link
state.
For details on how to configure MDA, see the “Using Multiple Domain Authentication and Multiple
Authentication” section on page 36-20.
Multiauthentication Mode
Available starting in Cisco IOS Release 12.2(50)SG, multiauthentication mode allows one client on the
voice VLAN and multiple authenticated clients on the data VLAN. When a hub or access point is
connected to an 802.1X port, multiauthentication mode provides enhanced security over multiple-hosts
mode by requiring authentication of each connected client. For non-802.1X devices, use MAB or
web-based authentication as the fallback method for individual host authentications, allowing you to
authenticate different hosts through different methods on a single port.
Multiauthentication also supports MDA functionality on the voice VLAN by assigning authenticated
devices to either a data or voice VLAN depending on the VSAs received from the authentication server.
Note When a port is in multiauthentication mode, all VLAN assignment features including RADIUS server
supplied VLAN assignment, Guest VLAN, Inaccessible Authentication Bypass, and Authentication
Failed VLAN does not activate for data devices. However, RADIUS server supplied VLAN assignment
is possible for voice devices.
Pre-Authentication Open Access
Starting with Cisco IOS Release 12.2(50)SG, any of the four host modes may be additionally configured
to allow a device to gain network access before authentication. This pre-authentication open access is
useful in an application such as the Pre-boot eXecution Environment (PXE), where a device must access
the network to download a bootable image containing an authentication client.
Enable pre-authentication open access by entering the authentication open command after host mode
configuration. It acts as an extension to the configured host mode. For example, if pre-authentication
open access is enabled with single-host mode, then the port allows only one MAC address. When
pre-authentication open access is enabled, initial traffic on the port is restricted only by whatever other
access restriction, independent of 802.1X, is configured on the port. If no access restriction other than
802.1X is configured on the port, then a client device has full access on the configured VLAN.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-8 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
Using 802.1X with VLAN Assignment
VLAN assignment allows you to limit network access for certain users. With the VLAN assignment,
802.1X-authenticated ports are assigned to a VLAN based on the username of the client connected to
that port. The RADIUS server database maintains the username-to-VLAN mappings. After successful
802.1X authentication of the port, the RADIUS server sends the VLAN assignment to the switch. The
VLAN can be a standard VLAN or a private VLAN (PVLAN).
On platforms that support PVLANs, you can isolate hosts by assigning ports into PVLANs.
When configured on the switch and the RADIUS server, 802.1X with VLAN assignment has these
characteristics:
• If no VLAN is supplied by the RADIUS server, the port is configured in its access VLAN or isolated
PVLAN when authentication succeeds.
• If the authentication server provides invalid VLAN information, the port remains unauthorized. This
situation prevents ports from appearing unexpectedly in an inappropriate VLAN due to a
configuration error.
• If the multiauthentication mode is enabled on an 802.1X port, the VLAN assignment is ignored for
data devices. VLAN assignment is possible for voice device even if the port is configured in
multiauthentication mode.
• If the authentication server provides valid VLAN information, the port is authorized and placed in
the specified VLAN when authentication succeeds.
• If the multiple-hosts mode is enabled, all hosts are in the same VLAN as the first authenticated user.
• If 802.1X is disabled on the port, the port is returned to the configured access VLAN.
• A port must be configured as an access port (which can be assigned only into “regular” VLANs), or
as a PVLAN host port (which can be assigned only into PVLANs). Configuring a port as a PVLAN
host port implies that all hosts on the port are assigned into PVLANs, whether their posture is
compliant or non-compliant. If the type of the VLAN named in the Access-Accept does not match
the type of VLAN expected to be assigned to the port (regular VLAN to access port, secondary
PVLAN to PVLAN host port), the VLAN assignment fails.
• If a guest VLAN is configured to handle non-responsive hosts, the type of VLAN configured as the
guest VLAN must match the port type (that is, guest VLANs configured on access ports must be
standard VLANs, and guest VLANs configured on PVLAN host ports must be PVLANs). If the
guest VLAN’s type does not match the port type, non-responsive hosts are treated as if no guest
VLAN is configured (that is, they are denied network access).
• To assign a port into a PVLAN, the named VLAN must be a secondary PVLAN. The switch
determines the implied primary VLAN from the locally configured secondary-primary association.
Note If you change the access VLAN or PVLAN host VLAN mapping on a port that is already authorized in
a RADIUS assigned VLAN, the port remains in the RADIUS assigned VLAN.
To configure VLAN assignment you need to perform these tasks:
• Enable AAA authorization with the network keyword to allow interface configuration from the
RADIUS server. For an illustration of how to apply the aaa authorization network group radius
command, refer to the section “Enabling 802.1X Authentication” on page 24.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-9
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
• Enable 802.1X. (The VLAN assignment feature is automatically enabled when you configure
802.1X on an access port.)
• Assign vendor-specific tunnel attributes in the RADIUS server. To ensure proper VLAN assignment,
the RADIUS server must return these attributes to the switch:
– Tunnel-Type = VLAN
– Tunnel-Medium-Type = 802
– Tunnel-Private-Group-ID = VLAN NAME
Using 802.1X for Guest VLANs
Guest VLANs allow you to enable non-802.1X-capable hosts to access networks that use 802.1X
authentication. For example, use guest VLANs when you upgrade your system to support 802.1X
authentication.
Guest VLANs are supported on individual ports. Any VLAN functions as a guest VLAN provided its
type matches the port type. If a port is already forwarding on the guest VLAN and you enable 802.1X
support on the network interface of the host, the port is immediately moved out of the guest VLAN and
the authenticator waits for authentication to occur.
Enabling 802.1X authentication on a port starts the 802.1X protocol. If the host fails to respond to
packets from the authenticator within a certain amount of time, the authenticator brings the port up in
the configured guest VLAN.
If the port is configured as a PVLAN host port, the guest VLAN must be a secondary PVLAN. If the
port is configured as an access port, the guest VLAN must be a regular VLAN. If the guest VLAN
configured on a port is not appropriate for the type of the port, the switch behaves as if no guest VLAN
is configured (that is, non-responsive hosts are denied network access).
For details on how to configure guest VLANs, see the “Configuring 802.1X with Guest VLANs” section
on page 36-46.
Usage Guidelines for Using 802.1X Authentication with Guest VLANs
The usage guidelines for using 802.1X authentication with guest VLANs are as follows:
• When you reconfigure a guest VLAN to a different VLAN, any authentication failed ports are also
moved and the ports stay in their current authorized state.
• When you shut down or remove a guest VLAN from the VLAN database, any authentication failed
ports are immediately moved to an unauthorized state and the authentication process is restarted.
Note No periodic reauthentication is allowed with guest VLANs.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-10 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
Usage Guidelines for Using 802.1X Authentication with Guest VLANs on Windows-XP Hosts
The usage guidelines for using 802.1X authentication with guest VLANs on Windows-XP hosts are as
follows:
• If the host fails to respond to the authenticator, the port attempts to connect three times (with a 30
second timeout between each attempt). After this time, the login/password window does not appear
on the host, so you must unplug and reconnect the network interface cable.
• Hosts responding with an incorrect login/password fail authentication. Hosts failing authentication
are not put in the guest VLAN. The first time that a host fails authentication, the quiet-period timer
starts, and no activity occurs for the duration of the quiet-period timer. When the quiet-period timer
expires, the host is presented with the login/password window. If the host fails authentication for the
second time, the quiet-period timer starts again, and no activity occurs for the duration of the
quiet-period timer. The host is presented with the login/password window a third time. If the host
fails authentication the third time, the port is placed in the unauthorized state, and you must
disconnect and reconnect the network interface cable.
Using 802.1X with MAC Authentication Bypass
The 802.1X protocol has 3 entities: client (supplicant), authenticator, and authentication server.
Typically, the host PC runs the supplicant software and tries to authenticate itself by sending its
credentials to the authenticator which in turn relays that info to the authentication server for
authentication.
However, not all hosts may have supplicant functionality. Devices that cannot authenticate themselves
using 802.1X but still need network access can use MAC Authentication Bypass (MAB), which uses the
connecting device's MAC address to grant or deny network access.
Typically, you would use this feature on ports where devices such as printers are connected. Such devices
do not have 802.1X supplicant functionality.
In a typical deployment, the RADIUS server maintains a database of MAC addresses that require access.
When this feature detects a new MAC address on a port, it generates a RADIUS request with both
username and password as the device's MAC address. After authorization succeeds, the port is accessible
to the particular device through the same code path that 802.1X authentication would take when
processing an 802.1X supplicant. If authentication fails, the port moves to the guest VLAN if configured,
or it remains unauthorized.
The Catalyst 4500 series switch also supports re-authentication of MACs on a per port level. Be aware
that the re-authentication functionality is by 802.1X and is not MAB specific. In the re-authentication
mode, a port stays in the previous RADIUS-sent VLAN and tries to re-authenticate itself. If the
re-authentication succeeds, the port stays in the RADIUS-sent VLAN. Otherwise, the port becomes
unauthorized and moves to the guest VLAN if one is configured.
For details on how to configure MAB, see the “Configuring 802.1X with MAC Authentication Bypass”
section on page 36-48.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-11
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
Feature Interaction
This section lists feature interactions and restrictions when MAB is enabled. If a feature is not listed,
assume that it interacts seamlessly with MAB (such as Unidirectional Controlled Port).
• MAB can only be enabled if 802.1X is configured on a port. MAB functions as a fall back
mechanism for authorizing MACs. If you configure both MAB and 802.1X on a port, the port
attempts to authenticate using 802.1X. If the host fails to respond to EAPOL requests and MAB is
configured, the 802.1X port is opened up to listen to packets and to grab a MAC address, rather than
attempt to authenticate endlessly.
Based on the default 802.1X timer values, the transition between mechanisms takes approximately
90 seconds. You can shorten the time by reducing the value of the transmission period time, which
affects the frequency of EAPOL transmission. A smaller timer value results in EAPOLs sent during
a shorter period of time. With MAB enabled, after 802.1X performs one full set of EAPOLs, the
learned MAC address is forwarded to the authentication server for processing.
The MAB module performs authorization for the first MAC address detected on the wire. The port
is considered authorized once a valid MAC address is received that RADIUS approves of.
802.1X authentication can re-start if an EAPOL packet is received on a port that was initially
authorized as a result of MAB.
Figure 36-6 shows the message exchange during MAB.
Figure 36-6 Message Exchange during MAC Authentication Bypass
Client
Workstation Catalyst 4500
Network Access Switch RADIUS
EAPOL-Request/Identity
EAPOL-Request/Identity
EAPOL-Request/Identity
Packet
(Device MAC)
RADIUS Access-Request
(Device MAC)
RADIUS Access-Request
RADIUS Access-Request
181377
RADIUS Accept
Port
Authorized
• The authentication-failed VLAN is used only with dot1x-authentication-failed users. MAB is not
attempted with dot1x-authentication-failed users. If 802.1X authentication fails, a port moves to the
authentication-failed VLAN (if configured) whether MAB is configured or not.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-12 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
• When both MAB and guest VLAN are configured and no EAPOL packets are received on a port, the
802.1X state-machine is moved to a MAB state where it opens the port to listen to traffic and grab
MAC addresses. The port remains in this state forever waiting to see a MAC on the port. A detected
MAC address that fails authorization causes the port to be moved to the guest VLAN if configured.
While in a guest VLAN, a port is open to all traffic on the specified guest VLAN. Therefore,
non-802.1X supplicants that normally would be authorized but are in guest VLAN due to the earlier
detection of a device that failed authorization, would remain in the guest VLAN indefinitely.
However, loss of link or the detection of an EAPOL on the wire causes a transition out of the guest
VLAN and back to the default 802.1X mode.
• Once a new MAC has been authenticated by MAB, the responsibility to limit access falls upon the
802.1X Authenticator (or port security) to secure the port. The 802.1X default host parameter is
defined only for a single host. If the port is changed to multi-user host, port security must be
employed to enforce the number of MAC addresses allowed thru this port.
• Catalyst 4500 series switch supports MAB with VVID, with the restriction that the MAC address
appears on a port data VLAN only. All IP phone MACs learned via CDP are allowed on voice
VLANs.
• MAB and VMPS are mutually exclusive because their functionality overlaps.
Using 802.1X with Web-Based Authentication
The web-based authentication feature, known as Web Authentication Proxy, enables you to authenticate
end users on host systems that do not run the IEEE 802.1X supplicant.
When configuring web-based authentication, note the following guidelines:
• Fallback to web-based authentication is configured on switch ports in access mode. Ports in trunk
mode are not supported.
• Fallback to web-based authentication is not supported on EtherChannels or EtherChannel members.
• Although fallback to web-based authentication is an interface-specific configuration, the web-based
authentication fallback behavior is defined in a global fallback profile. If the global fallback
configuration changes, the new profile is not used until the next instance of authentication fallback.
For detailed information on configuring web-based authentication, see Chapter 37, “Configuring
Web-Based Authentication.”
Using 802.1X with Inaccessible Authentication Bypass
When a switch cannot reach the configured RADIUS servers and clients (supplicants) cannot be
authenticated, you can configure a switch to allow network access to hosts connected to critical ports
that are enabled for Inaccessible Authentication Bypass.
When this feature is enabled, a switch monitors the status of the configured RADIUS servers. If no
RADIUS servers are available, ports with Inaccessible Authentication Bypass enabled are authorized.
You can specify a Inaccessible Authentication Bypass VLAN on a per-port basis.
Ports that were already authorized when RADIUS becomes unavailable are unaffected by Inaccessible
Authentication Bypass.
When RADIUS becomes available, critically-authorized ports may be configured to automatically
reauthenticate themselves.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-13
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
For details on how to configure Inaccessible Authentication Bypass, see the “Configuring 802.1X with
Inaccessible Authentication Bypass” section on page 36-50.
Using 802.1X with Unidirectional Controlled Port
Unidirectional Controlled Port is a combined hardware/software feature that allows dormant PCs to be
“powered on” based on the receipt of a specific Ethernet frame, known as the magic packet. Generally,
Unidirectional Controlled Port is used in environments where administrators plan to manage remote
systems during off-hours, when it’s likely that the systems have been powered down.
Use of Unidirectional Controlled Port with hosts attached through 802.1X ports presents a unique
problem; when the host powers down, a 802.1X port becomes unauthorized. In this state, the port allows
the receipt and transmission of EAPoL packets only. Therefore, the Unidirectional Controlled Port
magic packet cannot reach the host; without powering up, the PC cannot authenticate and open the port.
Unidirectional Controlled Port solves this problem by allowing packets to be transmitted on
unauthorized 802.1X ports.
Note Unidirectional Controlled Port only works when Spanning Tree Portfast is enabled on the port.
For details on how to configure 802.1X with Unidirectional Controlled Port, see the “Configuring
802.1X with Unidirectional Controlled Port” section on page 36-52
Unidirectional State
A unidirectional controlled port is typically configured when a connected host might enter a sleeping
mode or power-down state. When either occurs, the host does not exchange traffic with other devices in
the network. A host connected to the unidirectional port cannot send traffic to the network; it can only
receive traffic from other devices in the network.
When you configure a port as unidirectional (with the authentication control-direction in interface
configuration command), the port will receive traffic in VLANs on that port, but it is not put into a
spanning-tree forwarding state. If a VLAN contains only unauthenticated ports, any SVI on that VLAN
will be in a down state, during which packets will not be routed into the VLAN. For the SVI to be up,
and so enable packets to be routed into the VLAN, at least one port in the VLAN must either be
authenticated or in the spanning-tree forwarding state..
Bidirectional State
When you configure a port as bidirectional with the authentication control-direction both interface
configuration command (or the dot1x control-direction both interface configuration command for
Cisco IOS Release 12.2(46) or earlier), the port is access-controlled in both directions. In this state,
except for EAPOL packets, a switch port does not receive or send packets.
Using 802.1X with Authentication Failed VLAN Assignment
Authentication-failed VLAN assignment allows you to provide access for authentication failed users on
a per-port basis . Authentication failed users are end hosts that are 802.1X- capable but do not have valid
credentials in an authentication server or end hosts that do not give any username and password
combination in the authentication pop-up window on the user side.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-14 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
If a user fails the authentication process, that port is placed in the authentication-failed VLAN. The port
remains in the authentication-failed VLAN until the reauthentication timer expires. When the
reauthentication timer expires the switch starts sending the port re-authentication requests. If the port
fails reauthentication it remains in the authentication-failed VLAN. If the port is successfully
reauthenticated, the port is moved either to the VLAN sent by RADIUS server or to the newly
authenticated ports configured VLAN; the location depends on whether RADIUS is configured to send
VLAN information.
Note When enabling periodic reauthentication (see the “Enabling Periodic Reauthentication” section on
page 36-61), only local reauthentication timer values are allowed. You cannot use a RADIUS server to
assign the reauthentication timer value.
You can set the maximum number of authentication attempts that the authenticator sends before moving
a port into the authentication-failed VLAN. The authenticator keeps a count of the failed authentication
attempts for each port. A failed authentication attempt is either an empty response or an EAP failure.
The authenticator tracks any mix of failed authentication attempts towards the authentication attempt
count. After the maximum number of attempts is reached the port is placed in the authentication-failed
VLAN until the reauthentication timer expires again.
Note RADIUS may send a response without an EAP packet in it when it does not support EAP, and sometimes
third party RADIUS servers also send empty responses. When this happens, the authentication attempt
counter is incremented.
For details on how to configure Authentication Failed VLAN Assignment, see the “Configuring 802.1X
with Authentication Failed” section on page 36-53.
Usage Guidelines for Using Authentication Failed VLAN Assignment
• You should enable reauthentication. The ports in authentication-failed VLANs do not receive
reauthentication attempts if reauthentication is disabled. In order to start the reauthentication
process the authentication-failed VLAN must receive a link down event or an EAP logoff event from
the port. If the host is behind a hub, you may never get a link down event and may not detect the new
host until the next reauthentication occurs. Therefore, it is recommended to have re-authentication
enabled in that case.
• EAP failure messages are not sent to the user. If the user failures authentication the port is moved
to an authentication-failed VLAN and a EAP success message is sent to the user. Because the user
is not notified of the authentication failure there may be confusion as to why there is restricted
access to the network. A EAP Success message is sent for the following reasons:
– If the EAP Success message is not sent, the user tries to authenticate every 60 seconds (by
default) by sending an EAP-start message.
– In some cases, users have configured DHCP to EAP-Success and unless the user sees a success,
DHCP does not work on the port.
• Sometimes a user caches an incorrect username and password combination after receiving a EAP
success message from the authenticator and reuses that information in every re-authentication. Until
the user passes the correct username and password combination the port remains in the
authentication-failed VLAN.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-15
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
• When an authentication failed port is moved to an unauthorized state the authentication process is
restarted. If you should fail the authentication process again the authenticator waits in the held state.
After you have correctly reauthenticated all 802.1X ports are reinitialized and treated as normal
802.1X ports.
• When you reconfigure an authentication-failed VLAN to a different VLAN, any authentication
failed ports are also moved and the ports stay in their current authorized state.
• When you shut down or remove an authentication-failed VLAN from the VLAN database, any
authentication failed ports are immediately moved to an unauthorized state and the authentication
process is restarted. The authenticator does not wait in a held state because the authentication-failed
VLAN configuration still exists. While the authentication-failed VLAN is inactive, all
authentication attempts are counted, and as soon as the VLAN becomes active the port is placed in
the authentication-failed VLAN.
• If you reconfigure the maximum number of authentication failures allowed by the VLAN, the
change takes affect after the reauthentication timer expires.
• Internal VLANs that are used for Layer 3 ports cannot be configured as authentication-failed
VLANs.
• The authentication-failed VLAN is supported only in single-host mode (the default port mode).
• When a port is placed in an authentication-failed VLAN the user’s MAC address is added to the
mac-address-table. If a new MAC address appears on the port, it is treated as a security violation.
• When an authentication failed port is moved to an authentication-failed VLAN, the Catalyst 4500
series switch does not transmit a RADIUS-Account Start Message like it does for regular 802.1X
authentication.
Using 802.1X with Port Security
You can enable port security on an 802.1X port in either single- or multiple-host mode. (To do so, you
must configure port security with the switchport port-security interface configuration command.)
When you enable port security and 802.1X on a port, 802.1X authenticates the port, and port security
manages the number of MAC addresses allowed on that port, including that of the client. Hence, 802.1X
port with port security allows you to limit the number or group of clients that can access the network.
For information on selecting multi-host mode, see the “Resetting the 802.1X Configuration to the
Default Values” section on page 36-66.
These examples describe the interaction between 802.1X and port security on a switch:
• When a client is authenticated, and the port security table is not full, the client’s MAC address is
added to the port security list of secure hosts. The port then proceeds to come up normally.
When a client is authenticated and manually configured for port security, it is guaranteed an entry
in the secure host table (unless port security static aging has been enabled).
A security violation occurs if an additional host is learned on the port. The action taken depends on
which feature (802.1X or port security) detects the security violation:
– If 802.1X detects the violation, the action is to err-disable the port.
– If port security detects the violation, the action is to shutdown or restrict the port (the action is
configurable).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-16 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
The following describes when port security and 802.1X security violations occur:
– In single host mode, after the port is authorized, any MAC address received other than the
client’s causes a 802.1X security violation.
– In single host mode, if installation of an 802.1X client’s MAC address fails because port
security has already reached its limit (due to a configured secure MAC addresses), a port
security violation is triggered.
– In multi host mode, once the port is authorized, any additional MAC addresses that cannot be
installed because the port security has reached its limit triggers a port security violation.
• When an 802.1X client logs off, the port transitions back to an unauthenticated state, and all
dynamic entries in the secure host table are cleared, including the entry for the client. Normal
authentication then ensues.
• If you administratively shut down the port, the port becomes unauthenticated, and all dynamic
entries are removed from the secure host table.
• Only 802.1X can remove the client’s MAC address from the port security table. Note that in multi
host mode, with the exception of the client’s MAC address, all MAC addresses that are learned by
port security can be deleted using port security CLIs.
• Whenever port security ages out a 802.1X client’s MAC address, 802.1X attempts to reauthenticate
the client. Only if the reauthentication succeeds is the client’s MAC address be retained in the port
security table.
• All of the 802.1X client’s MAC addresses are tagged with (dot1x) when you display the port security
table by using CLI.
Using 802.1X Authentication with ACL Assignments and Redirect URLs
You can download per-host policies such as ACLs and redirect URLs to the switch from the RADIUS
server during 802.1X or MAB authentication of the host. ACL download is also supported with web
authentication after a fallback from 802.1X or MAB.
When the 802.1X host mode of the port is either single-host, MDA, or multiauthentication, the
downloaded ACLs (DACLs) are modified to use the authenticated host’s IP address as the source
address. When the host mode is multiple-hosts, the source address is configured as ANY, and the
downloaded ACLs or redirects apply to all devices on the port.
If no ACLs are provided during the authentication of a host, the static default ACL configured on the
port is applied to the host. On a voice VLAN port, only the static default ACL of the port is applied to
the phone.
Topics include:
• Cisco Secure ACS and AV Pairs for URL-Redirect, page 36-17
• ACLs, page 36-18
For details on how to configure downloadable ACL and URL redirect, refer to the “Configuring 802.1X
Authentication with ACL Assignments and Redirect URLs” section on page 36-32.
Cisco Secure ACS and AV Pairs for URL-Redirect
When downloadable ACL is enabled, Cisco Secure ACS provides AAA services through RADIUS.
You can set these Attribute-Value (AV) pairs on the Cisco Secure ACS with RADIUS cisco-av-pair
vendor-specific attributes (VSAs).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-17
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
CiscoSecure-Defined-ACL specifies the names of the DACLs on the Cisco Secure ACS. The switch
receives the ACL name through the CiscoSecure-Defined-ACL AV pair in the format:
#ACL#-IP-name-number
name is the ACL name. number is the version number (like 3f783768).
The Auth-Manager code verifies whether the access control entries (ACEs) of the specified
downloadable ACL were previously downloaded. If not, the Auth-Manager code sends an AAA request
with the downloadable ACL name as the username so that the ACEs are downloaded. The downloadable
ACL is then created as a named ACL on the switch. This ACL has ACEs with a source address of any
and does not have an implicit deny statement at the end. When the downloadable ACL is applied to an
interface after authentication completes, the source address changes from any to the host source IP
address depending on the host mode of the interface. The ACEs are prepended to the downloadable ACL
applied to the switch interface to which the endpoint device is connected. If traffic matches the
CiscoSecure-Defined-ACL ACEs, the appropriate actions are taken.
url-redirect and url-redirect-acl specify the local URL policy on the switch. The switches use these
cisco-av-pair VSAs as follows:
– url-redirect = <HTTP or HTTPS URL>
– url-redirect-acl = switch ACL name or number
These AV pairs enable the switch to intercept an HTTP or HTTPS request from the endpoint device and
forward the client web browser to the specified redirect address from which the latest antivirus files can
be downloaded. The url-redirect AV pair on the Cisco Secure ACS contains the URL to which the web
browser is redirected. The url-redirect-acl AV pair contains the name or number of an ACL that specifies
the HTTP or HTTPS traffic to be redirected. Traffic that matches a permit entry in the redirect ACL is
redirected.
Note The redirect or default ACL must be defined on the switch.
ACLs
If downloadable ACL is configured for a particular client on the authentication server, you must
configure a default port ACL on a client-facing switch port.
If the default ACL is configured on the switch and the Cisco Secure ACS sends a host access policy to
the switch, it applies the policy to traffic from the host connected to a switch port. If the policy does not
apply, the switch applies the default ACL. If the Cisco Secure ACS sends the switch a downloadable
ACL, this ACL takes precedence over the default ACL already configured on the switch port. However,
if the switch receives a host access policy from the Cisco Secure ACS, but the default ACL is not
configured, the authorization failure is declared.
For details on how to configure a downloadable policy, refer to the “Configuring a Downloadable Policy”
section on page 36-37.
Using 802.1X with RADIUS-Provided Session Timeouts
You can specify whether a switch uses a locally configured or a RADIUS-provided reauthentication
timeout. If the switch is configured to use the local timeout, it reauthenticates the host when the timer
expires.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-18 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
If the switch is configured to use the RADIUS-provided timeout, it scans the RADIUS Access-Accept
message for the Session-Timeout and optional Termination-Action attributes. The switch uses the value
of the Session-Timeout attribute to determine the duration of the session, and it uses the value of the
Termination-Action attribute to determine the switch action when the session's timer expires.
If the Termination-Action attribute is present and its value is RADIUS-Request, the switch
reauthenticates the host. If the Termination-Action attribute is not present, or its value is Default, the
switch terminates the session.
Note The supplicant on the port detects that its session has been terminated and attempts to initiate a new
session. Unless the authentication server treats this new session differently, the client may see only a
brief interruption in network connectivity as the switch sets up a new session.
If the switch is configured to use the RADIUS-supplied timeout, but the Access-Accept message does
not include a Session-Timeout attribute, the switch never reauthenticates the supplicant. This behavior
is consistent with Cisco's wireless access points.
For details on how to configure RADIUS-provided session timeouts, see the “Configuring
RADIUS-Provided Session Timeouts” section on page 36-45.
Using 802.1X with Voice VLAN Ports
A voice VLAN port is a special access port associated with two VLAN identifiers:
• Voice VLAN ID (VVID) to carry voice traffic to and from the IP phone. The VVID is used to
configure the IP phone connected to the port.
• Port VLAN ID (PVID) to carry the data traffic to and from the workstation connected to the switch
through the IP phone. The PVID is the native VLAN of the port.
Each port that you configure for a voice VLAN is associated with a VVID and a PVID. This
configuration allows voice traffic and data traffic to be separated onto different VLANs.
A voice VLAN port becomes active when a link exists whether the port is AUTHORIZED or
UNAUTHORIZED. All traffic exiting the voice VLAN is obtained correctly and appears in the MAC
address table. Cisco IP phones do not relay CDP messages from other devices. So, if several Cisco IP
phones are connected in a series, the switch recognizes only the one directly connected to it. When
802.1X is enabled on a voice VLAN port, the switch drops packets from unrecognized Cisco IP phones
more than one hop away.
When 802.1X is enabled on a port, you cannot configure a PVID that is equal to a VVID. For more
information about voice VLANs, see Chapter 34, “Configuring Voice Interfaces.”
Observe the following feature interactions:
• 802.1X VLAN assignment cannot assign to the port the same VLAN as the voice VLAN; otherwise,
the 802.1X authentication fails. The same holds true for dynamic VLAN assignment.
• 802.1X guest VLAN works with the 802.1X voice VLAN port feature. However, the guest VLAN
cannot be the same as the voice VLAN.
• 802.1X port security works with the 802.1X voice VLAN port feature and is configured per port.
Two MAC addresses must be configured: one for the Cisco IP phone MAC address on the VVID and
one for the PC MAC address on PVID.
However, you cannot use the 802.1X voice VLAN port feature with 802.1X port security’s sticky
MAC address configuration and statically configured MAC address configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-19
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
• 802.1X accounting is unaffected by the 802.1X voice VLAN port feature.
• When 802.1X is configured on a port, you cannot connect multiple IP phones to a
Catalyst 4500 series switch through a hub.
• Because voice VLANs cannot be configured as PVLAN host ports, and because only PVLANs can
be assigned to PVLAN host ports, VLAN assignment cannot assign a PVLAN to a port with a voice
VLAN configured.
For details on how to configure 802.1X with voice VLANs, see the “Configuring 802.1X with Voice
VLAN” section on page 36-54.
Using Multiple Domain Authentication and Multiple Authentication
Multiple Domain Authentication (MDA) allows both a data device and a voice device, such as an IP
phone (Cisco or 3rd party non-Cisco), to authenticate on the same switch port, which is divided into a
data domain and a voice domain.
Multiple Authentication allows multiple data devices and a voice device. When a voice VLAN is
configured on a multi-authentication port, the port can perform authentication in the voice domain as on
an MDA port.
MDA does not enforce the order of device authentication. For best results, however, you should
authenticate a voice device before you authenticate a data device on an MDA-enabled port.
Observe the following guidelines for configuring MDA:
Note The same guidelines also apply for Multiple Authentication when voice VLAN is configured.
• It is highly recommended that you enable CoPP on an MDA-enabled port to protect against a DoS
attack. Refer to Chapter 39, “Configuring Control Plane Policing.”
• To configure a switch port for MDA or Multiple Authentication, see the “Configuring Multiple
Domain Authentication and Multiple Authorization” section on page 36-29.
• You must configure the voice VLAN for the IP phone when the host mode is set to multidomain. For
more information, see Chapter 34, “Configuring Voice Interfaces.”
• To authorize a voice device, the AAA server must be configured to send a Cisco Attribute-Value
(AV) pair attribute with a value of device-traffic-class=voice. Without this value, the switch
treats the voice device as a data device.
• The guest VLAN and restricted VLAN features only apply to the data devices on an MDA-enabled
port. The switch treats a voice device that fails authorization as a data device.
• If more than one device attempts authorization on either the voice or the data domain of a port, it is
error disabled.
• Until a device is authorized, the port drops its traffic. Non-Cisco IP phones or voice devices are
allowed into both the data and voice VLANs. The data VLAN allows the voice device to contact a
DHCP server to obtain an IP address and acquire the voice VLAN information. After the voice
device starts sending on the voice VLAN, its access to the data VLAN is blocked. A security
violation may occur in MDA if the voice device continues to send traffic on the data VLAN.
• MDA can use MAC authentication bypass as a fallback mechanism to allow the switch port to
connect to devices that do not support 802.1X authentication. This is especially useful for 3rd-party
phones without 802.1X supplicant. For more information, see the “Using 802.1X with MAC
Authentication Bypass” section on page 36-11.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-20 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
About 802.1X Port-Based Authentication
• When a data or a voice device is detected on a port, its MAC address is blocked until authorization
succeeds. If the authorization fails, the MAC address remains blocked for 5 minutes.
• If more than one device is detected on the data VLAN or more than one voice device is detected on
the voice VLAN while a port is unauthorized, the port is error disabled.
• When a port host mode is changed from single- or multihost to multidomain mode, an authorized
data device remains authorized on the port. However, a Cisco IP phone that has been allowed on the
port in the voice VLAN is automatically removed and must be reauthenticated on that port.
• Active fallback mechanisms such as guest VLAN and restricted VLAN remain configured after a
port changes from single- or multihost mode to multidomain mode.
• Switching a port host mode from multidomain to single- or multihost mode removes all authorized
devices from the port.
• If a data domain is authorized first and placed in the guest VLAN, non-802.1X-capable voice
devices need to tag their packets on the voice VLAN to trigger authentication.
• We do not recommend per-user ACLs with an MDA-enabled port. An authorized device with a
per-user ACL policy might impact traffic on both the voice and data VLANs of the port. If used,
only one device on the port should enforce per-user ACLs.
How 802.1X Fails on a Port
802.1X may fail on a port in three ways: timeout, explicit failure, and protocol timeout.
Timeout—A switch attempts 802.1X at link up but the attached endpoint is not 802.1X-capable.
After the configured number of retries and timeouts, the switch attempts the next authentication
method if one is configured (like MAB). If MAB fails, the switch deploys the Guest VLAN (also
called the no-response VLAN), if configured. The Guest VLAN is configured with the
authentication event no-response interface command.
Explicit Failure—A switch and the endpoint perform the entire 802.1X authentication sequence and
the result is an explicit failure (usually indicated by an Access-Reject from the RADIUS server to
the switch and an EAP-Failure sent from the switch to the endpoint). In this case, the switch
attempts MAB (if "authentication event failure action next-method" is configured) or deploy the
AuthFail VLAN (if "authentication event failure action authorize vlan" is configured).
Protocol Timeout—A switch and the endpoint start the 802.1X authentication process but do not
complete it. For example, the endpoint may send an 802.1X EAPoL-Start message and then stop
responding to the switch (perhaps, because the endpoint lacks a credential or because it is waiting
for end user to enter some information). In this case, the switch knows that the connected device is
EAPoL-capable, so it will not deploy the Guest VLAN after timing out. Instead, it restarts
authentication after a timeout. The switch continues to label the port as EAPoL-capable until a
physical link down event is detected. To force the switch to deploy the Guest VLAN in the case of
a protocol timeout, configure dot1x guest-vlan supplicant globally. If the port is configured for
hostmode multi-domain authentication, the switch behaves as if dot1x guest-vlan supplicant is
configured.
Supported Topologies
The 802.1X port-based authentication supports two topologies:
• Point-to-point
• Wireless LAN
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-21
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
In a point-to-point configuration (see Figure 36-1 on page 36-2), only one client can be connected to the
802.1X-enabled switch port when the multi-host mode is not enabled (the default). The switch detects
the client when the port link state changes to the up state. If a client leaves or is replaced with another
client, the switch changes the port link state to down, and the port returns to the unauthorized state.
For 802.1X port-based authentication in a wireless LAN (Figure 36-7), you must configure the 802.1X
port as a multiple-host port that is authorized as a wireless access point once the client is authenticated.
(See the “Resetting the 802.1X Configuration to the Default Values” section on page 36-66.) When the
port is authorized, all other hosts that are indirectly attached to the port are granted access to the network.
If the port becomes unauthorized (reauthentication fails or an EAPOL-logoff message is received), the
switch denies access to the network for all wireless access point-attached clients. In this topology, the
wireless access point is responsible for authenticating clients attached to it, and the wireless access point
acts as a client to the switch.
Figure 36-7 Wireless LAN Example
Wireless Wireless
Catalyst 4500 Network
clients access point RADIUS
Access Switch
94160
Supplicants Authenticator Authentication server
Configuring 802.1X Port-Based Authentication
Note Although we recommend using the authentication commands described in this section, legacy 802.1X
commands in 12.2(46)SG and earlier releases are still accepted.
To configure 802.1X, follow this procedure:
Step 1 Enable 802.1X authentication. See the “Enabling 802.1X Authentication” section on page 36-24.
Step 2 Configure switch to RADIUS server communication. See the “Configuring Switch-to-RADIUS-Server
Communication” section on page 36-27.
Step 3 Adjust the 802.1X timer values. See the “Changing the Quiet Period” section on page 36-63.
Step 4 Configure optional features. See the “Configuring RADIUS-Provided Session Timeouts” section on
page 36-45.
These sections describe how to configure 802.1X:
• Default 802.1X Configuration, page 36-23
• 802.1X Configuration Guidelines, page 36-24
• Enabling 802.1X Authentication, page 36-24 (required)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-22 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
• Configuring Switch-to-RADIUS-Server Communication, page 36-27 (required)
• Configuring Multiple Domain Authentication and Multiple Authorization, page 36-29
• Configuring 802.1X Authentication with ACL Assignments and Redirect URLs, page 36-32
• Configuring 802.1X Authentication with Per-User ACL and Filter-ID ACL, page 36-38
• Configuring RADIUS-Provided Session Timeouts, page 36-45 (optional)
• Configuring 802.1X with Guest VLANs, page 36-46 (optional)
• Configuring 802.1X with MAC Authentication Bypass, page 36-48 (optional)
• Configuring 802.1X with Inaccessible Authentication Bypass, page 36-50 (optional)
• Configuring 802.1X with Unidirectional Controlled Port, page 36-52 (optional)
• Configuring 802.1X with Authentication Failed, page 36-53 (optional)
• Configuring 802.1X with Voice VLAN, page 36-54 (optional)
• Configuring 802.1X with VLAN Assignment, page 36-55
• Enabling Fallback Authentication, page 36-57
• Enabling Periodic Reauthentication, page 36-61 (optional)
• Enabling Multiple Hosts, page 36-62 (optional
• Changing the Quiet Period, page 36-63 (optional)
• Changing the Switch-to-Client Retransmission Time, page 36-63 (optional)
• Setting the Switch-to-Client Frame-Retransmission Number, page 36-64 (optional)
• Manually Reauthenticating a Client Connected to a Port, page 36-66 (optional)
• Initializing the 802.1X Authentication State, page 36-66
• Removing 802.1X Client Information, page 36-66
• Resetting the 802.1X Configuration to the Default Values, page 36-66 (optional)
Default 802.1X Configuration
Table 36-1 shows the default 802.1X configuration.
Table 36-1 Default 802.1X Configuration
Feature Default Setting
Authentication, authorization, and accounting (AAA) Disabled
RADIUS server
• IP address • None specified
• UDP authentication port • 1645
• Key • None specified
Per-interface 802.1X protocol enable state Force-authorized
The port transmits and receives normal traffic without
802.1X-based authentication of the client.
Periodic reauthentication Disabled
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-23
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Table 36-1 Default 802.1X Configuration (continued)
Feature Default Setting
Time between reauthentication attempts 3600 sec
Quiet period 60 sec
Number of seconds that the switch remains in the quiet state
following a failed authentication exchange with the client.
Retransmission time 30 sec
Number of seconds that the switch should wait for a response to
an EAP request/identity frame from the client before
retransmitting the request.
Maximum retransmission number 2
Number of times that the switch sends an EAP-request/identity
frame before restarting the authentication process.
Multiple host support Disabled
Client timeout period 30 sec
When relaying a request from the authentication server to the
client, the amount of time that the switch waits for a response
before retransmitting the request to the client.
Authentication server timeout period 30 sec
When relaying a response from the client to the authentication
server, the amount of time that the switch waits for a reply before
retransmitting the response to the server. This setting is not
configurable.
802.1X Configuration Guidelines
This section describes the guidelines for configuring 802.1X authentication:
• The 802.1X protocol is supported only on Layer 2 static access, PVLAN host ports, and Layer 3
routed ports. You cannot configure 802.1X for any other port modes.
• If you are planning to use VLAN assignment, be aware that the features use general AAA
commands. For information on how to configure AAA, refer to the “Enabling 802.1X
Authentication” section on page 36-24. Alternatively, you can refer to the Cisco IOS security
documentation:
– http://www.cisco.com/en/US/products/ps6586/products_ios_technology_home.html
Enabling 802.1X Authentication
To enable 802.1X port-based authentication, you first must enable 802.1X globally on your switch, then
enable AAA and specify the authentication method list. A method list describes the sequence and
authentication methods that must be queried to authenticate a user.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-24 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
The software uses the first method listed in the method list to authenticate users; if that method fails to
respond, the software selects the next authentication method in the list. This process continues until there
is successful communication with a listed authentication method or until all defined methods are
exhausted. If authentication fails at any point in this cycle, the authentication process stops, and no other
authentication methods are attempted.
Note To allow VLAN assignment, you must enable AAA authorization to configure the switch for all
network-related service requests.
To configure 802.1X port-based authentication, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# Enables 802.1X on your switch.
dot1x system-auth-control
To disable 802.1X globally on the switch, use the
no dot1x system-auth-control command.
Step 3 Switch(config)# aaa new-model Enables AAA.
To disable AAA, use the no aaa new-model command.
Step 4 Switch(config)# aaa authentication Creates an 802.1X AAA authentication method list.
dot1x {default} method1 [method2...]
To create a default list that is used when a named list is not specified in
the authentication command, use the default keyword followed by the
methods that are to be used in default situations. The default method list
is automatically applied to all interfaces.
Enter at least one of these keywords:
• group radius—Use the list of all RADIUS servers for authentication.
• none—Use no authentication. The client is automatically
authenticated by the switch without using the information supplied by
the client.
To disable 802.1X AAA authentication, use the
no aaa authentication dot1x {default | list-name} method1 [method2...]
global configuration command.
Step 5 Switch(config)# aaa authorization (Optional) Configures the switch for user RADIUS authorization for all
network {default} group radius network-related service requests, such as VLAN assignment.
Step 6 Switch(config)# interface Enters interface configuration mode and specifies the interface to be
interface-id enabled for 802.1X authentication.
Step 7 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
Step 8 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 9 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 10 Switch(config-if)# end Returns to privileged EXEC mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-25
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 11 Switch # show dot1x interface Verifies your entries.
interface-id details
Check the PortControl row in the 802.1X port summary section of this
display. The PortControl value is set to auto.
Step 12 Switch# show running-config Verifies your entries.
Step 13 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Note Enabling Spanning Tree PortFast ensures that a port comes up immediately after authorization.
Note Whenever you configure any 802.1X parameter on a port, a dot1x authenticator is automatically created
on the port. As a result dot1x pae authenticator appears in the configuration. This is to ensure that
dot1x authentication still works on legacy configurations without manual intervention. This is likely to
change in future releases.
This example shows how to enable 802.1X and AAA on Fast Ethernet port 2/1, and how to verify the
configuration:
Switch# configure terminal
Switch(config)# dot1x system-auth-control
Switch(config)# aaa new-model
Switch(config)# aaa authentication dot1x default group radius
Switch(config)# interface fastethernet2/1
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication port-control auto
Switch(config-if)# end
Switch# show authentication sessions interface f9/2
Interface: FastEthernet9/2
MAC Address: 0007.e95d.83c4
IP Address: Unknown
Status: Running
Domain: UNKNOWN
Oper host mode: single-host
Oper control dir: both
Session timeout: N/A
Idle timeout: N/A
Common Session ID: 0A050B160000009505106398
Acct Session ID: 0x0000009B
Handle: 0x0D000095
Runnable methods list:
Method State
dot1x Running
mab Not run
The following example illustrates when a port is authorized:
Switch# show authentication sessions int G4/5
Interface: GigabitEthernet4/5
MAC Address: 0015.e981.0531
IP Address: Unknown
User-Name: ctssxp
Status: Authz Success
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-26 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Domain: DATA
Oper host mode: single-host
Oper control dir: both
Session timeout: N/A
Idle timeout: N/A
Common Session ID: 0A053F0F00000004041E6B0C
Acct Session ID: 0x00000021
Handle: 0x2C000004
Runnable methods list:
Method State
dot1x Authc Success
Switch# show dot1x interface G4/5 details
Dot1x Info for GigabitEthernet4/5
-----------------------------------
PAE = AUTHENTICATOR
PortControl = AUTO
ControlDirection = Both
HostMode = SINGLE_HOST
QuietPeriod = 60
ServerTimeout = 0
SuppTimeout = 30
ReAuthMax = 2
MaxReq = 2
TxPeriod = 30
Dot1x Authenticator Client List
-------------------------------
Supplicant = 0015.e981.0531
Session ID = 0A053F0F00000004041E6B0C
Auth SM State = AUTHENTICATED
Auth BEND SM State = IDLE
Port Status = AUTHORIZED
Configuring Switch-to-RADIUS-Server Communication
A RADIUS security server is identified by its host name or IP address, host name and specific UDP port
number, or IP address and specific UDP port numbers. The combination of the IP address and UDP port
number creates a unique identifier, which enables RADIUS requests to be sent to multiple UDP ports on
a server at the same IP address. If two different host entries on the same RADIUS server are configured
for the same service—for example, authentication—the second host entry configured acts as the fail-over
backup to the first one. The RADIUS host entries are tried in the order they were configured.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-27
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
To configure the RADIUS server parameters on the switch, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# radius-server host Configures the RADIUS server parameters on the switch.
{hostname | ip-address} auth-port
port-number [acct-port port-number] For hostname | ip-address, specify the hostname or IP address of the
[test username name] remote RADIUS server.
[ignore-auth-port] [ignore-acct-port]
[idle-time min] key string To delete the specified RADIUS server, use the no radius-server host
{hostname | ip-address} global configuration command.
The auth-port port-number specifies the UDP destination port for
authentication requests. The default is 1645.
The acct-port port-number specifies the UDP destination port for
accounting requests. The default is 1646.
Use test username name to enable automated RADIUS server testing,
and to detect the RADIUS server going up and down. The name
parameter is the username used in the test access request sent to the
RADIUS server; it does not need to be a valid user configured on the
server. The ignore-auth-port and ignore-acct-port options disable
testing on the authentication and accounting ports respectively.
The idle-time min parameter specifies the number of minutes before
an idle RADIUS server is tested to verify that it is still up. The default
is 60 minutes.
The key string specifies the authentication and encryption key used
between the switch and the RADIUS daemon running on the RADIUS
server. The key is a text string that must match the encryption key used
on the RADIUS server.
Note Always configure the key as the last item in the
radius-server host command syntax because leading spaces
are ignored, but spaces within and at the end of the key are
used. If you use spaces in the key, do not enclose the key in
quotation marks unless the quotation marks are part of the key.
This key must match the encryption used on the RADIUS
daemon.
If you want to use multiple RADIUS servers, use this command
multiple times.
Step 3 Switch(config-if)# radius deadtime (Optional) Configures the number of minutes before a dead RADIUS
min server is tested to check whether it has come back up. The default is 1
minute.
Step 4 Switch(config-if)# radius (Optional) Configures the criteria used to decide whether a RADIUS
dead-criteria time seconds tries num server is dead. The time parameter specifies the number of seconds
after which a request to the server is unanswered before it is
considered dead. The tries parameter specifies the number of times a
request to the server is unanswered before it is considered dead.
The recommended values for these parameters are tries equal to
radius-server retransmit and time equal to radius-server
retransmit x radius-server timeout.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-28 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 5 Switch(config-if)# ip radius Establishes the IP address to be used as the source address for all
source-interface m/p outgoing RADIUS packets.
Step 6 Switch(config)# end Returns to privileged EXEC mode.
Step 7 Switch# show running-config Verifies your entries.
Step 8 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to specify the server with IP address 172.120.39.46 as the RADIUS server. The
first command specifies port 1612 as the authorization port, sets the encryption key to rad123.
The second command dictates that key matches are performed on the RADIUS server:
Switch# configure terminal
Switch(config)# radius-server host 172.l20.39.46 auth-port 1612 key rad123
Switch(config)# ip radius source-interface g3/2
Switch(config)# end
Switch#
You can globally configure the timeout, retransmission, and encryption key values for all RADIUS
servers by using the radius-server host global configuration command. If you want to configure these
options on a per-server basis, use the radius-server timeout, radius-server retransmit, and the
radius-server key global configuration commands.
You also need to create a AAA client setting on the RADIUS server. These settings include the IP
address of the switch and the key string to be shared by both the server and the switch.
Configuring Multiple Domain Authentication and Multiple Authorization
To configure MDA and Multiple Authentication, perform this task.
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# radius-server vsa Configures the network access server to recognize and use
send authentication vendor-specific attributes (VSAs).
Step 3 Switch(config)# interface Specifies the port to which multiple hosts are indirectly attached, and
interface-id enters interface configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-29
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 4 Switch(config-if)# [no] The keywords allow the following:
authentication host-mode
{single-host | multi-host | • single-host–Single host (client) on an IEEE 802.1X-authorized port.
multi-domain} | multi-auth}
• multi-host–Multiple hosts on an 802.1X-authorized port after a
authenticating a single host.
• multi-domain–Both a host and a voice device (like an IP phone,
Cisco or non-Cisco), to authenticate on an IEEE 802.1X-authorized
port.
Note You must configure a voice VLAN for an IP phone when the host
mode is set to multi-domain. For more information, see
Chapter 34, “Configuring Voice Interfaces.”
• multi-auth–Allows multiple hosts and a voice device, such as an IP
phone (Cisco or non-Cisco), to be authenticated on an IEEE
802.1x-authorized port. This keyword requires Cisco IOS Release
12.2(50)SG or a later release.
Ensure that the dot1x port-control interface configuration command is
set to auto for the specified interface.
To disable multiple hosts on the port, use the
no authentication host-mode {multi-host | multi-domain | multi-auth}
interface configuration command (for earlier releases, use the
no dot1x host-mode {multi-host | multi-domain} interface
configuration command).
Step 5 Switch(config-if)# switchport voice (Optional) Configures the voice VLAN.
vlan vlan-id
Step 6 Switch(config-if)# end Returns to privileged EXEC mode.
Step 7 Switch# show dot1x interface Verifies your entries.
interface-id [detail]
Step 8 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to enable 802.1X authentication and to allow multiple hosts:
Switch(config)# interface gigabitethernet2/1
Switch(config-if)# authentication port-control auto
Switch(config-if)# authentication host-mode multi-host
Switch(config-if)# end
This example shows how to enable MDA and to allow both a host and a 802.1X voice device (a Cisco or
third-party phone with 802.1X supplicant) on the port:
Switch# conf terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface FastEthernet3/1
Switch(config-if)# shut
Switch(config-if)# switchport access vlan 12
Switch(config-if)# switchport mode access
Switch(config-if)# switchport voice vlan 10
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication port-control auto
Switch(config-if)# authentication host-mode multi-domain
Switch(config-if)# no shut
Switch(config-if)# end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-30 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
This example shows how to enable MDA and to allow both a host and a non-802.1X voice device on the
port:
Switch# conf t
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface FastEthernet3/1
Switch(config-if)# shut
Switch(config-if)# switchport access vlan 12
Switch(config-if)# switchport mode access
Switch(config-if)# switchport voice vlan 10
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication port-control auto
Switch(config-if)# authentication host-mode multi-domain
Switch(config-if)# mab eap
Switch(config-if)# no shut
Switch(config-if)# end
This example shows how to verify the dot1x MDA settings on interface FastEthernet3/1:
Switch# show dot1x interface FastEthernet3/1 detail
Dot1x Info for FastEthernet3/1
-----------------------------------
PAE = AUTHENTICATOR
PortControl = AUTO
ControlDirection = Both
HostMode = MULTI_DOMAIN
ReAuthentication = Disabled
QuietPeriod = 60
ServerTimeout = 30
SuppTimeout = 30
ReAuthPeriod = 3600 (Locally configured)
ReAuthMax = 2
MaxReq = 2
TxPeriod = 30
RateLimitPeriod = 0
Dot1x Authenticator Client List
-------------------------------
Domain = DATA
Supplicant = 0000.0000.ab01
Auth SM State = AUTHENTICATED
Auth BEND SM Stat = IDLE
Port Status = AUTHORIZED
Authentication Method = Dot1x
Authorized By = Authentication Server
Vlan Policy = 12
Domain = VOICE
Supplicant = 0060.b057.4687
Auth SM State = AUTHENTICATED
Auth BEND SM Stat = IDLE
Port Status = AUTHORIZED
Authentication Method = Dot1x
Authorized By = Authentication Server
Switch#
This example shows how to enable MDA and to authentication of multiple hosts and a voice device on
an IEEE 802.1x-authorized port:
Switch# conf t
Enter configuration commands, one per line. End with CNTL/Z.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-31
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Switch(config)# interface FastEthernet3/1
Switch(config-if)# shut
Switch(config-if)# switchport access vlan 12
Switch(config-if)# switchport mode access
Switch(config-if)# switchport voice vlan 10
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication port-control auto
Switch(config-if)# authentication host-mode multi-auth
Switch(config-if)# map eap
Switch(config-if)# no shut
Switch(config-if)# end
Configuring 802.1X Authentication with ACL Assignments and Redirect URLs
Topics include:
• Downloadable ACL, page 36-32
• URL-Redirect, page 36-34
• Configuring a Downloadable Policy, page 36-37
Downloadable ACL
The Downloadable ACL feature enables you to download device specific authorization policies from the
authentication server. These policies activate after authentication succeeds for the respective client and
the client's IP address has been populated in the IP device tracking table. (Downloadable ACL is applied
on the port, once the port is authenticated and the IP device tracking table has the host IP address entry).
The following sections illustrates the configuration needed to complement the related authentication
(802.1X or MAB) configuration. (No unique configuration is required on the switch. All of the
configuration is on the ACS.) After authentication succeeds, enter the show ip access-list command to
display the downloadable ACLs.
Switch Configuration
Step 1 Configure the IP device tracking table.
Switch(config)# ip device tracking
Step 2 Configure RADIUS VSA to forward authentication.
Switch(config)# radius-server vsa send authentication
Step 3 Configure Static ACL (PACL) for the interface.
Switch(config)# int g2/9
Switch(config-if)# ip access-group pacl-4 in
Sample Interface Configuration
Switch# show running-configuration interface g2/9
Building configuration...
Current configuration : 617 bytes
!
interface GigabitEthernet2/9
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-32 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
switchport
switchport access vlan 29
switchport mode access
switchport voice vlan 1234
access-group mode prefer port
ip access-group pacl-4 in
speed 100
duplex full
authentication event fail action authorize vlan 111
authentication event server dead action authorize vlan 333
authentication event server alive action reinitialize
authentication host-mode multi-auth
authentication order dot1x
authentication port-control auto
authentication timer restart 100
authentication timer reauthenticate 20
authentication timer inactivity 200
mab eap
dot1x pae authenticator
end
Switch#
Switch# show ip access-list pacl-4
10 permit ip host 1.1.1.1 host 2.2.2.2
20 permit icmp host 1.1.1.1 host 2.2.2.2
Switch#
Debug Commands for DACL
The IP device tracking table contains the host IP address learned through ARP or DHCP.
The following commands displays the constraints on the IP device tracking table:
Switch# show ip device tracking all
IP Device Tracking = Enabled
IP Device Tracking Probe Count = 3
IP Device Tracking Probe Interval = 30
--------------------------------------------------------------
IP Address MAC Address Interface STATE
--------------------------------------------------------------
50.0.0.12 0015.60a4.5e84 GigabitEthernet2/9 ACTIVE
The following command shows that the EPM (Policy Enforced Module) session contains the DACL
downloaded from ACS:
Switch# show epm session ip 50.0.0.12
Admission feature : DOT1X
AAA Policies :
ACS ACL : xACSACLx-IP-auth-48b79b6e
The following command reveals the contents of the downloadable ACL:
Switch# show ip accesslists xACSACLx-IP-auth-48b79b6e
Extended IP access list xACSACLx-IP-auth-48b79b6e (per-user)
10 permit udp any any
Switch(config)#
Cisco ACS Configuration for DACL
Note Only Cisco ACS supports DACL.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-33
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Follow these steps to ensure correct functioning of the ACS configuration required for DACL:
Step 1 Configure a downloadable IP ACL on the window that appears when you select
Radius Shared Profile > Downloadable IP ACL Content:
Figure 36-8 Shared Profile Components
Step 2 Attach this DACL with the USER on the window that appears when you select User > DACLs:
Figure 36-9 Downloadable ACLs
URL-Redirect
This configuration consists of two configurations: one on ACS, and one on the switch.
ACS configuration
To configure two Cisco-AV pairs, add the following statements under the user or group Cisco IOS/PIX
6x RADIUS attributes:
url-redirect-acl=urlacl
url-redirect=http://www.cisco.com
Note A default port ACL must be configured on the interface.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-34 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Switch configuration
To configure the switch for URL redirect, do the following:
Step 1 Configure the IP device tracking table.
Switch(config)# ip device tracking
Step 2 Configure RADIUS with the send authentication command.
Switch(config)# radius-server vsa send authentication
Step 3 Configure the URL redirect ACL (URLACL).
Switch# ip access-list urlacl
10 permit tcp any any
Switch#
Step 4 Configure static ACL (PACL) for the interface.
Switch(config)# int g2/9
Switch(config-if)# ip access-group pacl-4 in
Sample Interface Configuration
Switch# show running-configuration int g2/9
Building configuration...
Current configuration : 617 bytes
!
interface GigabitEthernet2/9
switchport
switchport access vlan 29
switchport mode access
switchport voice vlan 1234
access-group mode prefer port
ip access-group pacl-4 in
speed 100
duplex full
authentication event fail action authorize vlan 111
authentication event server dead action authorize vlan 333
authentication event server alive action reinitialize
authentication host-mode multi-auth
authentication order dot1x
authentication port-control auto
authentication timer restart 100
authentication timer reauthenticate 20
authentication timer inactivity 200
mab
dot1x pae authenticator
end
Switch#
Switch# show access-list pacl-4
10 permit ip host 1.1.1.1 host 2.2.2.2
20 permit icmp host 1.1.1.1 host 2.2.2.2
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-35
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Verify URL-redirect with the following commands.
The show ip device tracking command illustrates the constraints on the IP device tracking table:
Switch(config)# show ip device tracking all
IP Device Tracking = Enabled
IP Device Tracking Probe Count = 3
IP Device Tracking Probe Interval = 30
--------------------------------------------------------------
IP Address MAC Address Interface STATE
--------------------------------------------------------------
50.0.0.12 0015.60a4.5e84 GigabitEthernet2/9 ACTIVE
The show epm session ip command displays the EPM session table for a particular host. Observe the
URL- redirect-acl and URL-redirect URL information that downloads from the ACS.
Switch# show epm session ip 50.0.0.12
Admission feature : DOT1X
AAA Policies :
URL Redirect ACL : urlacl
URL Redirect : http://www.cisco.com
For more information about AV pairs that are supported by Cisco IOS software, see the
ACS configuration and command reference documentation about the software releases running on the
AAA clients.
Guidelines and Restrictions for DACL and URL Redirect
For downloadable ACL or URL redirect, the ACL source must be ANY
(permit TCP ANY host 1.1.1.1 eq 80 or permit TCP ANY host 1.1.1.1 eq 443).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-36 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Configuring a Downloadable Policy
To configure downloadable policies, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# access-list Defines the default port ACL through a source address and wildcard.
access-list-number {deny | permit}
source [source-wildcard] [log] The access-list-number is a decimal from 1 to 99 or 1300 to 1999.
Enter deny or permit to specify whether to deny or permit access if
conditions match.
source is the address of the network or host from which the packet is sent,
specified as follows:
• The 32-bit quantity in dotted-decimal format
• The keyword any as an abbreviation for source and source-wildcard
value of 0.0.0.0 255.255.255.255
You do not need a source-wildcard value.
• The keyword host as an abbreviation for source and source-wildcard
of source 0.0.0.0.
(Optional) Applies the source-wildcard wildcard bits to the source.
(Optional) Enters log to cause an informational logging message about the
packet that matches the entry to be sent to the console.
Step 3 Switch(config-if)# interface Enters interface configuration mode.
interface-id
Step 4 Switch(config-if)# ip access-group Controls access to the specified interface.
{access-list-number | name} in
This step is mandatory for a functioning downloaded policy.
Step 5 Switch(config)# exit Returns to global configuration mode.
Step 6 Switch(config)# aaa new-model Enables AAA.
Step 7 Switch(config)# aaa authorization Sets the authorization method to local. To remove the authorization
network default local method, use the no aaa authorization network default local command.
Step 8 Switch(config)# ip device tracking Enables the IP device tracking table.
To disable the IP device tracking table, use the no ip device tracking
global configuration commands.
Step 9 Switch(config)# ip device tracking (Optional) Configures these parameters for the IP device tracking table:
[probe {count count | interval
interval}] • count - Number of times that the switch sends the ARP probe. The
range is 1 to 5. The default is 3.
• interval - Number of seconds that the switch waits for a response
before resending the ARP probe. The range is 30 to 300 seconds. The
default is 30 seconds.
Step 10 Switch(config)# radius-server vsa Configures the network access server to recognize and use vendor-specific
send authentication attributes.
Note The downloadable ACL must be operational.
Step 11 Switch(config)# end Returns to privileged EXEC mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-37
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 12 Switch# show ip device tracking Displays information about the entries in the IP device tracking table.
{all | interface interface-id | ip
ip-address | mac mac-address}
Step 13 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
The following example illustrates how to configure a switch for downloadable policy:
Switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# aaa new-model
Switch(config)# aaa authorization network default local
Switch(config)# ip device tracking
Switch(config)# ip access-list extended default_acl
Switch(config-ext-nacl)# permit ip any any
Switch(config-ext-nacl)# exit
Switch(config)# radius-server vsa send authentication
Switch(config)# int fastEthernet 2/13
Switch(config-if)# ip access-group default_acl in
Switch(config-if)# exit
Configuring 802.1X Authentication with Per-User ACL and Filter-ID ACL
Topics include:
• Per-User ACL and Filter-ID ACL, page 36-38
• Configuring a Per-User ACL and Filter-ID ACL, page 36-44
Per-User ACL and Filter-ID ACL
Prior to Cisco IOS Release 12.2(52)SG, the Cat4K platform only supported downloadable ACLs, which
work with the Cisco ACS server but not with third-party AAA servers. With
Cisco IOS Release 12.2(52)SG, the Catalyst 4500 switch offers the Filter-ID/Per-user-acl
enhancement(s), which allow ACL policy enforcement using a third-party AAA server.
The Filter-ID feature provides the following capabilities:
Filter-ID option allows an administrator to define the ACL name on the AAA server using IETF
standard Radius attribute. The ACL itself must be pre-configured locally on the switch.
The Per-user-acl feature provides the following capabilities:
Per-user ACL allows an administrator to define the per-user ACL on the AAA server using Cisco
Radius AV pairs. This allows third-party AAA server to interoperate by loading Cisco Radius
dictionary. Cisco radius dictionary has Cisco Radius AV pairs configured as a VSA.
Note The Radius Vendor-specific attributes (VSAs) allow vendors to support their own proprietary
RADIUS attributes that are not included in standard radius attributes.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-38 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Switch Configuration
Step 1 Configure the IP device tracking table.
Switch(config)# ip device tracking
Step 2 Configure Static ACL (PACL) for the interface.
Switch(config)# int g2/9
Switch(config-if)# ip access-group pacl-4 in
Sample Interface Configuration
Switch# show running-configuration interface g2/9
Building configuration...
Current configuration : 617 bytes
!
interface GigabitEthernet2/9
switchport
switchport access vlan 29
switchport mode access
switchport voice vlan 1234
access-group mode prefer port
ip access-group pacl-4 in
speed 100
duplex full
authentication event fail action authorize vlan 111
authentication event server dead action authorize vlan 333
authentication event server alive action reinitialize
authentication host-mode multi-auth
authentication order dot1x
authentication port-control auto
authentication timer restart 100
authentication timer reauthenticate 20
authentication timer inactivity 200
mab eap
dot1x pae authenticator
end
Switch#
Switch# show ip access-list pacl-4
10 permit ip host 1.1.1.1 host 2.2.2.2
20 permit icmp host 1.1.1.1 host 2.2.2.2
Switch#
Per-User-Acl configuration in ACS
In the Group/User Setting page, scroll down to the Cisco IOS/PIX 6.x RADIUS Attributes section.
Select the box next to [009\001 cisco-av-pair] and enter the elements of the per-user ACL. Per-user
ACLS take this format:
<protocol>:inacl#<sequence number>=<ACE>
<protocol> can be either "ip" for IP-based ACLs or "mac" for MAC-based ACLs.
In the following example, members of the group you are configuring are denied all access to the
10.100.60.0 subnet, denied http access to the server at 10.100.10.116, and permitted everywhere else.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-39
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Figure 36-10 Define the ACEs for the per-user ACL
Note outbound ACLs (outacl) are not supported.
Filter-Id configuration in ACS:
In the Group/User Setting page, scroll down to the " IETF RADIUS Attributes" section. Select the box
next to [011] Filter-Id and enter the ACL to apply for members of this group (Figure 36-11).
The Filter-Id takes this format:
<ACL>.in
<ACL> is the number of the ACL that was configured on the switch in the previous step
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-40 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Figure 36-11 Configuring the Filter-ID Attribute
Note Outbound ACLs (e.g. "100.out") are not supported.
Debug Commands for Per-User ACL and Filter-ID ACL
The IP device tracking table contains the host IP address learned through ARP or DHCP. The following
command displays the constraints on the IP device tracking table:
Switch# show ip device tracking all
IP Device Tracking = Enabled
IP Device Tracking Probe Count = 3
IP Device Tracking Probe Interval = 30
--------------------------------------------------------------
IP Address MAC Address Interface STATE
--------------------------------------------------------------
50.0.0.12 0015.60a4.5e84 GigabitEthernet2/9 ACTIVE
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-41
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
The following command shows that the EPM (Policy Enforced Module) session contains the per-user-acl
from ACS:
Switch# show epm session ip 50.0.0.12
Admission feature : DOT1X
AAA Policies :
Per-User ACL : deny ip any host 20.20.10.10
The following command reveals the contents of the per-user-acl (note that per-user-acl are shown above
the default port ACL configured on the interface, 151 is the default port ACL in the following example):
Switch# show access-list
Extended IP access list 151
deny ip host 20.20.0.3 host 20.20.10.10
10 permit ip any any (57 estimate matches)
The following commands reveals the number of sessions and the corresponding client ip addresses,
Switch# show epm session summary
EPM Session Information
-----------------------
Total sessions seen so far : 1
Total active sessions : 1
Session IP Address :
-------------------
50.0.0.12
The following command shows that the EPM (Policy Enforced Module) session contains the
per-user-acl(both ip and mac acl from ACS):
Switch# show epm session ip 50.0.0.12
Admission feature : DOT1X
AAA Policies :
Per-User ACL : deny ip any host 20.20.10.10
Per-User ACL : deny any host 0000.AAAA.AAAA
The following command reveals the contents of the per-user-acl (note that per-user-acl are shown above
the default port acl configured on the interface, 151 is the default port acl in the example below):
Switch# show access-list
Extended IP access list 151
deny ip host 20.20.0.3 host 20.20.10.10
10 permit ip any any (57 estimate matches)
..
..
..(check for the mac access-list created)..
..
Extended MAC access list PerUser_MAC_ACL-589079192 (per-user)
deny any host 0000.aaaa.aaaa
..
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-42 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
The following command shows that the EPM (Policy Enforced Module) session contains the Filter-Id
155 from ACS:
Note The 156 IP extended acl is to be pre-configured on the switch, so that the policy enforcement
can happen.
Switch# show ip access-list 156
Extended IP access list 156
10 deny ip any host 155.155.155.156
20 deny ip any 156.100.60.0 0.0.0.255
30 deny tcp any host 156.100.10.116 eq www
Switch# show epm session ip 50.0.0.12
Admission feature : DOT1X
AAA Policies :
Filter-Id : 155
The following command reveals the contents of the Filter-Id applied on the interface:
Switch# show ip access-list int <gi6/3>
Switch# show ip access-list interface gi6/3
deny ip host 20.20.0.2 host 155.155.155.156
deny ip host 20.20.0.2 156.100.60.0 0.0.0.255
deny tcp host 20.20.0.2 host 156.100.10.116 eq www
Guidelines and Restrictions for Per-User-ACL and Filter-ID ACL
For Per-User-ACL and Filter-ID ACL, the ACL source must be ANY
(permit TCP ANY host 1.1.1.1 eq 80 or permit TCP ANY host 1.1.1.1 eq 443).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-43
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Configuring a Per-User ACL and Filter-ID ACL
To configure Per-User-ACL and Filter-ID ACL, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# access-list Defines the default port ACL through a source address and wildcard.
access-list-number {deny | permit}
source [source-wildcard] [log] The access-list-number is a decimal from 1 to 99 or 1300 to 1999.
Enter deny or permit to specify whether to deny or permit access if
conditions match.
source is the address of the network or host from which the packet is sent,
specified as follows:
• The 32-bit quantity in dotted-decimal format
• The keyword any as an abbreviation for source and source-wildcard
value of 0.0.0.0 255.255.255.255
You do not need a source-wildcard value.
• The keyword host as an abbreviation for source and source-wildcard
of source 0.0.0.0.
(Optional) Applies the source-wildcard wildcard bits to the source.
(Optional) Enters log to cause an informational logging message about the
packet that matches the entry to be sent to the console.
Step 3 Switch(config-if)# interface Enters interface configuration mode.
interface-id
Step 4 Switch(config-if)# ip access-group Controls access to the specified interface.
{access-list-number | name} in
This step is mandatory for a functioning downloaded policy.
Step 5 Switch(config)# exit Returns to global configuration mode.
Step 6 Switch(config)# aaa new-model Enables AAA.
Step 7 Switch(config)# aaa authorization Sets the authorization method to local. To remove the authorization
network default local method, use the no aaa authorization network default local command.
Step 8 Switch(config)# ip device tracking Enables the IP device tracking table.
To disable the IP device tracking table, use the no ip device tracking
global configuration commands.
Step 9 Switch(config)# ip device tracking (Optional) Configures these parameters for the IP device tracking table:
[probe {count count | interval
interval}] • count - Number of times that the switch sends the ARP probe. The
range is 1 to 5. The default is 3.
• interval - Number of seconds that the switch waits for a response
before resending the ARP probe. The range is 30 to 300 seconds. The
default is 30 seconds.
Step 10 Switch(config)# end Returns to privileged EXEC mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-44 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 11 Switch# show ip device tracking Displays information about the entries in the IP device tracking table.
{all | interface interface-id | ip
ip-address | mac mac-address}
Step 12 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
The following example illustrates how to configure a switch for downloadable policy:
Switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# aaa new-model
Switch(config)# aaa authorization network default local
Switch(config)# ip device tracking
Switch(config)# ip access-list extended default_acl
Switch(config-ext-nacl)# permit ip any any
Switch(config-ext-nacl)# exit
Switch(config)# int fastEthernet 2/13
Switch(config-if)# ip access-group default_acl in
Switch(config-if)# exit
Configuring RADIUS-Provided Session Timeouts
You can configure the Catalyst 4500 series switch to use a RADIUS-provided reauthentication timeout.
To configure RADIUS-provided timeouts, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode.
interface-id
Step 3 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
Step 4 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 5 Switch(config-if)# authentication Sets the re-authentication period (seconds).
timer reauthenticate {interface |
server}
Step 6 Switch(config-if)# end Returns to privileged EXEC mode.
Step 7 Switch# show dot1x interface Verifies your entries.
interface-id details
Step 8 Switch # copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to configure a switch to derive the re-authentication period from the server and
to verify the configuration:
Switch# configure terminal
Switch(config)# interface f7/1
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication timer reauthenticate server
Switch(config-if)# end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-45
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Switch# show dot1x interface f7/1 det
Dot1x Info for FastEthernet7/11
-----------------------------------
PAE = AUTHENTICATOR
PortControl = FORCE_AUTHORIZED
ControlDirection = Both
HostMode = SINGLE_HOST
ReAuthentication = Disabled
QuietPeriod = 60
ServerTimeout = 30
SuppTimeout = 30
ReAuthPeriod = (From Authentication Server)
ReAuthMax = 2
MaxReq = 2
TxPeriod = 30
RateLimitPeriod = 0
Dot1x Authenticator Client List Empty
Port Status = AUTHORIZED
Switch#
Configuring 802.1X with Guest VLANs
You can configure a guest VLAN for each 802.1X port on the Catalyst 4500 series switch to provide
limited services to clients, such as downloading the 802.1X client. These clients might be upgrading
their system for 802.1X authentication, and some hosts, such as Windows 98 systems, might not be
802.1X-capable.
When you enable a guest VLAN on an 802.1X port, the Catalyst 4500 series switch assigns clients to a
guest VLAN provided the authentication server does not receive a response to its EAPOL request (or
identity frame), or the EAPOL packets are not sent by the client.
Starting with Cisco IOS Release 12.2(25)EWA, the Catalyst 4500 series switch maintains the EAPOL
packet history. If another EAPOL packet is detected on the interface during the lifetime of the link,
network access is denied. The EAPOL history is reset upon loss of the link.
Any number of 802.1X-incapable clients are allowed access when the switch port is moved to the guest
VLAN. If an 802.1X-capable client joins the same port on which the guest VLAN is configured, the port
is put into the unauthorized state in the user-configured access VLAN, and authentication is restarted.
Guest VLANs are supported on 802.1X ports in single-host or multiple-hosts mode.
Note When a port is put into a guest VLAN, it is automatically placed into multihost mode, and an unlimited
number of hosts can connect through the port. Changing the multihost configuration does not effect a
port in a guest VLAN.
Note Except for an RSPAN VLAN or a voice VLAN, you can configure any active VLAN as an 802.1X guest
VLAN.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-46 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
To configure 802.1X with guest VLAN on a port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode and specifies the interface to be
interface-id enabled for 802.1X authentication.
Step 3 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
or
Switch(config-if)# switchport mode Specifies that the ports with a valid PVLAN trunk association become active
private-vlan host host PVLAN trunk ports.
Step 4 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 5 Switch(config-if)# authentication Enables a guest VLAN on a particular interface.
event no-response action authorize
vlan vlan-id To disable the guest VLAN feature on a particular port, use the
no authentication event no-response action authorize vlan interface
configuration command (for earlier releases, use the no dot1x guest-vlan
interface configuration command).
Step 6 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 7 Switch(config-if)# end Returns to configuration mode.
Step 8 Switch(config)# end Returns to privileged EXEC mode.
This example shows how to enable regular VLAN 50 on Fast Ethernet 4/3 as a guest VLAN on a static
access port:
Switch# configure terminal
Switch(config)# interface fa4/3
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication event no-response action authorize vlan 50
Switch(config-if)# authentication port-control auto
Switch(config-if)# end
Switch#
This example shows how to enable a secondary PVLAN 100 as a guest VLAN on a PVLAN host port:
Switch# configure terminal
Switch(config)# interface fa4/3
Switch(config-if)# switchport mode private-vlan host
Switch(config-if)# authentication port-control auto
Switch(config-if)# authentication event no-response action authorize vlan 100
Switch(config-if)# end
Switch#
To allow supplicants into a guest VLAN on a switch, perform this task:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-47
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch# dot1x guest-vlan supplicant (Optional) Enables supplicants to be allowed into the guest VLANs
globally on the switch.
To disable the supplicant guest VLAN feature on a switch, use the
no dot1x guest-vlan supplicant global configuration command.
Step 3 Switch(config)# interface Enters interface configuration mode and specifies the interface to be
interface-id enabled for 802.1X authentication.
Step 4 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
or
Switch(config-if)# switchport mode Specifies that the ports with a valid PVLAN trunk association become active
private-vlan host host PVLAN trunk ports.
Step 5 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 6 Switch(config-if)# dot1x guest-vlan Specifies an active VLAN as an 802.1X guest VLAN. The range is 1 to
vlan-id 4094.
Step 7 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 8 Switch(config-if)# end Returns to privileged EXEC mode.
Step 9 Switch# show dot1x interface Verifies your entries.
interface-id
Step 10 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to enable the guest VLAN feature and to specify VLAN 5 as a guest VLAN:
Switch# configure terminal
Switch(config)# dot1x guest-vlan supplicant
Switch(config)# interface gigabitethernet5/9
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication event no-response action authorize vlan 5
Switch(config-if)# authentication port-control auto
Switch(config-if)# end
Switch#
Configuring 802.1X with MAC Authentication Bypass
To enable MAB, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Specifies the port to be configured, and enters interface configuration
interface-id mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-48 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 3 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
or
Switch(config-if)# switchport mode Specifies that the ports with a valid PVLAN trunk association become active
private-vlan host host PVLAN trunk ports.
Step 4 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 5 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 6 Switch(config-if)# mab [eap] Enables MAB on a switch.
The eap option specifies that a complete EAP conversation should be
used, as opposed to standard RADIUS Access-Request, Access-Accept
conversation. By default, the eap option is not enabled for MAB.
Step 7 Switch(config)# end Returns to privileged EXEC mode.
Step 8 Switch# show mab interface (Optional) Verifies your entries.
interface-id details
Step 9 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Note Removing a 802.1X MAB configuration from a port does not impact the authorized or authenticated
state of the port. If the port is in an unauthenticated state, it remains in that state. If the port is in an
authenticated state because of MAB, the switch reverts to the 802.1X Authenticator. If the port was
already authorized with a MAC address and the MAB configuration was removed, the port remains in
an authorized state until re-authentication occurs. At that time, if an 802.1X supplicant is detected on
the wire, the MAC address is removed.
This example shows how to enable MAB on Gigabit Ethernet interface 3/3 and to verify the
configuration:
Switch# configure terminal
Switch(config)# interface gigabitethernet3/3
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication port-control auto
Switch(config-if)# mab
Switch(config-if)# end
Switch# show mab int g3/3 details
MAB details for GigabitEthernet3/3
-------------------------------------
Mac-Auth-Bypass = Enabled
MAB Client List
---------------
Client MAC = 0001.0001.0001
Session ID = C0A8016F0000002304175914
MAB SM state = TERMINATE
Auth Status = AUTHORIZED
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-49
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Configuring 802.1X with Inaccessible Authentication Bypass
Caution You must configure the switch to monitor the state of the RADIUS server as described in the section
Configuring Switch-to-RADIUS-Server Communication, page 36-27 for Inaccessible Authentication
Bypass to work properly. Specifically, you must configure the RADIUS test username, idle-time,
deadtime and dead-criteria. Failure to do so results in the switch failing to detect that the RADIUS server
has gone down, or prematurely marking a dead RADIUS server as alive again.
To configure a port as a critical port and to enable the Inaccessible Authentication Bypass feature,
perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# authentication (Optional) Configures whether to send an EAPOL-Success packet when
critical eapol a port is critically authorized partway through an EAP exchange.
Note Some supplicants require this.
The default is not to send EAPOL-Success packets when ports are
critically authorized.
Step 3 Switch(config)# authentication (Optional) Specifies a throttle rate for the reinitialization of critically
critical recovery delay msec authorized ports when the RADIUS server becomes available. The default
throttle rate is 100 milliseconds. This means that 10 ports reinitialize per
second.
Step 4 Switch(config)# interface Specifies the port to be configured and enters interface configuration
interface-id mode.
Step 5 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
or
Switch(config-if)# switchport mode Specifies that the ports with a valid PVLAN trunk association become active
private-vlan host host PVLAN trunk ports.
Step 6 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 7 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 8 Switch(config-if)# authentication Enables the Inaccessible Authentication Bypass feature on the port.
event server dead action authorize
[vlan vlan-id] To disable the feature, use the
no authentication event server dead action authorize vlan interface
configuration command (for earlier releases, use the
no dot1x critical interface configuration command).
Step 9 Switch(config-if)# authentication (Optional) Specifies that the port should be reinitialized if it is critically
event server alive action authorized and RADIUS becomes available.
reinitialize
The default is not to reinitialize the port.
Step 10 Switch(config)# end Returns to privileged EXEC mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-50 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 11 Switch# show dot1x interface (Optional) Verifies your entries.
interface-id details
Step 12 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
The following example shows a full configuration of 802.1X with Inaccessible Authentication Bypass,
including required AAA and RADIUS configuration as specified in the “Enabling 802.1X
Authentication” section on page 36-24and “Configuring Switch-to-RADIUS-Server Communication”
section on page 36-27.
The RADIUS server configured is at IP address 10.1.2.3, using port 1645 for authentication and 1646
for accounting. The RADIUS secret key is mykey. The username used for the test server probes is
randomuser. The test probes for both living and dead servers are generated once per minute. The
interface FastEthernet 3/1 is configured to critically authenticate into VLAN 17 when AAA becomes
unresponsive, and to reinitialize automatically when AAA becomes available again.
Switch# configure terminal
Switch(config)# aaa new-model
Switch(config)# aaa authentication dot1x default group radius
Switch(config)# dot1x system-auth-control
Switch(config)# radius-server host 10.1.2.3 auth-port 1645 acct-port 1646 test username
randomuser idle-time 1 key mykey
Switch(config)# radius deadtime 1
Switch(config)# radius dead-criteria time 15 tries 3
Switch(config)# interface f3/1
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication port-control auto
Switch(config-if)# authentication event server dead action authorize vlan 17
Switch(config-if)# end
Switch# show dot1x int fastethernet 3/1 details
Dot1x Info for FastEthernet3/1
-----------------------------------
PAE = AUTHENTICATOR
PortControl = AUTO
ControlDirection = Both
HostMode = SINGLE_HOST
ReAuthentication = Disabled
QuietPeriod = 60
ServerTimeout = 30
SuppTimeout = 30
ReAuthPeriod = 3600 (Locally configured)
ReAuthMax = 2
MaxReq = 2
TxPeriod = 30
RateLimitPeriod = 0
Critical-Auth = Enabled
Critical Recovery Action = Reinitialize
Critical-Auth VLAN = 17
Dot1x Authenticator Client List
-------------------------------
Supplicant = 0000.0000.0001
Auth SM State = AUTHENTICATING
Auth BEND SM Stat = RESPONSE
Port Status = AUTHORIZED
Authentication Method = Dot1x
Authorized By = Critical-Auth
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-51
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Operational HostMode = SINGLE_HOST
Vlan Policy = 17
Switch#
Configuring 802.1X with Unidirectional Controlled Port
To configure unidirectional controlled port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Specifies the port to be configured and enters interface configuration
interface-id mode.
Step 3 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
or
Switch(config-if)# switchport mode Specifies that the ports with a valid PVLAN trunk association become active
private-vlan host host PVLAN trunk ports.
Step 4 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 5 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 6 Switch(config-if)# authentication Enables unidirectional port control on each port.
control-direction {in | both}
Step 7 Switch(config)# end Returns to privileged EXEC mode.
Step 8 Switch# show dot1x interface (Optional) Verifies your entries.
interface-id details
Step 9 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Note Unidirectional Controlled Port only works when Spanning Tree Portfast is enabled on the port.
Unidirectional Controlled Port and Spanning Tree Portfast should be configured on a switch port that
connects to a host. If two such ports are connected together with an Ethernet cable, high CPU utilization
may result because host learning is flapping between the two ports.
This example shows how to enable unidirectional port control:
Switch# configure terminal
Switch(config)# interface gigabitethernet3/3
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication port-control auto
Switch(config-if)# authentication control-direction in
Switch(config-if)# end
Switch# show dot1x int g3/3
Dot1x Info for GigabitEthernet3/3
-----------------------------------
PAE = AUTHENTICATOR
PortControl = AUTO
ControlDirection = In
HostMode = SINGLE_HOST
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-52 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
ReAuthentication = Disabled
QuietPeriod = 60
ServerTimeout = 30
SuppTimeout = 30
ReAuthPeriod = 3600 (Locally configured)
ReAuthMax = 2
MaxReq = 2
TxPeriod = 30
RateLimitPeriod = 0
Switch#
Configuring 802.1X with Authentication Failed
By configuring authentication-failed VLAN alignment on any Layer 2 port on the Catalyst 4500 series
switch, you can provide limited network services to clients that fail the authentication process.
Note Use the authentication-failed VLAN assignment with other security features, such as Dynamic ARP
Inspection (DAI), Dynamic Host Configuration Protocol (DHCP) snooping, and IP Source Guard. Each
of these features can be enabled and disabled independently on the authentication-failed VLAN.
To configure 802.1X with authentication-failed VLAN assignment, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode and specifies the interface to be
interface-id enabled for 802.1X authentication.
Step 3 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
Step 4 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 5 Switch(config-if)# authentication Enables authentication-failed VLAN on a particular interface.
event fail action authorize vlan
vlan-id To disable the authentication-failed VLAN feature on a particular port,
use the no authentication event fail action authorize vlan interface
configuration command.
Step 6 Switch(config-if)# authentication Configure a maximum number of attempts before the port is moved to
event fail retry max-attempts authentication-failed VLAN.
action [authorize vlan vlan-id |
next-method] Default is 3 attempts.
Step 7 Switch(config-if)# end Returns to configuration mode.
Step 8 Switch(config)# end Returns to privileged EXEC mode.
Step 9 Switch# show dot1x interface (Optional) Verifies your entries.
interface-id details
Step 10 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-53
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
This example shows how to enable a regular VLAN 40 on Fast Ethernet 4/3 as a authentication-failed
VLAN on a static access port:
Switch# configure terminal
Switch(config)# interface gigabitEthernet3/1
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication port-control auto
Switch(config-if)# authentication event fail retry 5 action authorize vlan 40
Switch(config-if)# end
Switch# show dot1x all
Sysauthcontrol Enabled
Dot1x Protocol Version 2
Dot1x Info for GigabitEthernet3/1
-----------------------------------
PAE = AUTHENTICATOR
PortControl = AUTO
ControlDirection = Both
HostMode = SINGLE_HOST
QuietPeriod = 60
ServerTimeout = 0
SuppTimeout = 30
ReAuthMax = 2
MaxReq = 2
TxPeriod = 30
Switch#
Configuring 802.1X with Voice VLAN
Note You must configure 802.1X and voice VLAN simultaneously.
Note You cannot configure an authentication-failed VLAN and a voice VLAN on the same port. When you
try to configure these two features on the same port, a syslog message appears.
To enable 802.1X with voice VLAN, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode.
interface-id
Step 3 Switch(config-if)# switchport Sets the VLAN for a switched interface in access mode.
access vlan vlan-id
Step 4 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
Step 5 Switch(config-if)# switchport voice Sets the voice VLAN for the interface.
vlan vlan-id
Step 6 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 7 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-54 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 8 Switch(config-if)# end Returns to configuration mode.
Step 9 Switch(config)# end Returns to privileged EXEC mode.
Step 10 Switch# show dot1x interface (Optional) Verifies your entries.
interface-id details
Step 11 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to enable 802.1X with voice VLAN feature on Fast Ethernet interface 5/9:
Switch# configure terminal
Switch(config)# interface fastethernet5/9
Switch(config-if)# switchport access vlan 2
Switch(config-if)# switchport mode access
Switch(config-if)# switchport voice vlan 10
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication port-control auto
Switch(config-if)# end
Switch(config# end
Switch#
Configuring 802.1X with VLAN Assignment
For enabling dynamic VLAN assignment, there is no additional configuration required in the switch. For
configuring MDA or Multi-authentication refer "Configuring Multiple Domain Authentication and
Multiple Authorization" section on page 39-29. To enable VLAN assignment, Cisco ACS Server has to
be configured correspondingly.
To enable 802.1X with VLAN assignment, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode.
interface-id
Step 3 Switch(config-if)# switchport Sets the VLAN for a switched interface in access mode.
access vlan-id
Step 4 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
Step 5 Switch(config-if)# switchport voice Sets the voice VLAN for the interface.
vlan vlan-id
Step 6 Switch(config-if)# authentication Enables MDA on the interface.
host-mode multi-domain
Step 7 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 8 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 9 Switch(config)# end Returns to privileged EXEC mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-55
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 10 Switch# show dot1x interface (Optional) Verifies your entries.
interface-id details
Step 11 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
The following example shows how to configure MDA on an interface and 802.1X as the authentication
mechanism:
Note You must configure VLAN assignment in the ACS server. No configuration changes are required
on the switch.
Switch(config)# interface FastEthernet3/3
Switch(config-if)# switchport access vlan 10
Switch(config-if)# switchport mode access
Switch(config-if)# switchport voice vlan 16
Switch(config-if)# authentication host-mode multi-domain
Switch(config-if)# authentication port-control auto
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# end
Cisco ACS Configuration for VLAN Assignment
The procedure for enabling MDA with Voice VLAN assignment is the same as that for activating MDA
except for one step: Configure a VLAN for dynamic VLAN Assignment after selecting
User > IETF RADIUS Attributes (Figure 36-12). This step ensures correct functioning of the ACS
configuration required for dynamic VLAN assignment.
Figure 36-12 User Setup
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-56 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Note The procedure is the same for voice devices except that the AAA server must be configured to send a
Cisco Attribute-Value (AV) pair attribute with a value of device-traffic-class=voice.
Enabling Fallback Authentication
On a port in multiauthentication mode, either or both of MAB and web-based authentication can be
configured as fallback authentication methods for non-802.1X hosts (those that do not respond to
EAPOL). You can configure the order and priority of the authentication methods.
For detailed configuration information for MAB, see the “Configuring 802.1X with MAC
Authentication Bypass” section on page 36-48.
For detailed configuration information for web-based authentication, see Chapter 37, “Configuring
Web-Based Authentication.”
Note When Webauth and other authentication methods are configured on an MDA or multiauthentication port,
downloadable ACL policies must be configured for all devices attached to that port.
To enable fallback authentication, perform this task:
Command Purpose
Step 1 Switch(config)# ip admission name rule-name proxy Configures an authentication rule for web-based
http authentication.
Step 2 Switch(config)# fallback profile profile-name Creates a fallback profile for web-based authentication.
Step 3 Switch(config-fallback-profile)# ip access-group Specifies the default ACL to apply to network traffic
rule-name in before web-based authentication.
Step 4 Switch(config-fallback-profile)# ip admission Associates an IP admission rule with the profile and
name rule-name specifies that a client connecting by web-based
authentication uses this rule.
Step 5 Switch(config-fallback-profile)# exit Returns to global configuration mode.
Step 6 Switch(config)# interface type slot/port Specifies the port to be configured and enters interface
configuration mode.
type = fastethernet, gigabitethernet, or
tengigabitethernet
Step 7 Switch(config-if)# authentication port-control Enables authentication on the port.
auto
Step 8 Switch(config-if)# authentication order method1 (Optional) Specifies the fallback order of authentication
[method2] [method3] methods to be used. The three values of method, in the
default order, are dot1x, mab, and webauth. The
specified order also determines the relative priority of the
methods for reauthentication (highest to lowest).
Step 9 Switch(config-if)# authentication priority (Optional) Overrides the relative priority of
method1 [method2] [method3] authentication methods to be used. The three values of
method, in the default order of priority, are dot1x, mab,
and webauth.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-57
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Command Purpose
Step 10 Switch(config-if)# authentication event fail Specifies that the next configured authentication method
action next-method be applied if authentication fails.
Step 11 Switch(config-if)# mab [eap] Enables MAC authentication bypass. The optional eap
keyword specifies that the EAP extension be used during
RADIUS authentication.
Step 12 Switch(config-if)# authentication fallback Enables web-based authentication using the specified
profile-name profile.
Step 13 Switch(config-if)# authentication violation (Optional) Configures the disposition of the port if a
[shutdown | restrict] security violation occurs. The default action is to shut
down the port. If the restrict keyword is configured, the
port does not shutdown, but trap entries are installed for
the violating MAC address, and traffic from that MAC
address is dropped.
Step 14 Switch(config-if)# authentication timer (Optional) Configures the inactivity timeout value for
inactivity {seconds | server} MAB and 802.1X. By default, inactivity aging is disabled
for a port.
• seconds—Specifies inactivity timeout period. The
range is from 1 to 65535 seconds.
• server—Specifies that the inactivity timeout period
value be obtained from the authentication server.
Step 15 Switch(config-if)# authentication timer restart (Optional) Specifies a period after which the
seconds authentication process restarts in an attempt to
authenticate an unauthorized port.
• seconds—Specifies the restart period. The range is
from 1 to 65535 seconds.
Step 16 Switch(config-if)# exit Returns to global configuration mode.
Step 17 Switch(config)# ip device tracking Enables the IP device tracking table, which is required for
web-based authentication.
Step 18 Switch(config)# exit Returns to privileged EXEC mode.
Step 19 Switch# show dot1x interface type slot/port Verifies your entries.
This example shows how to enable 802.1X fallback to MAB, and then to enable web-based
authentication, on an 802.1X-enabled port:
Switch(config)# ip admission name rule1 proxy http
Switch(config)# fallback profile fallback1
Switch(config-fallback-profile)# ip access-group default-policy in
Switch(config-fallback-profile)# ip admission rule1
Switch(config-fallback-profile)# exit
Switch(config)# interface gigabit5/9
Switch(config-if)# switchport mode access
Switch(config-if)# authentication port-control auto
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication order dot1x mab webauth
Switch(config-if)# mab eap
Switch(config-if)# authentication fallback fallback1
Switch(config-if)# exit
Switch(config)# ip device tracking
Switch(config)# exit
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-58 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
To determine if a host has been authenticated using 802.1X when fallback authentication is configured
on the port, enter the following commands:
Switch# show authentication sessions interface g7/2
Interface: GigabitEthernet7/2
MAC Address: 0060.b057.4687
IP Address: Unknown
User-Name: test2
Status: Authz Success
Domain: DATA
Oper host mode: multi-auth
Oper control dir: both
Authorized By: Authentication Server
Vlan Policy: N/A
Session timeout: N/A
Idle timeout: N/A
Common Session ID: C0A8013F0000000901BAB560
Acct Session ID: 0x0000000B
Handle: 0xE8000009
Runnable methods list:
Method State
dot1x Authc Success
mab Not run
Switch# show dot1x interfaces g7/2 detail
Dot1x Info for GigabitEthernet7/2
-----------------------------------
PAE = AUTHENTICATOR
PortControl = AUTO
ControlDirection = Both
HostMode = MULTI_AUTH
QuietPeriod = 60
ServerTimeout = 0
SuppTimeout = 30
ReAuthMax = 2
MaxReq = 2
TxPeriod = 2
Dot1x Authenticator Client List
-------------------------------
Supplicant = 0060.b057.4687
Session ID = C0A8013F0000000901BAB560
Auth SM State = AUTHENTICATED
Auth BEND SM State = IDLE
Port Status = AUTHORIZED
To determine if a host has been authenticated using MAB when fallback authentication is configured on
the port, enter the following commands:
Switch# show authentication sessions interface g7/2
Interface: GigabitEthernet7/2
MAC Address: 0060.b057.4687
IP Address: 192.168.22.22
User-Name: 0060b0574687
Status: Authz Success
Domain: DATA
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-59
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Oper host mode: multi-auth
Oper control dir: both
Authorized By: Authentication Server
Vlan Policy: N/A
Session timeout: N/A
Idle timeout: N/A
Common Session ID: C0A8013F0000000B01BBD278
Acct Session ID: 0x0000000D
Handle: 0xF500000B
Runnable methods list:
Method State
dot1x Failed over
mab Authc Success
Switch# show mab interface g7/2 detail
MAB details for GigabitEthernet7/2
-------------------------------------
Mac-Auth-Bypass = Enabled
MAB Client List
---------------
Client MAC = 0060.b057.4687
Session ID = C0A8013F0000000B01BBD278
MAB SM state = TERMINATE
Auth Status = AUTHORIZED
To determine if a host has been authenticated using web authentication when fallback authentication is
configured on the port, enter the following commands:
Switch# show authentication sessions interface G4/3
Interface: GigabitEthernet4/3
MAC Address: 0015.e981.0531
IP Address: 10.5.63.13
Status: Authz Success
Domain: DATA
Oper host mode: single-host
Oper control dir: both
Authorized By: Authentication Server
Vlan Policy: N/A
Session timeout: N/A
Idle timeout: N/A
Common Session ID: 0A053F0F0000000200112FFC
Acct Session ID: 0x00000003
Handle: 0x09000002
Runnable methods list:
Method State
dot1x Failed over
mab Failed over
webauth Authc Success
Switch# show ip admission cache
Authentication Proxy Cache
Total Sessions: 1 Init Sessions: 0
Client IP 10.5.63.13 Port 4643, timeout 1000, state ESTAB
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-60 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Enabling Periodic Reauthentication
You can enable periodic 802.1X client reauthentication and specify how often it occurs. If you do not
specify a time value before enabling reauthentication, the interval between reauthentication attempts is
3600 seconds.
Automatic 802.1X client reauthentication is a per-interface setting and can be set for clients connected
to individual ports. To manually reauthenticate the client connected to a specific port, see the “Changing
the Quiet Period” section on page 36-63.
To enable periodic reauthentication of the client and to configure the number of seconds between
reauthentication attempts, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode and specifies the interface to be
interface-id enabled for periodic reauthentication.
Step 3 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
Step 4 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 5 Switch(config-if)# authentication Enables periodic reauthentication of the client, which is disabled by
periodic default.
To disable periodic reauthentication, use the no authentication periodic
interface configuration command (for earlier releases, use the
no dot1x reauthentication interface configuration command).
Step 6 Switch(config-if)# authentication Specifies the number of seconds between reauthentication attempts or
timer reauthenticate {seconds | have the switch use a RADIUS-provided session timeout.
server}
The range is 1 to 65,535; the default is 3600 seconds.
To return to the default number of seconds between reauthentication
attempts, use the no authentication timer reauthenticate global
configuration command (for earlier releases, use the
dot1x timeout reauth-attempts command).
This command affects the behavior of the switch only if periodic
reauthentication is enabled.
Step 7 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 8 Switch(config-if)# end Returns to privileged EXEC mode.
This example shows how to enable periodic reauthentication and set the number of seconds between
reauthentication attempts to 4000:
Switch# configure terminal
Switch(config)# interface fastethernet5/9
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication periodic
Switch(config-if)# authentication timer reauthenticate 4000
Switch(config-if)# authentication port-control auto
Switch(config-if)# end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-61
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Switch#
Enabling Multiple Hosts
You can attach multiple hosts (clients) to a single 802.1X-enabled port as shown in Figure 36-7 on
page 36-22. In this mode, when the port is authorized, all other hosts that are indirectly attached to the
port are granted access to the network. If the port becomes unauthorized (reauthentication fails or an
EAPOL-logoff message is received), the switch denies access to the network for all wireless access
point-attached clients.
To allow multiple hosts (clients) on an 802.1X-authorized port that has the dot1x port-control interface
configuration command set to auto, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode and specifies the interface to which
interface-id multiple hosts are indirectly attached.
Step 3 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
Step 4 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 5 Switch(config-if)# authentication Allows multiple hosts (clients) on an 802.1X-authorized port.
host-mode multi-host
Note Ensure that the dot1x port-control interface configuration
command set is set to auto for the specified interface.
To disable multiple hosts on the port, use the
no authentication host-mode multi-host interface configuration
command (for earlier releases, use the no dot1x host-mode multi-host
interface configuration command).
Step 6 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 7 Switch(config-if)# end Returns to privileged EXEC mode.
Step 8 Switch# show dot1x all interface Verifies your entries.
interface-id
Step 9 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to enable 802.1X on Fast Ethernet interface 5/9 and to allow multiple hosts:
Switch# configure terminal
Switch(config)# interface fastethernet5/9
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# authentication host-mode multi-host
Switch(config-if)# authentication port-control auto
Switch(config-if)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-62 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Changing the Quiet Period
When the switch cannot authenticate the client, the switch remains idle for a set period of time, and then
tries again. The idle time is determined by the quiet-period value. A failed authentication of the client
might occur because the client provided an invalid password. You can provide a faster response time to
the user by entering a number smaller than the default.
To change the quiet period, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode and specifies the interface to be
interface-id enabled for timeout quiet-period.
Step 3 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
Step 4 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 5 Switch(config-if)# dot1x timeout Sets the number of seconds that the switch remains in the quiet-period
quiet-period seconds following a failed authentication exchange with the client.
To return to the default quiet-period, use the
no dot1x timeout quiet-period configuration command.
The range is 0 to 65,535 seconds; the default is 60.
Step 6 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 7 Switch(config-if)# end Returns to privileged EXEC mode.
Step 8 Switch# show dot1x all Verifies your entries.
Step 9 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to set the quiet period on the switch to 30 seconds:
Switch# configure terminal
Switch(config)# interface fastethernet4/1
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# dot1x timeout quiet-period 30
Switch(config-if)# authentication port-control auto
Switch(config-if)# end
Switch#
Changing the Switch-to-Client Retransmission Time
The client responds to the EAP-request/identity frame from the switch with an EAP-response/identity
frame. If the switch does not receive this response, it waits a set period of time (known as the
retransmission time) and then retransmits the frame.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-63
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Note You should change the default value of this command only to adjust for unusual circumstances, such as
unreliable links or specific behavioral problems with certain clients and authentication servers.
To change the amount of time that the switch waits for client notification, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode and specifies the interface to be
interface-id enabled for timeout tx-period.
Step 3 Switch(config-if)# switchport mode Specifies a nontrunking, nontagged single VLAN Layer 2 interface.
access
Step 4 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 5 Switch(config-if)# dot1x timeout Sets the number of seconds that the switch waits for a response to an
tx-period seconds EAP-request/identity frame from the client before retransmitting the
request.
The range is 1 to 65,535 seconds; the default is 30.
To return to the default retransmission time, use the
no dot1x timeout tx-period interface configuration command.
Step 6 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 7 Switch(config-if)# end Returns to privileged EXEC mode.
Step 8 Switch# show dot1x all Verifies your entries.
Step 9 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to set the retransmission time to 60 seconds:
Switch# configure terminal
Switch(config)# interface fastethernet5/9
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# dot1x timeout tx-period 60
Switch(config-if)# authentication port-control auto
Switch(config-if)# end
Switch#
Setting the Switch-to-Client Frame-Retransmission Number
In addition to changing the switch-to-client retransmission times, you can change the number of times
that the switch sends EAP-Request/Identity and other EAP-Request frames to the client before restarting
the authentication process. The number of EAP-Request/Identity retransmissions is controlled by the
dot1x max-reauth-req command; the number of retransmissions for other EAP-Request frames is
controlled by the dot1x max-req command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-64 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Note You should change the default values of these commands only to adjust for unusual circumstances such
as unreliable links or specific behavioral problems with certain clients and authentication servers.
To set the switch-to-client frame-retransmission numbers, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode and specifies the interface to be
interface-id enabled for max-reauth-req and/or max-req.
Step 3 Switch(config-if)# switchport mode Specifies a non-trunking, nontagged single VLAN Layer 2 interface.
access
Step 4 Switch(config-if)# dot1x pae Enables 802.1X authentication on the port with default parameters.
authenticator
Refer to the “Default 802.1X Configuration” section on page 36-23.
Step 5 Switch(config-if)# dot1x max-req Specifies the number of times EAPOL DATA packets are re-transmitted
count (if lost or not replied to). For example, if you have a supplicant in the
midst of authenticating and it experiences a problem, the authenticator
or
re-transmits requests for data three times before abandoning the
authentication request. The range for count is 1 to 10; the default is 2.
Switch(config-if)#
dot1x max-reauth-req count Specifies the timer for EAPOL-Identity-Request frames (only). If you
plug in a device incapable of 802.1X, three EAPOL-Id-Req frames are
sent before the state machine resets. Alternatively, if you have configured
Guest-VLAN, three frames are sent before the port is enabled. This
parameter has a default value of 2.
To return to the default retransmission number, use the no dot1x max-req
and no dot1x max-reauth-req global configuration command.
Step 6 Switch(config-if)# authentication Enables 802.1X authentication on the interface.
port-control auto
Step 7 Switch(config-if)# end Returns to privileged EXEC mode.
Step 8 Switch# show dot1x all Verifies your entries.
Step 9 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to set 5 as the number of times that the switch retransmits an
EAP-request/identity request before restarting the authentication process:
Switch# configure terminal
Switch(config)# interface fastethernet5/9
Switch(config-if)# switchport mode access
Switch(config-if)# dot1x pae authenticator
Switch(config-if)# dot1x max-reauth-req 5
Switch(config-if)# authentication port-control auto
Switch(config-if)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-65
Chapter 36 Configuring 802.1X Port-Based Authentication
Configuring 802.1X Port-Based Authentication
Manually Reauthenticating a Client Connected to a Port
You can manually reauthenticate a client connected to a specific port at any time by entering the
dot1x re-authenticate interface privileged EXEC command. If you want to enable or disable periodic
reauthentication, see the “Enabling Periodic Reauthentication” section on page 36-61.
This example shows how to manually reauthenticate the client connected to Fast Ethernet port 1/1:
Switch# dot1x re-authenticate interface fastethernet1/1
Starting reauthentication on FastEthernet1/1
Initializing the 802.1X Authentication State
The dot1x initialize command causes the authentication process to be restarted irrespective of the state
it is in currently.
This example shows how to restart the authentication process on Fast Ethernet port 1/1:
Switch# dot1x initialize interface fastethernet1/1
This example shows how to restart the authentication process on all ports of the switch:
Switch# dot1x initialize
Removing 802.1X Client Information
The clear dot1x command causes all existing supplicants to be completely deleted from an interface or
from all the interfaces on a switch.
This example shows how to remove 802.1X client information on Fast Ethernet port 1/1:
Switch# clear dot1x interface fastethernet1/1
This example shows how to remove 802.1X client information on all ports of the switch:
Switch# clear dot1x all
Resetting the 802.1X Configuration to the Default Values
To reset the 802.1X configuration to the default values, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# dot1x default Resets the configurable 802.1X parameters to the default values.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show dot1x all Verifies your entries.
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-66 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Displaying 802.1X Statistics and Status
Displaying 802.1X Statistics and Status
To display 802.1X statistics for all interfaces, use the show dot1x all statistics privileged EXEC
command.
To display the 802.1X administrative and operational status for the switch, use the
show dot1x all details privileged EXEC command. To display the 802.1X administrative and
operational status for a specific interface, use the show dot1x interface details privileged EXEC
command.
Displaying Authentication Details
Topics in this section include:
• Determining the Authentication Methods Registered with the Auth Manager, page 36-67
• Displaying the Auth Manager Summary for an Interface, page 36-67
• Displaying the Summary of All Auth Manager Sessions on the Switch, page 36-68
• Displaying a Summary of All Auth Manager Sessions on the Switch Authorized for a Specified
Authentication Method, page 36-68
• Verifying the Auth Manager Session for an Interface, page 36-68
• Displaying MAB Details, page 36-70
• EPM Logging, page 36-70
Determining the Authentication Methods Registered with the Auth Manager
Enter the following:
Switch# show authentication registrations
Handle Priority Name
3 0 dot1x
2 1 mab
1 2 webauth
Displaying the Auth Manager Summary for an Interface
In the following example, MAB has been configured for a higher priority (lower value) than 802.1X:
Switch# show authentication int gi1/5
Client list:
Interface MAC Address Method Domain Status Session ID
Gi1/5 000f.23c4.a401 mab DATA Authz Success 0A3462B10000000D24F80B58
Gi1/5 0014.bf5d.d26d dot1x DATA Authz Success 0A3462B10000000E29811B94
Available methods list:
Handle Priority Name
3 0 dot1x
2 1 mab
Runnable methods list:
Handle Priority Name
2 0 mab
3 1 dot1x
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-67
Chapter 36 Configuring 802.1X Port-Based Authentication
Displaying Authentication Details
Displaying the Summary of All Auth Manager Sessions on the Switch
Enter the following:
Switch# show authentication sessions
Interface MAC Address Method Domain Status Session ID
Gi1/48 0015.63b0.f676 dot1x DATA Authz Success 0A3462B1000000102983C05C
Gi1/5 000f.23c4.a401 mab DATA Authz Success 0A3462B10000000D24F80B58
Gi1/5 0014.bf5d.d26d dot1x DATA Authz Success 0A3462B10000000E29811B94
Displaying a Summary of All Auth Manager Sessions on the Switch Authorized
for a Specified Authentication Method
Enter the following:
Switch# show authentication method dot1x
Interface MAC Address Method Domain Status Session ID
Gi1/48 0015.63b0.f676 dot1x DATA Authz Success 0A3462B1000000102983C05C
Gi1/5 0014.bf5d.d26d dot1x DATA Authz Success 0A3462B10000000E29811B94
Verifying the Auth Manager Session for an Interface
The Auth manage session could be verified with the show authentication sessions command.
Switch# show authentication sessions int gi1/5
Interface: GigabitEthernet1/5
MAC Address: 000f.23c4.a401
IP Address: Unknown
User-Name: 000f23c4a401
Status: Authz Success
Domain: DATA
Oper host mode: multi-auth
Oper control dir: both
Authorized By: Authentication Server
Vlan Policy: N/A
Session timeout: N/A
Idle timeout: N/A
Common Session ID: 0A3462B10000000D24F80B58
Acct Session ID: 0x0000000F
Handle: 0x2400000D
Runnable methods list:
Method State
dot1x Failed over
mab Authc Success
----------------------------------------
Interface: GigabitEthernet1/5
MAC Address: 0014.bf5d.d26d
IP Address: 20.0.0.7
User-Name: johndoe
Status: Authz Success
Domain: DATA
Oper host mode: multi-auth
Oper control dir: both
Authorized By: Authentication Server
Vlan Policy: N/A
Session timeout: N/A
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-68 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
Displaying Authentication Details
Idle timeout: N/A
Common Session ID: 0A3462B10000000E29811B94
Acct Session ID: 0x00000010
Handle: 0x1100000E
Runnable methods list:
Method State
dot1x Authc Success
mab Not run
The individual output could be further refined with the handle, interface, MAC, session-id, or method
keywords:
Switch# show authentication sessions mac 000f.23c4.a401
Interface: GigabitEthernet1/5
MAC Address: 000f.23c4.a401
IP Address: Unknown
User-Name: 000f23c4a401
Status: Authz Success
Domain: DATA
Oper host mode: multi-auth
Oper control dir: both
Authorized By: Authentication Server
Vlan Policy: N/A
Session timeout: N/A
Idle timeout: N/A
Common Session ID: 0A3462B10000000D24F80B58
Acct Session ID: 0x0000000F
Handle: 0x2400000D
Runnable methods list:
Method State
dot1x Failed over
mab Authc Success
Switch# show authentication sessions session-id 0A3462B10000000D24F80B58
Interface: GigabitEthernet1/5
MAC Address: 000f.23c4.a401
IP Address: Unknown
User-Name: 000f23c4a401
Status: Authz Success
Domain: DATA
Oper host mode: multi-auth
Oper control dir: both
Authorized By: Authentication Server
Vlan Policy: N/A
Session timeout: N/A
Idle timeout: N/A
Common Session ID: 0A3462B10000000D24F80B58
Acct Session ID: 0x0000000F
Handle: 0x2400000D
Runnable methods list:
Method State
dot1x Failed over
mab uthc Success
Switch# show authentication session method dot1x int gi1/5
Interface: GigabitEthernet1/5
MAC Address: 0014.bf5d.d26d
IP Address: 20.0.0.7
User-Name: johndoe
Status: Authz Success
Domain: DATA
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-69
Chapter 36 Configuring 802.1X Port-Based Authentication
Displaying Authentication Details
Oper host mode: multi-auth
Oper control dir: both
Authorized By: Authentication Server
Vlan Policy: N/A
Session timeout: N/A
Idle timeout: N/A
Common Session ID: 0A3462B10000000E29811B94
Acct Session ID: 0x00000010
Handle: 0x1100000E
Runnable methods list:
Method State
dot1x Authc Success
mab Not run
Displaying MAB Details
Enter one of the following commands:
Switch# show mab all
MAB details for FastEthernet5/9
-------------------------------------
Mac-Auth-Bypass = Enabled
Inactivity Timeout = None
Switch# show mab all detail
MAB details for FastEthernet5/9
-------------------------------------
Mac-Auth-Bypass = Enabled
Inactivity Timeout = None
MAB Client List
---------------
Client MAC = 000f.23c4.a401
MAB SM state = TERMINATE
Auth Status = AUTHORIZED
Switch# show mab int fa5/9
MAB details for FastEthernet5/9
-------------------------------------
Mac-Auth-Bypass = Enabled
Inactivity Timeout = None
Switch# show mab int fa5/9 detail
MAB details for FastEthernet5/9
-------------------------------------
Mac-Auth-Bypass = Enabled
Inactivity Timeout = None
MAB Client List
---------------
Client MAC = 000f.23c4.a401
MAB SM state = TERMINATE
Auth Status = AUTHORIZED
EPM Logging
EPM logging enables you to display EPM logging messages with the epm logging command in global
configuration mode. To disable EPM logging, enter no epm logging.
Logging messages are displayed during the following events:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-70 OL-22250-01
Chapter 36 Configuring 802.1X Port-Based Authentication
-Cisco IOS Security Features in Cisco IOS XE 3.1.0 SG Release
POLICY_APP_SUCCESS - Policy application success events on Named ACLs, Proxy ACLs, and
service policies, URL redirect policies.
POLICY_APP_FAILURE - Policy application failure conditions like unconfigured policies, wrong
policies, download request failures and download failures from AAA.
IPEVENT - IP assignment, IP release and IP wait events for clients.
AAA - AAA events (like download requests, or download successes from AAA)
Example 1
Switch# conf t
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# epm logging
Switch# clear dot1x all
Switch#
*May 15 08:31:26.561: %EPM-6-POLICY_REQ: IP=100.0.0.222| MAC=0000.0000.0001|
AUDITSESID=0A050B2C000000030004956C| AUTHTYPE=DOT1X|
EVENT=REMOVE
*May 15 08:31:26.581: %AUTHMGR-5-START: Starting 'dot1x' for client (0000.0000.0001) on
Interface Fa9/25
*May 15 08:31:26.681: %DOT1X-5-SUCCESS: Authentication successful for client
(0000.0000.0001) on Interface Fa9/25
*May 15 08:31:26.681: %AUTHMGR-7-RESULT: Authentication result 'success' from 'dot1x' for
client (0000.0000.0001) on Interface Fa9/25
Example 2
Switch# conf t
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# epm logging
Switch(config)# int f9/25
Switch(config-if)# shut
Switch(config-if)# no shut
*May 15 08:41:56.329: %EPM-6-IPEVENT: IP=100.0.0.222| MAC=0000.0000.0001|
AUDITSESID=0A050B2C0000026108FB7924| AUTHTYPE=DOT1X|
EVENT=IP-RELEASE
*May 15 08:41:56.333: %EPM-6-IPEVENT: IP=100.0.0.222| MAC=0000.0000.0001|
AUDITSESID=0A050B2C0000026108FB7924| AUTHTYPE=DOT1X|
EVENT=IP-WAIT
-Cisco IOS Security Features in Cisco IOS XE 3.1.0 SG Release
This document provides a list of security software features that are supported in Cisco IOS XE 3.1.0 SG.
Links to the feature documentation are included.
Feature guides may contain information about more than one feature. To find information about a
specific feature within a feature guide, see the Feature Information table at the end of the guide.
Feature guides document features that are supported on many different software releases and platforms.
Your Cisco software release or platform may not support all the features documented in a feature guide.
See the Feature Information table at the end of the feature guide for information about which features in
that guide are supported in your software release. Use Cisco Feature Navigator to find information about
platform support and Cisco software image support. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Role-Based Access Control CLI Commands
http://www.cisco.com/en/US/docs/ios/sec_user_services/configuration/guide/sec_role_base_cli.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 36-71
Chapter 36 Configuring 802.1X Port-Based Authentication
-Cisco IOS Security Features in Cisco IOS XE 3.1.0 SG Release
Authentication Proxy Accounting for HTTP
http://www.cisco.com/en/US/docs/ios/sec_user_services/configuration/guide/sec_cfg_authen_prxy.htm
l
Enhanced Password Security
http://www.cisco.com/en/US/docs/ios/sec_user_services/configuration/guide/sec_cfg_sec_4cli.html
IEEE 802.1X - Flexible Authentication
http://www.cisco.com/en/US/docs/ios/sec_user_services/configuration/guide/sec_cfg_authen_prxy.htm
l
Image Verification
http://www.cisco.com/en/US/docs/ios/sec_user_services/configuration/guide/sec_image_verifctn.html
Manual Certificate Enrollment via TFTP
http://www.cisco.com/en/US/docs/ios/sec_secure_connectivity/configuration/guide/sec_cert_enroll_pk
i.html
Pre-fragmentation For Ipsec VPNs
http://www.cisco.com/en/US/docs/ios/sec_secure_connectivity/configuration/guide/sec_pre_frag_vpns
.html
Router Security Audit Manageability
http://www.cisco.com/en/US/docs/ios/12_3t/12_3t4/feature/guide/gtaudlog.html
Trusted Root Certification Authority
http://www.cisco.com/en/US/docs/ios/12_1t/12_1t1/feature/guide/dtrustrt.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
36-72 OL-22250-01
CH A P T E R 37
Configuring Web-Based Authentication
This chapter describes how to configure web-based authentication. It consists of these sections:
• About Web-Based Authentication, page 37-1
• Configuring Web-Based Authentication, page 37-5
• Displaying Web-Based Authentication Status, page 37-13
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Web-Based Authentication
The web-based authentication feature, known as Web Authentication Proxy, enables you to authenticate
end users on host systems that do not run the IEEE 802.1X supplicant.
When you initiate an HTTP session, web-based authentication intercepts ingress HTTP packets from the
host and sends an HTML login page to the user. The user keys in their credentials, which the web-based
authentication feature sends to the AAA server for authentication.
If authentication succeeds, web-based authentication sends a Login-Successful HTML page to the
host and applies the access policies returned by the AAA server.
If authentication fails, web-based authentication forwards a Login-Fail HTML page to the user,
prompting the user to retry the login. If the user exceeds the maximum number of attempts,
web-based authentication forwards a Login-Expired HTML page to the host and the user is placed
on a watch list for a waiting period.
These sections describe the role of web-based authentication as part of the authentication, authorization,
and accounting (AAA) system:
• Device Roles, page 37-2
• Host Detection, page 37-2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 37-1
Chapter 37 Configuring Web-Based Authentication
About Web-Based Authentication
• Session Creation, page 37-3
• Authentication Process, page 37-3
• Customization of the Authentication Proxy Web Pages, page 37-4
• Web-based Authentication Interactions with Other Features, page 37-4
Device Roles
With web-based authentication, the devices in the network have specific role (Figure 37-1).
Figure 37-1 Web-Based Authentication Device Roles
Authentication
Catalyst switch server
or
Cisco Router (RADIUS)
Workstations
(clients)
79549
The roles are as follows:
• Client—The device (workstation) that requests access to the LAN and switch services and responds
to requests from the switch. The workstation must be running an HTML browser with Java Script
enabled.
• Authentication server—Performs the actual authentication of the client. The authentication server
validates the identity of the client and notifies the switch that the client is authorized to access the
LAN and switch services or that the client is denied.
• Switch—Controls the physical access to the network based on the authentication status of the client.
The switch acts as an intermediary (proxy) between the client and the authentication server,
requesting identity information from the client, verifying that information with the authentication
server, and relaying a response to the client.
Host Detection
The switch maintains an IP device tracking table to store information about detected hosts.
Note By default, the IP device tracking feature is disabled on a switch. You must enable the IP device tracking
feature to use web-based authentication.
For Layer 3 interfaces, web-based authentication sets an HTTP intercept ACL when the feature is
configured on the interface (or when the interface is put in service).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
37-2 OL-22250-01
Chapter 37 Configuring Web-Based Authentication
About Web-Based Authentication
For Layer 2 interfaces, web-based authentication detects IP hosts using the following mechanisms:
• ARP based trigger—ARP redirect ACL allows web-based authentication to detect hosts with static
IP address or dynamically acquired IP address.
• Dynamic ARP Inspection
• DHCP snooping—Web-based authentication is notified when the switch creates a DHCP binding
entry for the host.
Session Creation
When web-based authentication detects a new host, it creates a session as follows:
• Checks for Auth bypass
If the host IP is not on the exception list, web-based authentication sends a nonresponsive host
(NRH) request to the server.
If the server response is Access Accepted, authorization is bypassed for this host. The session is
established.
• Sets up the HTTP Intercept ACL
If the server response to the NRH request is Access Rejected, the HTTP intercept ACL is activated
and the session waits for HTTP traffic from the host.
Authentication Process
When you enable web-based authentication, the following events occur:
• The user initiates an HTTP session.
• The HTTP traffic is intercepted, and authorization is initiated. The switch sends the login page to
the user. The user enters a username and password on the login page, and the switch sends the entries
to the authentication server.
• If the client identity is valid and the authentication succeeds, the switch downloads and activates the
user’s access policy from the authentication server. The login success page is sent to the user.
• If the authentication fails, the switch sends the login fail page. The user retries the login. If the
maximum number of attempts fails, the switch sends the login expired page and the host is placed
in a watch list. After the watch list times out, the user can retry the authentication process.
• If the authentication server does not respond to the switch, and if an AAA fail policy is configured,
the switch applies the failure access policy to the host. The login success page is sent to the user.
(See the “Customization of the Authentication Proxy Web Pages” section on page 37-4.)
• The switch reauthenticates a client when the host does not respond to an ARP probe on a Layer 2
interface, or the host does not send any traffic within the idle timeout on a Layer 3 interface.
• The feature applies the downloaded timeout or the locally configured session timeout.
• If the terminate action is RADIUS, the feature sends a nonresponsive host (NRH) request to the
server. The terminate action is included in the response from the server.
• If the terminate action is default, the session is dismantled and the applied policy is removed.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 37-3
Chapter 37 Configuring Web-Based Authentication
About Web-Based Authentication
Customization of the Authentication Proxy Web Pages
During the web-based authentication process, the internal HTTP server of the switch hosts four HTML
pages for delivery to an authenticating client. The four pages allow the server to notify you of the
following four states of the authentication process:
• Login—Your credentials are requested
• Success—The login was successful
• Fail—The login failed
• Expire—The login session has expired because of excessive login failures
You can substitute your custom HTML pages for the four default internal HTML pages, or you can
specify a URL to which you are redirected upon successful authentication, effectively replacing the
internal Success page.
Web-based Authentication Interactions with Other Features
These sections describe web-based authentication interactions with these features:
• Port Security, page 37-4
• LAN Port IP, page 37-4
• ACLs, page 37-5
• Context-Based Access Control, page 37-5
• 802.1X Authentication, page 37-5
• EtherChannel, page 37-5
• Switchover, page 37-5
Port Security
You can configure web-based authentication and port security on the same port. (You configure port
security on the port with the switchport port-security interface configuration command.) When you
enable port security and web-based authentication on a port, web-based authentication authenticates the
port, and port security manages network access for all MAC addresses, including that of the client. You
can then limit the number or group of clients that can access the network through the port.
For more information about enabling port security, see Chapter 38, “Configuring Port Security.”
LAN Port IP
You can configure LAN port IP (LPIP) and Layer 2 web-based authentication on the same port. The host
is authenticated using web-based authentication first, followed by LPIP posture validation. The LPIP
host policy overrides the web-based authentication host policy.
If the web-based authentication idle timer expires, the NAC policy is removed. The host is authenticated
and posture is validated again.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
37-4 OL-22250-01
Chapter 37 Configuring Web-Based Authentication
Configuring Web-Based Authentication
ACLs
If you configure a VLAN ACL or Cisco IOS ACL on an interface, the ACL is applied to the host traffic
only after the web-based authentication host policy is applied.
For Layer 2 web-based authentication, you must configure a port ACL (PACL) as the default access
policy for ingress traffic from hosts connected to the port. After authentication, the web-based
authentication host policy overrides the PACL.
You cannot configure a MAC ACL and web-based authentication on the same interface.
You cannot configure web-based authentication on a port whose access VLAN is configured for VACL
capture.
Context-Based Access Control
Web-based authentication cannot be configured on a Layer 2 port if context-based access control
(CBAC) is configured on the Layer 3 VLAN interface of the port’s VLAN.
802.1X Authentication
You cannot configure web-based authentication on the same port as 802.1X authentication except as a
fallback authentication method.
EtherChannel
You can configure web-based authentication on a Layer 2 EtherChannel interface. The web-based
authentication configuration applies to all member channels.
Switchover
On Catalyst 4500 series switches with redundant supervisor engines in RPR mode, information about
currently authenticated hosts is maintained during a switchover. You do not need to reauthenticate.
Configuring Web-Based Authentication
These sections describe how to configure web-based authentication:
• Default Web-Based Authentication Configuration, page 37-6
• Web-Based Authentication Configuration Guidelines and Restrictions, page 37-6
• Web-Based Authentication Configuration Task List, page 37-7
• Configuring the Authentication Rule and Interfaces, page 37-7
• Configuring AAA Authentication, page 37-8
• Configuring Switch-to-RADIUS-Server Communication, page 37-8
• Configuring the HTTP Server, page 37-10
• Configuring the Web-Based Authentication Parameters, page 37-13
• Removing Web-Based Authentication Cache Entries, page 37-13
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 37-5
Chapter 37 Configuring Web-Based Authentication
Configuring Web-Based Authentication
Default Web-Based Authentication Configuration
Table 37-1 shows the default web-based authentication configuration.
Table 37-1 Default Web-based Authentication Configuration
Feature Default Setting
AAA Disabled
RADIUS server
• IP address • None specified
• UDP authentication port • 1812
• Key • None specified
Default value of inactivity timeout 3600 seconds
Inactivity timeout Enabled
Web-Based Authentication Configuration Guidelines and Restrictions
These are the web-based authentication configuration guidelines:
• Web authentication requires two Cisco Attribute-Value (AV) pair attributes:
The first attribute, priv-lvl=15, must always be set to 15. This sets the privilege level of the user who
is logging into the switch.
The second attribute is an access list to be applied for web-authenticated hosts. The syntax is similar
to 802.1x per-user access control lists (ACLs). However, instead of ip:inacl, this attribute must
begin with proxyacl, and the source field in each entry must be any. (After authentication, the client
IP address replaces the any field when the ACL is applied.)
For example:
proxyacl# 10=permit ip any 10.0.0.0 0.255.255.255
proxyacl# 20=permit ip any 11.1.0.0 0.0.255.255
proxyacl# 30=permit udp any any eq syslog
proxyacl# 40=permit udp any any eq tftp
Note The proxyacl entry determines the type of allowed network access.
• Web-based authentication is an ingress-only feature.
• You can configure web-based authentication only on access ports. Web-based authentication is not
supported on trunk ports, EtherChannel member ports, or dynamic trunk ports.
• You must configure the default ACL on the interface before configuring web-based authentication.
• On Layer 2 interfaces, you cannot authenticate hosts with static ARP cache assignment. These hosts
are not detected by the web-based authentication feature, because they do not send ARP messages.
• By default, the IP device tracking feature is disabled on a switch. You must enable the IP device
tracking feature to use web-based authentication.
• You must configure at least one IP address to run the HTTP server on the switch. You must also
configure routes to reach each host IP address. The HTTP server sends the HTTP login page to the
host.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
37-6 OL-22250-01
Chapter 37 Configuring Web-Based Authentication
Configuring Web-Based Authentication
• Hosts that are more than one hop away may experience traffic disruption if an STP topology change
results in the host traffic arriving on a different port. This is because ARP and DHCP updates may
not be sent after a Layer 2 (STP) topology change.
• Web-based authentication does not support VLAN assignment as a downloadable host policy.
• Starting with Cisco IOS Release 12.2(50)SG , you can apply downloadable ACLs (DACLs) from
the RADIUS server.
• Web-based authentication is not supported for IPv6 traffic.
Web-Based Authentication Configuration Task List
To configure the web-based authentication feature, perform the following tasks:
• Configuring the Authentication Rule and Interfaces, page 37-7
• Configuring AAA Authentication, page 37-8
• Configuring Switch-to-RADIUS-Server Communication, page 37-8
• Configuring the HTTP Server, page 37-10
• Configuring the Web-Based Authentication Parameters, page 37-13
• Removing Web-Based Authentication Cache Entries, page 37-13
Configuring the Authentication Rule and Interfaces
To configure web-based authentication, perform this task:
Command Purpose
Step 1 Switch(config)# ip admission name name proxy http Configures an authentication rule for web-based
authorization.
Switch(config)# no ip admission name name Removes the authentication rule.
Step 2 Switch(config)# interface type slot/port Enters interface configuration mode and specifies the
ingress Layer 2 or Layer 3 interface to be enabled for
web-based authentication.
type can be fastethernet, gigabit ethernet, or
tengigabitethernet
Step 3 Switch(config-if)# ip access-group name Applies the default ACL.
Step 4 Switch(config-if)# ip admission name Configures web-based authentication on the specified
interface.
Step 5 Switch(config-if)# exit Returns to configuration mode.
Step 6 Switch(config)# ip device tracking Enables the IP device tracking table.
Step 7 Switch(config)# end Returns to privileged EXEC mode.
Step 8 Switch# show ip admission configuration Displays the configuration.
This example shows how to enable web-based authentication on Fast Ethernet port 5/1:
Switch(config)# ip admission name webauth1 proxy http
Switch(config)# interface fastethernet 5/1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 37-7
Chapter 37 Configuring Web-Based Authentication
Configuring Web-Based Authentication
Switch(config-if)# ip admission webauth1
Switch(config-if)# exit
Switch(config)# ip device tracking
This example shows how to verify the configuration:
Switch# show ip admission configuration
Authentication Proxy Banner not configured
Authentication global cache time is 60 minutes
Authentication global absolute time is 0 minutes
Authentication global init state time is 2 minutes
Authentication Proxy Watch-list is disabled
Authentication Proxy Rule Configuration
Auth-proxy name webauth1
http list not specified inactivity-time 60 minutes
Authentication Proxy Auditing is disabled
Max Login attempts per user is 5
Configuring AAA Authentication
To enable web-based authentication, perform this task:
Command Purpose
Step 1 Switch(config)# aaa new-model Enables AAA functionality.
Switch(config)# no aaa new-model Disables AAA functionality.
Step 2 Switch(config)# aaa authentication login default Defines the list of authentication methods at login.
group {tacacs+ | radius}
Step 3 Switch(config)# aaa authorization auth-proxy Creates an authorization method list for web-based
default group {tacacs+ | radius} authorization.
Switch(config)# no aaa authorization auth-proxy Clears the configured method list.
default group {tacacs+ | radius}
Step 4 Switch(config)# tacacs-server host {hostname | Specifies an AAA server. For RADIUS servers, see the
ip_address} section “Configuring Switch-to-RADIUS-Server
Communication” section on page 37-8.
Step 5 Switch(config)# tacacs-server key {key-data} Configures the authorization and encryption key used
between the switch and the TACACS server.
This example shows how to enable AAA:
Switch(config)# aaa new-model
Switch(config)# aaa authentication login default group tacacs+
Switch(config)# aaa authorization auth-proxy default group tacacs+
Configuring Switch-to-RADIUS-Server Communication
RADIUS security servers are identified by one of the following:
• Host name
• Host IP address
• Host name and specific UDP port numbers
Software Configuration Guide—Release IOS-XE 3.1.0 SG
37-8 OL-22250-01
Chapter 37 Configuring Web-Based Authentication
Configuring Web-Based Authentication
• IP address and specific UDP port numbers
The combination of the IP address and UDP port number creates a unique identifier, which enables
RADIUS requests to be sent to multiple UDP ports on a server at the same IP address. If two different
host entries on the same RADIUS server are configured for the same service (for example,
authentication) the second host entry that is configured functions as the failover backup to the first one.
The RADIUS host entries are chosen in the order that they were configured.
To configure the RADIUS server parameters, perform this task:
Command Purpose
Step 1 Switch(config)# ip radius source-interface Specifies that the RADIUS packets have the IP address of
interface_name the indicated interface.
Switch(config)# no ip radius source-interface Prevents the RADIUS packets from having the IP address
of the previously indicated interface.
Step 2 Switch(config)# radius-server host {hostname | Specifies the host name or IP address of the remote
ip-address} test username username RADIUS server.
The test username username option enables automated
testing of the RADIUS server connection. The specified
username does not need to be a valid user name.
The key option specifies an authentication and encryption
key to be used between the switch and the RADIUS
server.
To use multiple RADIUS servers, reenter this command.
Switch(config)# no radius-server host {hostname | Deletes the specified RADIUS server.
ip-address}
Step 3 Switch(config)# radius-server key string Configures the authorization and encryption key used
between the switch and the RADIUS daemon running on
the RADIUS server.
Step 4 Switch(config)# radius-server vsa send Enables downloading of an ACL from the RADIUS
authentication server.
This feature was introduced in Cisco IOS Release
12.2(50)SG.
Step 5 Switch(config)# radius-server dead-criteria tries Specifies the number of unanswered transmits to a
num-tries RADIUS server before considering the server to be
inactive. The range of num-tries is 1 to 100.
When you configure the RADIUS server parameters, do the following:
• Specify the key string on a separate command line.
• For key string, specify the authentication and encryption key used between the switch and the
RADIUS daemon running on the RADIUS server. The key is a text string that must match the
encryption key used on the RADIUS server.
• When you specify the key string, use spaces within and at the end of the key. If you use spaces in
the key, do not enclose the key in quotation marks unless the quotation marks are part of the key.
This key must match the encryption used on the RADIUS daemon.
• You can globally configure the timeout, retransmission, and encryption key values for all RADIUS
servers with the radius-server host global configuration command. If you want to configure these
options on a per-server basis, use the radius-server timeout, radius-server retransmit, and the
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 37-9
Chapter 37 Configuring Web-Based Authentication
Configuring Web-Based Authentication
radius-server key global configuration commands. For more information, see the
Cisco IOS Security Configuration Guide, Release 12.2, publication and the
Cisco IOS Security Command Reference, Release 12.2, publication at this URL:
http://www.cisco.com/en/US/docs/ios/12_2/security/command/reference/fsecur_r.html
Note You need to configure some settings on the RADIUS server, including: the IP address of the switch, the
key string to be shared by both the server and the switch, and the downloadable ACL (DACL). (Starting
with Cisco IOS Release 12.2(50)SG, Catalyst 4500 series switches support DACLs.) For more
information, see the RADIUS server documentation.
This example shows how to configure the RADIUS server parameters on a switch:
Switch(config)# ip radius source-interface Vlan80
Switch(config)# radius-server host 172.l20.39.46 test username user1
Switch(config)# radius-server key rad123
Switch(config)# radius-server dead-criteria tries 2
Configuring the HTTP Server
To use web-based authentication, you must enable the HTTP server within the switch. You can enable
the server for either HTTP or HTTPS.
To enable the server, perform one of these tasks:
Command Purpose
Switch(config)# ip http server Enables the HTTP server. The web-based authentication
feature uses the HTTP server to communicate with the
hosts for user authentication.
Switch(config)# ip http secure-server Enables HTTPS.
Starting with Cisco IOS Release 12.2(50)SG, you can optionally configure custom authentication proxy
web pages or specify a redirection URL for successful login, as described in the following sections:
• Customizing the Authentication Proxy Web Pages
• Specifying a Redirection URL for Successful Login
Software Configuration Guide—Release IOS-XE 3.1.0 SG
37-10 OL-22250-01
Chapter 37 Configuring Web-Based Authentication
Configuring Web-Based Authentication
Customizing the Authentication Proxy Web Pages
With Cisco IOS Release 12.2(50)SG, you can display four substitute HTML pages to the user rather than
the switch’s switch internal default HTML pages during web-based authentication.
To specify the use of your custom authentication proxy web pages, first store your custom HTML files
on the switch’s internal disk or flash memory, then perform this task in global configuration mode:
Command Purpose
Step 1 Switch(config)# ip admission proxy http login Specifies the location in the switch memory file system
page file device:login-filename of the custom HTML file to use in place of the default
login page. The device: is either disk or flash memory,
such as disk0:.
Step 2 Switch(config)# ip admission proxy http success Specifies the location of the custom HTML file to use in
page file device:success-filename place of the default login success page.
Step 3 Switch(config)# ip admission proxy http failure Specifies the location of the custom HTML file to use in
page file device:fail-filename place of the default login failure page.
Step 4 Switch(config)# ip admission proxy http login Specifies the location of the custom HTML file to use in
expired page file device:expired-filename place of the default login expired page.
When configuring customized authentication proxy web pages, observe the following guidelines:
• To enable the custom web pages feature, specify all four custom HTML files. If you specify fewer
than four files, the internal default HTML pages are used.
• The four custom HTML files must be present on the disk or flash of the switch. The maximum size
of each HTML file is 8 KB.
• Any images on the custom pages must be located on an accessible HTTP server. An intercept ACL
must be configured within the admission rule to allow access to the HTTP server.
• Any external link from a custom page requires configuration of an intercept ACL within the
admission rule.
• Any name resolution required for external links or images requires configuration of an intercept
ACL within the admission rule to access a valid DNS server.
• If the custom web pages feature is enabled, a configured auth-proxy-banner is not used.
• If the custom web pages feature is enabled, the redirection URL for successful login feature is not
available.
• To remove the specification of a custom file, use the no form of the command.
Because the custom login page is a public web form, consider the following guidelines for this page:
• The login form must accept user input for the username and password and must POST the data as
uname and pwd.
• The custom login page should follow best practices for a web form, such as page timeout, hidden
password, and prevention of redundant submissions.
The following example shows how to configure custom authentication proxy web pages:
Switch(config)# ip admission proxy http login page file disk1:login.htm
Switch(config)# ip admission proxy http success page file disk1:success.htm
Switch(config)# ip admission proxy http fail page file disk1:fail.htm
Switch(config)# ip admission proxy http login expired page file disk1:expired.htm
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 37-11
Chapter 37 Configuring Web-Based Authentication
Configuring Web-Based Authentication
The following example shows how to verify the configuration of custom authentication proxy web
pages:
Switch# show ip admission configuration
Authentication proxy webpage
Login page : disk1:login.htm
Success page : disk1:success.htm
Fail Page : disk1:fail.htm
Login expired Page : disk1:expired.htm
Authentication global cache time is 60 minutes
Authentication global absolute time is 0 minutes
Authentication global init state time is 2 minutes
Authentication Proxy Session ratelimit is 100
Authentication Proxy Watch-list is disabled
Authentication Proxy Auditing is disabled
Max Login attempts per user is 5
Specifying a Redirection URL for Successful Login
With Cisco IOS Release 12.2(50)SG, you have the option to specify a URL to which the user is
redirected upon successful authentication, effectively replacing the internal Success HTML page.
To specify a redirection URL for successful login, perform this task:
Command Purpose
Switch(config)# ip admission proxy http success Specifies a URL for redirection of the user in place of the
redirect url-string default login success page.
When configuring a redirection URL for successful login, consider the following guidelines:
• If the custom authentication proxy web pages feature is enabled, the redirection URL feature is
disabled and is not available in the CLI. You can perform redirection in the custom login success
page.
• If the redirection URL feature is enabled, a configured auth-proxy-banner is not used.
• To remove the specification of a redirection URL, use the no form of the command.
The following example shows how to configure a redirection URL for successful login:
Switch(config)# ip admission proxy http success redirect www.cisco.com
The following example shows how to verify the redirection URL for successful login:
Switch# show ip admission configuration
Authentication Proxy Banner not configured
Customizable Authentication Proxy webpage not configured
HTTP Authentication success redirect to URL: http://www.cisco.com
Authentication global cache time is 60 minutes
Authentication global absolute time is 0 minutes
Authentication global init state time is 2 minutes
Authentication Proxy Watch-list is disabled
Authentication Proxy Max HTTP process is 7
Authentication Proxy Auditing is disabled
Max Login attempts per user is 5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
37-12 OL-22250-01
Chapter 37 Configuring Web-Based Authentication
Displaying Web-Based Authentication Status
Configuring the Web-Based Authentication Parameters
You can configure the maximum number of failed login attempts allowed before the client is placed in
a watch list for a waiting period.
To configure the web-based authentication parameters, perform this task:
Command Purpose
Step 1 Switch(config)# ip admission max-login-attempts Sets the maximum number of failed login attempts. The
number range is 1 to 2147483647 attempts; the default is 5.
Step 2 Switch(config)# end Returns to privileged EXEC mode.
Step 3 Switch# show ip admission configuration Displays the authentication proxy configuration.
Step 4 Switch# show ip admission cache Displays the list of authentication entries.
This example shows how to set the maximum number of failed login attempts to 10:
Switch(config)# ip admission max-login-attempts 10
Removing Web-Based Authentication Cache Entries
To delete existing session entries, perform either of these tasks:
Command Purpose
Switch# clear ip auth-proxy cache {* | host ip Deletes authentication proxy entries. Use an asterisk to
address} delete all cache entries. Enter a specific IP address to
delete the entry for a single host.
Switch# clear ip admission cache {* | host ip Deletes authentication proxy entries. Use an asterisk to
address} delete all cache entries. Enter a specific IP address to
delete the entry for a single host.
This example shows how to remove the web-based authentication session for the client at IP address
209.165.201.1:
Switch# clear ip auth-proxy cache 209.165.201.1
Displaying Web-Based Authentication Status
To display the web-based authentication settings for all interfaces or for specific ports, perform this task:
Command Purpose
Step 1 Switch# show authentication sessions Displays the web-based authentication settings.
[interface type slot/port]
type = fastethernet, gigabitethernet, or tengigabitethernet
(Optional) Use the interface keyword to display the
web-based authentication settings for a specific interface.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 37-13
Chapter 37 Configuring Web-Based Authentication
Displaying Web-Based Authentication Status
This example shows how to view only the global web-based authentication status:
Switch# show authentication sessions
This example shows how to view the web-based authentication settings for interface Gi 3/27:
Switch# show authentication sessions interface gigabitethernet 3/27
Software Configuration Guide—Release IOS-XE 3.1.0 SG
37-14 OL-22250-01
CH A P T E R 38
Configuring Port Security
This chapter describes how to configure port security on the Catalyst 4500 series switch. It provides an
overview of port security on the Catalyst 4500 series switch and details the configuration on various
types of ports such as access, voice, trunk and private VLAN (PVLAN).
This chapter consists of these sections:
• Command List, page 38-1
• Port Security, page 38-3
• Configuring Port Security on Access Ports, page 38-7
• Configuring Port Security on PVLAN Ports, page 38-14
• Configuring Port Security on Trunk Ports, page 38-17
• Configuring Port Security on Voice Ports, page 38-22
• Displaying Port Security Settings, page 38-27
• Configuring Port Security with Other Features/Environments, page 38-31
• Guidelines and Restrictions, page 38-33
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Command List
This table lists the commands most commonly used with Port Security.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-1
Chapter 38 Configuring Port Security
Command List
Command Purpose Navigation
errdisable recovery cause Brings a secure port out of Violation Actions, page 38-6
psecure-violation error-disabled state
errdisable recovery interval Customizes the time to recover from Violation Actions, page 38-6
a specified error disable cause
port-security mac-address Configures all secure MAC addresses Secure MAC Addresses, page 38-3
on each VLAN
port-security maximum Configures a maximum number of Configuring Port Security on Access
MAC addresses on an interface Ports, page 38-7
private-vlan association add Creates an association between a Example of Port Security on an
secondary VLAN and a primary Isolated Private VLAN Host Port,
VLAN page 38-16
private-vlan isolated Designates the VLAN as a private Configuring Port Security on an
VLAN Isolated Private VLAN Host Port,
page 38-14
private-vlan primary Specifies the VLAN as the primary Configuring Port Security on an
private VLAN Isolated Private VLAN Host Port,
page 38-14
switchport mode private-vlan host Specifies that ports with valid private Configuring Port Security on an
VLAN trunk association become Isolated Private VLAN Host Port,
active host private VLAN trunk ports page 38-14
switchport private-vlan host-association Defines a host association on an Configuring Port Security on an
isolated host port Isolated Private VLAN Host Port,
page 38-14
switchport private-vlan mapping Defines a private VLAN for the Configuring Port Security on an
promiscuous ports Isolated Private VLAN Host Port,
page 38-14
switchport port-security Enables port security Configuring Port Security on Access
Ports, page 38-7
switchport port-security aging static Configures static aging of MAC Aging Secure MAC Addresses,
address. page 38-5
switchport port-security aging time Specifies an aging time for a port Example 3: Setting the Aging Timer,
page 38-11
switchport port-security limit rate Sets the rate limit for bad packets Example 7: Setting a Rate Limit for
invalid-source-mac Bad Packets, page 38-13
switchport port-security mac-address Configures a secure MAC address for Example 5: Configuring a Secure
an interface MAC Address, page 38-12
switchport port-security mac-address Specifies the sticky MAC address for Configuring Port Security on Access
mac_address sticky an interface Ports, page 38-7
switchport port-security mac-address Enables sticky Port Security Sticky Addresses on a Port,
sticky page 38-5
no switchport port-security mac-address Converts a sticky secure MAC Configuring Port Security on Access
sticky address to a dynamic MAC secure Ports, page 38-7
address
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-2 OL-22250-01
Chapter 38 Configuring Port Security
Port Security
Command Purpose Navigation
switchport port-security maximum Sets the maximum number of secure Example 1: Setting Maximum
MAC addresses for an interface Number of Secure Addresses,
page 38-11
switchport port-security violation Sets the violation mode Example 2: Setting a Violation
Mode, page 38-11
no switchport port-security violation Sets the violation mode Configuring Port Security on Access
Ports, page 38-7
Port Security
Port security enables you to restrict the number of MAC addresses (termed secure MAC addresses) on
a port, allowing you to prevent access by unauthorized MAC addresses. It also allows you to configure
a maximum number of secure MAC addresses on a given port (and optionally for a VLAN for trunk
ports). When a secure port exceeds the maximum, a security violation is triggered, and a violation action
is performed based on the violation action mode configured on the port.
If you configure the maximum number of secure MAC addresses as 1 on the port, the device attached to
the secure port is assured sole access to the port.
If a secure MAC address is secured on a port, that MAC address is not allowed to enter on any other port
off that VLAN. If it does, the packet is dropped unnoticed in the hardware. Other than through the
interface or port counters, you do not receive a log message reflecting this fact. Be aware that this
condition does not trigger a violation. Dropping these packets in the hardware is more efficient and can
be done without putting additional load on the CPU.
Port Security has the following characteristics:
• It allows you to age out secure MAC addresses. Two types of aging are supported: inactivity and
absolute.
• It supports a sticky feature whereby the secure MAC addresses on a port are retained through switch
reboots and link flaps.
• It can be configured on various types of ports such as access, voice, trunk, and private VLAN ports.
This overview contains the following topics:
• Secure MAC Addresses, page 38-3
• Maximum Number of Secure MAC Addresses, page 38-4
• Aging Secure MAC Addresses, page 38-5
• Sticky Addresses on a Port, page 38-5
• Violation Actions, page 38-6
Secure MAC Addresses
Port Security supports the following types of secure MAC addresses:
• Dynamic or Learned—Dynamic secure MAC addresses are learned when packets are received from
the host on the secure port. You might want to use this type if the user’s MAC address is not fixed
(laptop).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-3
Chapter 38 Configuring Port Security
Port Security
• Static or Configured—Static secure MAC addresses are configured by the user through CLI or
SNMP. You might want to use this type if your MAC address remains fixed (PC).
• Sticky—Sticky addresses are learned like dynamic secure MAC addresses, but persist through
switch reboots and link flaps like static secure MAC addresses. You might want to use this type if
a large number of fixed MAC addresses exist and you do not want to configure MAC addresses
manually (100 PCs secured on their own ports).
If a port has reached its maximum number of secure MAC addresses and you try to configure a static
secure MAC address, your configuration is rejected and an error message displays. If a port has reached
its maximum number of secure MAC addresses and a new dynamic secure MAC address is added, a
violation action is triggered.
You can clear dynamic secure MAC addresses with the clear port-security command. You can clear
sticky and static secure MAC addresses one at a time with the no form of the
switchport port-security mac-address command.
Maximum Number of Secure MAC Addresses
A secure port has a default of one MAC address. You can change the default to any value between 1 and
3,072. The upper limit of 3,072 guarantees one MAC address per port and an additional 3,072 across all
ports in the system.
After you have set the maximum number of secure MAC addresses on a port, you can include the secure
addresses in an address table in one of the following ways:
• You can configure the secure MAC addresses with the switchport port-security mac-address
mac_address interface configuration command.
• You can configure all secure MAC addresses on a range of VLANs with the port-security
mac-address VLAN range configuration command for trunk ports.
• You can allow the port to dynamically configure secure MAC addresses with the MAC addresses of
connected devices.
• You can configure some of the addresses and allow the rest to be dynamically configured.
Note If a port’s link goes down, all dynamically secured addresses on that port are no longer secure.
• You can configure MAC addresses to be sticky. These can be dynamically learned or manually
configured, stored in the address table, and added to the running configuration. After these addresses
are saved in the configuration file, the interface does not need to dynamically relearn them when the
switch restarts. Although you can manually configure sticky secure addresses, this action is not
recommended.
Note On a trunk port, a maximum number of secure MAC addresses can be configured on both the port and
port VLAN. The port’s maximum value can be greater than or equal to the port VLAN maximum(s) but
not less than the port VLAN maximum(s). If the port’s maximum value is less than at least one of the
port VLAN’s maximum (for example, if we have max set to 3 on VLAN 10 while no “sw port max” is
set (defaults to 1)), the port shuts down when dynamic adds reaches 2 on VLAN 10 (see “Guidelines and
Restrictions” on page 33). The port VLAN maximum enforces the maximum allowed on a given port on
a given VLAN. If the maximum is exceeded on a given VLAN but the port’s maximum is not exceeded,
the port still shuts down. The entire port is shut down even if one of the VLANs on the port has actually
caused the violation.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-4 OL-22250-01
Chapter 38 Configuring Port Security
Port Security
Aging Secure MAC Addresses
You might want to age secure MAC addresses when the switch may be receiving more than 3,000 MAC
addresses ingress.
Note Aging of sticky addresses is not supported.
By default, port security does not age out the secure MAC addresses. After learned, the MAC addresses
remain on the port until either the switch reboots or the link goes down (unless the sticky feature is
enabled). However, port security does allow you to configure aging based on the absolute or inactivity
mode and aging interval (in minutes, from 1 to n).
• Absolute mode: ages between n and n+1
• Inactivity mode: ages between n+1 and n+2
Use this feature to remove and add PCs on a secure port without manually deleting the existing secure
MAC addresses, while still limiting the number of secure addresses on a port.
Unless static aging is explicitly configured with the switchport port-security aging static command,
static addresses are not aged even if aging is configured on the port.
Note The aging increment is one minute.
Sticky Addresses on a Port
By enabling sticky port security, you can configure an interface to convert the dynamic MAC addresses
to sticky secure MAC addresses and to add them to the running configuration. You might want to do this
if you do not expect the user to move to another port, and you want to avoid statically configuring a MAC
address on every port.
Note If you use a different chassis, you might need another MAC address.
To enable sticky port security, enter the switchport port-security mac-address sticky command. When
you enter this command, the interface converts all the dynamic secure MAC addresses, including those
that were dynamically learned before sticky learning was enabled, to sticky secure MAC addresses.
The sticky secure MAC addresses do not automatically become part of the configuration file, which is
the startup configuration used each time the switch restarts. If you save the running config file to the
configuration file, the interface does not need to relearn these addresses when the switch restarts. If you
do not save the configuration, they are lost.
If sticky port security is disabled, the sticky secure MAC addresses are converted to dynamic secure
addresses and are removed from the running configuration.
After the maximum number of secure MAC addresses is configured, they are stored in an address table.
To ensure that an attached device has sole access of the port, configure the MAC address of the attached
device and set the maximum number of addresses to one, which is the default.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-5
Chapter 38 Configuring Port Security
Port Security
A security violation occurs if the maximum number of secure MAC addresses to a port has been added
to the address table and a workstation whose MAC address is not in the address table attempts to access
the interface.
Violation Actions
A security violation is triggered when the number of secure MAC addresses on the port exceeds the
maximum number of secure MAC addresses allowed on the port.
Note A secure violation is not triggered if the host secured on one port shows up on another port. The Catalyst
4500 series switch drops such packets on the new port silently in the hardware and does not overload the
CPU.
You can configure the interface for one of following violation modes, which are based on the response
to the violation:
• Restrict—A port security violation restricts data (that is, packets are dropped in software), causes
the SecurityViolation counter to increment, and causes an SNMP Notification to be generated. You
might want to configure this mode in order to provide uninterrupted service/access on a secure port.
The rate at which SNMP traps are generated can be controlled by the
snmp-server enable traps port-security trap-rate command. The default value (“0”) causes an
SNMP trap to be generated for every security violation.
• Shutdown—A port security violation causes the interface to shut down immediately. You might
want to configure this mode in a highly secure environment, where you do not want unsecured MAC
addresses to be denied in software and service interruption is not an issue.
• Shutdown VLAN—Use to set the security violation mode for each VLAN. In this mode, the
offending VLAN is error disabled instead of the entire port when a violation occurs.
When a secure port is in the error-disabled state, you can bring it out of this state automatically by
configuring the errdisable recovery cause psecure-violation global configuration command or you
can manually reenable it by entering the shutdown and no shut down interface configuration
commands. This is the default mode. If a port is in per-VLAN errdisable mode, you can also use
clear errdisable interface name vlan range command to re-enable the VLAN on the port.
You can also customize the time to recover from the specified error disable cause (default is 300
seconds) by entering the errdisable recovery interval interval command.
Invalid Packet Handling
You might want to rate limit invalid source MAC address packets on a secure port if you anticipate
that a device will send invalid packets (such as traffic generator, sniffer, and bad NICs).
The port security feature considers the following as “invalid frames”:
– Packets with a source or destination MAC address that is all zero
– Packets with a multicast or broadcast source MAC address
– Packets from an address either learned or configured on a secure interface that are observed on
another secure interface in the same VLAN
You can chose to rate limit these packets. If the rate is exceeded, you can trigger a violation action
for the port.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-6 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security on Access Ports
Configuring Port Security on Access Ports
These sections describe how to configure port security:
• Configuring Port Security on Access Ports, page 38-7
• Examples, page 38-10
Note Port security can be enabled on a Layer 2 port channel interface configured in access mode. The port
security configuration on an EtherChannel is kept independent of the configuration of any physical
member ports.
Configuring Port Security on Access Ports
To restrict traffic through a port by limiting and identifying MAC addresses of the stations allowed to
the port, perform this task:
Command Purpose
Step 1 Switch(config)# interface interface_id Enters interface configuration mode and specifies the
interface port-channel port_channel_number interface to configure.
Note The interface can be a Layer 2 port channel
logical interface.
Step 2 Switch(config-if)# switchport mode access Sets the interface mode.
Note An interface in the default mode (dynamic auto)
cannot be configured as a secure port.
Step 3 Switch(config-if)# [no] switchport port-security Enables port security on the interface.
To return the interface to the default condition as
nonsecure port, use the no switchport port-security
command.
Step 4 Switch(config-if)# [no] switchport port-security (Optional) Sets the maximum number of secure MAC
maximum value addresses for the interface. The range is 1 to 3072; the
default is 1.
To return the interface to the default number of secure
MAC addresses, use the no
switchport port-security maximum value.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-7
Chapter 38 Configuring Port Security
Configuring Port Security on Access Ports
Command Purpose (continued)
Step 5 Switch(config-if)# switchport port-security Sets the aging time and aging type for all secure addresses
[aging {static | time aging_time | type {absolute on a port.
| inactivity}]
Use this feature to remove and add PCs on a secure port
without manually deleting the existing secure MAC
addresses while still limiting the number of secure
addresses on a port.
The static keyword enables aging for statically
configured secure addresses on this port.
The time aging_time keyword specifies the aging time for
this port. Valid range for aging_time is from 0 to 1440
minutes. If the time is equal to 0, aging is disabled for this
port.
The type keyword sets the aging type as absolute or
inactive.
• absolute—All the secure addresses on this port ago
out exactly after the time (minutes) specified and are
removed from the secure address list.
• inactive—The secure addresses on this port age out
only if there is no data traffic from the secure source
address for the specified time period.
To disable port security aging for all secure addresses on
a port, use the
no switchport port-security aging time interface
configuration command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-8 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security on Access Ports
Command Purpose (continued)
Step 6 Switch(config-if)# [no] switchport port-security (Optional) Sets the violation mode, the action to be taken
violation {restrict | shutdown | shutdown vlan} when a security violation is detected, as one of these:
• restrict—A port security violation restricts data and
causes the SecurityViolation counter to increment
and send an SNMP trap notification.
• shutdown—The interface is error-disabled when a
security violation occurs.
• shutdown vlan—Use to set the security violation
mode for each VLAN. In this mode, the VLAN is
error-disabled instead of the entire port when a
violation occurs.
Note When a secure port is in the error-disabled state,
you can bring it out of this state by entering the
errdisable recovery cause psecure-violation
global configuration command or you can
manually reenable it by entering the shutdown
and no shut down interface configuration
commands.
To return the violation mode to the default condition
(shutdown mode), use the
no switchport port-security violation shutdown
command.
Step 7 Switch(config-if)# switchport port-security limit Sets the rate limit for bad packets.
rate invalid-source-mac packets_per_sec
Default is 10 pps.
Step 8 Switch(config-if)# [no] switchport port-security (Optional) Enters a secure MAC address for the interface.
mac-address mac_address Use this command to configure a secure MAC addresses.
If you configure fewer secure MAC addresses than the
maximum, the remaining MAC addresses are
dynamically learned.
To delete a MAC address from the address table, use the
no switchport port-security mac-address mac_address
command.
Note This command only applies to access, PVLAN
host, and PVLAN promiscuous mode. For more
details on PVLAN, trunk, or regular trunk mode,
refer to the “Configuring Port Security on Trunk
Ports” section on page 38-17.
Step 9 Switch(config-if)# [no] switchport port-security (Optional) Enables sticky learning on the interface.
mac-address sticky
To disable sticky learning on an interface, use the
no switchport port-security mac-address sticky
command. The interface converts the sticky secure MAC
addresses to dynamic secure addresses.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-9
Chapter 38 Configuring Port Security
Configuring Port Security on Access Ports
Command Purpose (continued)
Step 10 Switch(config-if)# [no] switchport port-security Specifies the sticky mac-address for the interface.
mac-address mac_address sticky [vlan [voice |
access]] When you specify the vlan keyword, the mac-address
becomes sticky in the specified VLAN.
To delete a sticky secure MAC addresses from the address
table, use the
no switchport port-security mac-address mac_address
sticky command. To convert sticky to dynamic addresses,
use the no switchport port-security mac-address sticky
command.
Note This command only applies to access, PVLAN
host, and PVLAN promiscuous mode. For more
details on PVLAN or trunk or regular trunk mode,
refer to the “Configuring Port Security on Trunk
Ports” section on page 38-17.
Step 11 Switch(config-if)# end Returns to privileged EXEC mode.
Step 12 Switch# show port-security address Verifies your entries.
interface interface_id
Switch# show port-security address
Note To clear dynamically learned port security MAC addresses in the CAM table, use the
clear port-security dynamic command. The address keyword enables you to clear a secure MAC
addresses. The interface keyword enables you to clear all secure addresses on any interface (including
any port channel interface). The VLAN keyword allows you to clear port security MACs on a per-VLAN
per-port basis.
Examples
The following examples are provided:
• Example 1: Setting Maximum Number of Secure Addresses, page 38-11
• Example 2: Setting a Violation Mode, page 38-11
• Example 3: Setting the Aging Timer, page 38-11
• Example 4: Setting the Aging Timer Type, page 38-12
• Example 5: Configuring a Secure MAC Address, page 38-12
• Example 6: Configuring Sticky Port Security, page 38-13
• Example 7: Setting a Rate Limit for Bad Packets, page 38-13
• Example 8: Clearing Dynamic Secure MAC Addresses, page 38-14
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-10 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security on Access Ports
Example 1: Setting Maximum Number of Secure Addresses
This example shows how to enable port security on the Fast Ethernet interface 3/12 and how to set the
maximum number of secure addresses to 5. The violation mode is the default, and no secure MAC
addresses are configured.
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 3/12
Switch(config-if)# switchport mode access
Switch(config-if)# switchport port-security
Switch(config-if)# switchport port-security maximum 5
Switch(config-if)# switchport port-security mac-address sticky
Switch(config-if)# end
Switch# show port-security interface fastethernet 3/12
Port Security : Enabled
Port Status : Secure-up
Violation Mode : Shutdown
Aging Time : 0 mins
Aging Type : Absolute
SecureStatic Address Aging : Enabled
Maximum MAC Addresses : 5
Total MAC Addresses : 0
Configured MAC Addresses : 0
Sticky MAC Addresses : 0
Last Source Address:Vlan : 0000.0000.0000:0
Security Violation Count : 0
Example 2: Setting a Violation Mode
This example shows how to set the violation mode on the Fast Ethernet interface 3/12 to restrict.
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 3/12
Switch(config-if)# switchport port-security violation restrict
Switch(config-if)# end
Switch#
SNMP traps can be enabled with a rate-limit to detect port-security violations due to restrict mode. The
following example shows how to enable traps for port-security with a rate of 5 traps per second:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# snmp-server enable traps port-security trap-rate 5
Switch(config)# end
Switch#
Example 3: Setting the Aging Timer
This example shows how to set the aging time to 2 hours (120 minutes) for the secure addresses on the
Fast Ethernet interface 5/1:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 5/1
Switch(config-if)# switchport port-security aging time 120
Switch(config-if)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-11
Chapter 38 Configuring Port Security
Configuring Port Security on Access Ports
This example shows how to set the aging time to 2 minutes:
Switch(config-if)# switchport port-security aging time 2
You can verify the previous commands with the show port-security interface command.
Example 4: Setting the Aging Timer Type
This example shows how to set the aging timer type to Inactivity for the secure addresses on the Fast
Ethernet interface 3/5:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 3/5
Switch(config-if)# switch port-security aging type inactivity
Switch(config-if)# end
Switch# show port-security interface fastethernet 3/5
Port Security : Enabled
Port Status : Secure-up
Violation Mode : Shutdown
Aging Time : 0 mins
Aging Type : Inactivity
SecureStatic Address Aging : Disabled
Maximum MAC Addresses : 1
Total MAC Addresses : 0
Configured MAC Addresses : 0
Sticky MAC Addresses : 0
Last Source Address:Vlan : 0000.0000.0000:0
Security Violation Count : 0
Example 5: Configuring a Secure MAC Address
This example shows how to configure a secure MAC address on Fast Ethernet interface 5/1 and to verify
the configuration:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 5/1
Switch(config-if)# switchport mode access
Switch(config-if)# switchport port-security
Switch(config-if)# switchport port-security maximum 10
Switch(config-if)# switchport port-security mac-address 0000.0000.0003 (Static secure MAC)
Switch(config-if)# end
Switch#show port address
Secure Mac Address Table
------------------------------------------------------------------------
Vlan Mac Address Type Ports Remaining Age
(mins)
---- ----------- ---- ----- -------------
1 0000.0000.0003 SecureConfigured Fa5/1 -
------------------------------------------------------------------------
Total Addresses in System (excluding one mac per port) : 2
Max Addresses limit in System (excluding one mac per port) : 3072
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-12 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security on Access Ports
Example 6: Configuring Sticky Port Security
This example shows how to configure a sticky MAC address on Fast Ethernet interface 5/1 and to verify
the configuration:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fa5/1
Switch(config-if)# switchport mode access
Switch(config-if)# switchport port-security
Switch(config-if)# switchport port-security mac-address sticky
Switch(config-if)# switchport port-security maximum 5
Switch(config-if)# end
Note Sending traffic to the ports causes the system to configure the port with sticky secure addresses.
Switch# show port-security address
Secure Mac Address Table
------------------------------------------------------------------------
Vlan Mac Address Type Ports Remaining Age
(mins)
---- ----------- ---- ----- -------------
1 0000.0000.0001 SecureSticky Fa5/1 -
1 0000.0000.0002 SecureSticky Fa5/1 -
1 0000.0000.0003 SecureSticky Fa5/1 -
------------------------------------------------------------------------
Total Addresses in System (excluding one mac per port) : 2
Max Addresses limit in System (excluding one mac per port) : 3072
Switch# show running-config interface fastEthernet 5/1
Building configuration...
Current configuration : 344 bytes
!
interface FastEthernet5/1
switchport mode access
switchport port-security
switchport port-security maximum 5
switchport port-security mac-address sticky
switchport port-security mac-address sticky 0000.0000.0001
switchport port-security mac-address sticky 0000.0000.0002
switchport port-security mac-address sticky 0000.0000.0003
end
Switch#
Example 7: Setting a Rate Limit for Bad Packets
The following example shows how to configure rate limit for invalid source packets on Fast Ethernet
interface 5/1:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 5/1
Switch(config-if)# switchport port-security limit rate invalid-source-mac 100
Switch(config-if)# end
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-13
Chapter 38 Configuring Port Security
Configuring Port Security on PVLAN Ports
The following example shows how to configure rate limit for invalid source packets on Fast Ethernet
interface 5/1:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fastethernet 5/1
Switch(config-if)# switchport port-security limit rate invalid-source-mac none
Switch(config-if)# end
Switch#
Example 8: Clearing Dynamic Secure MAC Addresses
The following example shows how to clear a dynamic secure MAC address:
Switch# clear port-security dynamic address 0000.0001.0001
The following example shows how to clear all dynamic secure MAC addresses on Fast Ethernet interface
2/1:
Switch# clear port-security dynamic interface fa2/1
The following example shows how to clear all dynamic secure MAC addresses in the system:
Switch# clear port-security dynamic
Configuring Port Security on PVLAN Ports
You can configure port security on a private VLAN port to take advantage of private VLAN
functionality as well as to limit the number of MAC addresses.
Note This section follows the same configuration model that was presented for access ports.
These sections describe how to configure trunk port security on host and promiscuous ports:
• Configuring Port Security on an Isolated Private VLAN Host Port, page 38-14
• Example of Port Security on an Isolated Private VLAN Host Port, page 38-16
• Configuring Port Security on a Private VLAN Promiscous Port, page 38-16
• Example of Port Security on a Private VLAN Promiscous Port, page 38-17
Configuring Port Security on an Isolated Private VLAN Host Port
Figure 38-1 illustrates a typical topology for port security implemented on private VLAN host ports. In
this topology, the PC connected through port a on the switch can communicate only with the router
connected through the promiscuous port on the switch. The PC connected through port a cannot
communicate with the PC connected through port b.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-14 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security on PVLAN Ports
Figure 38-1 Port Security on Isolated Private VLAN Host Ports
Router
Layer 2 switch Promiscuous port
a b
X
Port security
implemented on
140973
isolated VLAN
PC PC host ports a and b
Note Dynamic addresses secured on an isolated private VLAN host port on private VLANs are secured on the
secondary VLANs, and not primary VLANs.
To configure port security on an isolated private VLAN host port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enter global configuration mode.
Step 2 Switch(config)# vlan sec_vlan_id Specifies a secondary VLAN.
Step 3 Switch(config-vlan)# private-vlan isolated Sets the private VLAN mode to isolated.
Step 4 Switch(config-vlan)# exit Returns to global configuration mode.
Step 5 Switch(config)# vlan pri_vlan_id Specifies a primary VLAN.
Step 6 Switch(config-vlan)# private-vlan primary Specifies the VLAN as the primary private VLAN.
Step 7 Switch(config-vlan)# private-vlan association Creates an association between a secondary VLAN and a
add sec_vlan_id primary VLAN.
Step 8 Switch(config-vlan)# exit Returns to global configuration mode.
Step 9 Switch(config)# interface interface_id Enters interface configuration mode and specifies the
physical interface to configure.
Step 10 Switch(config-if)# switchport mode private-vlan Specifies that the ports with a valid private VLAN trunk
host association become active host private VLAN trunk ports.
Step 11 Switch(config-if)# switchport private-vlan Establishes a host association on an isolated host port.
host-association primary_vlan secondary_vlan
Step 12 Switch(config-if)# [no] switchport port-security Enables port security on the interface.
Step 13 Switch(config-if)# end Returns to privileged EXEC mode.
Step 14 Switch# show port-security address Verifies your entries.
interface interface_id
Switch# show port-security address
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-15
Chapter 38 Configuring Port Security
Configuring Port Security on PVLAN Ports
Example of Port Security on an Isolated Private VLAN Host Port
The following example shows how to configure port security on an isolated private VLAN host port,
Fast Ethernet interface 3/12:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# vlan 6
Switch(config-vlan)# private-vlan isolated
Switch(config-vlan)# exit
Switch(config)# vlan 3
Switch(config-vlan)# private-vlan primary
Switch(config-vlan)# private-vlan association add 6
Switch(config-vlan)# exit
Switch(config)# interface fastethernet 3/12
Switch(config-if)# switchport mode private-vlan host
Switch(config-if)# switchport private-vlan association host 3 6
Switch(config-if)# switchport port-security
Switch(config-if)# end
Configuring Port Security on a Private VLAN Promiscous Port
To configure port security on a private VLAN promiscuous port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# vlan sec_vlan_id Specifies the VLAN.
Step 3 Switch(config-vlan)# private-vlan isolated Sets the private VLAN mode to isolated.
Step 4 Switch(config-vlan)# exit Returns to global configuration mode.
Step 5 Switch(config)# vlan pri_vlan_id Specifies the VLAN.
Step 6 Switch(config-vlan)# private-vlan primary Designates the VLAN as the primary private VLAN.
Step 7 Switch(config-vlan)# private-vlan association Creates an association between a secondary VLAN and a
add sec_vlan_id primary VLAN.
Step 8 Switch(config-vlan)# exit Returns to global configuration mode.
Step 9 Switch(config)# interface interface_id Enters interface configuration mode and specifies the
physical interface to configure.
Step 10 Switch(config-if)# switchport mode private-vlan Specifies that the ports with a valid PVLAN mapping
promiscuous become active promiscuous ports.
Step 11 Switch(config-if)# switchport private-vlan Configures a private VLAN for the promiscuous ports
mapping primary_vlan secondary_vlan
Step 12 Switch(config-if)# switchport port-security Enables port security on the interface.
Step 13 Switch(config-if)# end Returns to privileged EXEC mode.
Step 14 Switch# show port-security address Verifies your entries.
interface interface_id
Switch# show port-security address
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-16 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security on Trunk Ports
Example of Port Security on a Private VLAN Promiscous Port
The following example shows how to configure port security on a private VLAN promiscuous port, Fast
Ethernet interface 3/12:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# vlan 6
Switch(config-vlan)# private-vlan isolated
Switch(config-vlan)# exit
Switch(config)# vlan 3
Switch(config-vlan)# private-vlan primary
Switch(config-vlan)# private-vlan association add 6
Switch(config-vlan)# exit
Switch(config)# interface fastethernet 3/12
Switch(config-if)# switchport mode private-vlan promiscuous
Switch(config-if)# switchport mode private-vlan mapping 3 6
Switch(config-if)# switchport port-security
Switch(config-if)# end
Configuring Port Security on Trunk Ports
You might want to configure port security on trunk ports in metro aggregation to limit the number of
MAC addresses per VLAN. Trunk port security extends port security to trunk ports. It restricts the
allowed MAC addresses or the maximum number of MAC addresses to individual VLANs on a trunk
port. Trunk port security enables service providers to block the access from a station with a different
MAC address than the ones specified for that VLAN on that trunk port. Trunk port security is also
supported on private VLAN trunk ports.
Note Port security can be enabled on a Layer 2 port channel interface configured in mode. The port security
configuration on an EtherChannel is kept independent of the configuration of any physical member
ports.
These sections describe how to configure trunk port security:
• Configuring Trunk Port Security, page 38-17
• Examples of Trunk Port Security, page 38-19
• Trunk Port Security Guidelines and Restrictions, page 38-21
Configuring Trunk Port Security
Trunk port security is used when a Catalyst 4500 series switch has a dot1q or isl trunk attached to a
neighborhood Layer 2 switch. This may be used, for example, in metro aggregation networks
(Figure 38-2).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-17
Chapter 38 Configuring Port Security
Configuring Port Security on Trunk Ports
Figure 38-2 Trunk Port Security
Logical representation of switch
SVI 2 SV1 3
5/1 5/2 5/3 5/4
gi1/1
ISL or
dot1q trunk
Metro
Layer 2 switch
130601
Access port in VLAN 2 Access port in VLAN 3
You can configure various port security related parameters on a per-port per-VLAN basis.
Note The steps involved in configuring port security parameters is similar to those for access ports. In addition
to those steps, the following per-port per-VLAN configuration steps are supported for trunk ports.
To configure port security related parameters on a per-VLAN per-port basis, perform this task:
Command Purpose
Step 1 Switch(config)# interface interface_id Enters interface configuration mode and specifies the
interface port-channel port_channel_number interface to configure.
Note The interface can be a Layer 2 port channel
logical interface.
Step 2 Switch(config-if)# switchport trunk encapsulation Sets the trunk encapsulation format to 802.1Q.
dot1q
Step 3 Switch(config-if)# switchport mode trunk Sets the interface mode.
Note An interface in the default mode (dynamic auto)
cannot be configured as a secure port.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-18 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security on Trunk Ports
Command Purpose (continued)
Step 4 Switch(config-if)# switchport port-security Configures a maximum number of secure mac-addresses
maximum value vlan for each VLAN on the interface that are not explicitly
configured with a maximum mac-address limit. (See the
“Maximum Number of Secure MAC Addresses” section
on page 38-4.)
Step 5 Switch(config-if)# vlan-range range Enters VLAN range sub-mode.
Note You can specify single or multiple VLANs.
Step 6 Switch(config-if-vlan-range)# Configures a maximum number of secure MAC addresses
port-security maximum value for each VLAN.
Step 7 Switch(config-if-vlan-range)# Removes a maximum number of secure MAC addresses
no port-security maximum configuration for all the VLANs. Subsequently, the
maximum value configured on the port is used for all the
VLANs.
Step 8 Switch(config-if-vlan-range)# [no] port-security Configures a secure MAC-address on a range of VLANs.
mac-address mac_address
Step 9 Switch(config-if-vlan-range)# [no] port-security Configures a sticky MAC-address on a range of VLANs.
mac-address sticky mac_address
Step 10 Switch(config-if-vlan-range)# end Returns to interface configuration mode.
Step 11 Switch(config-if)# end Returns to privileged EXEC mode.
Examples of Trunk Port Security
The following examples are provided:
• Example 1: Configuring a Maximum Limit of Secure MAC Addresses for all VLANs, page 38-19
• Example 2: Configuring a Maximum Limit of Secure MAC Addresses for Specific VLANs,
page 38-20
• Example 3: Configuring Secure MAC Addresses in a VLAN Range, page 38-20
Example 1: Configuring a Maximum Limit of Secure MAC Addresses for all VLANs
This example shows how to configure a secure MAC-address and a maximum limit of secure MAC
addresses on Gigabit Ethernet interface 1/1 for all VLANs:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface g1/1
Switch(config-if)# sw mode trunk
Switch(config-if)# switchport port-security
Switch(config-if)# switchport port-security maximum 3
Switch# show port-security in gi1/1 vlan
Default maximum: 3
VLAN Maximum Current
1 3 0
2 3 0
3 3 0
4 3 0
5 3 0
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-19
Chapter 38 Configuring Port Security
Configuring Port Security on Trunk Ports
6 3 0
Switch#
Switch# show running interface gi1/1
Building configuration...
Current configuration : 161 bytes
!
interface GigabitEthernet1/1
switchport trunk encapsulation dot1q
switchport mode trunk
switchport port-security
switchport port-security maximum 3 vlan
end
Example 2: Configuring a Maximum Limit of Secure MAC Addresses for Specific VLANs
This example shows how to configure a secure MAC-address on interface g1/1 in a specific VLAN or
range of VLANs:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface g1/1
Switch(config-if)# sw mode trunk
Switch(config-if)# switchport port-security
Switch(config-if)# vlan-range 2-6
Switch(config-if-vlan-range)# port-security maximum 3
Switch(config-if)# exit
Switch# show port-security interface g1/1 vlan
Default maximum: not set, using 3072
VLAN Maximum Current
2 3 0
3 3 0
4 3 0
5 3 0
6 3 0
Switch#
Example 3: Configuring Secure MAC Addresses in a VLAN Range
This example shows how to configure a secure MAC-address in a VLAN on interface g1/1:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface g1/1
Switch(config-if)# sw mode trunk
Switch(config-if)# switchport port-security
Switch(config-if)# switchport port-security mac-address sticky
Switch(config-if)# vlan-range 2-6
Switch(config-if-vlan-range)# port-security mac-address 1.1.1
Switch(config-if-vlan-range)# port-security mac-address sticky 1.1.2
Switch(config-if-vlan-range)# port-security mac-address sticky 1.1.3
Switch(config-if-vlan-range)# exit
Switch# show port-security interface g1/1 address vlan 2-4
Secure Mac Address Table
------------------------------------------------------------------------
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-20 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security on Trunk Ports
Vlan Mac Address Type Ports
Remaining Age
(mins)
---- ----------- ---- ----- -------------
2 0001.0001.0001 SecureConfigured Gi1/1 -
2 0001.0001.0002 SecureSticky Gi1/1 -
2 0001.0001.0003 SecureSticky Gi1/1 -
3 0001.0001.0001 SecureConfigured Gi1/1 -
3 0001.0001.0002 SecureSticky Gi1/1 -
3 0001.0001.0003 SecureSticky Gi1/1 -
4 0001.0001.0001 SecureConfigured Gi1/1 -
4 0001.0001.0002 SecureSticky Gi1/1 -
4 0001.0001.0003 SecureSticky Gi1/1 -
------------------------------------------------------------------------
Total Addresses: 9
Switch#
Trunk Port Security Guidelines and Restrictions
Follow these guidelines when configuring port security related parameters on a per-port per-VLAN
basis:
• A secure MAC-address cannot be configured on a VLAN that is not allowed on a regular trunk port.
• The configuration on the primary VLAN on the private VLAN trunk is not allowed. The CLI is
rejected and an error message is displayed.
• If a specific VLAN on a port is not configured with a maximum value (directly or indirectly), the
maximum configured for the port is used for that VLAN. In this situation, the maximum number of
addresses that can be secured on this VLAN is limited to the maximum value configured on the port.
Each VLAN can be configured with a maximum count that is greater than the value configured on
the port. Also, the sum of the maximum configured values for all the VLANs can exceed the
maximum configured for the port. In either of these situations, the number of MAC addresses
secured on each VLAN is limited to the lesser of the VLAN configuration maximum and the port
configuration maximum. Also, the number of addresses secured on the port across all VLANs
cannot exceed a maximum that is configured on the port.
• For private VLAN trunk ports, the VLAN on which the configuration is being performed must be
in either the allowed VLAN list of the private VLAN trunk or the secondary VLAN list in the
association pairs. (The CLI is rejected if this condition is not met.) The allowed VLAN list on a
private VLAN trunk is intended to hold the VLAN-IDs of all the regular VLANs that are allowed
on the private VLAN trunk.
• Removal of an association pair from a PVLAN trunk causes all static and sticky addresses
associated with the secondary VLAN of the pair to be removed from the running configuration.
Dynamic addresses associated with the secondary VLAN are deleted from the system.
Similarly, when a VLAN is removed from the list of allowed PVLAN trunks, the addresses
associated with that VLAN are removed.
Note For a regular or private VLAN trunk port, if the VLAN is removed from the allowed VLAN list, all the
addresses associated with that VLAN are removed.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-21
Chapter 38 Configuring Port Security
Configuring Port Security on Voice Ports
Port Mode Changes
Generally, when a port mode changes, all dynamic addresses associated with that port are removed. All
static or sticky addresses and other port security parameters configured on the native VLAN are moved
to the native VLAN of the port in the new mode. All the addresses on the non-native VLANs are
removed.
The native VLAN refers to the following VLAN on the specified port type:
Port Type Native VLAN
access access VLAN
trunk native VLAN
isolated secondary VLAN (from host association)
promiscuous primary VLAN (from mapping)
private VLAN trunk private VLAN trunk native VLAN
.1Q tunnel access VLAN
For example, when the mode changes from access to private VLAN trunk, all the static or sticky
addresses configured on the access VLAN of the access port are moved to the private VLAN native
VLAN of the private VLAN trunk port. All other addresses are removed.
Similarly, when the mode changes from private VLAN trunk to access mode, all the static or sticky
addresses configured on the private VLAN native VLAN are moved to the access VLAN of the access
port. All other addresses are removed.
When a port is changed from trunk to private VLAN trunk, addresses associated with a VLAN on the
trunk are retained if that VLAN is present in the allowed list of private VLAN trunk or the secondary
VLAN of an association on the private VLAN trunk. If the VLAN is not present in either of them, the
address is removed from the running configuration.
When a port is changed from private VLAN trunk to trunk, a static or sticky address is retained if the
VLAN associated with the address is present in the allowed VLAN list of the trunk. If the VLAN is not
present in the allowed list, the address is removed from running configuration.
Configuring Port Security on Voice Ports
You might want to configure port security in an IP Telephony environment when a port is configured
with a data VLAN for a PC and a voice VLAN for a Cisco IP Phone.
These sections describe how to configure port security on voice ports:
• Configuring Port Security on Voice Ports, page 38-23
• Examples of Voice Port Security, page 38-25
• Voice Port Security Guidelines and Restrictions, page 38-27
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-22 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security on Voice Ports
Configuring Port Security on Voice Ports
To configure port security on a voice port, perform this task:
Command Purpose
Step 1 Switch(config)# interface interface_id Enters interface configuration mode and specifies the
physical interface to configure.
Step 2 Switch(config-if)# switchport mode access Sets the interface mode.
Note An interface in the default mode (dynamic auto)
cannot be configured as a secure port.
Step 3 Switch(config-if)# [no] switchport port-security Enables port security on the interface.
To return the interface to the default condition as
nonsecure port, use the no switchport port-security
command.
Step 4 Switch(config-if)# [no] switchport port-security (Optional) Sets the violation mode, the action to be taken
violation {restrict | shutdown} when a security violation is detected, as one of these:
• restrict—A port security violation restricts data and
causes the SecurityViolation counter to increment
and send an SNMP trap notification.
• shutdown—The interface is error-disabled when a
security violation occurs.
Note When a secure port is in the error-disabled state,
you can bring it out of this state by entering the
errdisable recovery cause psecure-violation
global configuration command or you can
manually reenable it by entering the shutdown
and no shut down interface configuration
commands.
To return the violation mode to the default condition
(shutdown mode), use the
no switchport port-security violation shutdown
command.
Step 5 Switch(config-if)# switchport port-security limit Sets the rate limit for bad packets.
rate invalid-source-mac packets_per_sec
Default is 10 pps.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-23
Chapter 38 Configuring Port Security
Configuring Port Security on Voice Ports
Command Purpose (continued)
Step 6 Switch(config-if)# [no] switchport port-security (Optional) Specifies a secure MAC address for the
mac-address mac_address [vlan {voice | access}] interface.
When you specify the vlan keyword, addresses are
configured in the specified VLAN.
• voice—MAC address is configured in the voice
VLAN.
• access—MAC address is configured in the access
VLAN.
Use this command to configure secure MAC addresses. If
you configure fewer secure MAC addresses than the
maximum, the remaining MAC addresses are
dynamically learned.
To delete a MAC address from the address table, use the
no switchport port-security mac-address mac_address
command.
Note This command only applies to access, PVLAN
host, and PVLAN promiscuous mode. For more
details on PVLAN, trunk, or regular trunk mode,
refer to the “Configuring Port Security on Trunk
Ports” section on page 38-17.
Step 7 Switch(config-if)# [no] switchport port-security (Optional) Enables sticky learning on the interface.
mac-address sticky
To disable sticky learning on an interface, use the
no switchport port-security mac-address sticky
command. The interface converts the sticky secure MAC
addresses to dynamic secure addresses.
Step 8 Switch(config-if)# [no] switchport port-security Specifies the sticky mac-address for the interface.
mac-address mac_address sticky [vlan {voice |
access}] When you specify the vlan keyword, the mac-address
becomes sticky in the specified VLAN.
• voice—MAC address becomes sticky in the voice
VLAN.
• access—MAC address becomes sticky in the access
VLAN.
To delete a sticky secure MAC addresses from the address
table, use the
no switchport port-security mac-address mac_address
sticky command. To convert sticky to dynamic addresses,
use the no switchport port-security mac-address sticky
command.
Note This command only applies to access, PVLAN
host, and PVLAN promiscuous mode. For more
details on PVLAN or trunk or regular trunk mode,
refer to the “Configuring Port Security on Trunk
Ports” section on page 38-17.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-24 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security on Voice Ports
Command Purpose (continued)
Step 9 Switch(config-if)# end Returns to privileged EXEC mode.
Step 10 Switch# show port-security address Verifies your entries.
interface interface_id
Switch# show port-security address
Note To clear dynamically learned port security MAC addresses in the CAM table, use the
clear port-security dynamic command. The address keyword enables you to clear a secure MAC
addresses. The interface keyword enables you to clear all secure addresses on an interface (including
any port channel interface). The VLAN keyword allows you to clear port security MACs on a per-VLAN
per-port basis.
Note Each port-security configured interface accepts one mac-address by default. With port-security port
level port-security configuration takes precedence over VLAN level port-security configuration. So, to
allow one mac-address each for voice and data VLAN, configure the port for a maximum of greater than
or equal to two addresses.
Examples of Voice Port Security
The following examples are provided:
• Example 1: Configuring Maximum MAC Addresses for Voice and Data VLANs, page 38-25
• Example 2: Configuring Sticky MAC Addresses for Voice and Data VLANs, page 38-26
Example 1: Configuring Maximum MAC Addresses for Voice and Data VLANs
This example shows how to designate a maximum of one MAC address for a voice VLAN (for a Cisco
IP Phone, let’s say) and one MAC address for the data VLAN (for a PC, let’s say) on Fast Ethernet
interface 5/1 and to verify the configuration:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fa5/1
Switch(config-if)# switchport mode access
Switch(config-if)# switchport port-security
Switch(config-if)# switchport port-security maximum 2
Switch(config-if)# switchport port-security mac-address sticky
Switch(config-if)# switchport port-security maximum 1 vlan voice
Switch(config-if)# switchport port-security maximum 1 vlan access
Switch(config-if)# end
Note Sending traffic to the ports causes the system to configure the port with sticky secure addresses.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-25
Chapter 38 Configuring Port Security
Configuring Port Security on Voice Ports
Switch# show port-security address
Secure Mac Address Table
------------------------------------------------------------------------
Vlan Mac Address Type Ports Remaining Age
(mins)
---- ----------- ---- ----- -------------
1 0000.0000.0001 SecureSticky Fa5/1 -
3 0000.0000.0004 SecureSticky Fa5/1 -
------------------------------------------------------------------------
Total Addresses in System (excluding one mac per port) : 1
Max Addresses limit in System (excluding one mac per port) : 3072
Switch# show running-config interface fastEthernet 5/1
Building configuration...
Current configuration : 344 bytes
!
interface FastEthernet5/1
switchport mode access
switchport voice vlan 3
switchport port-security
switchport port-security maximum 1 vlan voice
switchport port-security maximum 3072
switchport port-security maximum 1 vlan access
switchport port-security mac-address sticky
switchport port-security mac-address sticky 0000.0000.0001
switchport port-security mac-address sticky 0000.0000.0004 vlan voice
end
Switch#
Example 2: Configuring Sticky MAC Addresses for Voice and Data VLANs
This example shows how to configure sticky MAC addresses for voice and data VLANs on Fast Ethernet
interface 5/1 and to verify the configuration:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fa5/1
Switch(config-if)# switchport mode access
Switch(config-if)# switchport port-security
Switch(config-if)# switchport port-security maximum 3072
Switch(config-if)# switchport port-security mac-address sticky 0000.0000.obob vlan voice
Switch(config-if)# switchport port-security mac-address sticky 0000.0000.0005 vlan access
Switch(config-if)# end
Note Sending traffic to the ports causes the system to configure the port with sticky secure addresses.
Switch# show port-security address
Secure Mac Address Table
------------------------------------------------------------------------
Vlan Mac Address Type Ports Remaining Age
(mins)
---- ----------- ---- ----- -------------
1 0000.0000.0001 SecureSticky Fa5/1 -
1 0000.0000.0002 SecureSticky Fa5/1 -
1 0000.0000.0003 SecureSticky Fa5/1 -
3 0000.0000.0004 SecureSticky Fa5/1 -
1 0000.0000.0005 SecureSticky Fa5/1 -
3 0000.0000.0b0b SecureSticky Fa5/1 -
------------------------------------------------------------------------
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-26 OL-22250-01
Chapter 38 Configuring Port Security
Displaying Port Security Settings
Total Addresses in System (excluding one mac per port) : 5
Max Addresses limit in System (excluding one mac per port) : 3072
Switch# show running-config interface fastEthernet 5/1
Building configuration...
Current configuration : 344 bytes
!
interface FastEthernet5/1
switchport mode access
switchport voice vlan 3
switchport port-security
switchport port-security maximum 3072
switchport port-security maximum 5 vlan voice
switchport port-security mac-address sticky
switchport port-security mac-address sticky 0000.0000.0001
switchport port-security mac-address sticky 0000.0000.0002
switchport port-security mac-address sticky 0000.0000.0003
switchport port-security mac-address sticky 0000.0000.0004 vlan voice
switchport port-security mac-address sticky 0000.0000.0005
switchport port-security mac-address sticky 0000.0000.0b0b vlan voice
end
Switch#
Voice Port Security Guidelines and Restrictions
Port security as implemented on voice ports behaves the same as port security on access ports:
• You can configure sticky port security on voice ports. If sticky port security is enabled on a voice
port, addresses secured on data and voice VLANs are secured as sticky addresses.
• You can configure maximum secure addresses per VLAN. You can set a maximum for either the
data VLAN or the voice VLAN. You can also set a maximum per-port, just as with access ports.
• You can configure port security MAC addresses on a per-VLAN basis on either the data or voice
VLANs.
• Prior to Cisco IOS Release 12.2(31)SG, you required three MAC addresses as the maximum
parameter to support an IP Phone and a PC. With Cisco IOS Release 12.2(31)SG and later releases,
the maximum parameter must be configured to two, one for the phone and one for the PC.
Displaying Port Security Settings
Use the show port-security command to display port-security settings for an interface or for the switch.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-27
Chapter 38 Configuring Port Security
Displaying Port Security Settings
To display traffic control information, perform one or more of these tasks:
Command Purpose
Switch# show interface status err-disable Displays interfaces that have been error-disabled along with
the cause for which they were disabled.
Switch# show port-security [interface interface_id | Displays port security settings for the switch or for the
interface port_channel port_channel_number] specified interface, including the maximum allowed number
of secure MAC addresses for each interface, the number of
secure MAC addresses on the interface, the number of
security violations that have occurred, and the violation
mode.
The interface can be a port channel logical interface.
Switch# show port-security [interface interface_id | Displays all secure MAC addresses configured on all switch
interface port_channel port_channel_number] address interfaces or on a specified interface with aging information
for each address.
Switch# show port-security [interface interface_id | Displays the maximum allowed number of secure MAC
interface port_channel port_channel_number] vlan addresses and the current number of secure MAC addresses
vlan_list
on a specific VLAN-list and a specific interface.
Switch# show port-security [interface interface_id | Displays all secure MAC addresses configured on a specific
interface port_channel port_channel_number] [address VLAN-list and a specific interface.
[vlan vlan_list]]
Examples
The following examples are provided:
• Example 1: Displaying Security Settings for the Entire Switch, page 38-28
• Example 2: Displaying Security Settings for an Interface, page 38-29
• Example 3: Displaying all Secure Addresses for the Entire Switch, page 38-29
• Example 4: Displaying a Maximum Number of MAC Addresses on an Interface, page 38-30
• Example 5: Displaying Security Settings on an Interface for a VLAN Range, page 38-30
• Example 6: Displaying Secured MAC Addresses and Aging Information on an Interface, page 38-30
• Example 7: Displaying Secured MAC Addresses for a VLAN Range on an Interface, page 38-30
Example 1: Displaying Security Settings for the Entire Switch
This example shows how to display port security settings for the entire switch:
Switch# show port-security
Secure Port MaxSecureAddr CurrentAddr SecurityViolation Security Action
(Count) (Count) (Count)
---------------------------------------------------------------------------
Fa3/1 2 2 0 Restrict
Fa3/2 2 2 0 Restrict
Fa3/3 2 2 0 Shutdown
Fa3/4 2 2 0 Shutdown
Fa3/5 2 2 0 Shutdown
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-28 OL-22250-01
Chapter 38 Configuring Port Security
Displaying Port Security Settings
Fa3/6 2 2 0 Shutdown
Fa3/7 2 2 0 Shutdown
Fa3/8 2 2 0 Shutdown
Fa3/10 1 0 0 Shutdown
Fa3/11 1 0 0 Shutdown
Fa3/12 1 0 0 Restrict
Fa3/13 1 0 0 Shutdown
Fa3/14 1 0 0 Shutdown
Fa3/15 1 0 0 Shutdown
Fa3/16 1 0 0 Shutdown
---------------------------------------------------------------------------
Total Addresses in System (excluding one mac per port) :8
Max Addresses limit in System (excluding one mac per port) :3072
Global SNMP trap control for port-security :20 (traps per second)
Example 2: Displaying Security Settings for an Interface
This example shows how to display port security settings for Fast Ethernet interface 5/1:
Switch# show port-security interface fastethernet 5/1
Port Security : Enabled
Port Status : Secure-up
Violation Mode : Shutdown
Aging Time : 0 mins
Aging Type : Absolute
SecureStatic Address Aging : Disabled
Maximum MAC Addresses : 1
Total MAC Addresses : 1
Configured MAC Addresses : 0
Sticky MAC Addresses : 1
Last Source Address:Vlan : 0000.0001.001a:1
Security Violation Count : 0
Example 3: Displaying all Secure Addresses for the Entire Switch
This example shows how to display all secure MAC addresses configured on all switch interfaces:
Switch# show port-security address
Secure Mac Address Table
-------------------------------------------------------------------
Vlan Mac Address Type Ports Remaining Age
(mins)
---- ----------- ---- ----- -------------
1 0000.0001.0000 SecureConfigured Fa3/1 15 (I)
1 0000.0001.0001 SecureConfigured Fa3/1 14 (I)
1 0000.0001.0100 SecureConfigured Fa3/2 -
1 0000.0001.0101 SecureConfigured Fa3/2 -
1 0000.0001.0200 SecureConfigured Fa3/3 -
1 0000.0001.0201 SecureConfigured Fa3/3 -
1 0000.0001.0300 SecureConfigured Fa3/4 -
1 0000.0001.0301 SecureConfigured Fa3/4 -
1 0000.0001.1000 SecureDynamic Fa3/5 -
1 0000.0001.1001 SecureDynamic Fa3/5 -
1 0000.0001.1100 SecureDynamic Fa3/6 -
1 0000.0001.1101 SecureDynamic Fa3/6 -
1 0000.0001.1200 SecureSticky Fa3/7 -
1 0000.0001.1201 SecureSticky Fa3/7 -
1 0000.0001.1300 SecureSticky Fa3/8 -
1 0000.0001.1301 SecureSticky Fa3/8 -
1 0000.0001.2000 SecureSticky Po2 -
-------------------------------------------------------------------
Total Addresses in System (excluding one mac per port) :8
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-29
Chapter 38 Configuring Port Security
Displaying Port Security Settings
Max Addresses limit in System (excluding one mac per port) :3072
Example 4: Displaying a Maximum Number of MAC Addresses on an Interface
This example shows how to display the maximum allowed number of secure MAC addresses and the
current number of secure MAC addressees on Gigabit Ethernet interface 1/1:
Switch# show port-security interface g1/1 vlan
Default maximum: 22
VLAN Maximum Current
2 22 3
3 22 3
4 22 3
5 22 1
6 22 2
Example 5: Displaying Security Settings on an Interface for a VLAN Range
This example shows how to display the port security settings on Gigabit Ethernet interface 1/1 for
VLANs 2 and 3:
Switch# show port-security interface g1/1 vlan 2-3
Default maximum: 22
VLAN Maximum Current
2 22 3
3 22 3
Example 6: Displaying Secured MAC Addresses and Aging Information on an Interface
This example shows how to display all secure MAC addresses configured on Gigabit Ethernet
interface 1/1 with aging information for each address.
Switch# show port-security interface g1/1 address
Secure Mac Address Table
------------------------------------------------------------------------
Vlan Mac Address Type Ports Remaining Age(mins)
---- ----------- ---- ----- -------------
2 0001.0001.0001 SecureConfigured Gi1/1 -
2 0001.0001.0002 SecureSticky Gi1/1 -
2 0001.0001.0003 SecureSticky Gi1/1 -
3 0001.0001.0001 SecureConfigured Gi1/1 -
3 0001.0001.0002 SecureSticky Gi1/1 -
3 0001.0001.0003 SecureSticky Gi1/1 -
4 0001.0001.0001 SecureConfigured Gi1/1 -
4 0001.0001.0002 SecureSticky Gi1/1 -
4 0001.0001.0003 SecureSticky Gi1/1 -
5 0001.0001.0001 SecureConfigured Gi1/1 -
6 0001.0001.0001 SecureConfigured Gi1/1 -
6 0001.0001.0002 SecureConfigured Gi1/1 -
------------------------------------------------------------------------
Total Addresses: 12
Example 7: Displaying Secured MAC Addresses for a VLAN Range on an Interface
This example shows how to display all secure MAC addresses configured on VLANs 2 and 3 on
Gigabit Ethernet interface 1/1 with aging information for each address:
Switch# show port-security interface g1/1 address vlan 2-3
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-30 OL-22250-01
Chapter 38 Configuring Port Security
Configuring Port Security with Other Features/Environments
Secure Mac Address Table
------------------------------------------------------------------------
Vlan Mac Address Type Ports Remaining Age(mins)
---- ----------- ---- ----- -------------
2 0001.0001.0001 SecureConfigured Gi1/1 -
2 0001.0001.0002 SecureSticky Gi1/1 -
2 0001.0001.0003 SecureSticky Gi1/1 -
3 0001.0001.0001 SecureConfigured Gi1/1 -
3 0001.0001.0002 SecureSticky Gi1/1 -
3 0001.0001.0003 SecureSticky Gi1/1 -
------------------------------------------------------------------------
Total Addresses: 12
Switch#
Configuring Port Security with Other Features/Environments
The following topics are discussed:
• DHCP and IP Source Guard, page 38-31
• 802.1X Authentication, page 38-32
• Configuring Port Security in a Wireless Environment, page 38-32
DHCP and IP Source Guard
You might want to configure port security with DHCP and IP Source Guard to prevent IP spoofing by
unsecured MAC addresses. IP Source Guard supports two levels of IP traffic filtering:
• Source IP address filtering
• Source IP and MAC address filtering
When used in source IP and MAC address filtering, IP Source Guard uses private ACLs to filter traffic
based on the source IP address, and uses port security to filter traffic based on the source MAC address.
So, port security must be enabled on the access port in this mode.
When both features are enabled, the following limitations apply:
• The DHCP packet is not subject to port security dynamic learning.
• If multiple IP clients are connected to a single access port, port security cannot enforce exact binding
of source IP and MAC address for each client.
Let’s say that clients reside on an access port with the following IP/MAC address:
– client1: MAC1 <---> IP1
– client2: MAC2 <---> IP2
Then, any combination of the source MAC and IP address traffic is allowed:
– MAC1 <---> IP1, valid
– MAC2 <---> IP2, valid
– MAC1 <---> IP2, invalid
– MAC2 <---> IP1, invalid
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-31
Chapter 38 Configuring Port Security
Configuring Port Security with Other Features/Environments
IP traffic with the correct source IP and MAC address binding is permitted and port security
dynamically learns its MAC address. IP traffic with source addresses that are not in the binding are
treated as invalid packets and dropped by port security. To prevent a denial of service attack, you
must configure port security rate limiting for the invalid source MAC address.
802.1X Authentication
You might want to configure port security with 802.1X authentication to prevent MAC spoofing. 802.1X
is not supported on regular or private VLAN trunks. On access ports and PVLAN host or promiscuous
ports, both port security and 802.1X can be configured simultaneously. When both are configured, hosts
must be 802.1X authenticated before port security can secure the MAC address of the host. Both 802.1X
and port security must approve of the host or a security violation is triggered. The type of security
violation depends on which feature rejects the port: if the host is allowed by 802.1X (for example,
because the port is in multi-host mode) but is disallowed by port security, the port-security violation
action is triggered. If the host is allowed by port security but rejected by 802.1X (for example, because
the host is non-authorized on a single-host mode port) then the 802.1X security violation action is
triggered.
Note 802.1X, port-security and VVID can all be configured on the same port.
For more information on the interaction between 802.1X and Port Security, see
“Using 802.1X with Port Security” on page 16.
Configuring Port Security in a Wireless Environment
If access points are connected to a secure port, do not configure a static MAC address for your users. A
MAC address might move from one access point to another and might cause security violations if both
the access points are connected on the same switch.
Figure 38-3 illustrates a typical topology of port security in a wireless environment.
Figure 38-3 Port Security in a Wireless Environment
Switch
AP1 AP2
140990
Wireless laptop Wireless laptop
associated with AP1 "roamed" out AP2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-32 OL-22250-01
Chapter 38 Configuring Port Security
Guidelines and Restrictions
Guidelines and Restrictions
Follow these guidelines when configuring port security:
• After port security is configured on a port along with a "denying" PACL, the CPU will neither see
any of the PACL packets denied from the given port nor learn the source MAC addresses from the
denied packets. Therefore, the port security feature will not be aware of such packets.
• A secure port cannot be a destination port for the Switch Port Analyzer (SPAN).
• A secure port and a static MAC address configuration for an interface are mutually exclusive.
• When you enter a maximum secure address value for an interface, and the new value is greater than
the previous value, the new value overwrites the previously configured value. If the new value is
less than the previous value and the number of configured secure addresses on the interface exceeds
the new value, the command is rejected.
• While configuring trunk port security on a trunk port, you do not need to account for the protocol
packets (like CDP and BPDU) because they are not learned and secured.
• You cannot enable port security aging on sticky secure MAC addresses.
• To restrict MAC spoofing using port security, you must enable 802.1X authentication.
• You cannot configure port security on dynamic ports. You must change the mode to access before
you enable port security.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 38-33
Chapter 38 Configuring Port Security
Guidelines and Restrictions
Software Configuration Guide—Release IOS-XE 3.1.0 SG
38-34 OL-22250-01
CH A P T E R 39
Configuring Control Plane Policing
This chapter contains information on how to protect your Catalyst 4000 family switch using control
plane policing (CoPP). The information covered in this chapter is unique to the Catalyst 4500 series
switches, and it supplements the network security information and procedures in Chapter 42,
“Configuring Network Security with ACLs.” This information also supplements the network security
information and procedures in these publications:
• Cisco IOS Security Configuration Guide, Cisco IOS Release 12.4, at this URL:
http://www.cisco.com/en/US/docs/ios/security/configuration/guide/12_4/sec_12_4_book.html
• Cisco IOS Security Command Reference, Cisco IOS Release 12.4, at this URL:
http://www.cisco.com/en/US/docs/ios/security/command/reference/sec_book.html
This chapter includes the following major sections:
• About Control Plane Policing, page 39-2
• CoPP Default Configuration, page 39-3
• Configuring CoPP, page 39-3
• CoPP Configuration Guidelines and Restrictions, page 39-7
• Monitoring CoPP, page 39-7
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 39-1
Chapter 39 Configuring Control Plane Policing
About Control Plane Policing
About Control Plane Policing
The control plane policing (CoPP) feature increases security on the Catalyst 4000 family switch by
protecting the CPU from unnecessary or DoS traffic and giving priority to important control plane and
management traffic. The Classification TCAM and QoS policers provide hardware support for CoPP.
CoPP works with all supervisor engines supported by Cisco IOS Release 12.2(31)SG.
The traffic managed by the CPU is divided into three functional components or planes:
• Data plane
• Management plane
• Control plane
You can use CoPP to protect most of the CPU bound traffic and ensure routing stability, reachability and
packet delivery. Most importantly, CoPP is often used to protect the CPU from the DoS attack. There is
a list of pre-defined ACLs matching a selected set of Layer 2 and Layer 3 control plane packets. You can
define your preferred policing parameters to each of these control packets but you cannot modify the
matching criteria of these pre-defined ACLs. Following is the list of pre-defined ACLs:
Pre-defined Named ACL Description
system-cpp-dot1x MAC DA = 0180.C200.0003
system-cpp-lldp MAC DA=0180.c200.000E
system-cpp-mcast-cfm MAC DA=0100.0ccc.ccc0 - 0100.0ccc.ccc7
system-cpp-ucast-cfm MAC DA=0100.0ccc.ccc0
system-cpp-bpdu-range MAC DA = 0180.C200.0000 - 0180.C200.000F
system-cpp-cdp MAC DA = 0100.0CCC.CCCC (UDLD/DTP/VTP/Pagp)
system-cpp-sstp MAC DA = 0100.0CCC.CCCD
system-cpp-cgmp MAC DA = 01-00-0C-DD-DD-DD
system-cpp-hsrpv2 IP Protocol = UDP, IPDA = 224.0.0.102
system-cpp-ospf IP Protocol = OSPF, IPDA matches 224.0.0.0/24
system-cpp-igmp IP Protocol = IGMP, IPDA matches 224.0.0.0/3
system-cpp-pim IP Protocol = PIM, IPDA matches 224.0.0.0/24
system-cpp-all-systems-on-subnet IPDA = 224.0.0.1
system-cpp-all-routers-on-subnet IPDA = 224.0.0.2
system-cpp-ripv2 IPDA = 224.0.0.9
system-cpp-ip-mcast-linklocal IP DA = 224.0.0.0/24
system-cpp-dhcp-cs IP Protocol = UDP, L4SrcPort = 68, L4DstPort = 67
system-cpp-dhcp-sc IP Protocol = UDP, L4SrcPort = 67, L4DstPort = 68
system-cpp-dhcp-ss IP Protocol = UDP, L4SrcPort = 67, L4DstPort = 67
For the Data Plane and Management Plane traffic, you can define your own ACLs to match the traffic
class that you want to police.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
39-2 OL-22250-01
Chapter 39 Configuring Control Plane Policing
CoPP Default Configuration
CoPP uses MQC to define traffic classification criteria and to specify the configurable policy actions for
the classified traffic. MQC uses class maps to define packets for a particular traffic class. After you have
classified the traffic, you can create policy maps to enforce policy actions for the identified traffic. The
control-plane global configuration command allows the CoPP service policy to be directly attached to
the control plane.
The only policy-map that you can attach to the control-plane is system-cpp-policy. It must contain the
pre-defined class-maps in the pre-defined order at the beginning of the policy map. The best way to
create the system-cpp-policy policy-map is through the global macro system-cpp.
The system-cpp-policy contains the pre-defined class maps for the control plane traffic. The names of
all system defined CoPP class maps and their matching ACLs contain the prefix “system-cpp-”. By
default, no action is specified for each traffic class. You can define your own class maps matching CPU
bound data plane and management plane traffic. You can add your defined class maps to the
system-cpp-policy policy-map.
CoPP Default Configuration
CoPP is disabled by default.
Configuring CoPP
This section includes the following tasks:
• Configure CoPP for Control Plane Traffic, page 39-3
• Configure CoPP for Data Plane and Management Plane Traffic, page 39-5
Configure CoPP for Control Plane Traffic
To configure CoPP for Control Plane traffic, perform this task:
Command Purpose
Step 1 Switch# config terminal Enters global configuration mode.
Step 2 Switch(config)# (Optional) Creates the system-cpp-policy
macro global apply system-cpp policy-map and attaches it to the control-plane.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 39-3
Chapter 39 Configuring Control Plane Policing
Configuring CoPP
Command Purpose
Step 3 Switch(config)# policy-map Associates actions to one or multiple system
system-cpp-policy defined control plane traffic in the service policy
Switch(config-pmap)# class
{system-cpp-dot1x | system-cpp-bpdu-range |
map. Repeat this step if necessary.
system-cpp-cdp | service | system-cpp-sstp
| system-cpp-cgmp | system-cpp-ospf |
system-cpp-igmp | system-cpp-pim |
system-cpp-all-systems-on-subnet |
system-cpp-all-routers-on-subnet |
system-cpp-ripv2 | system-cpp-hsrpv2 |
system-cpp-ip-mcast-linklocal |
system-cpp-dhcp-cs | system-cpp-dhcp-sc |
system-cpp-dhcp-ss}
Switch(config-pmap-c)# police [aggregate
name] rate burst [conform-action {drop |
transmit}] [{exceed-action {drop |
transmit}}]}
Step 4 Switch# show policy-map system-cpp-policy (Optional) Verifies the configuration
The following example shows how to police CDP packets:
Switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# qos
Switch(config)# macro global apply system-cpp
Switch(config)# policy-map system-cpp-policy
Switch(config-pmap)# class system-cpp-cdp
Switch(config-pmap-c)# police 32000 1000 conform-action transmit exceed-action drop
Switch(config-pmap-c)# end
Switch# show policy-map system-cpp-policy
Policy Map system-cpp-policy
Class system-cpp-dot1x
Class system-cpp-bpdu-range
* Class system-cpp-cdp
police 32000 bps 1000 byte conform-action transmit exceed-action drop *
Class system-cpp-sstp
Class system-cpp-cgmp
Class system-cpp-ospf
Class system-cpp-hsrpv2
Class system-cpp-igmp
Class system-cpp-pim
Class system-cpp-all-systems-on-subnet
Class system-cpp-all-routers-on-subnet
Class system-cpp-ripv2
Class system-cpp-ip-mcast-linklocal
Class system-cpp-dhcp-cs
Class system-cpp-dhcp-sc
Class system-cpp-dhcp-ss
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
39-4 OL-22250-01
Chapter 39 Configuring Control Plane Policing
Configuring CoPP
Configure CoPP for Data Plane and Management Plane Traffic
To configure CoPP for Data Plane and Management Plane traffic, perform this task:
Command Purpose
Step 1 Switch# config terminal Enters global configuration mode.
Step 2 Switch(config)# (Optional) Attaches the system-cpp-policy
macro global apply system-cpp policy-map to the control-plane.
Step 3 Switch(config)# {ip | mac} access-list Defines ACLs to match traffic:
extended {access-list-name}
• permit - sets the conditions under which a
For an ip access list, issue packet passes a named ACL
Switch(config-ext-nacl)#{permit|deny}
{protocol} source {source-wildcard} • deny - sets the conditions under which a
destination {destination-wildcard} packet does not pass a name ACL
For a mac access list, issue Note You must configure ACLs in most cases to
Switch(config-ext-macl)#{permit|deny} identify the important or unimportant
source {source-wildcard} destination traffic.
{destination-wildcard} [protocol-family]
• type-code - 16-bit hexadecimal number
OR
written with a leading 0x; for example,
Switch(config)# access-list 0x6000. Specify either a Link Service Access
{access-list-name} {permit | deny} Point (LSAP) type code for 802-encapsulated
{type-code wild-mask | address mask} packets or a SNAP type code for
SNAP-encapsulated packets. (LSAP,
sometimes called SAP, refers to the type codes
found in the DSAP and SSAP fields of the 802
header.)
• wild-mask - 16-bit hexadecimal number
whose ones bits correspond to bits in the
type-code argument. The wild-mask indicates
which bits in the type-code argument should
be ignored when making a comparison. (A
mask for a DSAP/SSAP pair should always be
0x0101 because these two bits are used for
purposes other than identifying the SAP
code.)
• address - 48-bit Token Ring address written
as a dotted triple of four-digit hexadecimal
numbers. This field is used for filtering by
vendor code.
• mask - 48-bit Token Ring address written as a
dotted triple of four-digit hexadecimal
numbers. The ones bits in mask are the bits to
be ignored in address. This field is used for
filtering by vendor code.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 39-5
Chapter 39 Configuring Control Plane Policing
Configuring CoPP
Command Purpose
Step 4 Switch(config)# class-map Defines the packet classification criteria. Use the
{traffic-class-name} match statements to identify the traffic associated
Switch(config-cmap)# match access-group
with the class.
{access-list-number | name
{access-list-name}}
Step 5 Switch(config-cmap)# exit Returns to global configuration mode.
Step 6 Switch(config)# policy-map Adds the traffic classes to the CoPP policy-map.
system-cpp-policy Uses the police statement to associate actions to
Switch(config-pmap)# class <class-map-name>
the traffic class.
Switch(config-pmap-c)# police
[aggregate name] rate burst
[conform-action {drop | transmit}]
[{exceed-action {drop | transmit}}]
Step 7 Switch(config)# end Returns to privileged EXEC mode.
Step 8 Switch# show policy-map system-cpp-policy Verifies your entries.
The following example shows how to configure trusted hosts with source addresses 10.1.1.1 and 10.1.1.2
to forward Telnet packets to the control plane without constraint, while allowing all remaining Telnet
packets to be policed at the specific rate (this example assumes the global qos is enabled and the
system-cpp-policy policy-map has been created):
Switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# qos
Switch(config)# macro global apply system-cpp
! Allow 10.1.1.1 trusted host traffic.
Switch(config)# access-list 140 deny tcp host 10.1.1.1 any eq telnet
! Allow 10.1.1.2 trusted host traffic.
Switch(config)# access-list 140 deny tcp host 10.1.1.2 any eq telnet
! Rate limit all other Telnet traffic.
Switch(config)# access-list 140 permit tcp any any eq telnet
! Define class-map "telnet-class."
Switch(config)# class-map telnet-class
Switch(config-cmap)# match access-group 140
Switch(config-cmap)# exit
! Add the class-map "telnet-class" to "system-cpp-policy" and define ! the proper action
Switch(config)# policy-map system-cpp-policy
Switch(config-pmap)# class telnet-class
Switch(config-pmap-c)# police 80000 1000 conform transmit exceed drop
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
! Verify the above configuration steps
Switch# show policy-map system-cpp-policy
Policy Map system-cpp-policy
Class system-cpp-dot1x
Class system-cpp-bpdu-range
Class system-cpp-cdp
police 32000 bps 1000 byte conform-action transmit exceed-action drop
Class system-cpp-sstp
Software Configuration Guide—Release IOS-XE 3.1.0 SG
39-6 OL-22250-01
Chapter 39 Configuring Control Plane Policing
CoPP Configuration Guidelines and Restrictions
Class system-cpp-cgmp
Class system-cpp-ospf
Class system-cpp-hsrpv2
Class system-cpp-igmp
Class system-cpp-pim
Class system-cpp-all-systems-on-subnet
Class system-cpp-all-routers-on-subnet
Class system-cpp-ripv2
Class system-cpp-ip-mcast-linklocal
Class system-cpp-dhcp-cs
Class system-cpp-dhcp-sc
Class system-cpp-dhcp-ss
* Class telnet-class
police 8000 bps 1000 byte conform-action drop exceed-action drop
CoPP Configuration Guidelines and Restrictions
When configuring CoPP, follow these guidelines and restrictions:
• Only ingress CoPP is supported. So only input keyword is supported in control-plane related CLIs.
• Use the system defined class maps for policing control plane traffic.
• System-defined class maps cannot be used in policy-maps for regular QoS.
• Use ACLs and class-maps to identify data plane and management plane traffic that are handled by
CPU. User-defined class maps should be added to the system-cpp-policy policy-map for CoPP.
• The policy-map named system-cpp-policy is dedicated for CoPP.
• The default system-cpp-policy map does not define actions for the system-defined class maps,
which means no policing.
• The only action supported in system-cpp-policy policy-map is police.
• Do not use the log keyword in the CoPP policy ACLs.
• Both MAC and IP ACLs can be used to define data plane and management plane traffic classes. But
if a packet also matches a pre-defined ACL for the control plane traffic, the police action (or no
police action) of the control plane class will be taken as the control plane classes appear above
user-defined classes in the service policy. This is the same MQC semantic.
• The exceeding action policed-dscp-transmit is not supported for CoPP.
Monitoring CoPP
You can enter the show policy-map control-plane command for developing site-specific policies,
monitoring statistics for the control plane policy, and troubleshooting CoPP. This command displays
dynamic information about the actual policy applied including rate information and the number of bytes
(and packets) that conformed or exceeded the configured policies both in hardware and in software.
The output of the show policy-map control-plane command is as follows:
Switch# show policy-map control-plane
Control Plane
Service-policy input: system-cpp-policy
Class-map: system-cpp-dot1x (match-all)
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 39-7
Chapter 39 Configuring Control Plane Policing
Monitoring CoPP
0 packets
Match: access-group name system-cpp-dot1x
Class-map: system-cpp-bpdu-range (match-all)
0 packets
Match: access-group name system-cpp-bpdu-range
* Class-map: system-cpp-cdp (match-all)
160 packets
Match: access-group name system-cpp-cdp
** police: Per-interface
Conform: 22960 bytes Exceed: 0 bytes
*
Class-map: system-cpp-sstp (match-all)
0 packets
Match: access-group name system-cpp-sstp
Class-map: system-cpp-cgmp (match-all)
0 packets
Match: access-group name system-cpp-cgmp
Class-map: system-cpp-hsrpv2 (match-all)
0 packets
Match: access-group name system-cpp-hsrpv2
Class-map: system-cpp-ospf (match-all)
0 packets
Match: access-group name system-cpp-ospf
Class-map: system-cpp-igmp (match-all)
0 packets
Match: access-group name system-cpp-igmp
Class-map: system-cpp-pim (match-all)
0 packets
Match: access-group name system-cpp-pim
Class-map: system-cpp-all-systems-on-subnet (match-all)
0 packets
Match: access-group name system-cpp-all-systems-on-subnet
Class-map: system-cpp-all-routers-on-subnet (match-all)
0 packets
Match: access-group name system-cpp-all-routers-on-subnet
Class-map: system-cpp-ripv2 (match-all)
0 packets
Match: access-group name system-cpp-ripv2
Class-map: system-cpp-ip-mcast-linklocal (match-all)
0 packets
Match: access-group name system-cpp-ip-mcast-linklocal
Class-map: system-cpp-dhcp-cs (match-all)
83 packets
Match: access-group name system-cpp-dhcp-cs
Class-map: system-cpp-dhcp-sc (match-all)
0 packets
Match: access-group name system-cpp-dhcp-sc
Class-map: system-cpp-dhcp-ss (match-all)
0 packets
Match: access-group name system-cpp-dhcp-ss
Software Configuration Guide—Release IOS-XE 3.1.0 SG
39-8 OL-22250-01
Chapter 39 Configuring Control Plane Policing
Monitoring CoPP
* Class-map: telnet-class (match-all)
0 packets
Match: access-group 140
** police: Per-interface
Conform: 0 bytes Exceed: 0 bytes*
Class-map: class-default (match-any)
0 packets
Match: any
0 packets
Switch#
To clear the counters on the control-plane, enter the clear control-plane * command:
Switch# clear control-plane *
Switch#
To display all the CoPP access list information, enter the show access-lists command:
Switch# show access-lists
Extended IP access list system-cpp-all-routers-on-subnet
10 permit ip any host 224.0.0.2
Extended IP access list system-cpp-all-systems-on-subnet
10 permit ip any host 224.0.0.1
Extended IP access list system-cpp-dhcp-cs
10 permit udp any eq bootpc any eq bootps Extended IP access list
system-cpp-dhcp-sc
10 permit udp any eq bootps any eq bootpc Extended IP access list
system-cpp-dhcp-ss
10 permit udp any eq bootps any eq bootps Extended IP access list
system-cpp-igmp
10 permit igmp any 224.0.0.0 31.255.255.255 Extended IP access list
system-cpp-ip-mcast-linklocal
10 permit ip any 224.0.0.0 0.0.0.255 Extended IP access list
system-cpp-ospf
10 permit ospf any 224.0.0.0 0.0.0.255 Extended IP access list
system-cpp-pim
10 permit pim any 224.0.0.0 0.0.0.255 Extended IP access list
system-cpp-ripv2
10 permit ip any host 224.0.0.9
Extended MAC access list system-cpp-bpdu-range
permit any 0180.c200.0000 0000.0000.000f Extended MAC access list
system-cpp-cdp
permit any host 0100.0ccc.cccc
Extended MAC access list system-cpp-cgmp
permit any host 0100.0cdd.dddd
Extended MAC access list system-cpp-dot1x
permit any host 0180.c200.0003
system-cpp-sstp
permit any host 0100.0ccc.cccd
To display one CoPP access list, enter the show access-lists system-cpp-cdp command:
Switch# show access-list system-cpp-cdp
Extended MAC access list system-cpp-cdp
permit any host 0100.0ccc.cccc
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 39-9
Chapter 39 Configuring Control Plane Policing
Monitoring CoPP
Software Configuration Guide—Release IOS-XE 3.1.0 SG
39-10 OL-22250-01
CH A P T E R 40
Configuring DHCP Snooping, IP Source Guard,
and IPSG for Static Hosts
This chapter describes how to configure Dynamic Host Configuration Protocol (DHCP) snooping, IP
Source Guard, and IPSG for Static Hosts on Catalyst 4500 series switches. It provides guidelines,
procedures, and configuration examples.
This chapter consists of the following major sections:
• About DHCP Snooping, page 40-1
• Configuring DHCP Snooping, page 40-6
• Displaying DHCP Snooping Information, page 40-18
• About IP Source Guard, page 40-19
• Configuring IP Source Guard, page 40-20
• Displaying IP Source Binding Information, page 40-23
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About DHCP Snooping
DHCP snooping is a DHCP security feature that provides security by filtering untrusted DHCP messages
and by building and maintaining a DHCP snooping binding table. An untrusted message is a message
that is received from outside the network or firewall and that can cause traffic attacks within your
network.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-1
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
About DHCP Snooping
The DHCP snooping binding table contains the MAC address, IP address, lease time, binding type,
VLAN number, and interface information that corresponds to the local untrusted interfaces of a switch;
it does not contain information regarding hosts interconnected with a trusted interface. An untrusted
interface is an interface that is configured to receive messages from outside the network or firewall. A
trusted interface is an interface that is configured to receive only messages from within the network.
DHCP snooping acts like a firewall between untrusted hosts and DHCP servers. It also gives you a way
to differentiate between untrusted interfaces connected to the end-user and trusted interfaces connected
to the DHCP server or another switch.
Note In order to enable DHCP snooping on a VLAN, you must enable DHCP snooping on the switch.
You can configure DHCP snooping for switches and VLANs. When you enable DHCP snooping on a
switch, the interface acts as a Layer 2 bridge, intercepting and safeguarding DHCP messages going to a
Layer 2 VLAN. When you enable DHCP snooping on a VLAN, the switch acts as a Layer 2 bridge
within a VLAN domain.
Topics include:
• Trusted and Untrusted Sources, page 40-2
• Overview of the DHCP Snooping Database Agent, page 40-2
• Option-82 Data Insertion, page 40-4
Trusted and Untrusted Sources
The DHCP snooping feature determines whether traffic sources are trusted or untrusted. An untrusted
source may initiate traffic attacks or other hostile actions. To prevent such attacks, the DHCP snooping
feature filters messages and rate-limits traffic from untrusted sources.
In an enterprise network, devices under your administrative control are trusted sources. These devices
include the switches, routers and servers in your network. Any device beyond the firewall or outside
your network is an untrusted source. Host ports are generally treated as untrusted sources.
In a service provider environment, any device that is not in the service provider network is an untrusted
source (such as a customer switch). Host ports are untrusted sources.
In the Catalyst 4500 series switch, you indicate that a source is trusted by configuring the trust state of
its connecting interface.
The default trust state of all interfaces is untrusted. You must configure DHCP server interfaces as
trusted. You can also configure other interfaces as trusted if they connect to devices (such as switches
or routers) inside your network. You usually do not configure host port interfaces as trusted.
Note For DHCP snooping to function properly, all DHCP servers must be connected to the switch through
trusted interfaces, as untrusted DHCP messages are forwarded only to trusted interfaces.
Overview of the DHCP Snooping Database Agent
To retain the bindings across switch reloads, you must use the DHCP snooping database agent. Without
this agent, the bindings established by DHCP snooping are lost upon switch reload. Connectivity is lost
as well.
Software Configuration Guide—Release 15.0(1)XO
40-2 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
About DHCP Snooping
The mechanism for the database agent stores the bindings in a file at a configured location. Upon reload,
the switch reads the file to build the database for the bindings. The switch keeps the file current by
writing to the file as the database changes.
The format of the file that contains the bindings is as follows:
<initial-checksum>
TYPE DHCP-SNOOPING
VERSION 1
BEGIN
<entry-1> <checksum-1>
<entry-2> <checksum-1-2>
...
...
<entry-n> <checksum-1-2-..-n>
END
Each entry in the file is tagged with a checksum that is used to validate the entries whenever the file is
read. The initial-checksum entry on the first line helps distinguish entries associated with the latest write
from entries that are associated with a previous write.
This is a sample bindings file:
3ebe1518
TYPE DHCP-SNOOPING
VERSION 1
BEGIN
1.1.1.1 512 0001.0001.0005 3EBE2881 Gi1/1 e5e1e733
1.1.1.1 512 0001.0001.0002 3EBE2881 Gi1/1 4b3486ec
1.1.1.1 1536 0001.0001.0004 3EBE2881 Gi1/1 f0e02872
1.1.1.1 1024 0001.0001.0003 3EBE2881 Gi1/1 ac41adf9
1.1.1.1 1 0001.0001.0001 3EBE2881 Gi1/1 34b3273e
END
Each entry holds an IP address, VLAN, MAC address, lease time (in hex), and the interface associated
with a binding. At the end of each entry is a checksum that accounts for all the bytes from the start of
the file through all the bytes associated with the entry. Each entry consists of 72 bytes of data, followed
by a space, followed by a checksum.
Upon bootup, when the calculated checksum equals the stored checksum, a switch reads entries from the
file and adds the bindings to the DHCP snooping database. When the calculated checksum does not equal
the stored checksum, the entry read from the file is ignored and so are all the entries following the failed
entry. The switch also ignores all those entries from the file whose lease time has expired. (This situation
is possible because the lease time might indicate an expired time.) An entry from the file is also ignored
if the interface referred to in the entry, no longer exists on the system or if it is a router port or a DHCP
snooping-trusted interface.
When a switch learns of new bindings or when it loses some bindings, the switch writes the modified set
of entries from the snooping database to the file. The writes are performed with a configurable delay to
batch as many changes as possible before the actual write happens. Associated with each transfer is a
timeout after which a transfer is aborted if it is not completed. These timers are referred to as the write
delay and abort timeout.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-3
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
About DHCP Snooping
Option-82 Data Insertion
In residential, metropolitan Ethernet-access environments, DHCP can centrally manage the IP address
assignments for a large number of subscribers. When the DHCP option-82 feature is enabled on the
switch, a subscriber device is identified by the switch port through which it connects to the network (in
addition to its MAC address). Multiple hosts on the subscriber LAN can be connected to the same port
on the access switch and are uniquely identified.
Note The DHCP option-82 feature is supported only when DHCP snooping is globally enabled and on the
VLANs to which subscriber devices using this feature are assigned.
Figure 40-1 is an example of a metropolitan Ethernet network in which a centralized DHCP server
assigns IP addresses to subscribers connected to the switch at the access layer. Because the DHCP clients
and their associated DHCP server do not reside on the same IP network or subnet, a DHCP relay agent
(the Catalyst switch) is configured with a helper address to enable broadcast forwarding and to transfer
DHCP messages between the clients and the server.
Figure 40-1 DHCP Relay Agent in a Metropolitan Ethernet Network
DHCP
server
Catalyst switch Access layer
(DHCP relay agent)
VLAN 10
Host A Subscribers Host B
(DHCP client) (DHCP client)
98813
When you enable the DHCP snooping information option 82 on the switch, this sequence of
events occurs:
• The host (DHCP client) generates a DHCP request and broadcasts it on the network.
• When the switch receives the DHCP request, it adds the option-82 information in the packet. By
default, the remote-ID suboption is the switch MAC address, and the circuit-ID suboption is the port
identifier, vlan-mod-port, from which the packet is received. Beginning with Cisco IOS
Release 12.2(40)SG, you can configure the remote ID and circuit ID. For information on
configuring these suboptions, see the “Enabling DHCP Snooping and Option 82” section on
page 40-10.
• If the IP address of the relay agent is configured, the switch adds this IP address in the DHCP packet.
• The switch forwards the DHCP request that includes the option-82 field to the DHCP server.
• The DHCP server receives the packet. If the server is option-82-capable, it can use the remote ID,
the circuit ID, or both to assign IP addresses and implement policies, such as restricting the number
of IP addresses that can be assigned to a single remote ID or circuit ID. Then the DHCP server
echoes the option-82 field in the DHCP reply.
Software Configuration Guide—Release 15.0(1)XO
40-4 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
About DHCP Snooping
• The DHCP server unicasts the reply to the switch if the request was relayed to the server by the
switch. The switch verifies that it originally inserted the option-82 data by inspecting the remote ID
and possibly the circuit ID fields. The switch removes the option-82 field and forwards the packet
to the switch port that connects to the DHCP client that sent the DHCP request.
In the default suboption configuration, when the described sequence of events occurs, the values in the
fields in Figure 40-2 do not change:
• Circuit-ID suboption fields
– Suboption type
– Length of the suboption type
– Circuit-ID type
– Length of the circuit-ID type
• Remote-ID suboption fields
– Suboption type
– Length of the suboption type
– Remote-ID type
– Length of the remote-ID type
Figure 40-2 shows the packet formats for the remote-ID suboption and the circuit-ID suboption when
the default suboption configuration is used. For the circuit-ID suboption, the module number
corresponds to the switch module number. The switch uses the packet formats when you globally enable
DHCP snooping and enter the ip dhcp snooping information option global configuration command.
Figure 40-2 Suboption Packet Formats
Circuit ID Suboption Frame Format
Suboption Circuit
type ID type
Length Length
1 6 0 4 VLAN Module Port
1 byte 1 byte 1 byte 1 byte 2 bytes 1 byte 1 byte
Remote ID Suboption Frame Format
Suboption Remote
type ID type
Length Length
2 8 0 6 MAC address
116300
1 byte 1 byte 1 byte 1 byte 6 bytes
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-5
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
Figure 40-3 shows the packet formats for user-configured remote-ID and circuit-ID suboptions The
switch uses these packet formats when DHCP snooping is globally enabled and when the ip dhcp
snooping information option format remote-id global configuration command and the ip dhcp
snooping vlan information option format-type circuit-id string interface configuration command are
entered.
The values for these fields in the packets change from the default values when you configure the
remote-ID and circuit-ID suboptions:
• Circuit-ID suboption fields
– The circuit-ID type is 1.
– The length values are variable, depending on the length of the string that you configure.
• Remote-ID suboption fields
– The remote-ID type is 1.
– The length values are variable, depending on the length of the string that you configure.
Figure 40-3 User-Configured Suboption Packet Formats
Circuit ID Suboption Frame Format (for user-configured string):
Suboption Circuit
type ID type
Length Length
1 N+2 1 N ASCII Circuit ID string
1 byte 1 byte 1 byte 1 byte N bytes (N = 3-63)
Remote ID Suboption Frame Format (for user-configured string):
Suboption Remote
type ID type
Length Length
145774
2 N+2 1 N ASCII Remote ID string or hostname
1 byte 1 byte 1 byte 1 byte N bytes (N = 1-63)
Configuring DHCP Snooping
When you configure DHCP snooping on your switch, you are enabling the switch to differentiate
untrusted interfaces from trusted interfaces. You must enable DHCP snooping globally before using
DHCP snooping on a VLAN. You can enable DHCP snooping independently from other DHCP features.
These sections describe how to configure DHCP snooping:
• Default Configuration for DHCP Snooping, page 40-7
• Enabling DHCP Snooping, page 40-7
• Enabling DHCP Snooping on the Aggregation Switch, page 40-9
Software Configuration Guide—Release 15.0(1)XO
40-6 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
• Enabling DHCP Snooping and Option 82, page 40-10
• Enabling DHCP Snooping on Private VLAN, page 40-11
• Configuring DHCP Snooping on Private VLAN, page 40-12
• Configuring DHCP Snooping with an Ethernet Channel Group, page 40-12
• Enabling the DHCP Snooping Database Agent, page 40-12
• Limiting the Rate of Incoming DHCP Packets, page 40-13
• Configuration Examples for the Database Agent, page 40-15
Note For DHCP server configuration information, refer to “Configuring DHCP” in the Cisco IOS IP and IP
Routing Configuration Guide at:
http://www.cisco.com/en/US/docs/ios/12_2/ip/configuration/guide/1cfdhcp.html
Default Configuration for DHCP Snooping
DHCP snooping is disabled by default. Table 40-1 shows all the default configuration values for each
DHCP snooping option.
Table 40-1 Default Configuration Values for DHCP Snooping
Option Default Value/State
DHCP snooping Disabled
DHCP snooping information option Enabled
DHCP snooping information option Disabled
allow-untrusted
DHCP snooping limit rate Infinite (functions as if rate limiting were disabled)
DHCP snooping trust Untrusted
DHCP snooping vlan Disabled
If you want to change the default configuration values, see the “Enabling DHCP Snooping” section.
Enabling DHCP Snooping
Note When DHCP snooping is enabled globally, DHCP requests are dropped until the ports are configured.
Consequently, you should probably configure this feature during a maintenance window and not during
production.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-7
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
To enable DHCP snooping, perform this task:
Command Purpose
Step 1 Switch(config)# ip dhcp snooping Enables DHCP snooping globally.
Use the no keyword to disable DHCP snooping.
Step 2 Switch(config)# ip dhcp snooping vlan number Enables DHCP snooping on your VLAN or VLAN
[number] | vlan {vlan range}] range.
Step 3 Switch(config)# errdisable recovery {cause (Optional) Configures the amount of time required for
dhcp-rate-limit | interval interval} recovery from a specified error disable cause.
Step 4 Switch(config)# errdisable detect cause (Optional) Enables per-VLAN error-disable detection.
dhcp-rate-limit {action shutdown vlan}
Note By default this command is enabled, and when a
violation occurs the interface is shutdown.
Step 5 Switch(config-if)# ip dhcp snooping trust Configures the interface as trusted or untrusted.
Use the no keyword to configure an interface to receive
messages from an untrusted client.
Step 6 Switch(config-if)# ip dhcp snooping limit rate Configures the number of DHCP packets per second
rate (pps) that an interface can receive.1
Step 7 Switch(config)# end Exits configuration mode.
Step 8 Switch# show ip dhcp snooping Verifies the configuration.
1. Cisco recommends not configuring the untrusted interface rate limit to more than 100 packets per second. The recommended rate limit for
each untrusted client is 15 packets per second. Normally, the rate limit applies to untrusted interfaces. If you want to set up rate limiting for
trusted interfaces, keep in mind that trusted interfaces aggregate all DHCP traffic in the switch, and you must adjust the rate limit to a higher
value. You should fine tune this threshold depending on the network configuration. The CPU should not receive DHCP packets at a sustained
rate of more than 1,000 packets per second.
You can configure DHCP snooping for a single VLAN or a range of VLANs. To configure a single
VLAN, enter a single VLAN number. To configure a range of VLANs, enter a beginning and an ending
VLAN number or a dash and range of VLANs.
The number of incoming DHCP packets is rate-limited to prevent a denial-of-service attack. When the
rate of incoming DHCP packets exceeds the configured limit, the switch places the port in the
error-disabled state. To prevent the port from shutting down, use the errdisable detect cause
dhcp-rate-limit action shutdown vlan global configuration command to shut down just the offending
VLAN on the port where the violation occurred.
When a secure port is in the error-disabled state, you can bring it out of this state automatically by
configuring the errdisable recovery cause dhcp-rate-limit global configuration command or you can
manually reenable it by entering the shutdown and no shut down interface configuration commands. If
a port is in per-VLAN errdisable mode, you can also use clear errdisable interface name vlan range
command to re-enable the VLAN on the port.
This example shows how to enable DHCP Snooping on Vlan 500 through 555:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# ip dhcp snooping
Switch(config)# ip dhcp snooping vlan 500 555
Switch(config)# ip dhcp snooping information option format remote-id string switch123
Switch(config)# interface GigabitEthernet 5/1
Switch(config-if)# ip dhcp snooping trust
Switch(config-if)# ip dhcp snooping limit rate 100
Software Configuration Guide—Release 15.0(1)XO
40-8 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
Switch(config-if)# ip dhcp snooping vlan 555 information option format-type circuit-id
string customer-555
Switch(config-if)# interface FastEthernet 2/1
Switch(config-if)# ip dhcp snooping vlan 555 information option format-type circuit-id
string customer-500
Switch(config)# end
Switch# show ip dhcp snooping
Switch DHCP snooping is enabled
DHCP snooping is configured on following VLANs:
500,555
DHCP snooping is operational on following VLANs:
500,555
DHCP snooping is configured on the following L3 Interfaces:
Insertion of option 82 is enabled
circuit-id default format: vlan-mod-port
remote-id: switch123 (string)
Option 82 on untrusted port is not allowed Verification of hwaddr field is enabled DHCP
snooping trust/rate is configured on the following Interfaces:
Interface Trusted Rate limit (pps)
------------------------ ------- ----------------
FastEthernet5/1 yes 100
Custom circuit-ids:
VLAN 555: customer-555
FastEthernet2/1 no unlimited
Custom circuit-ids:
VLAN 500: customer-500
Switch#
The following configuration describes the DHCP snooping configuration steps if routing is defined on
another Catalyst switch (for example, a Catalyst 6500 series switch):
// Trust the uplink gigabit Ethernet trunk port
interface range GigabitEthernet 1/1 – 2
switchport mode trunk
switchport trunk encapsulation dot1q
ip dhcp snooping trust
interface VLAN 14
ip address 10.33.234.1 255.255.254.0
ip helper-address 10.5.1.2
Note If you are enabling trunking on uplink gigabit interfaces, and the above routing configuration is defined
on a Catalyst 6500 series switch, you must configure the “trust” relationship with downstream DHCP
Snooping (on a Catalyst 4500 series switch) which adds Option 82. On a Catalyst 6500 series switch,
this task is accomplished with ip dhcp relay information trusted VLAN configuration command.
Enabling DHCP Snooping on the Aggregation Switch
To enable DHCP Snooping on an aggregation switch, configure the interface connecting to a
downstream switch as a snooping untrusted port. If the downstream switch (or a device such as a
DSLAM in the path between the aggregation switch and the DHCP clients) adds DHCP information
option 82 to the DHCP packets, the DHCP packets would be dropped on arriving on a snooping untrusted
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-9
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
port. Configuring the ip dhcp snooping information option allow-untrusted global configuration
command on the aggregation switch would allow the aggregation switch to accept DHCP requests with
option 82 information from any snooping untrusted port.
Enabling DHCP Snooping and Option 82
To enable DHCP snooping and Option 82 on the switch, perform the following steps:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ip dhcp snooping Enables DHCP snooping globally.
Step 3 Switch(config)# ip dhcp snooping Enables DHCP snooping on a VLAN or range of VLANs. The range is 1
vlan vlan-range to 4094.
You can enter a single VLAN ID identified by VLAN ID number, a series
of VLAN IDs separated by commas, a range of VLAN IDs separated by
hyphens, or a range of VLAN IDs separated by entering the starting and
ending VLAN IDs separated by a space.
Step 4 Switch(config)# ip dhcp snooping Enables the switch to insert and remove DHCP relay information
information option (option-82 field) in forwarded DHCP request messages to the DHCP
server. This is the default setting.
Step 5 Switch(config)# ip dhcp snooping (Optional) Configures the remote-ID suboption.
information option format remote-id
[string ASCII-string | hostname] You can configure the remote ID to be:
• String of up to 63 ASCII characters (no spaces)
• Configured hostname for the switch
a. If the hostname is longer than 63 characters, it is truncated to 63
characters in the remote-ID configuration.
The default remote ID is the switch MAC address.
Step 6 Switch(config)# ip dhcp snooping (Optional) If the switch is an aggregation switch connected to an edge
information option allow-untrusted switch, enables the switch to accept incoming DHCP snooping packets
with option-82 information from the edge switch.
The default setting is disabled.
Note Enter this command only on aggregation switches that are
connected to trusted devices.
Step 7 Switch(config)# interface Specifies the interface to be configured, and enter interface configuration
interface-id mode.
Step 8 Switch(config-if)# ip dhcp snooping (Optional) Configures the circuit-ID suboption for the specified
vlan vlan information option interface.
format-type circuit-id string
ASCII-string Specify the VLAN and port identifier, using a VLAN ID in the range of 1
to 4094. The default circuit ID is the port identifier, in the format
vlan-mod-port.
You can configure the circuit ID to be a string of 3 to 63 ASCII characters
(no spaces).
Software Configuration Guide—Release 15.0(1)XO
40-10 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
Command Purpose
Step 9 Switch(config-if)# ip dhcp snooping (Optional) Configures the interface as trusted or untrusted. Use the no
trust keyword to configure an interface to receive messages from an untrusted
client. The default setting is untrusted.
Step 10 Switch(config-if)# ip dhcp snooping (Optional) Configures the number of DHCP packets per second that an
limit rate rate interface can receive. The range is 1 to 2048. By default, no rate limit is
configured.
Note We recommend an untrusted rate limit of not more than 100
packets per second. If you configure rate limiting for trusted
interfaces, you might need to increase the rate limit if the port is
a trunk port assigned to more than one VLAN on which DHCP
snooping is enabled.
Step 11 Switch(config-if)# exit Returns to global configuration mode.
Step 12 Switch(config)# ip dhcp snooping (Optional) Configures the switch to verify that the source MAC address
verify mac-address in a DHCP packet that is received on untrusted ports matches the client
hardware address in the packet. The default is to verify that the source
MAC address matches the client hardware address in the packet.
Step 13 Switch(config)# end Returns to privileged EXEC mode.
Step 14 Switch# show running-config Verifies your entries.
Step 15 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To disable DHCP snooping, use the no ip dhcp snooping global configuration command. To disable
DHCP snooping on a VLAN or range of VLANs, use the no ip dhcp snooping vlan vlan-range global
configuration command. To disable the insertion and removal of the option-82 field, use the no ip dhcp
snooping information option global configuration command. To configure an aggregation switch to
drop incoming DHCP snooping packets with option-82 information from an edge switch, use the no ip
dhcp snooping information option allow-untrusted global configuration command.
This example shows how to enable DHCP snooping globally and on VLAN 10 and to configure a rate
limit of 100 packets per second on a port:
Switch(config)# ip dhcp snooping
Switch(config)# ip dhcp snooping vlan 10
Switch(config)# ip dhcp snooping information option
Switch(config)# interface gigabitethernet2/0/1
Switch(config-if)# ip dhcp snooping limit rate 100
Enabling DHCP Snooping on Private VLAN
DHCP snooping can be enabled on private VLANs, which provide isolation between Layer 2 ports
within the same VLAN. If DHCP snooping is enabled (or disabled), the configuration is propagated to
both the primary VLAN and its associated secondary VLANs. You cannot enable (or disable) DHCP
snooping on a primary VLAN without reflecting this configuration change on the secondary VLANs.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-11
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
Configuring DHCP snooping on a secondary VLAN is still allowed, but it does not take effect if the
associated primary VLAN is already configured. If the associated primary VLAN is configured, the
effective DHCP snooping mode on the secondary VLAN is derived from the corresponding primary
VLAN. Manually configuring DHCP snooping on a secondary VLAN causes the switch to issue this
warning message:
DHCP Snooping configuration may not take effect on secondary vlan XXX
The show ip dhcp snooping command displays all VLANs (both primary and secondary) that have
DHCP snooping enabled.
Configuring DHCP Snooping on Private VLAN
DHCP snooping, IPSG, and DAI are Layer 2 based security features that can be enabled and disabled on
an individual VLAN, including auxiliary/voice VLAN. This means that you need to enable DHCP
snooping on a voice VLAN for a Cisco IP phone to function properly.
Configuring DHCP Snooping with an Ethernet Channel Group
When you configure DHCP snooping, you need to configure trunk interfaces that transmit DHCP
packets as trusted interfaces by adding ip dhcp snooping trust to the physical interface configuration.
However, if DHCP packets are transmitted over an ethernet channel group, you must configure
ip dhcp snooping trust on the logical port-channel interface, for example:
Switch# show run int port-channel50
Building configuration...
Current configuration : 150 bytes
!
interface Port-channel50
switchport
switchport trunk native vlan 4092
switchport mode trunk
switchport nonegotiate
ip dhcp snooping trust
end
Switch#
Enabling the DHCP Snooping Database Agent
To configure the database agent, perform one or more of the following tasks:
Command Purpose
Switch(config)# ip dhcp snooping database {url | (Required) Configures a URL for the database agent (or file)
write-delay seconds | timeout seconds } and the related timeout values.
Switch(config)# no ip dhcp snooping database
[write-delay | timeout]
Switch# show ip dhcp snooping database [detail] (Optional) Displays the current operating state of the
database agent and statistics associated with the transfers.
Software Configuration Guide—Release 15.0(1)XO
40-12 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
Command Purpose
Switch# clear ip dhcp snooping database statistics (Optional) Clears the statistics associated with the database
agent.
Switch# renew ip dhcp snooping database [validation (Optional) Requests the read entries from a file at the given
none] [url] URL.
Switch# ip dhcp snooping binding mac-addr vlan vlan (Optional) Adds/deletes bindings to the snooping database.
ipaddr interface ifname expiry lease-in-seconds
Switch# no ip dhcp snooping binding mac-addr vlan
vlan ipaddr interface ifname
Note Because both NVRAM and bootflash have limited storage capacity, you should use TFTP or
network-based files. If you use flash to store the database file, new updates (by the agent) result in the
creation of new files (flash fills quickly). Moreover, because of the filesystem used on the flash, a large
number of files can cause slow access. When a file is stored in a remote location accessible through
TFTP, an RPR/SSO standby supervisor engine can take over the binding list when a switchover occurs.
Note Network-based URLs (such as TFTP and FTP) require that you create an empty file at the configured
URL before the switch can write the set of bindings for the first time.
Limiting the Rate of Incoming DHCP Packets
The switch CPU performs DHCP validation checks; therefore, the number of incoming DHCP packets
is rate-limited to prevent a denial-of-service attack.
When the rate of incoming DHCP packets exceeds the configured limit, the switch places the port in the
error-disabled state. The port remains in that state until you intervene or you enable error-disable
recovery so that ports automatically emerge from this state after a specified timeout period.
Note Unless you explicitly configure a rate limit on an interface, changing the trust state of the interface also
changes its rate limit to the default value for that trust state. After you configure the rate limit, the
interface retains the rate limit even when its trust state is changed. If you enter the
no ip dhcp snooping limit rate interface configuration command, the interface reverts to its default rate
limit.
To prevent the port from shutting down, use the errdisable detect cause dhcp-rate-limit action
shutdown vlan global configuration command to shut down only the offending VLAN on the port where
the violation occurred.
To limit the rate of incoming DHCP packets, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# errdisable detect Enables per-VLAN error-disable detection.
cause dhcp-rate-limit [action
shutdown vlan]
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-13
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
Command Purpose
Step 3 Switch(config)# interface Specifies the interface to be rate-limited, and enter interface
interface-id configuration mode.
Step 4 Switch(config-if)# [no] ip dhcp Limits the rate of incoming DHCP requests and responses on the
snooping limit rate interface.
The default rate is disabled.
Step 5 Switch(config-if)# exit Returns to global configuration mode.
Step 6 Switch(config)# errdisable recovery (Optional) Enables error recovery from the DHCP error-disable state.
{cause dhcp-rate-limit |
interval interval} By default, recovery is disabled, and the recovery interval is 300
seconds.
For interval interval, specify the time in seconds to recover from the
error-disable state. The range is 30 to 86400.
Step 7 Switch(config)# exit Returns to privileged EXEC mode.
Step 8 Switch# show interfaces status Verifies your settings.
Step 9 Switch# show errdisable recovery Verifies your settings.
Step 10 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To return to the default rate-limit configuration, use the no ip dhcp-rate-limit interface configuration
command. To disable error recovery for DHCP inspection, use the
no errdisable recovery cause dhcp-rate-limit global configuration command.
This example shows how to set an upper limit for the number of incoming packets (100 pps) and to
specify a burst interval (1 second):
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface g3/31
Switch(config-if)# ip dhcp-rate-limit rate 100 burst interval 1
Switch(config-if)# exit
Switch(config)# errdisable recovery cause dhcp-rate-limit
Switch(config)# exit
Switch# show interfaces status
Port Name Status Vlan Duplex Speed Type
Te1/1 connected 1 full 10G 10GBase-LR
Te1/2 connected vl-err-dis full 10G 10GBase-LR
Switch# show errdisable recovery
ErrDisable Reason Timer Status
----------------- --------------
udld Disabled
bpduguard Disabled
security-violatio Disabled
channel-misconfig Disabled
vmps Disabled
pagp-flap Disabled
dtp-flap Disabled
link-flap Disabled
l2ptguard Disabled
psecure-violation Disabled
gbic-invalid Disabled
dhcp-rate-limit Disabled
unicast-flood Disabled
storm-control Disabled
Software Configuration Guide—Release 15.0(1)XO
40-14 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
arp-inspection Enabled
Timer interval: 300 seconds
Interfaces that will be enabled at the next timeout:
Switch#
1w2d: %SW_DAI-4-PACKET_RATE_EXCEEDED: 101 packets received in 739 milliseconds on Gi3/31.
1w2d: %PM-4-ERR_DISABLE: arp-inspection error detected on Gi3/31, putting Gi3/31 in
err-disable state
Switch# show clock
*02:21:43.556 UTC Fri Feb 4 2005
Switch#
Switch# show interface g3/31 status
Port Name Status Vlan Duplex Speed Type
Gi3/31 err-disabled 100 auto auto 10/100/1000-TX
Switch#
Switch#
1w2d: %PM-4-ERR_RECOVER: Attempting to recover from arp-inspection err-disable state on
Gi3/31
Switch# show interface g3/31 status
Port Name Status Vlan Duplex Speed Type
Gi3/31 connected 100 a-full a-100 10/100/1000-TX
Switch# show clock
*02:27:40.336 UTC Fri Feb 4 2005
Switch#
Configuration Examples for the Database Agent
The following examples show how to use the above commands.
Example 1: Enabling the Database Agent
The following example shows how to configure the DHCP snooping database agent to store the bindings
at a given location and to view the configuration and operating state:
Switch# configure terminal
Switch(config)# ip dhcp snooping database tftp://10.1.1.1/directory/file
Switch(config)# end
Switch# show ip dhcp snooping database detail
Agent URL : tftp://10.1.1.1/directory/file
Write delay Timer : 300 seconds
Abort Timer : 300 seconds
Agent Running : No
Delay Timer Expiry : 7 (00:00:07)
Abort Timer Expiry : Not Running
Last Succeded Time : None
Last Failed Time : 17:14:25 UTC Sat Jul 7 2001
Last Failed Reason : Unable to access URL.
Total Attempts : 21 Startup Failures : 0
Successful Transfers : 0 Failed Transfers : 21
Successful Reads : 0 Failed Reads : 0
Successful Writes : 0 Failed Writes : 21
Media Failures : 0
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-15
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
First successful access: Read
Last ignored bindings counters :
Binding Collisions : 0 Expired leases : 0
Invalid interfaces : 0 Unsupported vlans : 0
Parse failures : 0
Last Ignored Time : None
Total ignored bindings counters:
Binding Collisions : 0 Expired leases : 0
Invalid interfaces : 0 Unsupported vlans : 0
Parse failures : 0
Switch#
The first three lines of output show the configured URL and related timer configuration values. The next
three lines show the operating state and the amount of time left for expiry of write delay and abort timers.
Among the statistics shown in the output, startup failures indicate the number of attempts the read or
create of the file has failed upon bootup.
Note Because the location is based off in the network, you must create a temporary file on the TFTP server.
You can create a temporary file on a typical UNIX workstation by creating a 0 byte file “file” in the
directory “directory” that can be referenced by the TFTP server daemon. With some server
implementations on UNIX workstations, the file should be provided with full (777) permissions for write
access to the file.
DHCP snooping bindings are keyed on the MAC address and VLAN combination. Therefore, if an entry
in the remote file has an entry for a given MAC address and VLAN set, for which the switch already has
a binding, the entry from the remote file is ignored when the file is read. This condition is referred to as
the binding collision.
An entry in a file may no longer be valid because the lease indicated by the entry may have expired by
the time it is read. The expired leases counter indicates the number of bindings ignored because of this
condition. The Invalid interfaces counter refers to the number of bindings that have been ignored when
the interface referred by the entry either does not exist on the system or is a router or DHCP snooping
trusted interface if it exists, when the read happened. Unsupported VLANs refers to the number of
entries that have been ignored because the indicated VLAN is not supported on the system. The Parse
failures counter provides the number of entries that have been ignored when the switch is unable to
interpret the meaning of the entries from the file.
The switch maintains two sets of counters for these ignored bindings. One provides the counters for a
read that has at least one binding ignored by at least one of these conditions. These counters are shown
as the “Last ignored bindings counters.” The total ignored bindings counters provides a sum of the
number of bindings that have been ignored because of all the reads since the switch bootup. These two
set of counters are cleared by the clear command. Therefore, the total counter set may indicate the
number of bindings that have been ignored since the last clear.
Example 2: Reading Binding Entries from a TFTP File
To manually read the entries from a TFTP file, perform this task:
Software Configuration Guide—Release 15.0(1)XO
40-16 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring DHCP Snooping
Command Purpose
Step 1 Switch# show ip dhcp snooping database Displays the DHCP snooping database agent statistics.
Step 2 Switch# renew ip dhcp snoop data url Directs the switch to read the file from given URL.
Step 3 Switch# show ip dhcp snoop data Displays the read status.
Step 4 Switch# show ip dhcp snoop bind Verifies whether the bindings were read successfully.
This is an example of how to manually read entries from the tftp://10.1.1.1/directory/file:
Switch# show ip dhcp snooping database
Agent URL :
Write delay Timer : 300 seconds
Abort Timer : 300 seconds
Agent Running : No
Delay Timer Expiry : Not Running
Abort Timer Expiry : Not Running
Last Succeded Time : None
Last Failed Time : None
Last Failed Reason : No failure recorded.
Total Attempts : 0 Startup Failures : 0
Successful Transfers : 0 Failed Transfers : 0
Successful Reads : 0 Failed Reads : 0
Successful Writes : 0 Failed Writes : 0
Media Failures : 0
Switch#
Switch# renew ip dhcp snoop data tftp://10.1.1.1/directory/file
Loading directory/file from 10.1.1.1 (via GigabitEthernet1/1): !
[OK - 457 bytes]
Database downloaded successfully.
Switch#
00:01:29: %DHCP_SNOOPING-6-AGENT_OPERATION_SUCCEEDED: DHCP snooping database Read
succeeded.
Switch#
Switch# show ip dhcp snoop data
Agent URL :
Write delay Timer : 300 seconds
Abort Timer : 300 seconds
Agent Running : No
Delay Timer Expiry : Not Running
Abort Timer Expiry : Not Running
Last Succeded Time : 15:24:34 UTC Sun Jul 8 2001
Last Failed Time : None
Last Failed Reason : No failure recorded.
Total Attempts : 1 Startup Failures : 0
Successful Transfers : 1 Failed Transfers : 0
Successful Reads : 1 Failed Reads : 0
Successful Writes : 0 Failed Writes : 0
Media Failures : 0
Switch#
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-17
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Displaying DHCP Snooping Information
Switch# show ip dhcp snoop bind
MacAddress IpAddress Lease(sec) Type VLAN Interface
------------------ --------------- ---------- ------------- ---- --------------------
00:01:00:01:00:05 1.1.1.1 49810 dhcp-snooping 512 GigabitEthernet1/1
00:01:00:01:00:02 1.1.1.1 49810 dhcp-snooping 512 GigabitEthernet1/1
00:01:00:01:00:04 1.1.1.1 49810 dhcp-snooping 1536 GigabitEthernet1/1
00:01:00:01:00:03 1.1.1.1 49810 dhcp-snooping 1024 GigabitEthernet1/1
00:01:00:01:00:01 1.1.1.1 49810 dhcp-snooping 1 GigabitEthernet1/1
Switch#
Switch# clear ip dhcp snoop bind
Switch# show ip dhcp snoop bind
MacAddress IpAddress Lease(sec) Type VLAN Interface
------------------ --------------- ---------- ------------- ---- --------------------
Switch#
Example 3: Adding Information to the DHCP Snooping Database
To manually add a binding to the DHCP snooping database, perform this task:
Command Purpose
Step 1 Switch# show ip dhcp snooping binding Views the DHCP snooping database
Step 2 Switch# ip dhcp snooping binding binding-id vlan Adds the binding using the 'ip dhcp snooping' exec
vlan-id interface interface expiry lease-time command
Step 3 Switch# show ip dhcp snooping binding Checks the DHCP snooping database
This example shows how to manually add a binding to the DHCP snooping database:
Switch# show ip dhcp snooping binding
MacAddress IpAddress Lease(sec) Type VLAN Interface
------------------ --------------- ---------- ------------- ---- --------------------
Switch#
Switch# ip dhcp snooping binding 1.1.1 vlan 1 1.1.1.1 interface gi1/1 expiry 1000
Switch# show ip dhcp snooping binding
MacAddress IpAddress Lease(sec) Type VLAN Interface
------------------ --------------- ---------- ------------- ---- --------------------
00:01:00:01:00:01 1.1.1.1 992 dhcp-snooping 1 GigabitEthernet1/1
Switch#
Displaying DHCP Snooping Information
You can display a DHCP snooping binding table and configuration information for all interfaces on a
switch.
Displaying a Binding Table
The DHCP snooping binding table for each switch contains binding entries that correspond to untrusted
ports. The table does not contain information about hosts interconnected with a trusted port because each
interconnected switch has its own DHCP snooping binding table.
This example shows how to display the DHCP snooping binding information for a switch:
Switch# show ip dhcp snooping binding
Software Configuration Guide—Release 15.0(1)XO
40-18 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
About IP Source Guard
MacAddress IpAddress Lease(sec) Type VLAN Interface
------------------ --------------- ---------- ------------- ---- --------------------
00:02:B3:3F:3B:99 55.5.5.2 6943 dhcp-snooping 10 FastEthernet6/10
Switch#
Table 40-2 describes the fields in the show ip dhcp snooping binding command output.
Table 40-2 show ip dhcp snooping binding Command Output
Field Description
MAC Address Client hardware MAC address
IP Address Client IP address assigned from the DHCP server
Lease (seconds) IP address lease time
Type Binding type; dynamic binding learned by dhcp-snooping or
statically-configured binding.
VLAN VLAN number of the client interface
Interface Interface that connects to the DHCP client host
Displaying the DHCP Snooping Configuration
This example shows how to display the DHCP snooping configuration for a switch.
Switch# show ip dhcp snooping
Switch DHCP snooping is enabled.
DHCP Snooping is configured on the following VLANs:
10 30-40 100 200-220
Insertion of option 82 is enabled
Option82 on untrusted port is not allowed
Verification of hwaddr field is enabled
Interface Trusted Rate limit (pps)
--------- ------- ----------------
FastEthernet2/1 yes 10
FastEthernet3/1 yes none
GigabitEthernet1/1 no 20
Switch#
About IP Source Guard
Similar to DHCP snooping, this feature is enabled on a DHCP snooping untrusted Layer 2 port. Initially,
all IP traffic on the port is blocked except for DHCP packets that are captured by the DHCP snooping
process. When a client receives a valid IP address from the DHCP server, or when a static IP source
binding is configured by the user, a per-port and VLAN Access Control List (PVACL) is installed on
the port. This process restricts the client IP traffic to those source IP addresses configured in the binding;
any IP traffic with a source IP address other than that in the IP source binding is filtered out. This
filtering limits a host’s ability to attack the network by claiming a neighbor host's IP address.
Note If IP Source Guard is enabled on a trunk port with a large number of VLANs that have DHCP snooping
enabled, you might run out of ACL hardware resources, and some packets might be switched in software
instead.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-19
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring IP Source Guard
Note When IP Source Guard is enabled, you might want to designate an alternative scheme for ACL hardware
programming. For more information, see the “TCAM Programming and ACLs” section in the
“Configuring Network Security with ACLs” chapter.
Note When an interface is in down state, TCAMs are not consumed for RACLs, but are for PACLs.
IP Source Guard supports the Layer 2 port only, including both access and trunk. For each untrusted
Layer 2 port, there are two levels of IP traffic security filtering:
• Source IP address filter
IP traffic is filtered based on its source IP address. Only IP traffic with a source IP address that
matches the IP source binding entry is permitted.
An IP source address filter is changed when a new IP source entry binding is created or deleted on
the port. The port PVACL is recalculated and reapplied in the hardware to reflect the IP source
binding change. By default, if the IP filter is enabled without any IP source binding on the port, a
default PVACL that denies all IP traffic is installed on the port. Similarly, when the IP filter is
disabled, any IP source filter PVACL is removed from the interface.
• Source IP and MAC address filter
IP traffic is filtered based on its source IP address as well as its MAC address; only IP traffic with
source IP and MAC addresses matching the IP source binding entry are permitted.
Note When IP source guard is enabled in IP and MAC filtering mode, the DHCP snooping option 82 must be
enabled to ensure that the DHCP protocol works properly. Without option 82 data, the switch cannot
locate the client host port to forward the DHCP server reply. Instead, the DHCP server reply is dropped,
and the client cannot obtain an IP address.
Configuring IP Source Guard
To enable IP Source Guard, perform this task:
Command Purpose
Step 1 Switch(config)# ip dhcp snooping Enables DHCP snooping globally.
Use the no keyword to disable DHCP snooping.
Step 2 Switch(config)# ip dhcp snooping vlan number Enables DHCP snooping on your VLANs.
[number]
Step 3 Switch(config-if)# no ip dhcp snooping trust Configures the interface as trusted or untrusted.
Use the no keyword of to configure an interface to
receive only messages from within the network.
Step 4 Switch(config-if)# ip verify source vlan Enables IP source guard, source IP, and source MAC
dhcp-snooping port-security address filtering on the port.
Software Configuration Guide—Release 15.0(1)XO
40-20 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Configuring IP Source Guard
Command Purpose
Step 5 Switch(config-if)# switchport port-security limit Enables security rate limiting for learned source MAC
rate invalid-source-mac N addresses on the port.
Note This limit only applies to the port where IP
Source Guard is enabled as filtering both IP and
MAC addresses.
Step 6 Switch(config)# ip source binding mac-address Configures a static IP binding on the port.
Vlan vlan-id ip-address interface interface-name
Step 7 Switch(config)# end Exits configuration mode.
Step 8 Switch# show ip verify source interface Verifies the configuration.
interface-name
If you want to stop IP Source Guard with Static Hosts on an interface, use the following commands in
interface configuration submode:
Switch(config-if)# no ip verify source
Switch(config-if)# no ip device tracking max
If the no ip device tracking command is entered in interface configuration submode, it is interpreted
and run in the global configuration mode, causing IP device tracking to be disabled globally. For all the
interfaces configured with the ip verify source tracking [port-security] command, disabling IP device
tracking globally causes the IP Source Guard with Static Hosts feature to deny all IP traffic from those
interfaces.
Note The static IP source binding can only be configured on switch port. If you issue the
ip source binding vlan interface command on a Layer 3 port, you receive this error message: Static
IP source binding can only be configured on switch port.
This example shows how to enable per-Layer 2-port IP source guard on VLANs 10 through 20:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# ip dhcp snooping
Switch(config)# ip dhcp snooping vlan 10 20
Switch(config)# interface fa6/1
Switch(config-if)# switchport trunk encapsulation dot1q
Switch(config-if)# switchport mode trunk
Switch(config-if)# switchport trunk native vlan 10
Switch(config-if)# switchport trunk allowed vlan 11-20
Switch(config-if)# no ip dhcp snooping trust
Switch(config-if)# ip verify source vlan dhcp-snooping
Switch(config)# end
Switch# show ip verify source interface f6/1
Interface Filter-type Filter-mode IP-address Mac-address Vlan
--------- ----------- ----------- --------------- ----------------- ----------
Fa6/1 ip-mac active 10.0.0.1 10
Fa6/1 ip-mac active deny-all 11-20
Switch#
The output shows that there is one valid DHCP binding to VLAN 10.
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-21
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Displaying IP Source Guard Information
Configuring IP Source Guard on Private VLANs
For private VLAN ports, you must enable DHCP snooping on primary VLANs in order for IP source
guard to be effective. IP source guard on a primary VLAN is automatically propagate to a secondary
VLAN. Configuring a static IP source binding on a secondary VLAN is allowed, but it does not take
effect. When manually configuring a static IP source binding on a secondary VLAN, you receive the
following warning:
Warning IP source filter may not take effect on secondary vlan where IP source binding is configured. If private
vlan feature is enabled, IP source filter on primary vlan automatically propagates to all secondary
vlans.
Displaying IP Source Guard Information
You can display IP Source Guard PVACL information for all interfaces on a switch using the
show ip verify source command.
• This example shows displayed PVACLs if DHCP snooping is enabled on VLAN 10 through 20, if
interface fa6/1 is configured for IP filtering, and if there is an existing IP address binding 10.0.01
on VLAN 10:
Interface Filter-type Filter-mode IP-address Mac-address Vlan
--------- ----------- ----------- --------------- -------------- ---------
fa6/1 ip active 10.0.0.1 10
fa6/1 ip active deny-all 11-20
Note The second entry shows that a default PVACL (deny all IP traffic) is installed on the port for those
snooping-enabled VLANs that do not have a valid IP source binding.
• This example shows displayed PVACL for a trusted port:
Interface Filter-type Filter-mode IP-address Mac-address Vlan
--------- ----------- ----------- --------------- -------------- ---------
fa6/2 ip inactive-trust-port
• This example shows displayed PVACL for a port in a VLAN not configured for DHCP snooping:
Interface Filter-type Filter-mode IP-address Mac-address Vlan
--------- ----------- ----------- --------------- -------------- ---------
fa6/3 ip inactive-no-snooping-vlan
• This example shows displayed PVACLs for a port with multiple bindings configured for an IP/MAC
filtering:
Interface Filter-type Filter-mode IP-address Mac-address Vlan
--------- ----------- ----------- --------------- -------------- ---------
fa6/4 ip-mac active 10.0.0.2 aaaa.bbbb.cccc 10
fa6/4 ip-mac active 11.0.0.1 aaaa.bbbb.cccd 11
fa6/4 ip-mac active deny-all deny-all 12-20
• This example shows displayed PVACLs for a port configured for IP/MAC filtering but not for port
security:
Interface Filter-type Filter-mode IP-address Mac-address Vlan
--------- ----------- ----------- --------------- -------------- ---------
Software Configuration Guide—Release 15.0(1)XO
40-22 OL-22250-01
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Displaying IP Source Binding Information
fa6/5 ip-mac active 10.0.0.3 permit-all 10
fa6/5 ip-mac active deny-all permit-all 11-20
Note The MAC filter shows permit-all because port security is not enabled, so the MAC filter
cannot apply to the port/VLAN and is effectively disabled. Always enable port security first.
• This example shows displayed error message when issuing the show ip verify source command on
a port that does not have an IP source filter mode configured:
IP Source Guard is not configured on the interface fa6/6.
You can also use the show ip verify source command to display all interfaces on the switch that have
IP source guard enabled:
Interface Filter-type Filter-mode IP-address Mac-address Vlan
--------- ----------- ----------- --------------- -------------- ---------
fa6/1 ip active 10.0.0.1 10
fa6/1 ip active deny-all 11-20
fa6/2 ip inactive-trust-port
fa6/3 ip inactive-no-snooping-vlan
fa6/4 ip-mac active 10.0.0.2 aaaa.bbbb.cccc 10
fa6/4 ip-mac active 11.0.0.1 aaaa.bbbb.cccd 11
fa6/4 ip-mac active deny-all deny-all 12-20
fa6/5 ip-mac active 10.0.0.3 permit-all 10
fa6/5 ip-mac active deny-all permit-all 11-20
Displaying IP Source Binding Information
You can display all IP source bindings configured on all interfaces on a switch using the
show ip source binding command.
Switch# show ip source binding
MacAddress IpAddress Lease(sec) Type VLAN Interface
------------------ --------------- ---------- ------------- ---- --------------------
00:02:B3:3F:3B:99 55.5.5.2 6522 dhcp-snooping 10 FastEthernet6/10
00:00:00:0A:00:0B 11.0.0.1 infinite static 10 FastEthernet6/10
Switch#
Table 40-3 describes the fields in the show ip source binding command output.
Table 40-3 show ip source binding Command Output
Field Description
MAC Address Client hardware MAC address
IP Address Client IP address assigned from the DHCP server
Lease (seconds) IP address lease time
Type Binding type; static bindings configured from CLI to dynamic binding
learned from DHCP Snooping
VLAN VLAN number of the client interface
Interface Interface that connects to the DHCP client host
Software Configuration Guide—Release 15.0(1)XO
OL-22250-01 40-23
Chapter 40 Configuring DHCP Snooping, IP Source Guard, and IPSG for Static Hosts
Displaying IP Source Binding Information
Software Configuration Guide—Release 15.0(1)XO
40-24 OL-22250-01
CH A P T E R 41
Configuring Dynamic ARP Inspection
This chapter describes how to configure Dynamic ARP Inspection (DAI) on the Catalyst 4500 series
switch.
This chapter includes the following major sections:
• About Dynamic ARP Inspection, page 41-1
• Configuring Dynamic ARP Inspection, page 41-5
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Dynamic ARP Inspection
Dynamic ARP Inspection (DAI) is a security feature that validates Address Resolution Protocol (ARP)
packets in a network. DAI allows a network administrator to intercept, log, and discard ARP packets
with invalid MAC-IP pairs. This capability protects the network from certain “man-in-the-middle”
attacks.
This section contains the following subsections:
• ARP Cache Poisoning, page 41-2
• Purpose of Dynamic ARP Inspection, page 41-2
• Interface Trust State, Security Coverage and Network Configuration, page 41-3
• Relative Priority of Static Bindings and DHCP Snooping Entries, page 41-4
• Logging of Dropped Packets, page 41-4
• Rate Limiting of ARP Packets, page 41-4
• Port Channels and Their Behavior, page 41-5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-1
Chapter 41 Configuring Dynamic ARP Inspection
About Dynamic ARP Inspection
ARP Cache Poisoning
You can attack hosts, switches, and routers connected to your Layer 2 network by “poisoning” their ARP
caches. For example, a malicious user might intercept traffic intended for other hosts on the subnet by
poisoning the ARP caches of systems connected to the subnet.
Consider the following configuration:
Figure 41-1 ARP Cache Poisoning
A B
HA HB
(IA, MA) (IB, MB)
C
HC
94072
(IC, MC)
Hosts HA, HB, and HC are connected to the switch on interfaces A, B and C, all of which are on the
same subnet. Their IP and MAC addresses are shown in parentheses; for example, Host HA uses IP
address IA and MAC address MA. When HA needs to communicate to HB at the IP Layer, HA
broadcasts an ARP request for the MAC address associated with IB. As soon as HB receives the ARP
request, the ARP cache on HB is populated with an ARP binding for a host with the IP address IA and
a MAC address MA. When HB responds to HA, the ARP cache on HA is populated with a binding for
a host with the IP address IB and a MAC address MB.
Host HC can “poison” the ARP caches of HA and HB by broadcasting forged ARP responses with
bindings for a host with an IP address of IA (or IB) and a MAC address of MC. Hosts with poisoned
ARP caches use the MAC address MC as the destination MAC address for traffic intended for IA or IB.
This means that HC intercepts that traffic. Because HC knows the true MAC addresses associated with
IA and IB, HC can forward the intercepted traffic to those hosts using the correct MAC address as the
destination. HC has inserted itself into the traffic stream from HA to HB, the classic “man in the middle”
attack.
Purpose of Dynamic ARP Inspection
To prevent ARP poisoning attacks, a switch must ensure that only valid ARP requests and responses are
relayed. DAI prevents these attacks by intercepting all ARP requests and responses. Each of these
intercepted packets is verified for valid MAC address to IP address bindings before the local ARP cache
is updated or the packet is forwarded to the appropriate destination. Invalid ARP packets are dropped.
DAI determines the validity of an ARP packet based on valid MAC address to IP address bindings stored
in a trusted database. This database is built at runtime by DHCP snooping, provided this feature is
enabled on VLANs and on the switch. In addition, in order to handle hosts that use statically configured
IP addresses, DAI can also validate ARP packets against user-configured ARP ACLs.
DAI can also be configured to drop ARP packets when the IP addresses in the packet are invalid or when
the MAC addresses in the body of the ARP packet do not match the addresses specified in the Ethernet
header.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-2 OL-22250-01
Chapter 41 Configuring Dynamic ARP Inspection
About Dynamic ARP Inspection
Interface Trust State, Security Coverage and Network Configuration
DAI associates a trust state with each interface on the system. Packets arriving on trusted interfaces
bypass all DAI validation checks. Those arriving on untrusted interfaces go through the DAI validation
process. In a typical network configuration for DAI, all ports connected to host ports are configured as
untrusted, while all ports connected to switches are configured as trusted. With this configuration, all
ARP packets entering the network from a given switch pass the security check.
Figure 41-2 Validation of ARP Packets on a DAI-Enabled VLAN
DHCP server
Switch S1 Switch S2
Fa6/3 Fa3/3
Fa6/4 Fa3/4
94075
Host H1 Host H2
Use the trust state configuration carefully. Configuring interfaces as untrusted when they should be
trusted can result in a loss of connectivity. If we assume that both S1 and S2 (in Figure 41-2) run DAI
on the VLAN ports that contains H1 and H2, and if H1 and H2 were to acquire their IP addresses from
the DHCP server connected to S1, then only S1 binds the IP to MAC address of H1. Therefore, if the
interface between S1 and S2 is untrusted, the ARP packets from H1 get dropped on S2. This condition
would result in a loss of connectivity between H1 and H2.
Configuring interfaces to be trusted when they are actually untrusted leaves a security hole in the
network. If S1 were not running DAI, then H1 can easily poison the ARP of S2 (and H2, if the inter-
switch link is configured as trusted). This condition can occur even though S2 is running DAI.
DAI ensures that hosts (on untrusted interfaces) connected to a switch running DAI do not poison the
ARP caches of other hosts in the network. It does not, however, ensure that hosts from other portions of
the network do not poison the caches of the hosts connected to it.
To handle cases in which some switches in a VLAN run DAI and other switches do not, the interfaces
connecting such switches should be configured as untrusted. To validate the bindings of packets from
non-DAI switches, however, the switch running DAI should be configured with ARP ACLs. When it is
not feasible to determine such bindings, switches running DAI should be isolated from non-DAI
switches at Layer 3.
Note Depending on the setup of the DHCP server and the network, it may not be possible to perform validation
of a given ARP packet on all switches in the VLAN.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-3
Chapter 41 Configuring Dynamic ARP Inspection
About Dynamic ARP Inspection
Relative Priority of Static Bindings and DHCP Snooping Entries
As mentioned previously, DAI populates its database of valid MAC address to IP address bindings
through DHCP snooping. It also validates ARP packets against statically configured ARP ACLs. It is
important to note that ARP ACLs have precedence over entries in the DHCP snooping database. ARP
packets are first compared to user-configured ARP ACLs. If the ARP ACL denies the ARP packet, then
the packet is denied even if a valid binding exists in the database populated by DHCP snooping.
Logging of Dropped Packets
When the switch drops a packet, it places an entry in the log buffer and then generates system messages
on a rate-controlled basis. After the message is generated, the switch clears the entry from the log buffer.
Each log 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.
You use the ip arp inspection log-buffer global configuration command to configure the number of
entries in the buffer and the number of entries needed in the specified interval to generate system
messages. You specify the type of packets that are logged by using the ip arp inspection vlan logging
global configuration command. For configuration information, see the “Configuring the Log Buffer”
section on page 41-14.
Rate Limiting of ARP Packets
DAI performs validation checks in the CPU, so the number of incoming ARP packets is rate-limited to
prevent a denial of service attack. By default, the rate for untrusted interfaces is set to 15 pps second,
whereas trusted interfaces have no rate limit. When the rate of incoming ARP packets exceeds the
configured limit, the port is placed in the errdisable state. The port remains in that state until an
administrator intervenes. With the errdisable recovery global configuration command, you can enable
errdisable recovery so that ports emerge from this state automatically after a specified timeout period.
You use the ip arp inspection limit global configuration command to limit the rate of incoming ARP
requests and responses on the interface. Unless a rate limit is explicitly configured on an interface,
changing the trust state of the interface also changes its rate limit to the default value for that trust state;
that is, 15 packets per second for untrusted interfaces and unlimited for trusted interfaces. After a rate
limit is configured explicitly, the interface retains the rate limit even when its trust state is changed. At
any time, the interface reverts to its default rate limit if the no form of the rate limit command is applied.
For configuration information, see the “Limiting the Rate of Incoming ARP Packets” section on
page 41-16.
Note When you enable DAI, all ARP packets are forwarded by CPU (software forwarding, the slow path).
With this mechanism, whenever a packet exits through multiple ports, the CPU must create as many
copies of the packet as there are egress ports. So, the number of egress ports is a multiplying factor for
the CPU. Furthermore, when QoS policing is applied on egress packets that were forwarded by CPU,
QoS must be applied in the CPU as well. (You cannot apply QoS in hardware on CPU generated packets
because the hardware forwarding path is turned off for CPU generated packets.) Both factors can drive
the CPU to a very high utilization level.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-4 OL-22250-01
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Port Channels and Their Behavior
A given physical port can join a channel only when the trust state of the physical port and of the channel
match. Otherwise, the physical port remains suspended in the channel. A channel inherits its trust state
from the first physical port that joined the channel. Consequently, the trust state of the first physical port
need not match the trust state of the channel.
Conversely, when the trust state is changed on the channel, the new trust state is configured on all the
physical ports that comprise the channel.
The rate limit check on port channels is unique. The rate of incoming packets on a physical port is
checked against the port channel configuration rather than the physical ports’ configuration.
The rate limit configuration on a port channel is independent of the configuration on its physical ports.
The rate limit is cumulative across all physical ports; that is, the rate of incoming packets on a port
channel equals the sum of rates across all physical ports.
When you configure rate limits for ARP packets on trunks, you must account for VLAN aggregation
because a high rate limit on one VLAN can cause a “denial of service” attack to other VLANs when the
port is errdisabled by software. Similarly, when a port channel is errdisabled, a high rate limit on one
physical port can cause other ports in the channel to go down.
Configuring Dynamic ARP Inspection
These sections describe how to configure dynamic ARP inspection on your switch:
• Configuring Dynamic ARP Inspection in DHCP Environments, page 41-5 (required)
• Configuring ARP ACLs for Non-DHCP Environments, page 41-11 (optional)
• Configuring the Log Buffer, page 41-14 (optional)
• Limiting the Rate of Incoming ARP Packets, page 41-16 (optional)
• Performing Validation Checks, page 41-19 (optional)
Configuring Dynamic ARP Inspection in DHCP Environments
This procedure shows how to configure dynamic ARP inspection when two switches support this
feature. Host 1 is connected to Switch A, and Host 2 is connected to Switch B as shown in Figure 41-3.
Both switches are running dynamic ARP inspection on VLAN 100 where the hosts are located. A DHCP
server is connected to Switch A. Both hosts acquire their IP addresses from the same DHCP server.
Therefore, Switch A has the bindings for Host 1, and Switch B has the bindings for Host 2.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-5
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Figure 41-3 ARP Packet Validation on a VLAN Enabled for Dynamic ARP Inspection
DHCP server
Switch A Switch B
Port 1 Port 3
111751
Host 1 Host 2
Note Dynamic ARP inspection depends on the entries in the DHCP snooping binding database to verify
IP-to-MAC address bindings in incoming ARP requests and ARP responses. Make sure to enable DHCP
snooping to permit ARP packets that have dynamically assigned IP addresses. For configuration
information, see Chapter 40, “Configuring DHCP Snooping, IP Source Guard, and IPSG for Static
Hosts.”
For information on how to configure dynamic ARP inspection when only one switch supports the
feature, see the “Configuring ARP ACLs for Non-DHCP Environments” section on page 41-11.
To configure dynamic ARP inspection, perform this task on both switches:
Command Purpose
Step 1 Switch# show cdp neighbors Verifies the connection between the switches.
Step 2 Switch# configure terminal Enters global configuration mode.
Step 3 Switch(config)# [no] ip arp inspection vlan Enables dynamic ARP inspection on a per-VLAN basis. By
vlan-range default, dynamic ARP inspection is disabled on all VLANs.
To disable dynamic ARP inspection, use the
no ip arp inspection vlan vlan-range global configuration
command.
For vlan-range, specify a single VLAN identified by VLAN ID
number, a range of VLANs separated by a hyphen, or a series of
VLANs separated by a comma. The range is 1 to 4094.
Specify the same VLAN ID for both switches.
Step 4 Switch(config)# interface interface-id Specifies the interface connected to the other switch, and enter
interface configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-6 OL-22250-01
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Command Purpose
Step 5 Switch(config-if)# ip arp inspection trust Configures the connection between the switches as trusted.
To return the interfaces to an untrusted state, use the
no ip arp inspection trust interface configuration command.
By default, all interfaces are untrusted.
The switch does not check ARP packets that it receives from the
other switch on the trusted interface. It simply forwards the
packets.
For untrusted interfaces, the switch intercepts all ARP requests
and responses. It verifies that the intercepted packets have valid
IP-to-MAC address bindings before updating the local cache and
before forwarding the packet to the appropriate destination. The
switch drops invalid packets and logs them in the log buffer
according to the logging configuration specified with the
ip arp inspection vlan logging global configuration command.
For more information, see the “Configuring the Log Buffer”
section on page 41-14.
Step 6 Switch(config-if)# end Returns to privileged EXEC mode.
Step 7 Switch# show ip arp inspection interfaces Verifies the dynamic ARP inspection configuration.
Switch# show ip arp inspection vlan
vlan-range
Step 8 Switch# show ip dhcp snooping binding Verifies the DHCP bindings.
Step 9 Switch# show ip arp inspection statistics Checks the dynamic ARP inspection statistics.
vlan vlan-range
Step 10 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
This example shows how to configure dynamic ARP inspection on Switch A in VLAN 100. You would
perform a similar procedure on Switch B.
On Switch A
SwitchA# show cdp neighbors
Capability Codes: R - Router, T - Trans Bridge, B - Source Route Bridge
S - Switch, H - Host, I - IGMP, r - Repeater, P - Phone
Device ID Local Intrfce Holdtme Capability Platform Port ID
SwitchB Gig 3/48 179 R S I WS-C4506 Gig 3/46
SwitchA# configure terminal
SwitchA(config)# ip arp inspection vlan 100
SwitchA(config)# interface g3/48
SwitchA(config-if)# ip arp inspection trust
SwitchA(config-if)# end
SwitchA# show ip arp inspection interfaces
Interface Trust State Rate (pps) Burst Interval
--------------- ----------- ---------- --------------
Gi1/1 Untrusted 15 1
Gi1/2 Untrusted 15 1
Gi3/1 Untrusted 15 1
Gi3/2 Untrusted 15 1
Gi3/3 Untrusted 15 1
Gi3/4 Untrusted 15 1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-7
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Gi3/5 Untrusted 15 1
Gi3/6 Untrusted 15 1
Gi3/7 Untrusted 15 1
Gi3/8 Untrusted 15 1
Gi3/9 Untrusted 15 1
Gi3/10 Untrusted 15 1
Gi3/11 Untrusted 15 1
Gi3/12 Untrusted 15 1
Gi3/13 Untrusted 15 1
Gi3/14 Untrusted 15 1
Gi3/15 Untrusted 15 1
Gi3/16 Untrusted 15 1
Gi3/17 Untrusted 15 1
Gi3/18 Untrusted 15 1
Gi3/19 Untrusted 15 1
Gi3/20 Untrusted 15 1
Gi3/21 Untrusted 15 1
Gi3/22 Untrusted 15 1
Gi3/23 Untrusted 15 1
Gi3/24 Untrusted 15 1
Gi3/25 Untrusted 15 1
Gi3/26 Untrusted 15 1
Gi3/27 Untrusted 15 1
Gi3/28 Untrusted 15 1
Gi3/29 Untrusted 15 1
Gi3/30 Untrusted 15 1
Gi3/31 Untrusted 15 1
Gi3/32 Untrusted 15 1
Gi3/33 Untrusted 15 1
Gi3/34 Untrusted 15 1
Gi3/35 Untrusted 15 1
Gi3/36 Untrusted 15 1
Gi3/37 Untrusted 15 1
Gi3/38 Untrusted 15 1
Gi3/39 Untrusted 15 1
Gi3/40 Untrusted 15 1
Gi3/41 Untrusted 15 1
Gi3/42 Untrusted 15 1
Gi3/43 Untrusted 15 1
Gi3/44 Untrusted 15 1
Gi3/45 Untrusted 15 1
Gi3/46 Untrusted 15 1
Gi3/47 Untrusted 15 1
Gi3/48 Trusted None N/A
SwitchA# show ip arp inspection vlan 100
Source Mac Validation : Disabled
Destination Mac Validation : Disabled
IP Address Validation : Disabled
Vlan Configuration Operation ACL Match Static ACL
---- ------------- --------- --------- ----------
100 Enabled Active
Vlan ACL Logging DHCP Logging
---- ----------- ------------
100 Deny Deny
SwitchA# show ip dhcp snooping binding
MacAddress IpAddress Lease(sec) Type VLAN Interface
------------------ --------------- ---------- ------------- ---- --------------------
00:01:00:01:00:01 170.1.1.1 3597 dhcp-snooping 100 GigabitEthernet3/27
Total number of bindings: 1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-8 OL-22250-01
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
SwitchA# show ip arp inspection statistics vlan 100
Vlan Forwarded Dropped DHCP Drops ACL Drops
---- --------- ------- ---------- ---------
100 15 0 0 0
Vlan DHCP Permits ACL Permits Source MAC Failures
---- ------------ ----------- -------------------
100 0 0 0
Vlan Dest MAC Failures IP Validation Failures Invalid Protocol Data
---- ----------------- ---------------------- ---------------------
100 0 0 0
SwitchA#
On Switch B
SwitchB# show cdp neighbors
Capability Codes: R - Router, T - Trans Bridge, B - Source Route Bridge
S - Switch, H - Host, I - IGMP, r - Repeater, P - Phone
Device ID Local Intrfce Holdtme Capability Platform Port ID
SwitchA Gig 3/46 163 R S I WS-C4507R Gig 3/48
SwitchB#
SwitchB# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
SwitchB(config)# ip arp inspection vlan 100
SwitchB(config)# interface g3/46
SwitchB(config-if)# ip arp inspection trust
SwitchB(config-if)# end
SwitchB#
SwitchB# show ip arp inspection interfaces
Interface Trust State Rate (pps) Burst Interval
--------------- ----------- ---------- --------------
Gi1/1 Untrusted 15 1
Gi1/2 Untrusted 15 1
Gi3/1 Untrusted 15 1
Gi3/2 Untrusted 15 1
Gi3/3 Untrusted 15 1
Gi3/4 Untrusted 15 1
Gi3/5 Untrusted 15 1
Gi3/6 Untrusted 15 1
Gi3/7 Untrusted 15 1
Gi3/8 Untrusted 15 1
Gi3/9 Untrusted 15 1
Gi3/10 Untrusted 15 1
Gi3/11 Untrusted 15 1
Gi3/12 Untrusted 15 1
Gi3/13 Untrusted 15 1
Gi3/14 Untrusted 15 1
Gi3/15 Untrusted 15 1
Gi3/16 Untrusted 15 1
Gi3/17 Untrusted 15 1
Gi3/18 Untrusted 15 1
Gi3/19 Untrusted 15 1
Gi3/20 Untrusted 15 1
Gi3/21 Untrusted 15 1
Gi3/22 Untrusted 15 1
Gi3/23 Untrusted 15 1
Gi3/24 Untrusted 15 1
Gi3/25 Untrusted 15 1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-9
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Gi3/26 Untrusted 15 1
Gi3/27 Untrusted 15 1
Gi3/28 Untrusted 15 1
Gi3/29 Untrusted 15 1
Gi3/30 Untrusted 15 1
Gi3/31 Untrusted 15 1
Gi3/32 Untrusted 15 1
Gi3/33 Untrusted 15 1
Gi3/34 Untrusted 15 1
Gi3/35 Untrusted 15 1
Gi3/36 Untrusted 15 1
Gi3/37 Untrusted 15 1
Gi3/38 Untrusted 15 1
Gi3/39 Untrusted 15 1
Gi3/40 Untrusted 15 1
Gi3/41 Untrusted 15 1
Gi3/42 Untrusted 15 1
Gi3/43 Untrusted 15 1
Gi3/44 Untrusted 15 1
Gi3/45 Untrusted 15 1
Gi3/46 Trusted None N/A
Gi3/47 Untrusted 15 1
Gi3/48 Untrusted 15 1
SwitchB# show ip arp inspection vlan 100
Source Mac Validation : Disabled
Destination Mac Validation : Disabled
IP Address Validation : Disabled
Vlan Configuration Operation ACL Match Static ACL
---- ------------- --------- --------- ----------
100 Enabled Active
Vlan ACL Logging DHCP Logging
---- ----------- ------------
100 Deny Deny#
SwitchB# show ip dhcp snooping binding
MacAddress IpAddress Lease(sec) Type VLAN Interface
------------------ --------------- ---------- ------------- ---- --------------------
00:02:00:02:00:02 170.1.1.2 3492 dhcp-snooping 100 GigabitEthernet3/31
Total number of bindings: 1
SwitchB# show ip arp insp statistics vlan 100
Vlan Forwarded Dropped DHCP Drops ACL Drops
---- --------- ------- ---------- ---------
100 2398 0 0 0
Vlan DHCP Permits ACL Permits Source MAC Failures
---- ------------ ----------- -------------------
100 2398 0 0
Vlan Dest MAC Failures IP Validation Failures Invalid Protocol Data
---- ----------------- ---------------------- ---------------------
100 0 0 0
SwitchB#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-10 OL-22250-01
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Configuring ARP ACLs for Non-DHCP Environments
This procedure shows how to configure dynamic ARP inspection when Switch B shown in Figure 41-3
on page 41-6 does not support dynamic ARP inspection or DHCP snooping.
If you configure port 1 on Switch A as trusted, a security hole is created because both Switch A and
Host 1 could be attacked by either Switch B or Host 2. To prevent this possibility, you must configure
port 1 on Switch A as untrusted. To permit ARP packets from Host 2, you must set up an ARP ACL and
apply it to VLAN 100. If the IP address of Host 2 is not static, such that it is impossible to apply the
ACL configuration on Switch A, you must separate Switch A from Switch B at Layer 3 and use a router
to route packets between them.
To configure an ARP ACL (on switch A in a non-DHCP environment), perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# arp access-list acl-name Defines an ARP ACL, and enter ARP access-list
configuration mode. By default, no ARP access lists
are defined.
Note At the end of the ARP access list, there is an
implicit deny ip any mac any command.
Step 3 Switch(config-arp-nac)# permit ip host sender-ip mac Permits ARP packets from the specified host (Host
host sender-mac [log] 2).
• For sender-ip, enter the IP address of Host 2.
• For sender-mac, enter the MAC address of
Host 2.
• (Optional) Specify log to log a packet in the log
buffer when it matches the access control entry
(ACE). Matches are logged if you also configure
the matchlog keyword in the ip arp inspection
vlan logging global configuration command. For
more information, see the “Configuring the Log
Buffer” section on page 41-14.
Step 4 Switch(config-arp-nac)# exit Returns to global configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-11
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Command Purpose
Step 5 Switch(config)# ip arp inspection filter arp-acl-name Applies the ARP ACL to the VLAN. By default, no
vlan vlan-range [static] defined ARP ACLs are applied to any VLAN.
• For arp-acl-name, specify the name of the ACL
created in Step 2.
• For vlan-range, specify the VLAN that the
switches and hosts are in. You can specify a
single VLAN identified by VLAN ID number, a
range of VLANs separated by a hyphen, or a
series of VLANs separated by a comma. The
range is 1 to 4094.
• (Optional) Specify static to treat implicit denies
in the ARP ACL as explicit denies and to drop
packets that do not match any previous clauses in
the ACL. DHCP bindings are not used.
If you do not specify this keyword, it means that
there is no explicit deny in the ACL that denies
the packet, and DHCP bindings determine
whether a packet is permitted or denied if the
packet does not match any clauses in the ACL.
ARP packets containing only IP-to-MAC address
bindings are compared against the ACL. Packets are
permitted only if the access list permits them.
Step 6 Switch(config)# interface interface-id Specifies the Switch A interface that is connected to
Switch B, and enter interface configuration mode.
Step 7 Switch(config-if)# no ip arp inspection trust Configures the Switch A interface that is connected to
Switch B as untrusted.
By default, all interfaces are untrusted.
For untrusted interfaces, the switch intercepts all
ARP requests and responses. It verifies that the
intercepted packets have valid IP-to-MAC address
bindings before updating the local cache and before
forwarding the packet to the appropriate destination.
The switch drops invalid packets and logs them in the
log buffer according to the logging configuration
specified with the ip arp inspection vlan logging
global configuration command. For more
information, see the “Configuring the Log Buffer”
section on page 41-14.
Step 8 Switch(config-if)# end Returns to privileged EXEC mode.
Step 9 Switch# show arp access-list [acl-name] Verifies the dynamic ARP inspection configuration.
Switch# show ip arp inspection vlan vlan-range
Switch# show ip arp inspection interfaces
Step 10 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration
file.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-12 OL-22250-01
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
To remove the ARP ACL, use the no arp access-list global configuration command. To remove the ARP
ACL attached to a VLAN, use the no ip arp inspection filter arp-acl-name vlan vlan-range global
configuration command.
This example shows how to configure an ARP ACL called host2 on Switch A, to permit ARP packets
from HostB (IP address 170.1.1.2 and MAC address 2.2.2), to apply the ACL to VLAN 100, and to
configure port 1 on Switch A as untrusted:
SwitchA# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
SwitchA(config)# arp access-list hostB
SwitchA(config-arp-nacl)# permit ip host 170.1.1.2 mac host 2.2.2 log
SwitchA(config-arp-nacl)# exit
SwitchA(config)# ip arp inspection filter hostB vlan 100 static
SwitchA(config)# interface g3/48
SwitchA(config-if)# no ip arp inspection trust
SwitchA(config-if)# end
SwitchA# show arp access-list hostB
ARP access list hostB
permit ip host 170.1.1.2 mac host 0002.0002.0002 log
SwitchA# show ip arp inspection interfaces
Interface Trust State Rate (pps) Burst Interval
--------------- ----------- ---------- --------------
Gi1/1 Untrusted 15 1
Gi1/2 Untrusted 15 1
Gi3/1 Untrusted 15 1
Gi3/2 Untrusted 15 1
Gi3/3 Untrusted 15 1
Gi3/4 Untrusted 15 1
Gi3/5 Untrusted 15 1
Gi3/6 Untrusted 15 1
Gi3/7 Untrusted 15 1
Gi3/8 Untrusted 15 1
Gi3/9 Untrusted 15 1
Gi3/10 Untrusted 15 1
Gi3/11 Untrusted 15 1
Gi3/12 Untrusted 15 1
Gi3/13 Untrusted 15 1
Gi3/14 Untrusted 15 1
Gi3/15 Untrusted 15 1
Gi3/16 Untrusted 15 1
Gi3/17 Untrusted 15 1
Gi3/18 Untrusted 15 1
Gi3/19 Untrusted 15 1
Gi3/20 Untrusted 15 1
Gi3/21 Untrusted 15 1
Gi3/22 Untrusted 15 1
Gi3/23 Untrusted 15 1
Gi3/24 Untrusted 15 1
Gi3/25 Untrusted 15 1
Gi3/26 Untrusted 15 1
Gi3/27 Untrusted 15 1
Gi3/28 Untrusted 15 1
Gi3/29 Untrusted 15 1
Gi3/30 Untrusted 15 1
Gi3/31 Untrusted 15 1
Gi3/32 Untrusted 15 1
Gi3/33 Untrusted 15 1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-13
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Gi3/34 Untrusted 15 1
Gi3/35 Untrusted 15 1
Gi3/36 Untrusted 15 1
Gi3/37 Untrusted 15 1
Gi3/38 Untrusted 15 1
Gi3/39 Untrusted 15 1
Gi3/40 Untrusted 15 1
Gi3/41 Untrusted 15 1
Gi3/42 Untrusted 15 1
Gi3/43 Untrusted 15 1
Gi3/44 Untrusted 15 1
Gi3/45 Untrusted 15 1
Gi3/46 Untrusted 15 1
Gi3/47 Untrusted 15 1
Gi3/48 Untrusted 15 1
SwitchA# show ip arp inspection statistics vlan 100
Vlan Forwarded Dropped DHCP Drops ACL Drops
---- --------- ------- ---------- ---------
100 15 169 160 9
Vlan DHCP Permits ACL Permits Source MAC Failures
---- ------------ ----------- -------------------
100 0 0 0
Vlan Dest MAC Failures IP Validation Failures Invalid Protocol Data
---- ----------------- ---------------------- ---------------------
100 0 0 0
SwitchA#
Configuring the Log Buffer
When the switch drops a packet, it places an entry in the log buffer and then generates system messages
on a rate-controlled basis. After the message is generated, the switch clears the entry from the log buffer.
Each log 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.
A log-buffer entry can represent more than one packet. For example, if an interface receives many
packets on the same VLAN with the same ARP parameters, the switch combines the packets as one entry
in the log buffer and generates a single system message for the entry.
If the log buffer overflows, it means that a log event does not fit into the log buffer, and the display for
the show ip arp inspection log privileged EXEC command is affected. No other statistics are provided
for the entry.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-14 OL-22250-01
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
To configure the log buffer, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ip arp inspection Configures the dynamic ARP inspection logging buffer.
log-buffer { entries number | logs
number interval seconds} By default, when dynamic ARP inspection is enabled, denied or dropped
ARP packets are logged. The number of log entries is 32. The number of
system messages is limited to 5 per second. The logging-rate interval is 1
second.
The keywords have these meanings:
• For entries number, specify the number of entries to be logged in the
buffer. The range is 0 to 1024.
• For logs number interval seconds, specify the number of entries to
generate system messages in the specified interval.
For logs number, the range is 0 to 1024. A 0 value means that the entry
is placed in the log buffer, but a system message is not generated.
For interval seconds, the range is 0 to 86400 seconds (1 day). A 0 value
means that a system message is immediately generated (and the log
buffer is always empty).
An interval setting of 0 overrides a log setting of 0.
The logs and interval settings interact. If the logs number X is greater than
interval seconds Y, X divided by Y (X/Y) system messages are sent every
second. Otherwise, one system message is sent every Y divided by X (Y/X)
seconds.
Step 3 Switch(config)# [no] ip arp Controls the type of packets that are logged per VLAN. By default, all
inspection vlan vlan-range logging denied or all dropped packets are logged. The term logged means the entry
{acl-match {matchlog | none} |
dhcp-bindings { all | none | permit}}
is placed in the log buffer and a system message is generated.
The keywords have these meanings:
• For vlan-range, specify a single VLAN identified by VLAN ID number,
a range of VLANs separated by a hyphen, or a series of VLANs
separated by a comma. The range is 1 to 4094.
• For acl-match matchlog, log packets based on the ACE logging
configuration. If you specify the matchlog keyword in this command
and the log keyword in the permit or deny ARP access-list
configuration command, ARP packets permitted or denied by ACEs
with log keyword are logged.
• For acl-match none, do not log packets that match ACLs.
• For dhcp-bindings all, log all packets that match DHCP bindings.
• For dhcp-bindings none, do not log packets that match DHCP
bindings.
• For dhcp-bindings permit, log DHCP-binding permitted packets.
Step 4 Switch(config)# exit Returns to privileged EXEC mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-15
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Command Purpose
Step 5 Switch# show ip arp inspection Verifies your settings.
log
Step 6 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To return to the default log buffer settings, use the no ip arp inspection log-buffer global configuration
command. To return to the default VLAN log settings, use the
no ip arp inspection vlan vlan-range logging {acl-match | dhcp-bindings} global configuration
command. To clear the log buffer, use the clear ip arp inspection log privileged EXEC command.
This example shows how to configure the number of entries for the log buffer to 1024. It also shows how
to configure your Catalyst 4500 series switch so that the logs must be generated from the buffer at the
rate of 100 per 10 seconds.
SwitchB# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
SwitchB(config)# ip arp inspection log-buffer entries 1024
SwitchB(config)# ip arp inspection log-buffer logs 100 interval 10
SwitchB(config)# end
SwitchB# show ip arp inspection log
Total Log Buffer Size : 1024
Syslog rate : 100 entries per 10 seconds.
Interface Vlan Sender MAC Sender IP Num Pkts Reason Time
---------- ---- -------------- --------------- --------- ----------- ----
Gi3/31 100 0002.0002.0003 170.1.1.2 5 DHCP Deny 02:05:45 UTC
Fri Feb 4 2005
SwitchB#
Limiting the Rate of Incoming ARP Packets
The switch CPU performs dynamic ARP inspection validation checks; therefore, the number of
incoming ARP packets is rate-limited to prevent a denial-of-service attack.
Note Unless you explicitly configure a rate limit on an interface, changing the trust state of the interface also
changes its rate limit to the default value for that trust state. After you configure the rate limit, the
interface retains the rate limit even when its trust state is changed. If you enter the
no ip arp-inspection limit interface configuration command, the interface reverts to its default rate
limit.
By default, the switch places the port in the error-disabled state when the rate of incoming ARP packets
exceeds the configured limit. To prevent the port from shutting down, use the errdisable detect cause
arp-inspection action shutdown vlan global configuration command to shut down just the offending
VLAN on the port where the violation occurred.
When a port is in the error-disabled state, you can bring it out of this state automatically by configuring
the errdisable recovery cause arp-inspection global configuration command or you can manually
reenable it by entering the shutdown and no shut down interface configuration commands. If a port is
in per-VLAN errdisable mode, you can also use clear errdisable interface name vlan range command
to re-enable the VLAN on the port.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-16 OL-22250-01
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
To limit the rate of incoming ARP packets, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# errdisable detect Enables per-VLAN error-disable detection.
cause arp-inspection [action shutdown
vlan] Note By default this command is enabled, and when a violation
occurs the interface is shutdown.
Step 3 Switch(config)# interface Specifies the interface to be rate-limited, and enters interface
interface-id configuration mode.
Step 4 Switch(config-if)# [no] ip arp Limits the rate of incoming ARP requests and responses on the
inspection limit { rate pps [burst interface.
interval seconds] | none}
The default rate is 15 pps on untrusted interfaces and unlimited on
trusted interfaces. The burst interval is 1 second.
The keywords have these meanings:
• For rate pps, specify an upper limit for the number of incoming
packets processed per second. The range is 0 to 2048 pps.
• (Optional) For burst interval seconds, specify the consecutive
interval in seconds, over which the interface is monitored for a high
rate of ARP packets.The range is 1 to 15.
• For rate none, specify no upper limit for the rate of incoming ARP
packets that can be processed.
Step 5 Switch(config-if)# exit Returns to global configuration mode.
Step 6 Switch(config)# errdisable recovery (Optional) Enables error recovery from the dynamic ARP inspection
{cause arp-inspection | error-disable state.
interval interval}
By default, recovery is disabled, and the recovery interval is 300
seconds.
For interval interval, specify the time in seconds to recover from the
error-disable state. The range is 30 to 86400.
Step 7 Switch(config)# exit Returns to privileged EXEC mode.
Step 8 Switch# show ip arp inspection Verifies your settings.
interfaces
Step 9 Switch# show errdisable recovery Verifies your settings.
Step 10 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To return to the default rate-limit configuration, use the no ip arp inspection limit interface
configuration command. To disable error recovery for dynamic ARP inspection, use the
no errdisable recovery cause arp-inspection global configuration command.
This example shows how to set an upper limit for the number of incoming packets (100 pps) and to
specify a burst interval (1 second):
SwitchB# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
SwitchB(config)# interface g3/31
SwitchB(config-if)# ip arp inspection limit rate 100 burst interval 1
SwitchB(config-if)# exit
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-17
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
SwitchB(config)# errdisable recovery cause arp-inspection
SwitchB(config)# exit
SwitchB# show ip arp inspection interfaces
Interface Trust State Rate (pps) Burst Interval
--------------- ----------- ---------- --------------
Gi1/1 Untrusted 15 1
Gi1/2 Untrusted 15 1
Gi3/1 Untrusted 15 1
Gi3/2 Untrusted 15 1
Gi3/3 Untrusted 15 1
Gi3/4 Untrusted 15 1
Gi3/5 Untrusted 15 1
Gi3/6 Untrusted 15 1
Gi3/7 Untrusted 15 1
Gi3/8 Untrusted 15 1
Gi3/9 Untrusted 15 1
Gi3/10 Untrusted 15 1
Gi3/11 Untrusted 15 1
Gi3/12 Untrusted 15 1
Gi3/13 Untrusted 15 1
Gi3/14 Untrusted 15 1
Gi3/15 Untrusted 15 1
Gi3/16 Untrusted 15 1
Gi3/17 Untrusted 15 1
Gi3/18 Untrusted 15 1
Gi3/19 Untrusted 15 1
Gi3/20 Untrusted 15 1
Gi3/21 Untrusted 15 1
Gi3/22 Untrusted 15 1
Gi3/23 Untrusted 15 1
Gi3/24 Untrusted 15 1
Gi3/25 Untrusted 15 1
Gi3/26 Untrusted 15 1
Gi3/27 Untrusted 15 1
Gi3/28 Untrusted 15 1
Gi3/29 Untrusted 15 1
Gi3/30 Untrusted 15 1
Gi3/31 Untrusted 100 1
Gi3/32 Untrusted 15 1
Gi3/33 Untrusted 15 1
Gi3/34 Untrusted 15 1
Gi3/35 Untrusted 15 1
Gi3/36 Untrusted 15 1
Gi3/37 Untrusted 15 1
Gi3/38 Untrusted 15 1
Gi3/39 Untrusted 15 1
Gi3/40 Untrusted 15 1
Gi3/41 Untrusted 15 1
Gi3/42 Untrusted 15 1
Gi3/43 Untrusted 15 1
Gi3/44 Untrusted 15 1
Gi3/45 Untrusted 15 1
Gi3/46 Trusted None N/A
Gi3/47 Untrusted 15 1
Gi3/48 Untrusted 15 1
SwitchB# show errdisable recovery
ErrDisable Reason Timer Status
----------------- --------------
udld Disabled
bpduguard Disabled
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-18 OL-22250-01
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
security-violatio Disabled
channel-misconfig Disabled
vmps Disabled
pagp-flap Disabled
dtp-flap Disabled
link-flap Disabled
l2ptguard Disabled
psecure-violation Disabled
gbic-invalid Disabled
dhcp-rate-limit Disabled
unicast-flood Disabled
storm-control Disabled
arp-inspection Enabled
Timer interval: 300 seconds
Interfaces that will be enabled at the next timeout:
SwitchB#
1w2d: %SW_DAI-4-PACKET_RATE_EXCEEDED: 101 packets received in 739 milliseconds on Gi3/31.
1w2d: %PM-4-ERR_DISABLE: arp-inspection error detected on Gi3/31, putting Gi3/31 in
err-disable state
SwitchB# show clock
*02:21:43.556 UTC Fri Feb 4 2005
SwitchB#
SwitchB# show interface g3/31 status
Port Name Status Vlan Duplex Speed Type
Gi3/31 err-disabled 100 auto auto 10/100/1000-TX
SwitchB#
SwitchB#
1w2d: %PM-4-ERR_RECOVER: Attempting to recover from arp-inspection err-disable state on
Gi3/31
SwitchB# show interface g3/31 status
Port Name Status Vlan Duplex Speed Type
Gi3/31 connected 100 a-full a-100 10/100/1000-TX
SwitchB# show clock
*02:27:40.336 UTC Fri Feb 4 2005
SwitchB#
Performing Validation Checks
Dynamic ARP inspection intercepts, logs, and discards ARP packets with invalid IP-to-MAC address
bindings. You can configure the switch to perform additional checks on the destination MAC address,
the sender and target IP addresses, and the source MAC address.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-19
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
To perform specific checks on incoming ARP packets, perform this task.
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ip arp inspection Performs a specific check on incoming ARP packets. By default, no
validate {[src-mac] [dst-mac] [ip]} additional checks are performed.
The keywords have these meanings:
• For src-mac, check 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.
• For dst-mac, check the destination MAC address in the Ethernet header
against the target MAC address in ARP body. This check is performed
for ARP responses. When enabled, packets with different MAC
addresses are classified as invalid and are dropped.
• For ip, check 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, and target IP addresses are checked only in ARP responses.
You must specify at least one of the keywords. Each command overrides the
configuration of the previous command; that is, if a command enables src
and dst mac validations, and a second command enables IP validation only,
the src and dst mac validations are disabled as a result of the second
command.
Step 3 Switch(config)# exit Returns to privileged EXEC mode.
Step 4 Switch# show ip arp inspection Verifies your settings.
vlan vlan-range
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To disable checking, use the no ip arp inspection validate [src-mac] [dst-mac] [ip] global
configuration command. To display statistics for forwarded, dropped, MAC validation failure, and IP
validation failure packets, use the show ip arp inspection statistics privileged EXEC command.
This example shows how to configure source mac validation. Packets are dropped and an error message
may be generated when the source address in the Ethernet header does not match the sender hardware
address in the ARP body.
SwitchB# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
SwitchB(config)# ip arp inspection validate src-mac
SwitchB(config)# exit
SwitchB# show ip arp inspection vlan 100
Source Mac Validation : Enabled
Destination Mac Validation : Disabled
IP Address Validation : Disabled
Vlan Configuration Operation ACL Match Static ACL
---- ------------- --------- --------- ----------
100 Enabled Active
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-20 OL-22250-01
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Vlan ACL Logging DHCP Logging
---- ----------- ------------
100 Deny Deny
SwitchB#
1w2d: %SW_DAI-4-INVALID_ARP: 9 Invalid ARPs (Req) on Gi3/31, vlan
100.([0002.0002.0002/170.1.1.2/0001.0001.0001/170.1.1.1/02:30:24 UTC Fri Feb 4 2005])
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 41-21
Chapter 41 Configuring Dynamic ARP Inspection
Configuring Dynamic ARP Inspection
Software Configuration Guide—Release IOS-XE 3.1.0 SG
41-22 OL-22250-01
CH A P T E R 42
Configuring Network Security with ACLs
This chapter describes how to use access control lists (ACLs) to configure network security on the
Catalyst 4500 series switches.
Note The Catalyst 4500 series switch supports time-based ACLs.
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
This chapter consists of the following major sections:
• About ACLs, page 42-2
• Hardware and Software ACL Support, page 42-5
• TCAM Programming and ACLs, page 42-6
• Layer 4 Operators in ACLs, page 42-9
• Configuring Unicast MAC Address Filtering, page 42-12
• Configuring Named MAC Extended ACLs, page 42-12
• Configuring EtherType Matching, page 42-14
• Configuring Named IPv6 ACLs, page 42-15
• Applying IPv6 ACLs to a Layer 2 Interface, page 42-16
• Applying IPv6 ACLs to a Layer 2 Interface, page 42-16
• Configuring VLAN Maps, page 42-17
• Displaying VLAN Access Map Information, page 42-24
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-1
Chapter 42 Configuring Network Security with ACLs
About ACLs
• Using VLAN Maps with Router ACLs, page 42-25
• Configuring PACLs, page 42-27
• Using PACL with VLAN Maps and Router ACLs, page 42-31
About ACLs
This section contains the following subsections:
• ACL Overview, page 42-2
• Supported Features That Use ACLs, page 42-3
• Router ACLs, page 42-3
• Port ACLs, page 42-4
• VLAN Maps, page 42-5
ACL Overview
An ACL is a collection of sequential permit and deny conditions that applies to packets. When a packet
is received on an interface, the switch compares the fields in the packet against any applied ACLs to
verify that the packet has the permissions required to be forwarded, based on the conditions specified in
the access lists. It tests the packets against the conditions in an access list one-by-one. The first match
determines whether the switch accepts or rejects the packets. Because the switch stops testing conditions
after the first match, the order of conditions in the list is critical. If no conditions match, the switch drops
the packet. If there are no restrictions, the switch forwards the packet; otherwise, the switch drops the
packet.
Switches traditionally operate at Layer 2, switching traffic within a VLAN, whereas routers route traffic
between VLANs at Layer 3. The Catalyst 4500 series switch can accelerate packet routing between
VLANs by using Layer 3 switching. The Layer 3 switch bridges the packet, and then routes the packet
internally without going to an external router. The packet is then bridged again and sent to its destination.
During this process, the switch can control all packets, including packets bridged within a VLAN.
You configure access lists on a router or switch to filter traffic and provide basic security for your
network. If you do not configure ACLs, all packets passing through the switch could be allowed on all
parts of the network. You can use ACLs to control which hosts can access different parts of a network
or to decide which types of traffic are forwarded or blocked at router interfaces. For example, you can
allow e-mail traffic to be forwarded but not Telnet traffic. ACLs can be configured to block inbound
traffic, outbound traffic, or both. However, on Layer 2 interfaces, you can apply ACLs only in the
inbound direction.
An ACL contains an ordered list of access control entries (ACEs). Each ACE specifies permit or deny
and a set of conditions the packet must satisfy in order to match the ACE. The meaning of permit or deny
depends on the context in which the ACL is used.
The Catalyst 4500 series switch supports three types of ACLs:
• IPv4 ACLs, which filter IPv4 traffic, including TCP, the User Datagram Protocol (UDP), Internet
Group Management Protocol (IGMP), and Internet Control Message Protocol (ICMP)
• IPv6 ACLs, which filter IPv6 traffic
• MAC ACLs, which filter non-IPv4, non-IPv6 traffic
Software Configuration Guide—IOS-XE 3.1.0 SG
42-2 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
About ACLs
Supported Features That Use ACLs
The switch supports two applications of ACLs to filter traffic:
• Router ACLs are applied to Layer 3 interfaces. They control the access of routed traffic between
VLANs. All Catalyst 4500 series switches can create router ACLs, but you must have a Cisco IOS
software image on your switch to apply an ACL to a Layer 3 interface and filter packets routed
between VLANs.
• Port ACLs perform access control on traffic entering a Layer 2 interface. If there are not enough
hardware CAM entries, the output port ACL is not applied to the port and a warning message is
given to user. (This restriction applies to all access group modes for output port ACLs.) When there
are enough CAM entries, the output port ACL might be reapplied.
If there is any output port ACL configured on a Layer 2 port, then no VACL or router ACL can be
configured on the VLANs that the Layer 2 port belongs to. Also, the reverse is true: port ACLs and
VLAN-based ACLs (VACLs and router ACLs) are mutually exclusive on a Layer 2 port. This
restriction applies to all access group modes. On the input direction, port ACLs, VLAN-based
ACLs, and router ACLs can co-exist.
You can apply only one IPv4 access list, one IPv6 access list, and one MAC access list to any given
Layer 2 interface.
• VLAN ACLs or VLAN maps control the access of all packets (bridged and routed). You can use
VLAN maps to filter traffic between devices in the same VLAN. You do not need the enhanced
image to create or apply VLAN maps. VLAN maps are configured to control access based on
Layer 3 addresses for IP. MAC addresses using Ethernet ACEs control the access of unsupported
protocols. After you apply a VLAN map to a VLAN, all packets (routed or bridged) entering the
VLAN are checked against that map. Packets can either enter the VLAN through a switch port or
through a routed port after being routed.
You can use both router ACLs and VLAN maps on the same switch.
Router ACLs
You can apply one access-list of each supported type to an interface.
Multiple features can use one ACL for a given interface, and one feature can use multiple ACLs. When
a single router ACL is used by multiple features, it is examined multiple times. The access list type
determines the input to the matching operation:
• Standard IP access lists use source addresses for matching operations.
• Extended IP access lists use source and destination addresses and optional protocol type information
for matching operations.
The switch examines ACLs associated with features configured on a given interface and a direction. As
packets enter the switch on an interface, ACLs associated with all inbound features configured on that
interface are examined. After packets are routed and before they are forwarded to the next hop, all ACLs
associated with outbound features configured on the egress interface are examined.
ACLs permit or deny packet forwarding based on how the packet matches the entries in the ACL. For
example, you can use access lists to allow one host to access a part of a network, but prevent another
host from accessing the same part. In Figure 42-1, ACLs applied at the router input allow Host A to
access the Human Resources network, but prevent Host B from accessing the same network.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-3
Chapter 42 Configuring Network Security with ACLs
About ACLs
Figure 42-1 Using ACLs to Control Traffic to a Network
Catalyst 4500 series switch
Host A
Si
Host B
Human Research &
Resources Development
network network
= ACL denying traffic from Host B
94152
and permitting traffic from Host A
= Packet
Port ACLs
You can also apply ACLs to Layer 2 interfaces on a switch. Port ACLs are supported on physical
interfaces and EtherChannel interfaces.
The following access lists are supported on Layer 2 interfaces:
• Standard IP access lists using source addresses
• Extended IP access lists using source and destination addresses and optional protocol type
information
• IPv6 access lists using source and destination addresses and optional protocol type information
• MAC extended access lists using source and destination MAC addresses and optional protocol type
information
As with router ACLs, the switch examines ACLs associated with features configured on a given
interface and permits or denies packet forwarding based on how the packet matches the entries in the
ACL. In the example in Figure 42-1, if all workstations were in the same VLAN, ACLs applied at the
Layer 2 input would allow Host A to access the Human Resources network, but prevent Host B from
accessing the same network.
When you apply a port ACL to a trunk port, the ACL filters traffic on all VLANs present on the trunk
port. When you apply a port ACL to a port with voice VLAN, the ACL filters traffic on both data and
voice VLANs.
With port ACLs, you can filter IPv4 traffic by using IPv4 access lists, , IPv6 traffic by using IPv6 access
lists , and non-IPv4 traffic by using MAC access lists. You can filter IPv4, IPv6, and non-IP traffic on
the same Layer 2 interface by applying IPv4, IPv6, and MAC access lists to the interface.
Software Configuration Guide—IOS-XE 3.1.0 SG
42-4 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Hardware and Software ACL Support
Note You cannot apply more than one access list of a given type to a Layer 2 interface. If an access list of a
given type is already configured on a Layer 2 interface and you apply a new access list of that type to
the interface, the new ACL replaces the previously configured one.
VLAN Maps
VLAN maps can control the access of all traffic in a VLAN. You can apply VLAN maps on the switch
to all packets that are routed into or out of a VLAN or are bridged within a VLAN. Unlike router ACLs,
VLAN maps are not defined by direction (input or output).
You can configure VLAN maps to match Layer 3 addresses for IPv4 traffic. Access of all non-IPv4,
non-IPv6 protocols is controlled with a MAC address and an Ethertype using MAC ACLs in VLAN
maps. (IP traffic is not controlled by MAC ACLs in VLAN maps.) You can enforce VLAN maps only
on packets going through the switch; you cannot enforce VLAN maps on traffic between hosts on a hub
or on another switch connected to this switch.
With VLAN maps, forwarding packets is permitted or denied, based on the action specified in the map.
Figure 42-2 illustrates how a VLAN map is applied to deny a specific type of traffic from Host A in
VLAN 10 from being forwarded.
Figure 42-2 Using VLAN Maps to Control Traffic
Si
Host A Catalyst 4500 series switch Host B
(VLAN 10) (VLAN 10)
= VLAN map denying specific type
94153
of traffic from Host A
= Packet
Hardware and Software ACL Support
This section describes how to determine whether ACLs are processed in hardware or in software:
• Flows that match a deny statement in standard and extended ACLs are dropped in hardware if ICMP
unreachable messages are disabled.
• Flows that match a permit statement in standard ACLs are processed in hardware.
• The following ACL types are not supported in software:
– Standard Xerox Network Systems (XNS) Protocol access list
– Extended XNS access list
– DECnet access list
– Protocol type-code access list
– Standard Internet Packet Exchange (IPX) access list
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-5
Chapter 42 Configuring Network Security with ACLs
TCAM Programming and ACLs
– Extended IPX access list
Note Packets that require logging are processed in software. A copy of the packets is sent to the CPU for
logging while the actual packets are forwarded in hardware so that non-logged packet processing is not
impacted.
By default, the Catalyst 4500 series switch sends ICMP unreachable messages when a packet is denied
by an access list; these packets are not dropped in hardware but are forwarded to the switch so that it can
generate the ICMP unreachable message.
To drop access-list denied packets in hardware on the input interface, you must disable ICMP
unreachable messages using the no ip unreachables interface configuration command. The
ip unreachables command is enabled by default.
Note If you set the no ip unreachable command on all Layer 3 interfaces, output ACL denied packets do not
come to the CPU.
TCAM Programming and ACLs
You apply three types of hardware resources when you program ACLs and ACL-based features on the
Supervisor Engine 7: mapping table entries (MTEs), profiles, and TCAM value/mask entries. If any of
these resources are exhausted, packets are sent to the CPU for software-based processing.
Note Supervisor Engine 7 automatically manages the available resources.
If you exhaust resources on the Supervisor Engine 7-E, you should try reducing the complexity of your
configuration.
Note When an interface is in down state, TCAMs are not consumed for RACLs, but are for PACLs.
Troubleshooting High CPU Due to ACLs
Packets that match entries in fully programmed ACLs are processed in hardware.
Packets that match entries in partially programmed ACLs are processed in software using the CPU. This
may cause high CPU utilization and packets to be dropped. To determine whether packets are being
dropped due to high CPU utilization, reference the following:
http://www.cisco.com/en/US/products/hw/switches/ps663/products_tech_note09186a00804cef15.shtml
Software Configuration Guide—IOS-XE 3.1.0 SG
42-6 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
TCAM Programming and ACLs
Selecting Mode of Capturing Control Packets
In some deployments, you might want to bridge control packets in hardware rather than globally capture
and forward them in software (at the expense of the CPU). The per-VLAN capture mode feature allows
a Catalyst 4500 series switch to capture control packets only on selected VLANs and bridge traffic in
hardware on all other VLANs.
When you employ per-VLAN capture mode on your switch, it partially disables the global TCAM
capture entries internally and attaches feature-specific capture ACLs on those VLANs that are enabled
for snooping or routing features. (All IP capture entries, CGMP, and other non-IP entries are still
captured through global TCAM.) Because this feature controls specific control packets, they are
captured only on the VLANs on which the internal ACLs are installed. On all other VLANs, the control
traffic is bridged in hardware rather than forwarded to CPU.
The per-VLAN capture mode allows you to apply user-defined ACLs and QoS policers (in hardware) on
control packets. Furthermore, you can subject the aggregate control traffic ingressing the CPU to Control
Plane Policing.
When you use per-VLAN capture mode, the following four protocol groups are selectable per VLAN.
Observe the breakdown of protocols intercepted by each group.
• IGMP Snooping - Cgmp, Ospf, Igmp, RipV2, Pim, 224.0.0.1, 224.0.0.2, 224.0.0.*
• DHCP Snooping - Client to Server, Server to Client, Server to Server
• Unicast Routing - Ospf, Rip v2, 224.0.0.1, 224.0.0.2, 224.0.0.*
• Multicast Routing - Ospf, Rip v2, Igmp, Pim, 224.0.0.1, 224.0.0.2, 224.0.0.*
Because some of the groups have multiple overlapping ACEs (for example, 224.0.0.* is present in all
the groups except for DHCP Snooping), turning on a certain group will also trigger the interception of
some protocols from other groups.
Following are the programming triggers for the four protocol groups per VLAN:
• IGMP Snooping should be enabled globally on a given VLAN.
• DHCP Snooping should be enabled globally on a given VLAN.
• Unicast Routing should be enabled and SVI (or a Layer 3 physical) interface should be up and
configured with an IP protocol address. This is because interfaces immediately become part of the
routing process once the SVI interface comes up and the protocol family address is configured.
• Multicast Routing should be enabled and one of the multicast routing protocols should be configured
on the interface (IGMP, PIMv1, PIMv2, MBGP, MOSPF, DVMRP, and IGMP snooping).
Caveats and Restriction
Note Before configuring per-VLAN capture mode, you should examine your configuration to ensure that only
the necessary features are enabled on the desired VLANs.
The following caveats and restrictions apply to per-VLAN capture mode:
• Enabling per-VLAN capture mode consumes additional entries in the ACL/feature TCAM.
The number of available TCAM entries depends on the type of supervisor engine. The entry/mask
count further limits the utilization of the ACL/feature TCAM.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-7
Chapter 42 Configuring Network Security with ACLs
TCAM Programming and ACLs
• Certain configurations can exhaust TCAM resource earlier in per-VLAN capture mode than in
global capture mode (such as, IP Source Guard is enabled on several interfaces, or on a user
configured PACL).
• In per-VLAN capture mode, you can configure ACLs to permit or deny control traffic on a VLAN
or port.
Because security ACLs are terminated by an implicit deny, you must ensure that the ACLs are
configured to permit the control packets necessary for the feature (protocol) to operate. However,
this rule does not differ from the default behavior.
Configuration
To select the mode of capturing control packets, perform this task:
Command Purpose
Step 1 Switch# conf terminal Enters configuration mode.
Step 2 Switch(config)# [no] access-list hardware Selects mode of capturing control packets.
capture mode [vlan | global]
The no form of the access-list hardware capture mode
command restores the capture mode to the default, global.
Step 3 Switch(config)# end Returns to enable mode.
This example shows how to configure a Catalyst 4500 series switch to capture control packets only on
VLANs where features are enabled:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# access-list hardware capture mode vlan
Switch(config)# end
Switch#
This example shows how to configure a Catalyst 4500 series switch to capture control packets globally
across all VLANs (using static ACL, the default mode):
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# access-list hardware capture mode global
Switch(config)# end
Switch#
When the capture mode changes from global to VLAN, the static CAM entries are invalidated. This
creates a window during which control packets may pass through a Catalyst 4500 series switch without
being intercepted to the CPU. This temporary situation is restored when the new per-VLAN capture
entries are programmed in the hardware.
When you configure per-VLAN capture mode, you should examine the show commands for individual
features to verify the appropriate behavior. In per-VLAN capture mode, the invalidated static CAM
entries will appear as inactive in the output of the show platform hardware acl input entries static
command. For example, the hit count for inactive entries will remain frozen because those entries are
invalidated and applied per VLAN where the feature is enabled:
Software Configuration Guide—IOS-XE 3.1.0 SG
42-8 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Layer 4 Operators in ACLs
CamIndex Entry Type Active Hit Count CamRegion
50 PermitSharedStp Y 3344 ControlPktsTwo
51 PermitLoopbackTest Y 0 ControlPktsTwo
52 PermitProtTunnel Y 0 ControlPktsTwo
53 CaptureCgmp N 440 ControlPktsTwo
54 CaptureOspf N 4321 ControlPktsTwo
55 CaptureIgmp N 0 ControlPktsTwo
Layer 4 Operators in ACLs
The following sections describe guidelines and restrictions for configuring ACLs that include Layer 4
port operations:
• Restrictions for Layer 4 Operations, page 42-9
• Configuration Guidelines for Layer 4 Operations, page 42-10
• How ACL Processing Impacts CPU, page 42-11
Restrictions for Layer 4 Operations
You can specify these operator types, each of which uses one Layer 4 operation in the hardware:
• gt (greater than)
• lt (less than)
• neq (not equal)
• range (inclusive range)
For Supervisor Engine 7-E, the limits on the number of Layer 4 operations differ for each type of ACL,
and can also vary based on other factors: whether an ACL is applied to incoming or outgoing traffic,
whether the ACL is a security ACL or is used as a match condition for a QoS policy, and whether IPv6
ACLs are being programmed using the compressed flowlabel format.
Note The IPv6 compressed flowlabel format uses the Layer 2 Address Table to compress a portion of the IPv6
source address of each ACE in the ACL. The extra space freed in the flowlabel can then be used to
support more Layer 4 operations. For this compression to be used, the IPv6 ACL cannot contain any
ACEs which mask in only a portion of the bottom 48 bits of the source IPv6 address.
Generally, you will receive at most the following number of Layer 4 operations on the same ACL:
Direction Protocol Type Operations
------------------------------------------------
Input IPv4 Security 16
Input IPv6 Compressed Security 16
Input IPv6 Uncompressed Security 7
Input IPv4 QoS 5
Input IPv6 Compressed QoS 12
Input IPv6 Uncompressed QoS 8
Output IPv4 Security 17
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-9
Chapter 42 Configuring Network Security with ACLs
Layer 4 Operators in ACLs
Output IPv6 Compressed Security 17
Output IPv6 Uncompressed Security 8
Output IPv4 QoS 5
Output IPv6 Compressed QoS 12
Output IPv6 Uncompressed QoS 8
Note Cases where up to 16 Operations are supported; the 17th will trigger an expansion.
If you exceed the number of available Layer 4 operations, each new operation might cause the affected
ACE to be translated into multiple ACEs in the hardware. If this translation fails, packets are sent to the
CPU for software processing.
Configuration Guidelines for Layer 4 Operations
Observe the following guidelines when using Layer 4 operators:
• Layer 4 operations are considered different if the operator or operand differ. For example, the
following ACL contains three different Layer 4 operations because gt 10 and gt 11 are considered
two different Layer 4 operations:
... gt 10 permit
... lt 9 deny
... gt 11 deny
Note The eq operator can be used an unlimited number of times because eq does not use a Layer 4
operation in hardware.
• Layer 4 operations are considered different if the same operator/operand couple applies once to a
source port and once to a destination port, as in the following example:
... Src gt 10....
... Dst gt 10
A more detailed example follows:
access-list 101
... (dst port) gt 10 permit
... (dst port) lt 9 deny
... (dst port) gt 11 deny
... (dst port) neq 6 permit
... (src port) neq 6 deny
... (dst port) gt 10 deny
access-list 102
... (dst port) gt 20 deny
... (src port) lt 9 deny
... (src port) range 11 13 deny
... (dst port) neq 6 permit
Access lists 101 and 102 use the following Layer 4 operations:
• Access list 101 Layer 4 operations: 5
– gt 10 permit and gt 10 deny both use the same operation because they are identical and both
operate on the destination port.
• Access list 102 Layer 4 operations: 4
Software Configuration Guide—IOS-XE 3.1.0 SG
42-10 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Layer 4 Operators in ACLs
• Total Layer 4 operations: 8 (due to sharing between the two access lists)
– neq6 permit is shared between the two ACLs because they are identical and both operate on the
same destination port.
• A description of the Layer 4 operations usage is as follows:
– Layer 4 operation 1 stores gt 10 permit and gt 10 deny from ACL 101
– Layer 4 operation 2 stores lt 9 deny from ACL 101
– Layer 4 operation 3 stores gt 11 deny from ACL 101
– Layer 4 operation 4 stores neg 6 permit from ACL 101 and 102
– Layer 4 operation 5 stores neg 6 deny from ACL 101
– Layer 4 operation 6 stores gt 20 deny from ACL 102
– Layer 4 operation 7 stores lt 9 deny from ACL 102
– Layer 4 operation 8 stores range 11 13 deny from ACL 102
How ACL Processing Impacts CPU
ACL processing can impact the CPU in two ways:
• For some packets, when the hardware runs out of resources, the software must perform the ACL
matches:
– For Supervisor Engine 7-E, the TCP flag combinations "rst ack", "syn fin rst", "urg" and "psh"
are processed in hardware. "rst ack" is equivalent to the keyword established. Other TCP flag
combinations are supported in software.
– For Supervisor Engine 7-E, refer to the “Restrictions for Layer 4 Operations” section on
page 42-9.
Examples:
The following access lists are processed completely in hardware:
access-list 104 permit tcp any any established
access-list 105 permit tcp any any rst ack
access-list 107 permit tcp any synfin rst
Access lists 104 and 105 are identical; established is shorthand for rst and ack.
Access list 101, below, is processed completely in software:
access-list 101 permit tcp any any syn
Because four source and two destination operations exist, access list 106, below, is processed
in hardware:
access-list 106 permit tcp any range 100 120 any range 120 140
access-list 106 permit tcp any range 140 160 any range 180 200
access-list 106 permit tcp any range 200 220
access-list 106 deny tcp any range 220 240
In the following code, the Layer 4 operations for the third ACE trigger an attempt to translate
dst lt 1023 into multiple ACEs in hardware, because three source and three destination
operations exist. If the translation attempt fails, the third ACE is processed in software.
access-list 102 permit tcp any lt 80 any gt 100
access-list 102 permit tcp any range 100 120 any range 120 1024
access-list 102 permit tcp any gt 1024 any lt 1023
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-11
Chapter 42 Configuring Network Security with ACLs
Configuring Unicast MAC Address Filtering
Similarly, for access list 103, below, the third ACE triggers an attempt to translate dst gt 1023
into multiple ACEs in hardware. If the attempt fails, the third ACE is processed in software.
Although the operations for source and destination ports look similar, they are considered
different Layer 4 operations.)
access-list 103 permit tcp any lt 80 any lt 80
access-list 103 permit tcp any range 100 120 any range 100 120
access-list 103 permit tcp any gt 1024 any gt 1023
Note Remember that source port lt 80 and destination port lt 80 are considered different
operations.
• Some packets must be sent to the CPU for accounting purposes, but the action is still performed by
the hardware. For example, if a packet must be logged, a copy is sent to the CPU for logging, but
the forwarding (or dropping) is performed in the hardware. Although logging slows the CPU, it does
not affect the forwarding rate. This sequence of events would happen under the following
conditions:
– When a log keyword is used
– When an output ACL denies a packet
– When an input ACL denies a packet, and on the interface where the ACL is applied,
ip unreachable is enabled (ip unreachable is enabled by default on all the interfaces)
Configuring Unicast MAC Address Filtering
To block all unicast traffic to or from a MAC address in a specified VLAN, perform this task:
Command Purpose
Switch(config)# mac-address-table static mac_address Blocks all traffic to or from the configured unicast MAC
vlan vlan_ID drop address in the specified VLAN.
To clear MAC address-based blocking, use the no form of this
command without the drop keyword.
This example shows how to block all unicast traffic to or from MAC address 0050.3e8d.6400 in VLAN
12:
Router# configure terminal
Router(config)# mac-address-table static 0050.3e8d.6400 vlan 12 drop
Configuring Named MAC Extended ACLs
You can filter non-IPv4, non-IPv6 traffic on a VLAN and on a physical Layer 2 port by using MAC
addresses and named MAC extended ACLs. The procedure is similar to that of configuring other
extended named ACLs. You can use a number to name the access list, but MAC access list numbers from
700 to 799 are not supported.
Software Configuration Guide—IOS-XE 3.1.0 SG
42-12 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Configuring Named MAC Extended ACLs
Note Named MAC extended ACLs cannot be applied to Layer 3 interfaces.
For more information about the supported non-IP protocols in the mac access-list extended command,
refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference.
To create a named MAC extended ACL, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# [no] mac access-list Defines an extended MAC access list using a name.
extended name
Use the no mac access-list extended name global configuration
command to delete the entire ACL. You can also delete individual
ACEs from named MAC extended ACLs.
Step 3 Switch(config-ext-macl)# {deny | permit} In extended MAC access-list configuration mode, specify to
{any | host source MAC address | source permit or deny any source MAC address, a source MAC address
MAC address mask} {any | host destination
MAC address | destination MAC address
with a mask, or a specific host source MAC address and any
mask} [protocol-family {appletalk | destination MAC address, destination MAC address with a mask,
arp-non-ipv4 | decnet | ipx | rarp-ipv4 | or a specific destination MAC address.
rarp-non-ipv4 | vines | xns]
(Optional)
• [protocol-family {appletalk | arp-non-ipv4 | decnet | ipx |
rarp-ipv4 | rarp-non-ipv4 | vines | xns]
Step 4 Switch(config-ext-macl)# end Returns to privileged EXEC mode.
Step 5 Switch# show access-lists [number | name] Shows the access list configuration.
Step 6 Switch(config)# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to create and display an access list named mac1, denying only EtherType
DECnet Phase IV traffic, but permitting all other types of traffic:
Switch(config)# mac access-list extended mac1
Switch(config-ext-macl)# deny any any decnet-iv (old) protocol-family decnet (new)
Switch(config-ext-macl)# permit any any
Switch(config-ext-macl)# end
Switch # show access-lists
Extended MAC access list mac1
deny any any decnet-iv (old) protocol-family decnet (new)
permit any any
The following example shows how to enable or disable hardware statistics while configuring ACEs in
the access list:
Switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# mac access-list extended mac1
Switch(config-ext-nacl)# hardware statistics
Switch(config-ext-nacl)# end
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-13
Chapter 42 Configuring Network Security with ACLs
Configuring EtherType Matching
Configuring EtherType Matching
You can classify non-IPv4 and non-IPv6 traffic based on the EtherType value using the existing MAC
access list commands. When you classify non-IPv4 and non-IPv6 traffic by EtherType, you can apply
security ACLs and QoS policies to traffic that carry the same EtherType.
EtherType matching allows you to classify tagged and untagged IP packets based on the EtherType
value. Tagged packets present a potential operation problem:
• While single-tagged packets are supported on the access and trunk ports, double-tagged packets are
not.
• Single and double-tagged packets are not supported if the port mode is dot1qtunnel.
For more information about the mac access-list extended command, refer to the Catalyst 4500 Series
Switch Cisco IOS Command Reference.
To create a named MAC extended ACL, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# [no] mac access-list Defines an extended MAC access list using a name.
extended name
Use the no mac access-list extended name global configuration
command to delete the entire ACL. You can also delete individual
ACEs from named MAC extended ACLs.
Step 3 Switch(config-ext-macl)# {deny | permit} In extended MAC access-list configuration mode, specify to
{any | host source MAC address | source permit or deny any based upon the EtherTypes value, valid values
MAC address mask} {any | host destination
MAC address | destination MAC address
are 15636-65535.
mask} [protocol-family {appletalk | Note You can specify matching by either EtherType or protocol
arp-non-ipv4 | decnet | ipx | rarp-ipv4 |
family but not both.
rarp-non-ipv4 | vines | xns} | ethertype]
Step 4 Switch(config-ext-macl)# end Returns to privileged EXEC mode.
Step 5 Switch# show access-lists [number | name] Shows the access list configuration.
Step 6 Switch(config)# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to create and display an access list named matching, permitting the 0x8863 and
0x8040 EtherType values:
Switch(config)# mac access-list extended matching
Switch(config-ext-macl)# permit any any 0x8863
Switch(config-ext-macl)# permit any any 0x8040
Switch(config-ext-macl)# end
Switch # show access-lists matching
Extended MAC access list matching
permit any any 0x8863
permit any any netbios
Switch #
Software Configuration Guide—IOS-XE 3.1.0 SG
42-14 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Configuring Named IPv6 ACLs
Configuring Named IPv6 ACLs
Supervisor 7-E also support hardware based IPv6 ACLs to filter unicast, multicast, and broadcast IPv6
traffic on a Layer 3 interface.
To create a named IPv6 ACLs, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# ipv6 access-list name Defines an IPv6 access list using a name.
Use the no form of the command to delete the IPv6 ACL. You can
also delete individual ACEs from IPv6 access-list.
Step 3 Switch(config-ipv6-acl)# {deny | permit} Specifies each IPv6 ACE
{any | proto} {host ipv6-addr |
ipv6-prefix} host ipv6-addr | Note This step may be repeated to define multiple ACEs in the
ipv6-prefix} ACL.
Step 4 Switch(config-ipv6-acl)# (Optional) Enables hardware statistics for the IPv6 ACL.
hardware statistics
Step 5 Switch(config-ipv6-acl)# end Returns to privileged EXEC mode.
Step 6 Switch# show ipv6 access-list Displays the IPv6 access list configuration.
The following example shows how to create and display an IPv6 access list named v6test, denying only
one ipv6 traffic with one particular source/destination address, but permitting all other types of IPv6
traffic:
Switch(config)# ipv6 access-list v6test
Switch(config-ipv6-acl)# deny ipv6 host 2020::10 host 2040::10
Switch(config-ipv6-acl)# permit any any
Switch(config-ipv6-acl)# end
Switch# show ipv6 access-list
IPv6 access list v6test
deny ipv6 host 2020::10 host 2040::10 sequence 10
permit ipv6 any any sequence 20
To enable hardware statistics, enter the following commands while configuring ACEs in the access list:
Switch(config)# ipv6 access-list v6test
Switch(config-ipv6-acl)# hardware statistics
Switch(config-ipv6-acl)# end
Note Hardware statistics is disabled by default.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-15
Chapter 42 Configuring Network Security with ACLs
Applying IPv6 ACLs to a Layer 2 Interface
Applying IPv6 ACLs to a Layer 2 Interface
To apply an IPv6 ACL to a Layer 2 interface, perform the following task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-type Specifies the interface to be configured.
slot/interface
Note interface-type must be a Layer 2 interface.
Step 3 Switch(config-if)# ipv6 traffic-filter Applies the IPv6 ACL to a Layer 2 interface.
ipv6-acl {in | out}
Note IPv6 ACLs are supported on Layer 3 interfaces and on Layer 2 ports using the ipv6 traffic-filter
command.
The following example applies the extended-named IPv6 ACL simple-ipv6-acl to SVI 300 routed
ingress traffic:
Switch# configure terminal
Switch(config)# interface vlan 300
Switch(config-if)# ipv6 traffic-filter simple-ipv6-acl in
Note Output IPv6 ACLs with Ace to match on the ICMP option fail on a switch.
The following conditions may cause a RACL to malfunction (There is no workaround.):
• ACL are applied on the output direction of the interface.
• IPv6 ACL contain Ace to match on the ICMP option fields (ICMP Type or ICMP Code).
Here are two examples of such non-functioning RACL:
IPv6 access list a1
permit icmp any any nd-ns sequence 10
deny ipv6 any any sequence 20
IPv6 access list a2
permit icmp 2020::/96 any nd-ns sequence 10
deny ipv6 any any sequence 20
Applying IPv6 ACLs to a Layer 3 Interface
To apply an IPv6 ACL to a Layer 3 interface, perform the following task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Software Configuration Guide—IOS-XE 3.1.0 SG
42-16 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Configuring VLAN Maps
Command Purpose
Step 2 Switch(config)# interface interface-type Specifies the interface to be configured.
slot/interface
Note interface-type must be a Layer 3 interface.
Step 3 Switch(config-if)# ipv6 traffic-filter Applies the IPv6 ACL to a Layer 3 interface.
ipv6-acl {in | out}
Note IPv6 ACLs are supported on Layer 3 interfaces and on Layer 2 ports using the ipv6 traffic-filter
command.
The following example applies the extended-named IPv6 ACL simple-ipv6-acl to SVI 300 routed
ingress traffic:
Switch# configure terminal
Switch(config)# interface vlan 300
Switch(config)# ip address 7.3.4.1 0.0.0.25
Switch(config-if)# ipv6 traffic-filter simple-ipv6-acl in
Note Output IPv6 ACLs with Ace to match on the ICMP option fail on a switch.
The following conditions may cause a RACL to malfunction (There is no workaround.):
• ACL are applied on the output direction of the interface.
• IPv6 ACL contains Aces matching on the ICMP option fields (ICMP Type or ICMP Code).
Here are two examples of such non-functioning RACL:
IPv6 access list a1
permit icmp any any nd-ns sequence 10
deny ipv6 any any sequence 20
IPv6 access list a2
permit icmp 2020::/96 any nd-ns sequence 10
deny ipv6 any any sequence 20
Configuring VLAN Maps
This section contains the following subsections:
• VLAN Map Configuration Guidelines, page 42-18
• Creating and Deleting VLAN Maps, page 42-19
• Applying a VLAN Map to a VLAN, page 42-21
• Using VLAN Maps in Your Network, page 42-22
This section describes how to configure VLAN maps, which is the only way to control filtering within
a VLAN. VLAN maps have no direction. To filter traffic in a specific direction by using a VLAN map,
you need to include an ACL with specific source or destination addresses. If there is a match clause for
that type of packet (IP or MAC) in the VLAN map, the default action is to drop the packet if the packet
does not match any of the entries within the map. If there is no match clause for that type of packet, the
default is to forward the packet.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-17
Chapter 42 Configuring Network Security with ACLs
Configuring VLAN Maps
To create a VLAN map and apply it to one or more VLANs, perform this task:
Step 1 Create the standard or extended IP ACLs or named MAC extended ACLs that you want to apply to the
VLAN.
Step 2 Enter the vlan access-map global configuration command to create a VLAN ACL map entry.
Step 3 In access map configuration mode, you have the optional to enter an action (forward [the default] or
drop) and enter the match command to specify an IP packet or a non-IP packet and to match the packet
against one or more ACLs (standard or extended). If a match clause is not specified, the action is applied
to all packets. The match clause can be used to match against multiple ACLs. If a packet matches any of
the specified ACLs, the action is applied.
Note If the VLAN map has a match clause for the type of packet (IP or MAC) and the packet does not
match the type, the default is to drop the packet. If there is no match clause in the VLAN map
for that type of packet, and no action specified, the packet is forwarded.
Step 4 Use the vlan filter global configuration command to apply a VLAN map to one or more VLANs.
Note You cannot apply a VLAN map to a VLAN on a switch that has ACLs applied to Layer 2 interfaces (port
ACLs).
VLAN Map Configuration Guidelines
Keep the following guidelines in mind when configuring VLAN maps:
• VLAN maps do not filter IPv4 ARP packets.
• VLAN maps do not filter IPv6 packets.
• If there is no router ACL configured to deny traffic on a routed VLAN interface (input or output),
and no VLAN map configured, all traffic is permitted.
• Each VLAN map consists of a series of entries. The order of entries in a VLAN map is important.
A packet that comes into the switch is tested against the first entry in the VLAN map. If it matches,
the action specified for that part of the VLAN map is taken. If there is no match, the packet is tested
against the next entry in the map.
• If the VLAN map has at least one match clause for the type of packet (IP or MAC) and the packet
does not match any of these match clauses, the default is to drop the packet. If there is no match
clause for that type of packet in the VLAN map, the default is to forward the packet.
• The system might take longer to boot if you have configured a very large number of ACLs.
Software Configuration Guide—IOS-XE 3.1.0 SG
42-18 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Configuring VLAN Maps
Creating and Deleting VLAN Maps
Each VLAN map consists of an ordered series of entries. To create, add to, or delete a VLAN map entry,
perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# vlan access-map name Creates a VLAN map, and give it a name and (optionally) a
[number] number. The number is the sequence number of the entry within
the map.
When you create VLAN maps with the same name, numbers are
assigned sequentially in increments of 10. When modifying or
deleting maps, you can enter the number of the map entry that
you want to modify or delete.
This command enables access-map configuration mode.
Step 3 Switch(config-access-map)# action {drop | (Optional) Sets the action for the map entry. The default is to
forward} forward.
Step 4 Switch(config-access-map)# match {ip | Matches the packet (using either the IP or MAC address) against
mac} address {name | number} [name | one or more standard or extended access lists. Note that packets
number]
are matched only against access lists of the correct protocol type.
IP packets are compared with standard or extended IP access
lists. Non-IP packets are only compared with named MAC
extended access lists. If a match clause is not specified, the action
is taken on all packets.
Step 5 Switch(config-access-map)# end Returns to global configuration mode.
Step 6 Switch(config)# show running-config Displays the access list configuration.
Step 7 Switch(config)# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
You can use the no vlan access-map name global configuration command to delete a map. You can use
the no vlan access-map name number global configuration command to delete a single sequence entry
from within the map. You can use the no action access-map configuration command to enforce the
default action, which is to forward.
VLAN maps do not use the specific permit or deny keywords. To deny a packet by using VLAN maps,
create an ACL that would match the packet, and then set the action to drop. A permit in the ACL is the
same as a match. A deny in the ACL means no match.
Examples of ACLs and VLAN Maps
These examples show how to create ACLs and VLAN maps in three different situations.
Example 1
This example shows how to create an ACL and a VLAN map to deny a packet. In the first map, any
packets that match the ip1 ACL (TCP packets) would be dropped. You first create the ip1 ACL to permit
any TCP packet and no other packets. Because there is a match clause for IP packets in the VLAN map,
the default action is to drop any IP packet that does not match any of the match clauses.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-19
Chapter 42 Configuring Network Security with ACLs
Configuring VLAN Maps
Switch(config)# ip access-list extended ip1
Switch(config-ext-nacl)# permit tcp any any
Switch(config-ext-nacl)# exit
Switch(config)# vlan access-map map_1 10
Switch(config-access-map)# match ip address ip1
Switch(config-access-map)# action drop
This example shows how to create a VLAN map to permit a packet. ACL ip2 permits UDP packets; and
any packets that match the ip2 ACL are forwarded.
Switch(config)# ip access-list extended ip2
Switch(config-ext-nacl)# permit udp any any
Switch(config-ext-nacl)# exit
Switch(config)# vlan access-map map_1 20
Switch(config-access-map)# match ip address ip2
Switch(config-access-map)# action forward
In this map, any IP packets that did not match any of the previous ACLs (that is, packets that are not
TCP packets or UDP packets) would get dropped.
Example 2
In this example, the VLAN map is configured to drop IP packets and to forward MAC packets by default.
By applying standard ACL 101 and the extended named access lists igmp-match and tcp-match, the
VLAN map is configured to do the following:
• Forward all UDP packets
• Drop all IGMP packets
• Forward all TCP packets
• Drop all other IP packets
• Forward all non-IP packets
Switch(config)# access-list 101 permit udp any any
Switch(config)# ip access-list extended igmp-match
Switch(config-ext-nacl)# permit igmp any any
Switch(config)# ip access-list extended tcp-match
Switch(config-ext-nacl)# permit tcp any any
Switch(config-ext-nacl)# exit
Switch(config)# vlan access-map drop-ip-default 10
Switch(config-access-map)# match ip address 101
Switch(config-access-map)# action forward
Switch(config-access-map)# exit
Switch(config)# vlan access-map drop-ip-default 20
Switch(config-access-map)# match ip address igmp-match
Switch(config-access-map)# action drop
Switch(config-access-map)# exit
Switch(config)# vlan access-map drop-ip-default 30
Switch(config-access-map)# match ip address tcp-match
Switch(config-access-map)# action forward
Example 3
In this example, the VLAN map is configured to drop MAC packets and forward IP packets by default.
By applying MAC extended access lists, good-hosts and good-protocols, the VLAN map is configured
to do the following:
• Forward MAC packets from hosts 0000.0c00.0111 and 0000.0c00.0211.
• Forward MAC packets of DECnet or VINES (Virtual Integrated Network Service) protocol-family.
Software Configuration Guide—IOS-XE 3.1.0 SG
42-20 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Configuring VLAN Maps
• Drop all other non-IPv4, non-IPv6 packets.
• Forward all IP packets.
Switch(config)# mac access-list extended good-hosts
Switch(config-ext-macl)# permit host 000.0c00.0111 any
Switch(config-ext-macl)# permit host 000.0c00.0211 any
Switch(config-ext-nacl)# exit
Switch(config)# mac access-list extended good-protocols
Switch(config-ext-macl)# permit any any protocol-family decnet
Switch(config-ext-macl)# permit any any protocol-family vines
Switch(config-ext-nacl)# exit
Switch(config)# vlan access-map drop-mac-default 10
Switch(config-access-map)# match mac address good-hosts
Switch(config-access-map)# action forward
Switch(config-access-map)# exit
Switch(config)# vlan access-map drop-mac-default 20
Switch(config-access-map)# match mac address good-protocols
Switch(config-access-map)# action forward
Example 4
In this example, the VLAN map is configured to drop all packets (IP and non-IP). By applying access
lists tcp-match and good-hosts, the VLAN map is configured to do the following:
• Forward all TCP packets
• Forward MAC packets from hosts 0000.0c00.0111 and 0000.0c00.0211
• Drop all other IP packets
• Drop all other MAC packets
Switch(config)# vlan access-map drop-all-default 10
Switch(config-access-map)# match ip address tcp-match
Switch(config-access-map)# action forward
Switch(config-access-map)# exit
Switch(config)# vlan access-map drop-all-default 20
Switch(config-access-map)# match mac address good-hosts
Switch(config-access-map)# action forward
Applying a VLAN Map to a VLAN
To apply a VLAN map to one or more VLANs, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# vlan filter mapname Applies the VLAN map to one or more VLAN IDs.
vlan-list list
The list can be a single VLAN ID (22), a consecutive list (10-22), or
a string of VLAN IDs (12, 22, 30). Spaces around comma, and dash,
are optional.
Step 3 Switch(config)# show running-config Displays the access list configuration.
Step 4 cSwitch(config)# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-21
Chapter 42 Configuring Network Security with ACLs
Configuring VLAN Maps
Note You cannot apply a VLAN map to a VLAN on a switch that has ACLs applied to Layer 2 interfaces (port
ACLs).
This example shows how to apply VLAN map 1 to VLANs 20 through 22:
Switch(config)# vlan filter map 1 vlan-list 20-22
Using VLAN Maps in Your Network
Figure 42-3 shows a typical wiring closet configuration. Host X and Host Y are in different VLANs,
connected to wiring closet switches A and C. Traffic moving from Host X to Host Y is routed by Switch
B. Access to traffic moving from Host X to Host Y can be controlled at the entry point of Switch A. In
the following configuration, the switch can support a VLAN map and a QoS classification ACL.
Figure 42-3 Wiring Closet Configuration
Catalyst 4500 series switch
Si
Switch B
Switch A Switch C
VLAN map: Deny HTTP
from X to Y
HTTP is dropped
at entry point
Host X Host Y
10.1.1.32 10.1.1.34
VLAN 1
94154
VLAN 2
Packet
For example, if you do not want HTTP traffic to be switched from Host X to Host Y, you could apply a
VLAN map on Switch A to drop all HTTP traffic moving from Host X (IP address 10.1.1.32) to Host Y
(IP address 10.1.1.34) at Switch A and not bridge the traffic to Switch B. To configure this scenario, you
would do the following:
First, define an IP access list http to permit (match) any TCP traffic on the HTTP port, as follows:
Switch(config)# ip access-list extended http
Switch(config-ext-nacl)# permit tcp host 10.1.1.32 host 10.1.1.34 eq www
Switch(config-ext-nacl)# exit
Software Configuration Guide—IOS-XE 3.1.0 SG
42-22 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Configuring VLAN Maps
Next, create a VLAN access map named map2 so that traffic that matches the http access list is dropped
and all other IP traffic is forwarded, as follows:
Switch(config)# vlan access-map map2 10
Switch(config-access-map)# match ip address http
Switch(config-access-map)# action drop
Switch(config-access-map)# exit
Switch(config)# ip access-list extended match_all
Switch(config-ext-nacl)# permit ip any any
Switch(config-ext-nacl)# exit
Switch(config)# vlan access-map map2 20
Switch(config-access-map)# match ip address match_all
Switch(config-access-map)# action forward
Then, apply the VLAN access map named map2 to VLAN 1, as follows:
Switch(config)# vlan filter map2 vlan 1
Denying Access to a Server on Another VLAN
Figure 42-4 shows how to restrict access to a server on another VLAN. In this example, server
10.1.1.100 in VLAN 10 has the following access restrictions:
• Hosts in subnet 10.1.2.0/8 in VLAN 20 should not have access.
• Hosts 10.1.1.4 and 10.1.1.8 in VLAN 10 should not have access.
Figure 42-4 Deny Access to a Server on Another VLAN
VLAN map
10.1.1.100
Subnet
Server (VLAN 10) 10.1.2.0/8
10.1.1.4
Host (VLAN 20)
Host (VLAN 10) Catalyst 4500 series switch
10.1.1.8
94155
Host (VLAN 10) Packet
This procedure configures ACLs with VLAN maps to deny access to a server on another VLAN. The
VLAN map SERVER 1_ACL denies access to hosts in subnet 10.1.2.0/8, host 10.1.1.4, and host
10.1.1.8. Then it permits all other IP traffic. In Step 3, VLAN map SERVER1 is applied to VLAN 10.
To configure this scenario, you could perform the following steps:
Step 1 Define the IP ACL to match and permit the correct packets.
Switch(config)# ip access-list extended SERVER1_ACL
Switch(config-ext-nacl))# permit ip 10.1.2.0 0.0.0.255 host 10.1.1.100
Switch(config-ext-nacl))# permit ip host 10.1.1.4 host 10.1.1.100
Switch(config-ext-nacl))# permit ip host 10.1.1.8 host 10.1.1.100
Switch(config-ext-nacl))# exit
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-23
Chapter 42 Configuring Network Security with ACLs
Displaying VLAN Access Map Information
Step 2 Define a VLAN map using the ACL to drop IP packets that match SERVER1_ACL and forward IP
packets that do not match the ACL.
Switch(config)# vlan access-map SERVER1_MAP
Switch(config-access-map)# match ip address SERVER1_ACL
Switch(config-access-map)# action drop
Switch(config)# vlan access-map SERVER1_MAP 20
Switch(config-access-map)# action forward
Switch(config-access-map)# exit
Step 3 Apply the VLAN map to VLAN 10.
Switch(config)# vlan filter SERVER1_MAP vlan-list 10.
Displaying VLAN Access Map Information
To display information about VLAN access maps or VLAN filters, perform one of these commands:
Command Purpose
Switch# show vlan access-map [mapname] Shows information about all VLAN access-maps or the
specified access map.
Switch# show vlan filter [access-map name | Shows information about all VLAN filters or about a
vlan vlan-id] specified VLAN or VLAN access map.
This is a sample output of the show vlan access-map command:
Switch# show vlan access-map
Vlan access-map "map_1" 10
Match clauses:
ip address: ip1
Action:
drop
Vlan access-map "map_1" 20
Match clauses:
mac address: mac1
Action:
forward
Vlan access-map "map_1" 30
Match clauses:
Action:
drop
Note Sequence 30 does not have a match clause. All packets (IP as well as non-IP) are matched against it and
dropped.
This is a sample output of the show vlan filter command:
Switch# show vlan filter
VLAN Map map_1 is filtering VLANs:
20-22
Software Configuration Guide—IOS-XE 3.1.0 SG
42-24 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Using VLAN Maps with Router ACLs
Using VLAN Maps with Router ACLs
If the VLAN map has a match clause for a packet type (IP or MAC) and the packet does not match the
type, the default is to drop the packet. If there is no match clause in the VLAN map, and no action is
specified, the packet is forwarded if it does not match any VLAN map entry.
Note You cannot combine VLAN maps or input router ACLs with port ACLs on a switch.
Guidelines for Using Router ACLs and VLAN Maps on the Same VLAN
Because the switch hardware performs one lookup for each direction (input and output), you must merge
a router ACL and a VLAN map when they are configured on the same VLAN. Merging the router ACL
with the VLAN map can significantly increase the number of ACEs.
When possible, try to write the ACL so that all entries have a single action except for the final, default
action. You should write the ACL using one of these two forms:
permit...
permit...
permit...
deny ip any any
or
deny...
deny...
deny...
permit ip any any
To define multiple permit or deny actions in an ACL, group each action type together to reduce the
number of entries.
If you need to specify the full-flow mode and the ACL contains both IP ACEs and TCP/UDP/ICMP
ACEs with Layer 4 information, put the Layer 4 ACEs at the end of the list. Doing this gives priority to
the filtering of traffic based on IP addresses.
Examples of Router ACLs and VLAN Maps Applied to VLANs
These examples show how router ACLs and VLAN maps are applied on a VLAN to control the access
of switched, bridged, routed, and multicast packets. Although the following illustrations show packets
being forwarded to their destination, each time a packet crosses a line indicating a VLAN map or an
ACL, the packet could be dropped rather than forwarded.
ACLs and Switched Packets
Figure 42-5 shows how an ACL processes packets that are switched within a VLAN. Packets switched
within the VLAN are not processed by router ACLs.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-25
Chapter 42 Configuring Network Security with ACLs
Using VLAN Maps with Router ACLs
Figure 42-5 Applying ACLs on Switched Packets
Catalyst 4500 series switch
Input Output
VLAN 10 router router VLAN 20
map ACL ACL map
Frame
Host A
(VLAN 10)
Routing function
Host C
(VLAN 10)
94156
VLAN 10 Packet VLAN 20
ACLs and Routed Packets
Figure 42-6 shows how ACLs are applied on routed packets. For routed packets, the ACLs are applied
in this order:
1. VLAN map for input VLAN
2. Input router ACL
3. Output router ACL
4. VLAN map for output VLAN
Software Configuration Guide—IOS-XE 3.1.0 SG
42-26 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Configuring PACLs
Figure 42-6 Applying ACLs on Routed Packets
Catalyst 4500 series switch
Input Output
VLAN 10 router router VLAN 20
map ACL ACL map
Frame
Host A Host B
(VLAN 10) (VLAN 20)
Routing function
94157
VLAN 10 Packet VLAN 20
Configuring PACLs
This section describes how to configure PACLs, which are used to control filtering on Layer 2 interfaces.
PACLs can filter traffic to or from Layer 2 interfaces based on Layer 3 information, Layer 4 head
information or non-IP Layer 2 information.
This section contains the following topics:
• Creating a PACL, page 42-27
• PACL Configuration Guidelines, page 42-28
• Configuring IPv6, IP, and MAC ACLs on a Layer 2 Interface, page 42-28
• Using PACL with Access-Group Mode, page 42-29
• Configuring Access-group Mode on Layer 2 Interface, page 42-30
• Applying ACLs to a Layer 2 Interface, page 42-30
• Displaying an ACL Configuration on a Layer 2 Interface, page 42-31
Creating a PACL
To create a PACL and apply it to one or more interfaces, perform this task:
Step 1 Create the standard or extended IPv4 ACLs, named IPv6 ACLs, or named MAC extended ACLs that you
want to apply to the interface.
Step 2 Use the ip access-group ipv6 traffic-filter or mac access-group interface command to apply an IPv4
ACL, IPv6 ACL, or MAC ACL to one or more Layer 2 interfaces.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-27
Chapter 42 Configuring Network Security with ACLs
Configuring PACLs
PACL Configuration Guidelines
Consider the following guidelines when configuring PACLs:
• There can be at most one IPv4 access list, one IPv6 access list, and one MAC access list applied to
the same Layer 2 interface per direction.
• The IPv4 access list filters only IPv4 packets; the IPv6 access list filters only IPv6 packets, and the
MAC access list filters only non-IPv4, non-IPv6 packets.
• The number of ACLs and ACEs that can be configured as part of a PACL are bounded by the
hardware resources on the switch. Those hardware resources are shared by various ACL features
(for example, RACL, VACL) that are configured on the system. If there are insufficient hardware
resources to program PACL in hardware, the actions for input and output PACLs differ:
– For input PACLs, some packets are sent to CPU for software forwarding.
– For output PACLs, the PACL is disabled on the port.
• These restrictions pertain to output PACLs only:
– If there are insufficient hardware resources to program the PACL, the output PACL is not
applied to the port, and you receive a warning message.
– If an output PACL is configured on a Layer 2 port, then neither a VACL nor a Router ACL can
be configured on the VLANs to which the Layer 2 port belongs.
If any VACL or Router ACL is configured on the VLANs to which the Layer 2 port belongs,
the output PACL cannot be configured on the Layer 2 port. That is, PACLs and VLAN-based
ACLs (VACL and Router ACL) are mutually exclusive on Layer 2 ports.
• The input IP ACL logging option is supported, although logging is not supported for output IP
ACLs, and MAC ACLs.
• The access group mode can change the way PACLs interact with other ACLs. To maintain
consistent behavior across Cisco platforms, use the default access group mode.
Configuring IPv6, IP, and MAC ACLs on a Layer 2 Interface
Only IPv4, IPv6, and MAC ACLs can be applied to Layer 2 physical interfaces. Standard (numbered,
named) and Extended (numbered, named) IP ACLs, Named IPv6 ACLs and Extended Named MAC
ACLs are also supported.
To apply IPv6 ACLs on a Layer 2 interface, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface Enters interface config mode.
Step 3 Switch(config-if)# [no] ipv6 traffic-filter Applies an IPv6 ACL to the Layer 2 interface. The no prefix
ipv6AclName [in | out] deletes the ACL from the Layer 2 interface.
Step 4 Switch(config)# show running-config Displays the access list configuration.
The following example shows how to apply IPv6 ACLs on interface Gi3/1:
Switch(config)# interface Gi3/1
Switch(config-if)# ipv6 traffic-filter ipv6AclName in
Switch(config-if)# end
Software Configuration Guide—IOS-XE 3.1.0 SG
42-28 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Configuring PACLs
To apply IP or MAC ACLs on a Layer 2 interface, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface Enters interface config mode.
Step 3 Switch(config-if)# [no] {ip | mac} Applies numbered or named ACL to the Layer 2 interface.
access-group {name | number| in| out} The no prefix deletes the IP or MAC ACL from the Layer 2
interface.
Step 4 Switch(config)# show running-config Displays the access list configuration.
The following example shows how to configure the Extended Named IP ACL simple-ip-acl to permit all
TCP traffic and implicitly deny all other IP traffic:
Switch(config)# interface Gi3/1
Switch(config-if)# ip access-list extended simple-ip-acl
Switch(config-ext-nacl)# permit tcp any any
Switch(config-ext-nacl)# end
The following example shows how to configure the Extended Named MACL simple-mac-acl to permit
source host 000.000.011 to any destination host:
Switch(config)# interface Gi3/1
Switch(config-if)# mac access-list extended simple-mac-acl
Switch(config-ext-macl)# permit host 000.000.011 any
Switch(config-ext-macl)# end
Using PACL with Access-Group Mode
You can use the access group mode to change the way PACLs interact with other ACLs. For example,
if a Layer 2 interface belongs to VLAN100, VACL (VLAN filter) V1 is applied on VLAN100, and
PACL P1 is applied on the Layer 2 interface. In this situation, you must specify how P1 and V1 impact
the traffic with the Layer 2 interface on VLAN100. In a per-interface fashion, the access-group mode
command can be used to specify one of the desired behaviors that are defined below.
The following modes are defined:
• prefer port mode—If PACL is configured on a Layer 2 interface, then PACL takes effect and
overwrites the effect of other ACLs (Router ACL and VACL). If no PACL feature is configured on
the Layer 2 interface, other features applicable to the interface are merged and applied on the
interface. This is the default access group mode.
• prefer vlan mode—VLAN-based ACL features take effect on the port provided they have been
applied on the port and no PACLs are in effect. If no VLAN-based ACL features are applicable to
the Layer 2 interface, then the PACL feature already on the interface is applied.
• merge mode—Merges applicable ACL features before they are programmed into the hardware.
Note Because output PACLs are mutually exclusive with VACL and Router ACLs, the access group mode
does not change the behavior of output traffic filtering.
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-29
Chapter 42 Configuring Network Security with ACLs
Configuring PACLs
Configuring Access-group Mode on Layer 2 Interface
To configure an access mode on a Layer 2 interface, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface Enters interface config mode.
Step 3 Switch(config-if)# [no] access-group mode Applies numbered or named ACL to the Layer 2 interface.
{prefer {port | vlan} | merge} The no prefix deletes the IP or MAC ACL from the Layer 2
interface.
Step 4 Switch(config)# show running-config Displays the access list configuration.
This example shows how to merge and apply features other than PACL on the interface:
Switch# configure terminal
Switch(config)# interface fast 6/1
Switch(config-if)# access-group mode prefer port
This example shows how to merge applicable ACL features before they are programmed into hardware:
Switch# configure terminal
Switch(config)# interface fast 6/1
Switch(config-if)# access-group mode merge
Applying ACLs to a Layer 2 Interface
To apply IP and MAC ACLs to a Layer 2 interface, perform one of these tasks:
Command Purpose
Switch(config-if)# ip access-group ip-acl {in | out} Applies an IP ACL to the Layer 2 interface
Switch(config-if)# mac access-group mac-acl {in | out} Applies a MAC ACL to the Layer 2 interface.
Note Supervisor Engines III and Supervisor Engine IV running on a Catalyst 4500 series switch support both
input and output PACLs on an interface.
This example applies the extended named IP ACL simple-ip-acl to interface FastEthernet 6/1 ingress
traffic:
Switch# configure terminal
Switch(config)# interface fast 6/1
Switch(config-if)# ip access-group simple-ip-acl in
This example applies the extended named MAC ACL simple-mac-acl to interface FastEthernet 6/1
egress traffic:
Switch# configure terminal
Switch(config)# interface fast 6/1
Switch(config-if)# mac access-group simple-mac-acl out
Software Configuration Guide—IOS-XE 3.1.0 SG
42-30 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Using PACL with VLAN Maps and Router ACLs
Displaying an ACL Configuration on a Layer 2 Interface
To display information about an ACL configuration on Layer 2 interfaces, perform one of these tasks:
Command Purpose
Switch# show ip interface [interface-name] Shows the IP access group configuration on the interface.
Switch# show mac access-group interface Shows the MAC access group configuration on the
[interface-name] interface.
Switch# show access-group mode interface Shows the access group mode configuration on the
[interface-name] interface.
This example shows that the IP access group simple-ip-acl is configured on the inbound direction of
interface fa6/1:
Switch# show ip interface fast 6/1
FastEthernet6/1 is up, line protocol is up
Inbound access list is simple-ip-acl
Outgoing access list is not set
This example shows that MAC access group simple-mac-acl is configured on the inbound direction of
interface fa6/1:
Switch# show mac access-group interface fast 6/1
Interface FastEthernet6/1:
Inbound access-list is simple-mac-acl
Outbound access-list is not set
This example shows that access group merge is configured on interface fa6/1:
Switch# show access-group mode interface fast 6/1
Interface FastEthernet6/1:
Access group mode is: merge
Using PACL with VLAN Maps and Router ACLs
For output PACLs, there is no interaction with VACL or output Router ACLs. (See the restrictions listed
in the “PACL Configuration Guidelines” section on page 42-28.) For input PACLs, however, the
interaction with Router ACLs and VACLs depends on the interface access group mode as shown in
Table 42-1.
Table 42-1 Interaction Between PACLs, VACLs and Router ACLs
ACL Type(s) Input PACL
prefer port prefer vlan merge mode
mode mode
1. Input Router ACL PACL applied Input Router PACL, Input Router ACL (merged)
ACL applied applied in order (ingress)
2. VACL PACL applied VACL PACL, VACL (merged) applied in order
applied (ingress)
3. VACL + Input Router PACL applied VACL + PACL, VACL, Input Router ACL
ACL Input Router (merged) applied in order (ingress)
ACL applied
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-31
Chapter 42 Configuring Network Security with ACLs
Using PACL with VLAN Maps and Router ACLs
Each ACL Type listed in Table 42-1 is synonymous with a different scenario, as explained in the
following discussion.
Scenario 1: Host A is connected to an interface in VLAN 20, which has an SVI configured. The interface
has input PACL configured, and the SVI has input Router ACL configured as shown in Figure 42-7:
Figure 42-7 Scenario 1: PACL Interaction with an Input Router ACL
Catalyst 4500 series switch
Input
Input router Output
PACL ACL PACL
Frame
Host A Host B
(VLAN 10) (VLAN 20)
Routing function
94092
VLAN 10 Packet VLAN 20
If the interface access group mode is prefer port, then only the input PACL is applied on the ingress
traffic from Host A. If the mode is prefer vlan, then only the input Router ACL is applied to ingress
traffic from Host A that requires routing. If the mode is merge, then the input PACL is first applied to
the ingress traffic from Host A, and the input Router ACL is applied on the traffic that requires routing.
Scenario 2: Host A is connected to an interface in VLAN 10, which has a VACL (VLAN Map)
configured and an input PACL configured as shown in Figure 42-8.
Software Configuration Guide—IOS-XE 3.1.0 SG
42-32 OL-22250-01
Chapter 42 Configuring Network Security with ACLs
Using PACL with VLAN Maps and Router ACLs
Figure 42-8 Scenario 2: PACL Interaction with a VACL
Catalyst 4500 series switch
Input VLAN 10
PACL map
Frame
Host A Host B
(VLAN 10) (VLAN 10)
94093
VLAN 10 Packet
If the interface access group mode is prefer port, then only the input PACL is applied on the ingress
traffic from Host A. If the mode is prefer vlan, then only the VACL is applied to the ingress traffic from
Host A. If the mode is merge, the input PACL is first applied to the ingress traffic from Host A, and the
VACL is applied on the traffic.
Scenario 3: Host A is connected to an interface in VLAN 10, which has a VACL and an SVI configured.
The SVI has an input Router ACL configured and the interface has an input PACL configured, as shown
in Figure 42-9.
Figure 42-9 Scenario 3: VACL and Input Router ACL
Catalyst 4500 series switch
Input Output
Input VLAN 10 router router VLAN 20
PACL map ACL ACL map
Frame
Host A Host B
(VLAN 10) (VLAN 20)
Routing function
94094
VLAN 10 Packet VLAN 20
Software Configuration Guide—IOS-XE 3.1.0 SG
OL-22250-01 42-33
Chapter 42 Configuring Network Security with ACLs
Using PACL with VLAN Maps and Router ACLs
If the interface access group mode is prefer port, then only the input PACL is applied on the ingress
traffic from Host A. If the mode is prefer vlan, then the merged results of the VACL and the input Router
ACL are applied to the ingress traffic from Host A. If the mode is merge, the input PACL is first applied
to the ingress traffic from Host A, the VACL is applied on the traffic and finally, and the input Router
ACL is applied to the traffic that needs routing. (that is, the merged results of the input PACL, VACL,
and input Router ACL are applied to the traffic).
Software Configuration Guide—IOS-XE 3.1.0 SG
42-34 OL-22250-01
CH A P T E R 43
Support for IPv6
This chapter lists the IP version 6 (IPv6) features supported on the Catalyst 4500 series switches.
The IPv6 for Cisco IOS software feature documentation provides implementation and command
reference information for IPv6 features supported in the Cisco IOS software. Not all IPv6 features are
supported on the Catalyst 4500 series switches. We strongly recommend that you read this entire chapter
before reading the other IPv6 for Cisco IOS software feature documentation.
Finding Feature Information
Use Cisco Feature Navigator to find information about platform support and Cisco IOS and Catalyst OS
software image support. To access Cisco Feature Navigator, go to http://tools.cisco.com/ITDIT/CFN/.
An account on Cisco.com is not required.
The Cisco IOS IPv6 Configuration Guide is located at the following website:
http://www.cisco.com/en/US/docs/ios-xml/ios/ipv6/configuration/15-2s/ip6-15-2s-book.html
The Cisco IOS IPv6 Command Reference is located at the following website:
http://www.cisco.com/en/US/docs/ios/ipv6/command/reference/ipv6_book.html
Note For complete syntax and usage information for the commands used in this chapter, see the Cisco IOS
documentation referenced in the procedures.
This chapter consists of these sections:
• About IPv6, page 43-1
• IPv6 Default States, page 43-7
About IPv6
IPv6 provides services such as end-to-end security, quality of service (QoS), and globally unique
addresses. The IPv6 address space reduces the need for private addresses and Network Address
Translation (NAT) processing by border routers at network edges.
For information about how Cisco Systems implements IPv6, go to this URL:
http://www.cisco.com/en/US/products/ps6553/products_ios_technology_home.html
This section describes the features that are supported for IPv6:
Catalyst 4500 Switch Software Configuration Guide
OL-22250-01 43-1
Chapter 43 Support for IPv6
About IPv6
• IPv6 Addressing and Basic Connectivity, page 43-2
• DHCP, page 43-3
• Security, page 43-3
• QoS, page 43-3
• Management, page 43-4
• Multicast, page 43-4
• Static Routes, page 43-4
• First-Hop Redundancy Protocols, page 43-5
• Unicast Routing, page 43-5
• Tunneling, page 43-6
IPv6 Addressing and Basic Connectivity
The switch supports only IPv6 unicast addresses. It does not support site-local unicast addresses or
multicast addresses.
The IPv6 128-bit addresses are represented as a series of eight 16-bit hexadecimal fields separated by
colons in the format: n:n:n:n:n:n:n:n. it is an example of an IPv6 address:
2031:0000:130F:0000:0000:09C0:080F:130B
The leading zeros in each field are optional, implementation is easier without them. it is the same address
without leading zeros:
2031:0:130F:0:0:9C0:80F:130B
You can also use two colons (::) to represent successive hexadecimal fields of zeros, but you can use this
short version only once in each address:
2031:0:130F::09C0:080F:130B
The switch supports the following features:
• IPv6 address types: Anycast
• IPv6 default router preferences
• IPv6 MTU path discovery
• Neighbor discovery duplicate address detection
• Cisco Discovery Protocol — IPv6 address family support for neighbor information
• ICMPv6 redirect
• ICMP rate limiting
• DNS lookups over an IPv6 transport
• uRPF
• ICMPv6
• AAAA DNS lookups over an IPv4 transport
You can find information about these features at this location:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-addrg_bsc_con.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
43-2 OL-22250-01
Chapter 43 Support for IPv6
About IPv6
DHCP
The following DHCP features are supported for IPv6 on the Catalyst 4500 series switch:
• Relay agent
• Relay agent notification for prefix delegation
• Reload persistent interface ID option
• Ethernet remote ID option
You can find information about these features at this location:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-dhcp.html
Security
The following security features are supported for IPv6 on the Catalyst 4500 series switch:
• Secure Shell (SSH) support over IPv6
• Traffic filters
• standard access control lists (ACL)
• extended access control lists
• ACL accounting
• ACL addressing
• ACL DSCP
• ACL flags
• ACL flows
• ACL fragments
• ACL ICMP codes
• ACL logging
• ACL protocols
You can find information about these features at this location:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-sec_trfltr_fw.html
QoS
The following QoS features are supported for IPv6 on the Catalyst 4500 series switch:
• MQC packet classification
• MQC traffic shaping and sharing
• MQC traffic policing
• MQC packing marking and remarking
You can find information about these features at this location:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-qos.html
Catalyst 4500 Switch Software Configuration Guide
OL-22250-01 43-3
Chapter 43 Support for IPv6
About IPv6
Management
The following management features are supported for IPv6 on the Catalyst 4500 series switch:
• Ping
• Syslog
• SNMP
• HTTP(s)
You can find information about these features at this location:
http://www.cisco.com/en/US/docs/ios-xml/ios/ipv6/configuration/12-2sx/ip6-mng-apps.html
Multicast
Traditional IP communication allows a host to send packets to a single host (unicast transmission) or to
all hosts (broadcast transmission). IPv6 multicast, allows a host to send a single data stream to a subset
of all hosts (group transmission) simultaneously.
The following multicast features are supported for IPv6 on the Catalyst 4500 series switch:
• Multicast Listener Discovery (MLD) protocol, versions 1 and 2
You can find information about IPv6 MLD Snooping at this location:
http://www.cisco.com/en/US/docs/switches/lan/catalyst4500/12.2/53SG/configuration/mldsnoop.h
tml
• PIM Sparse Mode (PIM-SM) (EntServices only)
• PIM Source Specific Multicast (PIM-SSM)
• MLD access group
• PIM embedded Rendezvous Point (RP) support
• Static multicast routing (mroute)
• Bootstrap routers (BSR)
• MLD snooping (EntServices and IP Base)
You can find information about these features at this location:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-multicast.html
Static Routes
Networking devices forward packets using route information that is either manually configured or
dynamically learned using a routing protocol. Static routes are manually configured and define an
explicit path between two networking devices. Unlike a dynamic routing protocol, static routes are not
automatically updated and must be manually reconfigured if the network topology changes. The benefits
of using static routes include security and resource efficiency. Static routes use less bandwidth than
dynamic routing protocols and no CPU cycles are used to calculate and communicate routes. The main
disadvantage to using static routes is the lack of automatic reconfiguration if the network topology
changes.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
43-4 OL-22250-01
Chapter 43 Support for IPv6
About IPv6
Static routes can be redistributed into dynamic routing protocols but routes generated by dynamic
routing protocols cannot be redistributed into the static routing table. No algorithm exists to prevent the
configuration of routing loops that use static routes.
Static routes are useful for smaller networks with only one path to an outside network and to provide
security for a larger network for certain types of traffic or links to other networks that need more control.
In general, most networks use dynamic routing protocols to communicate between networking devices
but may have one or two static routes configured for special cases.
You can find more information regarding static routes at:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-stat_routes.html
First-Hop Redundancy Protocols
IPv6 routing protocols ensure router-to-router resilience and failover. However, in situations in which
the path between a host and the first-hop router fails, or the first-hop router itself fails, First-Hop
Redundancy Protocols (FHRPs) ensure host-to-router resilience and failover.
The Hot Standby Router Protocol (HSRP) protects data traffic in case of a gateway failure.
You can find more information about First-Hop Redundancy Protocols at:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-fhrp.html
Unicast Routing
These sections describe the IPv6 unicast routing protocol features supported by the switch:
• RIP, page 43-5
• OSPF, page 43-5
• EIGRP, page 43-6
• Multiprotocol BGP, page 43-6
RIP
Routing Information Protocol (RIP) for IPv6 is a distance-vector protocol that uses hop count as a
routing metric. It includes support for IPv6 addresses and prefixes and the all-RIP routers multicast
group address FF02::9 as the destination address for RIP update messages.
You can find more about RIP at this location:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-rip.html
OSPF
The switch running the IP services feature set supports Open Shortest Path First (OSPF) for IPv6, a
link-state protocol for IP.
You can find more information about OSPF at this location:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-ospf.html
Catalyst 4500 Switch Software Configuration Guide
OL-22250-01 43-5
Chapter 43 Support for IPv6
About IPv6
EIGRP
The switch running the IP-services feature set supports Enhanced Interior Gateway Routing Protocol
(EIGRP) for IPv6. It is configured on the interfaces on which it runs and does not require a global IPv6
address.
Before running, an instance of EIGRP IPv6 requires an implicit or explicit router ID. An implicit router
ID is derived from a local IPv4 address, so any IPv4 node always has an available router ID. However,
EIGRP IPv6 might be running in a network with only IPv6 nodes and therefore might not have an
available IPv4 router ID.
You can find more information about EIGRP at this location:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-eigrp.html
Multiprotocol BGP
Multiprotocol Border Gateway Protocol (BGP) is an Exterior Gateway Protocol (EGP) used mainly to
connect separate routing domains that contain independent routing policies (autonomous systems).
Connecting to a service provider for access to the Internet is a common use for BGP. BGP can also be
used within an autonomous system, which is referred to as internal BGP (iBGP). Multiprotocol BGP is
an enhanced BGP that carries routing information for multiple network layer protocol address families,
for example, IPv6 address family and for IP multicast routes. All BGP commands and routing policy
capabilities can be used with multiprotocol BGP.
You can find more information about multiprotocol BGP at this location:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-mptcl_bgp.html
Tunneling
The following tunneling features are supported for IPv6 on the Catalyst 4500 series switch:
• Automatic 6to4
• ISATAP
• Configured tunnels
Note Tunneling is not supported in hardware but is supported in software.
You can find information about these features at this location:
http://www.cisco.com/en/US/docs/ios/ipv6/configuration/guide/ip6-tunnel.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
43-6 OL-22250-01
Chapter 43 Support for IPv6
IPv6 Default States
IPv6 Default States
Table 43-1 shows the default states of IPv6 configuration.
Table 43-1 Default IPv6 Configuration
Feature Default Setting
IPv6 routing Disabled globally and on all interfaces
CEFv6 Disabled (IPv4 CEF is enabled by default)
Note When IPv6 routing is enabled, CEFv6 is automatically enabled.
IPv6 addresses None configured
Catalyst 4500 Switch Software Configuration Guide
OL-22250-01 43-7
Chapter 43 Support for IPv6
IPv6 Default States
Software Configuration Guide—Release IOS-XE 3.1.0 SG
43-8 OL-22250-01
CH A P T E R 44
Port Unicast and Multicast Flood Blocking
This chapter describes how to configure multicast and unicast flood blocking on the Catalyst 4000
family switch. This chapter contains these topics:
• About Flood Blocking, page 44-1
• Configuring Port Blocking, page 44-1
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Flood Blocking
Occasionally, unknown unicast or multicast traffic is flooded to a switch port because a MAC address
has timed out or has not been learned by the switch. (This condition is especially undesirable for a
private VLAN isolated port.) To guarantee that no unicast and multicast traffic is flooded to the port, use
the switchport block unicast and switchport block multicast commands to enable flood blocking on
the switch.
Note The flood blocking feature is supported on all switched ports (including PVLAN ports) and is applied
to all VLANs on which the port is forwarding.
Configuring Port Blocking
By default, a switch floods packets with unknown destination MAC addresses to all ports. If unknown
unicast and multicast traffic is forwarded to a switch port, there might be security issues. To prevent
forwarding such traffic, you can configure a port to block unknown unicast or multicast packets.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 44-1
Chapter 44 Port Unicast and Multicast Flood Blocking
Configuring Port Blocking
Note Blocking of unicast or multicast traffic is not automatically enabled on a switch port; you must explicitly
configure it.
Blocking Flooded Traffic on an Interface
Note The interface can be a physical interface (for example, GigabitEthernet 1/1) or an EtherChannel group
(such as port-channel 5). When you block multicast or unicast traffic for a port channel, it is blocked on
all ports in the port channel group.
Note Starting with Cisco IOS Release 12.2(52)SG, only IPV4 and IPv6 unknown multicast traffic flooding is
blocked; Layer 2 unknown multicast flooding is not. This behavior stems from a fix for the following
problem: when you configure blocking of unknown multicast flooding on a port, broadcast traffic to the
port is also blocked.
To disable the flooding of multicast and unicast packets to an interface, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Enters interface configuration mode and enter the type and
number of the switchport interface (for example,
GigabitEthernet 1/1).
Step 3 Switch(config-if)# switchport block Blocks unknown multicast forwarding to the port.
multicast
Step 4 Switch(config-if)# switchport block unicast Blocks unknown unicast forwarding to the port.
Step 5 Switch(config)# end Returns to privileged EXEC mode.
Step 6 Switch# Verifies your entry.
show interface interface-id switchport
Step 7 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
This example shows how to block unicast and multicast flooding on a GigabitEthernet interface1/1 and
how to verify the configuration:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface gigabitethernet1/1
Switch(config-if)# switchport block multicast
Switch(config-if)# switchport block unicast
Switch(config-if)# end
Switch# show interface gigabitethernet1/1 switchport
Name: Gi1/3
Switchport: Enabled
<output truncated>
Software Configuration Guide—Release IOS-XE 3.1.0 SG
44-2 OL-22250-01
Chapter 44 Port Unicast and Multicast Flood Blocking
Configuring Port Blocking
Port Protected: On
Unknown Unicast Traffic: Not Allowed
Unknown Multicast Traffic: Not Allowed
Broadcast Suppression Level: 100
Multicast Suppression Level: 100
Unicast Suppression Level: 100
Resuming Normal Forwarding on a Port
To resume normal forwarding on a port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface Enters interface configuration mode and enter the type and number of
interface-id the switchport interface (GigabitEthernet1/1).
Step 3 Switch(config-if)# no switchport Enables unknown multicast flooding to the port.
block multicast
Step 4 Switch(config-if)# no switchport Enables unknown unicast flooding to the port.
block unicast
Step 5 Switch(config)# end Returns to privileged EXEC mode.
Step 6 Switch# show interface interface-id Verifies your entry.
switchport
Step 7 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 44-3
Chapter 44 Port Unicast and Multicast Flood Blocking
Configuring Port Blocking
Software Configuration Guide—Release IOS-XE 3.1.0 SG
44-4 OL-22250-01
CH A P T E R 45
Configuring Storm Control
This chapter describes how to configure port-based traffic control on the Catalyst 4500 series switch.
This chapter consists of these sections:
• About Storm Control, page 45-1
• Enabling Broadcast Storm Control, page 45-3
• Enabling Multicast Storm Control, page 45-4
• Disabling Broadcast Storm Control, page 45-5
• Disabling Multicast Storm Control, page 45-6
• Displaying Storm Control, page 45-6
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About Storm Control
This section contains the following subsections:
• Hardware-based Storm Control Implementation, page 45-2
• Software-based Storm Control Implementation, page 45-2
Storm control prevents LAN interfaces from being disrupted by a broadcast storm. A broadcast storm
occurs when broadcast packets flood the subnet, creating excessive traffic and degrading network
performance. Errors in the protocol-stack implementation or in the network configuration can cause a
broadcast storm.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 45-1
Chapter 45 Configuring Storm Control
About Storm Control
Note Storm control and Multicast storm control are supported in hardware on all ports on Supervisor Engine
7-E.
Hardware-based Storm Control Implementation
Broadcast suppression uses filtering that measures broadcast activity in a subnet over a one-second
interval and compares the measurement with a predefined threshold. If the threshold is reached, further
broadcast activity is suppressed for the duration of the interval. Broadcast suppression is disabled by
default.
Figure 45-1 shows the broadcast traffic patterns on a LAN interface over a given interval. In this
example, broadcast suppression occurs between times T1 and T2 and between T4 and T5. During those
intervals, the amount of broadcast traffic exceeded the configured threshold.
Figure 45-1 Storm Control Example - Hardware-based Implementation
Total
number of
Threshold
broadcast
packets
or bytes
S5706
0 T1 T2 T3 T4 T5 Time
The broadcast suppression threshold numbers and the time interval combination make the broadcast
suppression algorithm work with different levels of granularity. A higher threshold allows more
broadcast packets to pass through.
Broadcast suppression on the Catalyst 4500 series switches (including Supervisor Engine 7-E) is
implemented in hardware. The suppression circuitry monitors packets passing from a LAN interface to
the switching bus. If the packet destination address is broadcast, then the broadcast suppression circuitry
tracks the current count of broadcasts within the one-second interval, and when a threshold is reached,
it filters out subsequent broadcast packets.
Because hardware broadcast suppression uses a bandwidth-based method to measure broadcast activity,
the most significant implementation factor is setting the percentage of total available bandwidth that can
be used by broadcast traffic. Because packets do not arrive at uniform intervals, the one-second interval
during which broadcast activity is measured can affect the behavior of broadcast suppression.
Software-based Storm Control Implementation
When storm control is enabled on an interface, the switch monitors packets received on the interface and
determines whether the packets are broadcast. The switch monitors the number of broadcast packets
received within a one-second time interval. When the interface threshold is met, all incoming data traffic
Software Configuration Guide—Release IOS-XE 3.1.0 SG
45-2 OL-22250-01
Chapter 45 Configuring Storm Control
Enabling Broadcast Storm Control
on the interface is dropped. This threshold is specified as a percentage of total available bandwidth that
can be used by broadcast traffic. If the lower threshold is specified, all data traffic is forwarded as soon
as the incoming traffic falls below that threshold.
Enabling Broadcast Storm Control
To enable storm control, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Enters interface configuration mode and enter the port to configure.
Step 3 Switch(config-if)# storm-control Configures broadcast storm control.
broadcast level [high level] [lower
level] Specifies the upper threshold levels for broadcast traffic. The storm
control action occurs when traffic utilization reaches this level.
(Optional) Specifies the falling threshold level. The normal
transmission restarts (if the action is filtering) when traffic drops
below this level for interfaces that support software-based
suppression.
Note For ports that perform hardware-based suppression, the
lower threshold is ignored.
Step 4 Switch(config-if)# storm-control action Specifies the action to be taken when a storm is detected.
{shutdown | trap}
The default is to filter out the broadcast traffic and not to send out
traps.
The shutdown keyword sets the port to error-disable state during a
storm. If the recover interval is not set, the port remains in shutdown
state.
Step 5 Switch(config-if)# exit Returns to configuration mode.
Step 6 Switch(config)# end Returns to privileged EXEC mode.
Step 7 Switch# show storm-control [interface] Displays the number of packets suppressed.
broadcast
Step 8 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
The following example shows how to enable storm control on interface.
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface fa3/1
Switch(config-if)# storm-control broadcast level 50
Switch(config-if)# end
Switch# show storm-control
Interface Filter State Broadcast Multicast Level
--------- ------------- --------- --------- -----
Fi3/1 Forwarding Enabled Disabled 50.00%
Switch# show int fa2/1 capabilities
FastEthernet2/1
Model: WS-X4148-RJ45V-RJ-45
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 45-3
Chapter 45 Configuring Storm Control
Enabling Multicast Storm Control
Type: 10/100BaseTX
Speed: 10,100,auto
Duplex: half,full,auto
Auto-MDIX: no
Trunk encap. type: 802.1Q
Trunk mode: on,off,desirable,nonegotiate
Channel: yes
Broadcast suppression: percentage(0-100), hw
Multicast suppression: percentage(0-100), hw
Flowcontrol: rx-(none),tx-(none)
VLAN Membership: static, dynamic
Fast Start: yes
CoS rewrite: yes
ToS rewrite: yes
Inline power: yes (Cisco Voice Protocol)
SPAN: source/destination
UDLD: yes
Link Debounce: no
Link Debounce Time: no
Port Security: yes
Dot1x: yes
Maximum MTU: 1552 bytes (Baby Giants)
Multiple Media Types: no
Diagnostic Monitoring: N/A\
Note Supervisor Engine 7-E supports multicast suppression
Enabling Multicast Storm Control
Supervisor Engine 7-E supports per-interface multicast suppression.
This allows the user to subject incoming multicast and broadcast traffic on an interface to suppression.
Note Multicast and broadcast suppression share a common threshold per interface.
Multicast suppression takes effect only if broadcast suppression is enabled.
Disabling broadcast suppression on an interface also disables multicast suppression.
To enable multicast suppression, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Enters interface configuration mode and enter the port to
configure.
Step 3 Switch(config-if)# storm-control Enables multicast suppression.
broadcast include multicast
Step 4 Switch(config-if)# exit Returns to configuration mode.
Step 5 Switch(config)# end Returns to privileged EXEC mode.
Step 6 Switch# show storm-control Verifies the configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
45-4 OL-22250-01
Chapter 45 Configuring Storm Control
Disabling Broadcast Storm Control
The following example shows how to enable multicast suppression on ports that have broadcast
suppression already enabled:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# int fa3/1
Switch(config-if)# storm-control broadcast include multicast
Switch(config-if)# end
Switch#
Switch# show storm-control
Interface Filter State Broadcast Multicast Level
--------- ------------- --------- --------- -----
Fi3/1 Forwarding Enabled Enabled 50.00%
Disabling Broadcast Storm Control
To disable storm control, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# interface interface-id Enters interface configuration mode and enter the port to
configure.
Step 3 Switch(config-if)# no storm-control Disables port storm control.
broadcast level
Step 4 Switch(config-if)# no storm-control action Disables the specified storm control action and returns to
{shutdown | trap} default filter action.
Step 5 Switch(config-if)# exit Returns to configuration mode.
Step 6 Switch(config)# end Returns to privileged EXEC mode.
Step 7 Switch# show storm-control broadcast Verifies your entries.
Step 8 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
The following example shows how to disable storm control on interface.
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# int fa3/1
Switch(config-if)# no storm-control broadcast level
Switch(config-if)# end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 45-5
Chapter 45 Configuring Storm Control
Disabling Multicast Storm Control
Switch# show storm-control
Interface Filter State Upper Lower Current
--------- ------------- ------- ------- -------
Switch#
Disabling Multicast Storm Control
To disable multicast suppression, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# [no] storm-control Enables/disables multicast suppression.
broadcast include multicast
Step 3 Switch(config-if)# no storm-control Disables port storm control (broadcast and multicast).
broadcast level
Step 4 Switch(config-if)# end Returns to configuration mode.
Step 5 Switch(config)# end Returns to privileged EXEC mode.
Displaying Storm Control
Note Use the show interface capabilities command to determine the mode in which storm control is
supported on an interface.
The following example shows an interface that supports broadcast suppression in software (sw).
Switch# show int fa2/1 capabilities
FastEthernet2/1
Model: WS-X4148-RJ45V-RJ-45
Type: 10/100BaseTX
Speed: 10,100,auto
Duplex: half,full,auto
Auto-MDIX: no
Trunk encap. type: 802.1Q
Trunk mode: on,off,desirable,nonegotiate
Channel: yes
Broadcast suppression: percentage(0-100), hw
Multicast suppression: percentage(0-100), hw
Flowcontrol: rx-(none),tx-(none)
VLAN Membership: static, dynamic
Fast Start: yes
CoS rewrite: yes
ToS rewrite: yes
Inline power: yes (Cisco Voice Protocol)
SPAN: source/destination
UDLD: yes
Link Debounce: no
Link Debounce Time: no
Port Security: yes
Dot1x: yes
Maximum MTU: 1552 bytes (Baby Giants)
Multiple Media Types: no
Diagnostic Monitoring: N/A
Software Configuration Guide—Release IOS-XE 3.1.0 SG
45-6 OL-22250-01
Chapter 45 Configuring Storm Control
Displaying Storm Control
Note Use the show interfaces counters storm-control command to display a count of discarded packets.
Switch# show interfaces counters storm-control
Port Broadcast Multicast Level TotalSuppressedPackets
Fa2/1 Enabled Disabled 10.00% 46516510
Gi3/1 Enabled Enabled 50.00% 0
The following example shows the output of the show storm-control command:
Switch# show storm-control
Interface Filter State Upper Lower Current
--------- ------------- ------- ------- -------
Gi4/4 Forwarding 2.00% 2.00% N/A
Switch
Note In the previous example, “current” represents the percentage of traffic suppressed at a given instant, and
the value is N/A for ports that perform suppression in hardware.
Switch# show storm-control
Interface Filter State Broadcast Multicast Level
--------- ------------- --------- --------- -----
Fa2/1 Blocking Enabled Disabled 10.00%
Gi3/1 Link Down Enabled Enabled 50.00%
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 45-7
Chapter 45 Configuring Storm Control
Displaying Storm Control
Software Configuration Guide—Release IOS-XE 3.1.0 SG
45-8 OL-22250-01
CH A P T E R 46
Configuring SPAN and RSPAN
This chapter describes how to configure the Switched Port Analyzer (SPAN) and Remote SPAN
(RSPAN) on the Catalyst 4500 series switches. SPAN selects network traffic for analysis by a network
analyzer, such as a SwitchProbe device or other Remote Monitoring (RMON) probe.
This chapter consists of the following sections:
• About SPAN and RSPAN, page 46-2
• Configuring SPAN, page 46-7
• CPU Port Sniffing, page 46-10
• Encapsulation Configuration, page 46-12
• Ingress Packets, page 46-12
• Access List Filtering, page 46-13
• Packet Type Filtering, page 46-14
• Configuration Example, page 46-15
• Configuring RSPAN, page 46-16
• Displaying SPAN and RSPAN Status, page 46-24
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-1
Chapter 46 Configuring SPAN and RSPAN
About SPAN and RSPAN
About SPAN and RSPAN
This sections includes the following subsections:
• SPAN and RSPAN Concepts and Terminology, page 46-3
• SPAN and RSPAN Session Limits, page 46-6
• Default SPAN and RSPAN Configuration, page 46-6
SPAN mirrors traffic from one or more source interfaces on any VLAN or from one or more VLANs to
a destination interface for analysis. In Figure 46-1, all traffic on Ethernet interface 5 (the source
interface) is mirrored to Ethernet interface 10. A network analyzer on Ethernet interface 10 receives all
network traffic from Ethernet interface 5 without being physically attached to it.
For SPAN configuration, the source interfaces and the destination interface must be on the same switch.
SPAN does not affect the switching of network traffic on source interfaces; copies of the packets received
or transmitted by the source interfaces are sent to the destination interface.
Figure 46-1 Example SPAN Configuration
Port 5 traffic mirrored
1 2 3 4 5 6 7 8 9 10 11 12 on port 10
E6 E7
E5 E8 E11
E4 E9 E12
E3 E10
E2
E1
S6884
Network analyzer
RSPAN extends SPAN by enabling remote monitoring of multiple switches across your network. The
traffic for each RSPAN session is carried over a user-specified RSPAN VLAN that is dedicated for that
RSPAN session in all participating switches. The SPAN traffic from the sources is copied onto the
RSPAN VLAN and then forwarded over trunk ports that are carrying the RSPAN VLAN to any RSPAN
destination sessions monitoring the RSPAN VLAN, as shown in Figure 46-2.
Figure 46-2 Example of RSPAN Configuration
Source switch Intermediate switch Destination switch
RSPAN RSPAN
VLAN VLAN
105028
RSPAN RSPAN
source port destination port
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-2 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
About SPAN and RSPAN
SPAN and RSPAN do not affect the switching of network traffic on source ports or source VLANs; a
copy of the packets received or sent by the sources is sent to the destination. Except for traffic that is
required for the SPAN or RSPAN session, by default, destination ports do not receive or forward traffic.
Use the SPAN or RSPAN destination port to forward transmitted traffic from a network security device.
For example, if you connect a Cisco Intrusion Detection System (IDS) sensor appliance to a destination
port, the IDS device can send TCP reset packets to close down the TCP session of a suspected attacker.
SPAN and RSPAN Concepts and Terminology
This section describes concepts and terminology associated with SPAN and RSPAN configuration and
includes the following subsections:
• SPAN Session, page 46-3
• Traffic Types, page 46-3
• Source Port, page 46-4
• Destination Port, page 46-5
• VLAN-Based SPAN, page 46-5
• SPAN Traffic, page 46-6
SPAN Session
A local SPAN session associates a destination port with source ports. You can monitor incoming or
outgoing traffic on a series or range of ports and source VLANs. An RSPAN session associates source
ports and source VLANs across your network with an RSPAN VLAN. The destination source is the
RSPAN VLAN.
You configure SPAN sessions by using parameters that specify the source of network traffic to monitor.
You can configure multiple SPAN or RSPAN sessions with separate or overlapping sets of SPAN
sources. Both switched and routed ports can be configured as SPAN sources or destination ports.
An RSPAN source session associates SPAN source ports or VLANs with a destination RSPAN VLAN.
An RSPAN destination session associates an RSPAN VLAN with a destination port.
SPAN sessions do not interfere with the normal operation of the switch; however, an oversubscribed
SPAN destination (for example, a 10-Mbps port monitoring a 100-Mbps port) results in dropped or lost
packets.
You can configure SPAN sessions on disabled ports; however, a SPAN session does not become active
unless you enable the destination port and at least one source port or VLAN for that session.
A SPAN session remains inactive after system startup until the destination port is operational.
Traffic Types
SPAN sessions include these traffic types:
• Receive (Rx) SPAN—The goal of receive (or ingress) SPAN is to monitor as much as possible all
packets received by the source interface or VLAN before any modification or processing is
performed by the switch. A copy of each packet received by the source is sent to the destination port
for that SPAN session. You can monitor a series or range of ingress ports or VLANs in a SPAN
session.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-3
Chapter 46 Configuring SPAN and RSPAN
About SPAN and RSPAN
On tagged packets (Inter-Switch Link [ISL] or IEEE 802.1Q), the tagging is removed at the ingress
port. At the destination port, if tagging is enabled, the packets appear with the ISL or 802.1Q
headers. If no tagging is specified, packets appear in the native format.
Packets that are modified because of routing are copied without modification for Rx SPAN; that is,
the original packet is copied. Packets that are modified because of quality of service (QoS)—for
example, modified Differentiated Services Code Point (DSCP)—are copied without modification for
Rx SPAN.
Some features that can cause a packet to be dropped during receive processing have no effect on
SPAN; the destination port receives a copy of the packet even if the actual incoming packet is
dropped. These features include IP standard and extended input access control lists (ACLs), IP
standard and extended output ACLs for unicast and ingress QoS policing, VLAN maps, ingress QoS
policing, and policy-based routing. Switch congestion that causes packets to be dropped also has no
effect on SPAN.
• Transmit (Tx) SPAN—The goal of transmit (or egress) SPAN is to monitor as much as possible all
packets sent by the source interface after the switch performs all modification and processing. After
the packet is modified, the source sends a copy of each packet to the destination port for that SPAN
session. You can monitor a range of egress ports in a SPAN session.
Packets that are modified because of routing—for example, with a time-to-live (TTL) or
MAC-address modification—are duplicated at the destination port. On packets that are modified
because of QoS, the modified packet might not have the same DSCP (IP packet) or CoS (non-IP
packet) as the SPAN source.
Some features that can cause a packet to be dropped during transmit processing might also affect
the duplicated copy for SPAN. These features include VLAN maps, IP standard and extended output
ACLs on multicast packets, and egress QoS policing. In the case of output ACLs, if the SPAN source
drops the packet, the SPAN destination would also drop the packet. In the case of egress QoS
policing, if the SPAN source drops the packet, the SPAN destination might not drop it. If the source
port is oversubscribed, the destination ports have different dropping behavior.
• Both—In a SPAN session, you can monitor a single port series or a range of ports for both received
and sent packets.
Source Port
A source port (also called a monitored port) is a switched or routed port that you monitor for network
traffic analysis. In a single local SPAN session or RSPAN source session, you can monitor source port
traffic, such as received (Rx), transmitted (Tx), or bidirectional (both). The switch supports any number
of source ports (up to the maximum number of available ports on the switch) and any number of source
VLANs.
A source port has these characteristics:
• It can be any port type (for example, EtherChannel, Fast Ethernet, Gigabit Ethernet, and so forth).
• It can be monitored in multiple SPAN sessions.
• It cannot be a destination port.
• Each source port can be configured with a direction (ingress, egress, or both) to monitor. For
EtherChannel sources, the monitored direction would apply to all physical ports in the group.
• Source ports can be in the same or different VLANs.
• For VLAN SPAN sources, all active ports in the source VLAN are included as source ports.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-4 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
About SPAN and RSPAN
You can configure a trunk port as a source port. By default, all VLANs active on the trunk are monitored.
You can limit SPAN traffic monitoring on trunk source ports to specific VLANs by using VLAN
filtering. Only switched traffic in the selected VLANs is sent to the destination port. This feature affects
only traffic forwarded to the destination SPAN port and does not affect the switching of normal traffic.
This feature is not allowed in sessions with VLAN sources.
Destination Port
Each local SPAN session or RSPAN destination session must have a destination port (also called a
monitoring port) that receives a copy of traffic from the source ports and VLANs.
A destination port has these characteristics:
• A destination port must reside on the same switch as the source port (for a local SPAN session).
• A destination port can be any Ethernet physical port.
• A destination port can participate in only one SPAN session at a time. (A destination port in one
SPAN session cannot be a destination port for a second SPAN session.)
• A destination port cannot be a source port.
• A destination port cannot be an EtherChannel group.
• A destination port can be a physical port that is assigned to an EtherChannel group, even if the
EtherChannel group has been specified as a SPAN source. The port is removed from the group while
it is configured as a SPAN destination port.
• The port does not transmit any traffic except that traffic required for the SPAN session unless
learning is enabled. If learning is enabled, the port also transmits traffic directed to hosts that have
been learned on the destination port.
• If ingress traffic forwarding is enabled for a network security device, the destination port forwards
traffic at Layer 2.
• A destination port does not participate in spanning tree while the SPAN session is active.
• When it is a destination port, it does not participate in any of the Layer 2 protocols (STP, VTP, CDP,
DTP, PagP).
• A destination port that belongs to a source VLAN of any SPAN session is excluded from the source
list and is not monitored.
• A destination port receives copies of sent and received traffic for all monitored source ports. If a
destination port is oversubscribed, it could become congested and result in packet drops at the
destination port. This congestion does not affect traffic forwarding on the source ports.
VLAN-Based SPAN
VLAN-based SPAN (VSPAN) is the monitoring of the network traffic in one or more VLANs.
Use these guidelines for VSPAN sessions:
• Traffic on RSPAN VLANs is not monitored by VLAN-based SPAN sessions.
• Only traffic on the monitored VLAN is sent to the destination port.
• If a destination port belongs to a source VLAN, it is excluded from the source list and is not
monitored.
• If ports are added to or removed from the source VLANs, the traffic on the source VLAN received
by those ports is added to or removed from the sources being monitored.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-5
Chapter 46 Configuring SPAN and RSPAN
About SPAN and RSPAN
• VLAN pruning and the VLAN allowed list have no effect on SPAN monitoring.
• VSPAN monitors only traffic that enters the switch, not traffic that is routed between VLANs. For
example, if a VLAN is being Rx-monitored, and the multilayer switch routes traffic from another
VLAN to the monitored VLAN, that traffic is not monitored and is not received on the SPAN
destination port.
• You cannot use filter VLANs in the same session with VLAN sources.
• You can monitor only Ethernet VLANs.
SPAN Traffic
Use the local SPAN to monitor all network traffic, including multicast and bridge protocol data unit
(BPDU) packets, Cisco Discovery Protocol (CDP), VLAN Trunk Protocol (VTP), Dynamic Trunking
Protocol (DTP), Spanning Tree Protocol (STP), and Port Aggregation Protocol (PAgP) packets. You
cannot use RSPAN to monitor Layer 2 protocols. (See the “RSPAN Configuration Guidelines” section
on page 46-16 for more information.)
In some SPAN configurations, multiple copies of the same source packet are sent to the SPAN
destination port. For example, a bidirectional (both Rx and Tx) SPAN session is configured for the
sources a1 Rx monitor and the a2 Rx and Tx monitor to destination port d1. If a packet enters the switch
through a1 and is switched to a2, both incoming and outgoing packets are sent to destination port d1.
Both packets are the same (unless a Layer-3 rewrite occurs, in which case the packets are different
because of the added Layer 3 information).
SPAN and RSPAN Session Limits
You can configure a maximum of sixteen SPAN/RSPAN sessions (eight concurrent sessions with
ingress-only sources and eight concurrent sessions with egress-only sources). Bidirectional sources
count as both ingress and egress. RSPAN destination sessions count as a session containing an ingress
source.
Default SPAN and RSPAN Configuration
Table 46-1 shows the default SPAN and RSPAN configuration.
Table 46-1 Default SPAN and RSPAN Configuration
Feature Default Setting
SPAN state Disabled.
Source port traffic to monitor Both received and sent traffic (both).
Filters All VLANs, all packet types, all address types.
Encapsulation type (destination port) Native form (no encapsulation type header).
Ingress forwarding (destination port) Disabled.
Host learning (destination port) Disabled.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-6 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
Configuring SPAN
Configuring SPAN
The following sections describe how to configure SPAN:
• SPAN Configuration Guidelines and Restrictions, page 46-7
• Configuring SPAN Sources, page 46-8
• Configuring SPAN Destinations, page 46-9
• Monitoring Source VLANs on a Trunk Interface, page 46-9
• Configuration Scenario, page 46-10
• Verifying a SPAN Configuration, page 46-10
Note Entering SPAN configuration commands does not clear previously configured SPAN parameters. You
must enter the no monitor session command to clear configured SPAN parameters.
SPAN Configuration Guidelines and Restrictions
Follow these guidelines and restrictions when configuring SPAN:
• You must use a network analyzer to monitor interfaces.
• You cannot mix source VLANs and filter VLANs within a SPAN session. You can have source
VLANs or filter VLANs, but not both at the same time.
• EtherChannel interfaces can be SPAN source interfaces; they cannot be SPAN destination
interfaces.
• When you specify source interfaces and do not specify a traffic type (Tx, Rx, or both), “both” is used
by default. To change from both to either “tx” or “rx,” unconfigure the corresponding other type “rx”
or “tx” with the no monitor session {session_number} {source {interface interface_list | {vlan
vlan_IDs | cpu [queue queue_ids] } {rx | tx} command.
• If you specify multiple SPAN source interfaces, the interfaces can belong to different VLANs.
• You must enter the no monitor session number command with no other parameters to clear the
SPAN session number.
• The no monitor command clears all SPAN sessions.
• SPAN destinations never participate in any spanning tree instance. SPAN includes BPDUs in the
monitored traffic, so any BPDUs seen on the SPAN destination are from the SPAN source.
• SPAN is limited to one destination port per session.
• When you create a SPAN session, the packet filter is set to good by default and you see another
configuration line automatically:
monitor session number filter packet-type good rx
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-7
Chapter 46 Configuring SPAN and RSPAN
Configuring SPAN
Configuring SPAN Sources
To configure the source for a SPAN session, perform this task:
Command Purpose
Switch(config)# [no] monitor session Specifies the SPAN session number (1 through
{session_number} {source {interface 16), the source interfaces (FastEthernet or
<interface_list> | {vlan vlan_IDs | cpu
[queue queue_ids] } [rx | tx | both]
GigabitEthernet), VLANs (1 through 4094),
whether traffic received or sent from the CPU is
copied to the session destination, and the traffic
direction to be monitored.
For session_number, specifies the session number
identified with this session (1 through 16).
For interface-list, specifies the source port to
monitor. Valid interfaces include physical
interfaces and port-channel logical interfaces
(port-channel port-channel-number).
For vlan_IDs, specifies the source VLAN.
For queue_ids, specifies the queue(s) involved.
(Optional) [, | -] Specifies a series or range of
interfaces. Enter a space after the comma; enter a
space before and after the hyphen.
(Optional) Specifies the direction of traffic to
monitor. If you do not specify a traffic direction,
the source interface sends both transmitted (Tx)
and received (Rx) traffic. Only received traffic
can be monitored on additional source ports.
• Rx—Monitor received traffic.
• Tx—Monitor transmitted traffic.
• both—Monitor both received and transmitted
traffic (bidirectional).
Queues may be identified either by number or by
name. Queue names may subsume multiple
numbered queues for convenience.
Use the no keyword to restore the defaults.
This example shows how to configure SPAN session 1 to monitor bidirectional traffic from source
interface Fast Ethernet 5/1:
Switch(config)# monitor session 1 source interface fastethernet 5/1
This example shows how to configure sources with differing directions within a SPAN session:
Switch(config)# monitor session 1 source interface fa2/3 rx
Switch(config)# monitor session 1 source interface fa2/2 tx
Switch(config)#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-8 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
Configuring SPAN
Configuring SPAN Destinations
To configure the destination for a SPAN session, perform this task:
Command Purpose
Switch(config)# [no] monitor session Specifies the SPAN session number (1
<session_number> destination interface through 16) and the destination interfaces or
<interface> [encapsulation dot1q] [ingress
[vlan vlan_IDs] [learning}]
VLANs.
For session_number, specifies the session
number identified with this session
(1 through 16).
For interface, specifies the destination
interface.
For vlan_IDs, specifies the destination VLAN.
Use the no keyword to restore the defaults.
Note SPAN is limited to one destination port per session.
This example shows how to configure interface Fast Ethernet 5/48 as the destination for SPAN session 1:
Switch(config)# monitor session 1 destination interface fastethernet 5/48
Monitoring Source VLANs on a Trunk Interface
To monitor specific VLANs when the SPAN source is a trunk interface, perform this task:
Command Purpose
Switch(config)# [no] monitor session Monitors specific VLANs when the SPAN source is a
{session_number} filter {vlan vlan_IDs trunk interface. The filter keyword restricts
[, | - ]} | {packet-type {good |
bad}} | {address-type {unicast |
monitoring to traffic that is on the specified VLANs;
multicast | broadcast} [rx | tx | it is typically used when monitoring a trunk interface.
both]}
For session_number, specifies the session number
identified with this session (1 through 16).
For vlan_IDs, specifies the VLAN.
Monitoring is established through all the ports in the
specified VLANs
Use the no keyword to restore the defaults.
This example shows how to monitor VLANs 1 through 5 and VLAN 9 when the SPAN source is a trunk
interface:
Switch(config)# monitor session 2 filter vlan 1 - 5 , 9
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-9
Chapter 46 Configuring SPAN and RSPAN
CPU Port Sniffing
Configuration Scenario
This example shows how to use the commands described in this chapter to completely configure and
unconfigure a span session. Assume that you want to monitor bidirectional traffic from source interfaces
Fast Ethernet 4/10, 4/11 and 4/12, Interface 4/10 is configured as a trunk interface carrying VLANs 1
through 4094. Interface Fast Ethernet 4/11 is configured as an access port in VLAN 57 and interface Fast
Ethernet 4/12 is configured as an access port in VLAN 58. You want to monitor only traffic in VLAN
57 in that session. Using Fast Ethernet 4/15 as your destination interface, you would enter the following
commands:
Switch(config)# monitor session 1 source interface fastethernet 4/10 - 12
Switch(config)# monitor session 1 filter vlan 57
Switch(config)# monitor session 1 destination interface fastethernet 4/15
You are now monitoring traffic from interface Fast Ethernet 4/10 that is on VLAN 57 out of interface
FastEthernet 4/15. To disable the span session enter the following command:
Switch(config)# no monitor session 1
Verifying a SPAN Configuration
This example shows how to verify the configuration of SPAN session 2:
Switch# show monitor session 2
Session 2
---------
Source Ports:
RX Only: Fa5/12
TX Only: None
Both: None
Source VLANs:
RX Only: None
TX Only: None
Both: None
Destination Ports: Fa5/45
Filter VLANs: 1-5,9
Switch#
CPU Port Sniffing
When configuring a SPAN session, you can specify the CPU (or a subset of CPU queues) as a SPAN
source. Queues may be specified either by number or by name. When such a source is specified, traffic
going to the CPU through one of the specified queues is mirrored and sent out of the SPAN destination
port in the session. This traffic includes both control packets and regular data packets that are sent to or
from the CPU (due to software forwarding).
You can mix the CPU source with either regular port sources or VLAN sources.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-10 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
CPU Port Sniffing
To configure CPU source sniffing, perform this task:
Command Purpose
Switch(config)# [no] monitor session Specifies that the CPU causes traffic received by
{session_number} {source {interface or sent from the CPU to be copied to the
interface_list | {vlan vlan_IDs | cpu
[queue queue_ids] } [rx | tx | both]
destination of the session. The queue identifier
optionally allows sniffing-only traffic (received)
on the specified CPU queue(s).
For session_number, specifies the session number
identified with this SPAN session (1 through 16).
For interface-list, specifies the source port to
monitor. Valid interfaces include physical
interfaces and port-channel logical interfaces
(port-channel port-channel-number).
For vlan_IDs, specifies the source VLAN.
For queue_ids, specifies the queue(s) involved.
(Optional) [, | -] Specifies a series or range of
interfaces. Enter a space after the comma; enter a
space before and after the hyphen.
(Optional) Specifies the direction of traffic to
monitor. If you do not specify a traffic direction,
the source interface sends both transmitted (Tx)
and received (Rx) traffic. Only received traffic
can be monitored on additional source ports.
• Rx—Monitor received traffic.
• Tx—Monitor transmitted traffic.
• both—Monitor both received and transmitted
traffic (bidirectional).
Queues may be identified either by number or by
name. Queue names may subsume multiple
numbered queues for convenience.
Use the no keyword to restore the defaults.
This example shows how to configure a CPU source to sniff all packets received by the CPU:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# monitor session 1 source cpu rx
This example shows how to use queue names and queue number ranges for the CPU as a SPAN source:
Switch(config)# monitor session 2 source cpu queue control-packet rx
Switch(config)# monitor session 3 source cpu queue 10 rx
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-11
Chapter 46 Configuring SPAN and RSPAN
Encapsulation Configuration
Encapsulation Configuration
When configuring a SPAN destination port, you can explicitly enable the encapsulation option. Packets
exiting the port are tagged with 802.1q encapsulation. The encapsulation mode also controls how tagged
packets are handled when the ingress packet option is enabled.
The replicate encapsulation type (in which packets are transmitted from the destination port using
whatever encapsulation applied to the original packet) is not supported. If no encapsulation mode is
specified, the port default is untagged. To view the task of configuring encapsulation, see the command
table below.
Ingress Packets
When ingress is enabled, the SPAN destination port accepts incoming packets (potentially tagged
depending on the encapsulation option) and switches them normally. When configuring a SPAN
destination port, you can specify whether the ingress feature is enabled and what VLAN to use to switch
untagged ingress packets. Although the port is STP forwarding, it does not participate in the STP, so use
caution when configuring this feature lest a spanning-tree loop be introduced in the network. When both
ingress and a trunk encapsulation are specified on a SPAN destination port, the port goes forwarding in
all active VLANs. Configuring a non-existent VLAN as an ingress VLAN is not allowed.
By default, host learning is disabled on SPAN destination ports with ingress enabled. The port is also
removed from VLAN floodsets, so regular traffic is not switched out of the destination port. If learning
is enabled, however, then traffic for hosts learned on the destination port is switched out the destination
port. A host connected to SPAN destination port will not receive broadcast ARP request and so will not
respond. It is also possible to configure static host entries (including a static ARP entry and a static entry
in the MAC-address table) on SPAN destination ports.
Note This configuration does not work if the SPAN session does not have a source configured; the session is
half configured with only the SPAN destination port.
To configure ingress packets and encapsulation, perform this task:
Command Purpose
Switch(config)# [no] monitor session Specifies the configuration of the ingress
<session_number> destination interface packet and the encapsulation of the destination
<interface> [encapsulation dot1q] [ingress
[vlan vlan_IDs] [learning]]
port.
For session_number, specifies the session
number identified with this SPAN session (1
through 16).
For interface, specifies the destination
interface.
For vlan_IDs, specifies the destination VLAN.
Use the no keyword to restore the defaults.
This example shows how to configure a destination port with 802.1q encapsulation and ingress packets
using native VLAN 7:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-12 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
Access List Filtering
Switch(config)# monitor session 1 destination interface fastethernet 5/48
encapsulation dot1q ingress vlan 7
With this configuration, traffic from SPAN sources associated with session 1 would be copied out of
interface Fast Ethernet 5/48, with 802.1q encapsulation. Incoming traffic would be accepted and
switched, with untagged packets being classified into VLAN 7.
Access List Filtering
When configuring a SPAN session, you can apply access list filtering. Access list filtering applies to all
packets passing through a SPAN destination port that might be sniffed in the egress or ingress direction.
Access list filters are allowed on local SPAN sessions only. If the SPAN destination is an RSPAN
VLAN, the access list filter is rejected.
ACL Configuration Guidelines
You can configure ACLs on a SPAN session. Use these guidelines for ACL/SPAN sessions:
• If an ACL is associated with a SPAN session, the rules associated with that ACL are applied against
all packets exiting the SPAN destination interface. Rules pertaining to other VACLs or RACLs
previously associated with the SPAN destination interface are not applied.
• Only one ACL can be associated with a SPAN session.
• When no ACLs are applied to packets exiting a SPAN destination interface, all traffic is permitted
regardless of the PACLs, VACLs, or RACLs that have been previously applied to the destination
interface or VLAN to which the SPAN destination interface belongs.
• If an ACL is removed from a SPAN session, all traffic is permitted once again.
• If SPAN configuration is removed from the SPAN session, all rules associated with the SPAN
destination interface are applied once again.
• If a SPAN destination port is configured as a trunk port and the VLANs to which it belongs have
ACLs associated with them, the traffic is not subjected to the VACLs.
• ACL configuration applies normally to the RSPAN VLAN and to trunk ports carrying the RSPAN
VLAN. This configuration enables the user to apply VACLs on RSPAN VLANs. If a user attempts
to configure an ACL on a SPAN session with the destination port as an RSPAN VLAN, the
configuration is rejected.
• If CAM resources are exhausted and packets are passed to the CPU for lookup, any output port
ACLs associated with a SPAN session are not applied.
• If a named IP ACL is configured on a SPAN session before an ACL is created, the configuration is
accepted, and the software creates an empty ACL with no ACEs. (An empty ACL permits all
packets.) Subsequently, the rules can be added to the ACL.
• The ACLs associated with a SPAN session are applied on the destination interface on output.
• No policing is allowed on traffic exiting SPAN ports.
• Only IP ACLs are supported on SPAN sessions.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-13
Chapter 46 Configuring SPAN and RSPAN
Packet Type Filtering
Configuring Access List Filtering
To configure access list filtering, perform this task:
Command Purpose
Switch(config)# [no] monitor session Specifies filter sniffing based on the access list.
{session_number} filter {ip access-group
[name | id] }{vlan vlan_IDs [, | - ] } | For session_number, specify the session number
{packet-type {good | bad}} | identified with this SPAN session (1 through 16).
{address-type {unicast | multicast |
broadcast} [rx | tx | both]} You can specify either a name or a numeric ID for the
access list.
For name, specify the IP access list name.
For id, specify a standard <1 to 199> or extended
<1300-2699> IP access list.
Note IP access lists must be created in configuration mode as described in the chapter “Configuring Network
Security with ACLs.”
This example shows how to configure IP access group 10 on a SPAN session and verify that an access
list has been configured:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# monitor session 1 source interface fa6/1 both
Switch(config)# monitor session 1 destination interface fa6/2
Switch(config)# monitor session 1 filter vlan 1
Switch(config)# monitor session 1 filter ip access-group 10
Switch(config)# exit
Switch# show monitor
Session 1
---------
Type : Local Session
Source Ports :
Both : Fa6/1
Destination Ports : Fa6/2
Encapsulation : Native
Ingress : Disabled
Learning : Disabled
Filter VLANs : 1
IP Access-group : 10
Packet Type Filtering
When configuring a SPAN session, you can specify packet filter parameters similar to VLAN filters.
When specified, the packet filters indicate types of packets that may be sniffed. If no packet filters are
specified, packets of all types may be sniffed. Different types of packet filters may be specified for
ingress and egress traffic.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-14 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
Configuration Example
There are two categories of packet filtering: packet-based (good, error) or address-based
(unicast/multicast/broadcast). Packet-based filters can only be applied in the ingress direction. Packets
are classified as broadcast, multicast, or unicast by the hardware based on the destination address.
Note When filters of both types are configured, only packets that pass both filters are spanned. For example,
if you set both “error” and “multicast,” only multicast packets with errors are spanned.
To configure packet type filtering, perform this task:
Command Purpose
Switch(config)# [no] monitor session Specifies filter sniffing of the specified packet types in
{session_number} filter {vlan vlan_IDs the specified directions.
[, | - ] } | {packet-type {good | bad}}
| {address-type {unicast | multicast | For session_number, specifies the session number
broadcast} [rx | tx | both]} identified with this SPAN session (1 through 6).
For vlan_IDs, specifies the VLAN.
You can specify both Rx and Tx type filters, as well as
specify multiple type filters at the same time (such as
good and unicast to only sniff non-error unicast
frames). As with VLAN filters, if no type or filter is
specified, then the session sniffs all packet types.
Use the no keyword to restore the defaults.
This example shows how to configure a session to accept only unicast packets in the ingress direction:
Switch(config)# monitor session 1 filter address-type unicast rx
Configuration Example
The following is an example of SPAN configuration using some of the SPAN enhancements.
In the example below, you configure a session to sniff unicast traffic arriving on interface Gi1/1. The
traffic is mirrored out of interface Gi1/2 with dot1q encapsulation. Ingress traffic is permitted.
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# monitor session 1 source interface gi1/1 rx
Switch(config)# monitor session 1 destination interface gi1/2 encapsulation dot1q ingress
Switch(config)# monitor session 1 filter address-type unicast rx
Switch(config)# exit
Switch# show monitor
Session 1
---------
Type : Local Session
Source Ports :
RX Only : Gi1/1
Destination Ports : Gi1/2
Encapsulation : DOT1q
Ingress : Enabled
Learning : Disabled
Filter Addr Type :
RX Only : Unicast
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-15
Chapter 46 Configuring SPAN and RSPAN
Configuring RSPAN
Configuring RSPAN
This section describes how to configure RSPAN on your switch and it contains this configuration
information:
• RSPAN Configuration Guidelines, page 46-16
• Creating an RSPAN Session, page 46-17
• Creating an RSPAN Destination Session, page 46-18
• Creating an RSPAN Destination Session and Enabling Ingress Traffic, page 46-19
• Removing Ports from an RSPAN Session, page 46-21
• Specifying VLANs to Monitor, page 46-22
• Specifying VLANs to Filter, page 46-23
RSPAN Configuration Guidelines
Follow these guidelines when configuring RSPAN:
Note Since RSPAN VLANs have special properties, you should reserve a few VLANs across your network
for use as RSPAN VLANs; do not assign access ports to these VLANs.
Note You can apply an output access control list (ACL) to RSPAN traffic to selectively filter or monitor
specific packets. Specify these ACLs on the RSPAN VLAN in the RSPAN source switches.
• RSPAN sessions can coexist with SPAN sessions within the limits described in the “SPAN and
RSPAN Session Limits” section on page 46-6.
• For RSPAN configuration, you can distribute the source ports and the destination ports across
multiple switches in your network.
• RSPAN does not support BPDU packet monitoring or other Layer 2 switch protocols.
• The RSPAN VLAN is configured only on trunk ports and not on access ports. To avoid unwanted
traffic in RSPAN VLANs, make sure that all participating switches support the VLAN remote-span
feature. Access ports on the RSPAN VLAN are silently disabled.
• You should create an RSPAN VLAN before configuring an RSPAN source or destination session.
• If you enable VTP and VTP pruning, RSPAN traffic is pruned in the trunks to prevent the unwanted
flooding of RSPAN traffic across the network for VLAN-IDs that are lower than 1005.
• Because RSPAN traffic is carried across a network on an RSPAN VLAN, the original VLAN
association of the mirrored packets is lost. Therefore, RSPAN can only support forwarding of traffic
from an IDS device onto a single user-specified VLAN.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-16 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
Configuring RSPAN
Creating an RSPAN Session
First create an RSPAN VLAN that does not exist for the RSPAN session in any of the switches that
participate in RSPAN. With VTP enabled in the network, you can create the RSPAN VLAN in one
switch, and then VTP propagates it to the other switches in the VTP domain for VLAN-IDs that are lower
than 1005.
Use VTP pruning to get efficient flow of RSPAN traffic, or manually delete the RSPAN VLAN from all
trunks that do not need to carry the RSPAN traffic.
To start an RSPAN source session and to specify the source (monitored) ports and the destination RSPAN
VLAN, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# no monitor session Clears any existing RSPAN configuration for the session.
{session_number | all | local | remote}
For session_number, specifies the session number identified with
this RSPAN session (1 through 16).
Specifies all to remove all RSPAN sessions, local to remove all local
sessions, or remote to remove all remote SPAN sessions.
Step 3 Switch(config)# vlan {remote_vlan_ID} Specifies a remote VLAN ID.
Ensure that the VLAN ID is not being used for any user traffic.
Step 4 Switch(config-vlan)# remote-span Converts the VLAN ID to a remote VLAN ID.
Step 5 Switch(config-vlan)# exit Returns to global configuration mode.
Step 6 Switch(config)# [no] monitor session Specifies the RSPAN session and the source port (monitored port).
{session_number} {source {interface
<interface_list> | {vlan vlan_IDs | cpu For session_number, specifies the session number identified with
[queue queue_ids]} [rx | tx | both] this RSPAN session (1 through 16).
For interface-list, specifies the source port to monitor. Valid
interfaces include physical interfaces and port-channel logical
interfaces (port-channel port-channel-number).
For vlan-IDs, specifies the source VLAN or VLANs to monitor.
Valid VLANs are in the range from 1 to 4094.
For queue_ids, specifies either a set of CPU queue numerical
identifiers from 1 to 32, or a named queue.
(Optional) [, | -] Specifies a series or range of interfaces. Enter a
space after the comma; enter a space before and after the hyphen.
(Optional) Specifies the direction of traffic to monitor. If you do not
specify a traffic direction, the source interface sends both transmitted
(Tx) and received (Rx) traffic. Only received traffic can be
monitored on additional source ports.
• Rx—Monitor received traffic.
• Tx—Monitor transmitted traffic.
• both—Monitor both received and transmitted traffic
(bidirectional).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-17
Chapter 46 Configuring SPAN and RSPAN
Configuring RSPAN
Command Purpose
Step 7 Switch(config)# monitor session Specifies the RSPAN session and the destination remote VLAN.
session_number destination remote vlan
vlan-ID For session_number, specifies the session number identified with
this RSPAN session (1 through 16).
For vlan-ID, specifies the RSPAN VLAN to carry the monitored
traffic to the destination port.
Step 8 Switch(config)# end Returns to privileged EXEC mode.
Step 9 Switch# show monitor [session Verifies your entries.
session_number]
Step 10 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to clear any existing RSPAN configuration for session 1, configure RSPAN
session 1 to monitor multiple source interfaces, and configure the destination RSPAN VLAN.
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# no monitor session 1
Switch(config)# monitor session 1 source interface fastEthernet3/10 tx
Switch(config)# monitor session 1 source interface fastEthernet3/2 rx
Switch(config)# monitor session 1 source interface fastEthernet3/3 rx
Switch(config)# monitor session 1 source interface port-channel 102 rx
Switch(config)# monitor session 1 destination remote vlan 901
Switch(config)# end
Creating an RSPAN Destination Session
To create an RSPAN destination session and to specify the source RSPAN VLAN and the destination
port, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# monitor session Specifies the RSPAN session and the source RSPAN VLAN.
session_number source remote vlan
vlan-ID For session_number, specifies the session number identified with
this RSPAN session (1 through 16).
For vlan-ID, specifies the source RSPAN VLAN to monitor.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-18 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
Configuring RSPAN
Command Purpose
Step 3 Switch(config)# [no] monitor session Specifies the RSPAN session and the destination interface.
<session_number> destination interface
<interface> [encapsulation dot1q] For session_number, specifies the session number identified with
[ingress [vlan vlan_IDs] [learning]] this RSPAN session (1 through 16).
For interface, specifies the destination interface.
For vlan_IDs, specifies the ingress VLAN, if necessary.
(Optional) [, | -] Specifies a series or range of interfaces. Enter a
space after the comma; enter a space before and after the hyphen.
(Optional) Specifies the direction of traffic to monitor. If you do not
specify a traffic direction, the source interface sends both sent and
received traffic. Only received (rx) traffic can be monitored on
additional source ports.
Step 4 Switch(config)# end Returns to privileged EXEC mode.
Step 5 Switch# show monitor [session Verifies your entries.
session_number]
Step 6 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to configure VLAN 901 as the source remote VLAN and port 5 as the
destination interface:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# monitor session 1 source remote vlan 901
Switch(config)# monitor session 1 destination interface gigabitEthernet1/2
Switch(config)# end
Creating an RSPAN Destination Session and Enabling Ingress Traffic
To create an RSPAN destination session, to specify the source RSPAN VLAN, and to enable ingress
traffic on the destination port for a network security device (such as a Cisco IDS [Intrusion Detection
System] sensor appliance), perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# monitor session Specifies the RSPAN session and the source RSPAN VLAN.
{session_number} source vlan vlan_IDs
For session_number, specifies the session number identified with
this RSPAN session (1 through 16).
For vlan_IDs, specifies the source VLAN or VLANs to monitor.
Valid VLANs are in the range from 1 to 4094.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-19
Chapter 46 Configuring SPAN and RSPAN
Configuring RSPAN
Command Purpose
Step 3 Switch(config)# [monitor session Specifies the RSPAN session, the destination port, the packet
session_number destination interface encapsulation, and the ingress VLAN.
interface-id [encapsulation dot1q]
ingress vlan vlan id] [learning]] For session_number, specifies the session number identified with
this RSPAN session (1 through 16).
For interface-id, specifies the destination port. Valid interfaces
include physical interfaces.
(Optional) Specifies the encapsulation of the packets transmitted on
the RSPAN destination port. If no encapsulation is specified, all
transmitted packets are sent in native format (untagged).
• Enter encapsulation dot1q to send native VLAN packets
untagged, and all other VLAN tx packets tagged dot1q.
(Optional) Specifies whether forwarding is enabled for ingress
traffic on the RSPAN destination port.
• For native (untagged) and dot1q encapsulation, specify ingress
vlan vlan id to enable ingress forwarding with vlan id as the
native VLAN; vlan id is also used as the native VLAN for
transmitted packets.
• Specify learning to enable learning when ingress is enabled.
Step 4 Switch(config)# end Returns to privileged EXEC mode.
Step 5 Switch# show monitor [session Verifies your entries.
session_number]
Step 6 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to configure VLAN 901 as the source remote VLAN and how to configure the
destination port for ingress traffic on VLAN 5 by using a security device that supports 802.1Q
encapsulation:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# monitor session 1 source remote vlan 901
Switch(config)# monitor session 1 destination interface gigabitEthernet1/2 ingress vlan 5
Switch(config)# end
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-20 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
Configuring RSPAN
Removing Ports from an RSPAN Session
To remove a port as an RSPAN source for a session, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# [no] monitor session Specifies the characteristics of the RSPAN source port (monitored
{session_number} {source {interface port) to remove.
interface_list | {vlan vlan_IDs | cpu
[queue queue_ids]} [rx | tx | both] For session_number, specifies the session number identified with
this RSPAN session (1 through 16).
For interface-list, specifies the source port to no longer monitor.
Valid interfaces include physical interfaces and port-channel
logical interfaces (port-channel port-channel-number).
For vlan_IDs, specifies the source vlan or vlans to monitor. Valid
VLANs are in the range from 1 to 4094.
For queue_ids, specifies either a set of CPU queue numerical
identifiers from 1 to 32, or a named queue.
(Optional) [, | -] Specifies a series or range of interfaces. Enter a
space after the comma; enter a space before and after the hyphen.
(Optional) Specifies the direction of traffic to monitor. If you do
not specify a traffic direction, the source interface sends both
transmitted (Tx) and received (Rx) traffic. Only received traffic
can be monitored on additional source ports.
• Rx—Monitor received traffic.
• Tx—Monitor transmitted traffic.
• both—Monitor both received and transmitted traffic
(bidirectional).
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show monitor [session Verifies your entries.
session_number]
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
This example shows how to remove port 1 as an RSPAN source for RSPAN session 1:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# no monitor session 1 source interface gigabitEthernet1/1
Switch(config)# end
This example shows how to disable received traffic monitoring on port 1, which was configured for
bidirectional monitoring:
Switch(config)# no monitor session 1 source interface gigabitEthernet1/1 rx
The monitoring of traffic received on port 1 is disabled, but traffic transmitted from this port continues
to be monitored.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-21
Chapter 46 Configuring SPAN and RSPAN
Configuring RSPAN
Specifying VLANs to Monitor
VLAN monitoring is similar to port monitoring. To specify VLANs to monitor, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# no monitor session Clears any existing SPAN configuration for the session.
{session_number | all | local |
remote} For session_number, specifies the session number identified with this
RSPAN session (1 through 16).
Specify all to remove all SPAN sessions, local to remove all local
sessions, or remote to remove all remote SPAN sessions.
Step 3 Switch(config)# [no] monitor session Specifies the RSPAN session and the source VLANs (monitored
{session_number} {source {interface VLANs). You can monitor only received (rx) traffic on VLANs.
interface_list | {vlan vlan_IDs | cpu
[queue queue_ids]} [rx | tx | both] For session_number, specifies the session number identified with this
RSPAN session (1 through 16).
For interface-list, specifies the source port to no longer monitor. Valid
interfaces include physical interfaces and port-channel logical
interfaces (port-channel port-channel-number).
For vlan-IDs, the range is 1 to 4094; do not enter leading zeros.
For queue_ids, specifies the source queue.
(Optional) [, | -] Specifies a series or range of interfaces. Enter a space
after the comma; enter a space before and after the hyphen.
(Optional) Specifies the direction of traffic to monitor. If you do not
specify a traffic direction, the source interface sends both transmitted
(Tx) and received (Rx) traffic. Only received traffic can be monitored
on additional source ports.
• Rx—Monitor received traffic.
• Tx—Monitor transmitted traffic.
• both—Monitor both received and transmitted traffic
(bidirectional).
Step 4 Switch(config)# monitor session Specifies the RSPAN session, the destination remote VLAN.
session_number destination remote
vlan vlan-id For session_number, specifies the session number identified with this
RSPAN session (1 through 16).
For vlan-id, specifies the RSPAN VLAN to carry the monitored traffic
to the destination port.
Step 5 Switch(config)# end Returns to privileged EXEC mode.
Step 6 Switch# show monitor [session Verifies your entries.
session_number]
Step 7 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To remove one or more source VLANs from the RSPAN session, use the no monitor session
session_number source vlan vlan-id rx global configuration command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-22 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
Configuring RSPAN
This example shows how to clear any existing configuration on RSPAN session 2, configure RSPAN
session 2 to monitor received traffic on all ports belonging to VLANs 1 through 3, and send it to
destination remote VLAN 902. The configuration is then modified to also monitor received traffic on all
ports belonging to VLAN 10.
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# no monitor session 2
Switch(config)# monitor session 2 source vlan 1 - 3 rx
Switch(config)# monitor session 2 destination remote vlan 902
Switch(config)# monitor session 2 source vlan 10 rx
Switch(config)# end
Specifying VLANs to Filter
To limit RSPAN source traffic to specific VLANs, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# no monitor session Clears any existing SPAN configuration for the session.
{session_number | all | local |
remote} For session_number, specifies the session number identified with this
RSPAN session (1 through 16).
Specify all to remove all SPAN sessions, local to remove all local
sessions, or remote to remove all remote SPAN sessions.
Step 3 Switch(config)# [no] monitor session Specifies the characteristics of the source port (monitored port) and
{session_number} {source {interface RSPAN session.
interface_list | {vlan vlan_IDs | cpu
[queue queue_ids]} [rx | tx | both] For session_number, specifies the session number identified with this
RSPAN session (1 through 16).
For interface-list, specifies the source port to monitor. The interface
specified must already be configured as a trunk port.
For vlan-IDs, the range is 1 to 4094; do not enter leading zeros.
For queue_ids, specifies the source queue.
(Optional) [, | -] Specifies a series or range of interfaces. Enter a space
after the comma; enter a space before and after the hyphen.
(Optional) Specifies the direction of traffic to monitor. If you do not
specify a traffic direction, the source interface sends both transmitted
(Tx) and received (Rx) traffic. Only received traffic can be monitored
on additional source ports.
• Rx—Monitor received traffic.
• Tx—Monitor transmitted traffic.
• both—Monitor both received and transmitted traffic
(bidirectional).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-23
Chapter 46 Configuring SPAN and RSPAN
Displaying SPAN and RSPAN Status
Command Purpose
Step 4 Switch(config)# monitor session Limits the RSPAN source traffic to specific VLANs.
session_number filter vlan vlan-id [,
| -] For session_number, specifies the session number identified with this
RSPAN session (1 through 16).
For vlan-id, the range is 1 to 4094; do not enter leading zeros.
(Optional) Use a comma (,) to specify a series of VLANs or use a
hyphen (-) to specify a range of VLANs. Enter a space after the
comma; enter a space before and after the hyphen.
Step 5 Switch(config)# monitor session Specifies the RSPAN session, the destination remote VLAN.
session_number destination remote vlan
vlan-id For session_number, specifies the session number identified with this
RSPAN session (1 through 16).
For vlan-id, specifies the RSPAN VLAN to carry the monitored traffic
to the destination port.
Step 6 Switch(config)# end Returns to privileged EXEC mode.
Step 7 Switch# show monitor [session Verifies your entries.
session_number]
Step 8 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To monitor all VLANs on the trunk port, use the no monitor session session_number filter vlan global
configuration command.
This example shows how to clear any existing configuration on RSPAN session 2, configure RSPAN
session 2 to monitor traffic received on trunk port 4, and send traffic for only VLANs 1 through 5 and 9
to destination remote VLAN 902.
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# no monitor session 2
Switch(config)# monitor session 2 source interface gigabitethernet1/1 rx
Switch(config)# monitor session 2 filter vlan 1 - 5 , 9
Switch(config)# monitor session 2 destination remote vlan 902
Switch(config)# end
Displaying SPAN and RSPAN Status
To display the status of the current SPAN or RSPAN configuration, use the show monitor privileged
EXEC command.
This example displays the output for the show monitor command for SPAN source session 1:
Switch# show monitor session 1
Session 1
---------
Type: Local Source Session
Source Ports:
RX Only: Fa3/13
TX Only: None
Both: None
Source VLANs:
RX Only: None
TX Only: None
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-24 OL-22250-01
Chapter 46 Configuring SPAN and RSPAN
Displaying SPAN and RSPAN Status
Both: None
Source RSPAN VLAN: None
Destination Ports: None
Encapsulation: DOT1Q
Ingress:Enabled, default VLAN=5
Filter VLANs: None
Dest RSPAN VLAN: None
Ingress : Enabled, default VLAN=2
Learning : Disabled
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 46-25
Chapter 46 Configuring SPAN and RSPAN
Displaying SPAN and RSPAN Status
Software Configuration Guide—Release IOS-XE 3.1.0 SG
46-26 OL-22250-01
CH A P T E R 47
Configuring System Message Logging
This chapter describes how to configure system message logging on the Catalyst 4500 series switch.
This chapter consists of these sections:
• About System Message Logging, page 47-1
• Configuring System Message Logging, page 47-2
• Displaying the Logging Configuration, page 47-12
Note For complete syntax and usage information for the commands used in this chapter, see the
Cisco IOS Configuration Fundamentals Command Reference
http://www.cisco.com/en/US/docs/ios/fundamentals/command/reference/cf_book.html
and related publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About System Message Logging
By default, a switch sends the output from system messages and debug privileged EXEC commands to
a logging process. The logging process controls the distribution of logging messages to various
destinations, such as the logging buffer, terminal lines, or a UNIX syslog server, depending on your
configuration. The process also sends messages to the console.
Note The syslog format is compatible with 4.3 BSD UNIX.
When the logging process is disabled, messages are sent only to the console. The messages are sent as
they are generated, so message and debug output are interspersed with prompts or output from other
commands. Messages are displayed on the console after the process that generated them has finished.
You can set the severity level of the messages to control the type of messages displayed on the consoles
and each of the destinations. You can time-stamp log messages or set the syslog source address to
enhance real-time debugging and management. For information on possible messages, see the system
message guide for this release.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 47-1
Chapter 47 Configuring System Message Logging
Configuring System Message Logging
You can access logged system messages by using the switch command-line interface (CLI) or by saving
them to a properly configured syslog server. The switch software saves syslog messages in an internal
buffer on the switchIf the switchfails, the log is lost unless you had saved it to flash memory.
You can remotely monitor system messages by viewing the logs on a syslog server or by accessing the
switch through Telnet or through the console port.
Configuring System Message Logging
These sections describe how to configure system message logging:
• System Log Message Format, page 47-2
• Default System Message Logging Configuration, page 47-3
• Disabling Message Logging, page 47-4 (optional)
• Setting the Message Display Destination Device, page 47-5 (optional)
• Synchronizing Log Messages, page 47-6 (optional)
• Enabling and Disabling Timestamps on Log Messages, page 47-7 (optional)
• Enabling and Disabling Sequence Numbers in Log Messages (Optional), page 47-7 (optional)
• Defining the Message Severity Level (Optional), page 47-8 (optional)
• Limiting Syslog Messages Sent to the History Table and to SNMP (Optional), page 47-9 (optional)
• Configuring UNIX Syslog Servers, page 47-10 (optional)
System Log Message Format
System log messages can contain up to 80 characters and a percent sign (%), which follows the optional
sequence number or time-stamp information, if configured. Messages are displayed in this format:
seq no:timestamp: %facility-severity-MNEMONIC:description
The part of the message preceding the percent sign depends on the setting of the
service sequence-numbers, service timestamps log datetime,
service timestamps log datetime [localtime] [msec] [show-timezone], or
service timestamps log uptime global configuration command.
Table 47-1 describes the elements of syslog messages.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
47-2 OL-22250-01
Chapter 47 Configuring System Message Logging
Configuring System Message Logging
Table 47-1 System Log Message Elements
Element Description
seq no: Stamps log messages with a sequence number only if the service sequence-numbers global
configuration command is configured.
For more information, see the “Enabling and Disabling Sequence Numbers in Log Messages
(Optional)” section on page 47-7.
timestamp formats: Date and time of the message or event. This information appears only if the service timestamps
log [datetime | log] global configuration command is configured.
mm/dd hh:mm:ss
For more information, see the “Enabling and Disabling Timestamps on Log Messages” section on
or
page 47-7.
hh:mm:ss (short uptime)
or
d h (long uptime)
facility The facility to which the message refers (for example, SNMP, SYS, and so forth). For a list of
supported facilities, see Table 47-4 on page 47-12.
severity Single-digit code from 0 to 7 that is the severity of the message. For a description of the severity
levels, see Table 47-3 on page 47-9.
MNEMONIC Text string that uniquely describes the message.
description Text string containing detailed information about the event being reported.
This example shows a partial switch system message:
00:00:46: %LINK-3-UPDOWN: Interface Port-channel1, changed state to up
00:00:47: %LINK-3-UPDOWN: Interface GigabitEthernet1/0/1, changed state to up
00:00:47: %LINK-3-UPDOWN: Interface GigabitEthernet1/0/2, changed state to up
00:00:48: %LINEPROTO-5-UPDOWN: Line protocol on Interface Vlan1, changed state to down
00:00:48: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet1/0/1, changed
state to down 2
*Mar 1 18:46:11: %SYS-5-CONFIG_I: Configured from console by vty2 (10.34.195.36)
18:47:02: %SYS-5-CONFIG_I: Configured from console by vty2 (10.34.195.36)
*Mar 1 18:48:50.483 UTC: %SYS-5-CONFIG_I: Configured from console by vty2 (10.34.195.36)
Default System Message Logging Configuration
Table 47-2 shows the default system message logging configuration.
Table 47-2 Default System Message Logging Configuration
Feature Default Setting
System message logging to the console Enabled.
Console severity Debugging (and numerically lower levels; see
Table 47-3 on page 47-9).
Logging file configuration No filename specified.
Logging buffer size 4096 bytes.
Logging history size 1 message.
Timestamps Disabled.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 47-3
Chapter 47 Configuring System Message Logging
Configuring System Message Logging
Table 47-2 Default System Message Logging Configuration (continued)
Feature Default Setting
Synchronous logging Disabled.
Logging server Disabled.
Syslog server IP address None configured.
Server facility Local7 (see Table 47-4 on page 47-12).
Server severity Informational (and numerically lower levels; see
Table 47-3 on page 47-9).
Disabling Message Logging
Message logging is enabled by default. It must be enabled to send messages to any destination other than
the console. When enabled, log messages are sent to a logging process, which logs messages to
designated locations asynchronously to the processes that generated the messages.
To disable message logging, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# no logging on Disables message logging.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show running-config Verifies your entries.
or
show logging
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Disabling the logging process can slow down the switch because a process must wait until the messages
are written to the console before continuing. When the logging process is disabled, messages are
displayed on the console as soon as they are produced, often appearing in the middle of command output.
The logging synchronous global configuration command also affects the display of messages to the
console. When this command is enabled, messages appear only after you press Return. For more
information, see the “Synchronizing Log Messages” section on page 47-6.
To re-enable message logging after it has been disabled, use the logging on global configuration
command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
47-4 OL-22250-01
Chapter 47 Configuring System Message Logging
Configuring System Message Logging
Setting the Message Display Destination Device
If message logging is enabled, you can send messages to specific locations in addition to the console.
To specify the locations that receive messages, perform this task, beginning in privileged EXEC mode:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# logging buffered Logs messages to an internal buffer on the switch. The default buffer size
[size] is 4096. The range is 4096 to 2147483647 bytes.
If the switch, the log file is lost unless you previously saved it to flash
memory. See Step 4.
Note Do not make the buffer size too large because the switch could run
out of memory for other tasks. Use the show memory privileged
EXEC command to view the free processor memory on the switch.
However, this value is the maximum available, and the buffer size
should not be set to this amount.
Step 3 Switch(config)# logging host Logs messages to a UNIX syslog server host.
For host, specify the name or IP address of the host to be used as the
syslog server.
To build a list of syslog servers that receive logging messages, enter this
command more than once.
For complete syslog server configuration steps, see the “Configuring
UNIX Syslog Servers” section on page 47-10.
Step 4 Switch(config)# end Returns to privileged EXEC mode.
Step 5 Switch# terminal monitor Logs messages to a nonconsole terminal during the current session.
Terminal parameter-setting commands are set locally and do not remain
in effect after the session has ended. You must perform this step for each
session to see the debugging messages.
Step 6 Switch# show running-config Verifies your entries.
Step 7 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
The logging buffered global configuration command copies logging messages to an internal buffer. The
buffer is circular, so newer messages overwrite older messages after the buffer is full. To display the
messages that are logged in the buffer, use the show logging privileged EXEC command. The first
message displayed is the oldest message in the buffer. To clear the contents of the buffer, use the
clear logging privileged EXEC command.
To disable logging to the console, use the no logging console global configuration command. To disable
logging to a file, use the no logging file [severity-level-number | type] global configuration command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 47-5
Chapter 47 Configuring System Message Logging
Configuring System Message Logging
Synchronizing Log Messages
You can synchronize unsolicited messages and debug privileged EXEC command output with solicited
device output and prompts for a specific console port line or virtual terminal line. You can identify the
types of messages to be output asynchronously based on the level of severity. You can also configure the
maximum number of buffers for storing asynchronous messages for the terminal after which messages
are dropped.
When synchronous logging of unsolicited messages and debug command output is enabled, unsolicited
device output appears on the console or printed after solicited device output appears or printed.
Unsolicited messages and debug command output appears on the console after the prompt for user input
is returned. Therefore, unsolicited messages and debug command output are not interspersed with
solicited device output and prompts. After the unsolicited messages are displayed, the console again
displays the user prompt.
To configure synchronous logging, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# line [console | vty] Specifies the line to be configured for synchronous logging of
line-number [ending-line-number] messages.
• Use the console keyword for configurations that occur through
the switch console port.
• Use the line vty line-number command to specify which vty
lines are to have synchronous logging enabled. You use a vty
connection for configurations that occur through a Telnet
session. The range of line numbers is from 0 to 15.
You can change the setting of all 16 vty lines at once by entering:
line vty 0 15
Or you can change the setting of the single vty line being used for
your current connection. For example, to change the setting for vty
line 2, enter:
line vty 2
When you enter this command, the mode changes to line
configuration.
Step 3 Switch(config)# logging synchronous Enables synchronous logging of messages.
[level [severity-level | all] | limit
number-of-buffers] • (Optional) For level severity-level, specify the message severity
level. Messages with a severity level equal to or higher than this
value are printed asynchronously. Low numbers mean greater
severity and high numbers mean lesser severity. The default is 2.
• (Optional) Specifying level all means that all messages are
printed asynchronously regardless of the severity level.
• (Optional) For limit number-of-buffers, specify the number of
buffers to be queued for the terminal after which new messages
are dropped. The range is 0 to 2147483647. The default is 20.
Step 4 Switch(config)# end Returns to privileged EXEC mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
47-6 OL-22250-01
Chapter 47 Configuring System Message Logging
Configuring System Message Logging
Command Purpose
Step 5 Switch# show running-config Verifies your entries.
Step 6 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To disable synchronization of unsolicited messages and debug output, use the
no logging synchronous [level severity-level | all] [limit number-of-buffers] line configuration
command.
Enabling and Disabling Timestamps on Log Messages
Note By default, log messages are not time-stamped.
To enable time-stamping of log messages, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# service timestamps log uptime Enables log time-stamps.
or
Switch(config)# service timestamps log The first command enables time-stamps on log messages,
datetime [msec] [localtime] [show-timezone] showing the time since the system was rebooted.
The second command enables time-stamps on log messages.
Depending on the options selected, the timestamp can
include the date, time in milliseconds relative to the local
time zone, and the time zone name.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show running-config Verifies your entries.
Step 5 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
To disable time-stamps for both debug and log messages, use the no service timestamps global
configuration command.
This example shows part of a logging display with the service timestamps log datetime global
configuration command enabled:
*Mar 1 18:46:11: %SYS-5-CONFIG_I: Configured from console by vty2 (10.34.195.36)
This example shows part of a logging display with the service timestamps log uptime global
configuration command enabled:
00:00:46: %LINK-3-UPDOWN: Interface Port-channel1, changed state to up
Enabling and Disabling Sequence Numbers in Log Messages (Optional)
Because more than one log message can have the same timestamp, you can display messages with
sequence numbers so that you can unambiguously refer to a single message. By default, sequence
numbers in log messages are not displayed.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 47-7
Chapter 47 Configuring System Message Logging
Configuring System Message Logging
To enable sequence numbers in log messages, perform this task, which is optional.
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# service Enables sequence numbers.
sequence-numbers
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show running-config Verifies your entries.
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To disable sequence numbers, use the no service sequence-numbers global configuration command.
This example shows part of a logging display with sequence numbers enabled:
000019: %SYS-5-CONFIG_I: Configured from console by vty2 (10.34.195.36)
Defining the Message Severity Level (Optional)
You can limit messages displayed to the selected device by specifying the severity level of the message,
which are described in Table 47-3.
To define the message severity level, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# logging console level Limits messages logged to the console.
By default, the console receives debugging messages and
numerically lower levels (see Table 47-3 on page 47-9).
Step 3 Switch(config)# logging monitor level Limits messages logged to the terminal lines.
By default, the terminal receives debugging messages and
numerically lower levels (see Table 47-3 on page 47-9).
Step 4 Switch(config)# logging trap level Limits messages logged to the syslog servers.
By default, syslog servers receive informational messages and
numerically lower levels (see Table 47-3 on page 47-9).
For complete syslog server configuration steps, see the
“Configuring UNIX Syslog Servers” section on page 47-10.
Step 5 Switch(config)# end Returns to privileged EXEC mode.
Step 6 Switch# show running-config Verifies your entries.
or
Switch# show logging
Step 7 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
Note Specifying a level causes messages at that level and numerically lower levels to be displayed at the
destination.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
47-8 OL-22250-01
Chapter 47 Configuring System Message Logging
Configuring System Message Logging
To disable logging to the console, use the no logging console global configuration command. To disable
logging to a terminal other than the console, use the no logging monitor global configuration command.
To disable logging to syslog servers, use the no logging trap global configuration command.
Table 47-3 describes the level keywords. It also lists the corresponding UNIX syslog definitions from
the most severe level to the least severe level.
Table 47-3 Message Logging Level Keywords
Level Keyword Level Description Syslog Definition
emergencies 0 System unstable LOG_EMERG
alerts 1 Immediate action needed LOG_ALERT
critical 2 Critical conditions LOG_CRIT
errors 3 Error conditions LOG_ERR
warnings 4 Warning conditions LOG_WARNING
notifications 5 Normal but significant condition LOG_NOTICE
informational 6 Informational messages only LOG_INFO
debugging 7 Debugging messages LOG_DEBUG
The software generates four other categories of messages:
• Error messages about software or hardware malfunctions, displayed at levels warnings through
emergencies. These types of messages mean that the functionality of the switch is affected. For
information on how to recover from these malfunctions, see the system message guide for this
release.
• Output from the debug commands, displayed at the debugging level. Debug commands are
typically used only by the Technical Assistance Center.
• Interface up or down transitions and system restart messages, displayed at the notifications level.
This message is only for information; switch functionality is not affected.
• Reload requests and low-process stack messages, displayed at the informational level. This
message is only for information; switch functionality is not affected.
Limiting Syslog Messages Sent to the History Table and to SNMP (Optional)
If you enabled syslog message traps to be sent to an SNMP network management station by using the
snmp-server enable trap global configuration command, you can change the level of messages sent and
stored in the switch history table. You also can change the number of messages that are stored in the
history table.
Messages are stored in the history table because SNMP traps are not guaranteed to reach their
destination. By default, one message of the level warning and numerically lower levels (see Table 47-3
on page 47-9) are stored in the history table even if syslog traps are not enabled.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 47-9
Chapter 47 Configuring System Message Logging
Configuring System Message Logging
To change the level and history table size defaults, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
1
Step 2 Switch(config)# logging history level Changes the default level of syslog messages stored in
the history file and sent to the SNMP server.
See Table 47-3 on page 47-9 for a list of level
keywords.
By default, warnings, errors, critical, alerts, and
emergencies messages are sent.
Step 3 Switch(config)# logging history size number Specifies the number of syslog messages that can be
stored in the history table.
The default is to store one message. The range is 0 to
500 messages.
Step 4 Switch(config)# end Returns to privileged EXEC mode.
Step 5 Switch# show running-config Verifies your entries.
Step 6 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
1. Table 47-3 lists the level keywords and severity level. For SNMP usage, the severity level values increase by 1. For example, emergencies
equal 1, not 0, and critical equals 3, not 2.
When the history table is full (it contains the maximum number of message entries specified with the
logging history size global configuration command), the oldest message entry is deleted from the table
to allow the new message entry to be stored.
To return the logging of syslog messages to the default level, use the no logging history global
configuration command. To return the number of messages in the history table to the default value, use
the no logging history size global configuration command.
Configuring UNIX Syslog Servers
The next sections describe how to configure the UNIX server syslog daemon and how to define the UNIX
system logging facility.
Logging Messages to a UNIX Syslog Daemon
Before you can send system log messages to a UNIX syslog server, you must configure the syslog
daemon on a UNIX server. This procedure is optional.
Note Some recent versions of UNIX syslog daemons no longer accept by default syslog packets from the
network. If this is the case with your system, use the UNIX man syslogd command to decide what
options must be added to or removed from the syslog command line to enable logging of remote syslog
messages.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
47-10 OL-22250-01
Chapter 47 Configuring System Message Logging
Configuring System Message Logging
Log in as root, and perform these steps:
Step 1 Add a line such as the following to the file /etc/syslog.conf:
local7.debug /usr/adm/logs/cisco.log
The local7 keyword specifies the logging facility to be used; see Table 47-4 on page 47-12 for
information on the facilities. The debug keyword specifies the syslog level; see Table 47-3 on page 47-9
for information on the severity levels. The syslog daemon sends messages at this level or at a more severe
level to the file specified in the next field. The file must already exist, and the syslog daemon must have
permission to write to it.
Step 2 Create the log file by entering these commands at the UNIX shell prompt:
$ touch /var/log/cisco.log
$ chmod 666 /var/log/cisco.log
Step 3 Ensure that the syslog daemon reads the new changes:
$ kill -HUP `cat /etc/syslog.pid`
For more information, see the man syslog.conf and man syslogd commands on your UNIX system.
Configuring the UNIX System Logging Facility
When sending system log messages to an external device, you can cause the switch to identify its
messages as originating from any of the UNIX syslog facilities.
To configure UNIX system facility message logging, perform this task, which is optional.
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# logging host Logs messages to a UNIX syslog server host by
entering its IP address.
To build a list of syslog servers that receive logging
messages, enter this command more than once.
Step 3 Switch(config)# logging trap level Limits messages logged to the syslog servers.
Be default, syslog servers receive informational
messages and lower. See Table 47-3 on page 47-9 for
level keywords.
Step 4 Switch(config)# logging facility facility-type Configures the syslog facility. See Table 47-4 on
page 47-12 for facility-type keywords.
The default is local7.
Step 5 Switch(config)# end Returns to privileged EXEC mode.
Step 6 Switch# show running-config Verifies your entries.
Step 7 Switch# copy running-config startup-config (Optional) Saves your entries in the configuration file.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 47-11
Chapter 47 Configuring System Message Logging
Displaying the Logging Configuration
To remove a syslog server, use the no logging host global configuration command, and specify the syslog
server IP address. To disable logging to syslog servers, enter the no logging trap global configuration
command.
Table 47-4 lists the UNIX system facilities supported by the software. For more information about these
facilities, consult the operator’s manual for your UNIX operating system.
Table 47-4 Logging Facility-Type Keywords
Facility Type Keyword Description
auth Authorization system
cron Cron facility
daemon System daemon
kern Kernel
local0-7 Locally defined messages
lpr Line printer system
mail Mail system
news USENET news
sys9-14 System use
syslog System log
user User process
uucp UNIX-to-UNIX copy system
Displaying the Logging Configuration
To display the logging configuration and the contents of the log buffer, use the show logging privileged
EXEC command. For information about the fields in this display, see the Cisco IOS Configuration
Fundamentals Command Reference, Release 12.3.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
47-12 OL-22250-01
CH A P T E R 48
Configuring Onboard Failure Logging (OBFL)
• Prerequisites for OBFL, page 48-1
• Restrictions for OBFL, page 48-2
• Information About OBFL, page 48-2
• Default Settings for OBFL, page 48-9
• Enabling OBFL, page 48-9
• Configuration Examples for OBFL, page 48-10
Note For complete syntax and usage information for the commands used in this chapter, see these
publications:
http://www.cisco.com/en/US/products/ps11845/prod_command_reference_list.html
Note For complete syntax and usage information for the switch commands used in this chapter, first look at
the Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products//hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Series Switch Command Reference, it will be found in
the larger Cisco IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference
and related publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Prerequisites for OBFL
None.
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
OL-27597-01 48-1
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Restrictions for OBFL
Restrictions for OBFL
They include:
• Software Restrictions—If a device (router or switch) intends to use linear flash memory as its OBFL
storage media, Cisco IOS software must reserve a minimum of two physical sectors (or physical
blocks) for the OBFL feature. Because an erase operation for a linear flash device is done on
per-sector (or per-block) basis, one extra physical sector is needed. Otherwise, the minimum amount
of space reserved for the OBFL feature on any device must be at least 8 KB.
• Firmware Restrictions—If a line card or port adapter runs an operating system or firmware that is
different from the Cisco IOS operating system, the line card or port adapter must provide device
driver level support or an interprocess communications (IPC) layer that allows the OBFL file system
to communicate to the line card or port adapter. This requirement is enforced to allow OBFL data to
be recorded on a storage device attached to the line card or port adapter.
• Hardware Restrictions—To support the OBFL feature, a device must have at least 8 KB of
nonvolatile memory space reserved for OBFL data logging.
Information About OBFL
• Overview of OBFL, page 48-2
• Information about Data Collected by OBFL, page 48-2
Overview of OBFL
The Onboard Failure Logging (OBFL) feature collects data such as operating temperatures, hardware
uptime, interrupts, and other important events and messages from system hardware installed in a Cisco
router or switch. The data is stored in nonvolatile memory and helps technical personnel diagnose
hardware problems.
Information about Data Collected by OBFL
• OBFL Data Overview, page 48-2
• Temperature, page 48-3
• Operational Uptime, page 48-4
• Interrupts, page 48-7
• Message Logging, page 48-8
OBFL Data Overview
The OBFL feature records operating temperatures, hardware uptime, interrupts, and other important
events and messages that can assist with diagnosing problems with hardware cards (or modules) installed
in a Cisco router or switch. Data is logged to files stored in nonvolatile memory. When the onboard
hardware is started up, a first record is made for each area monitored and becomes a base value for
subsequent records. The OBFL feature provides a circular updating scheme for collecting continuous
records and archiving older (historical) records, ensuring accurate data about the system. Data is
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
48-2 OL-27597-01
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Information About OBFL
recorded in one of two formats: continuous information that displays a snapshot of measurements and
samples in a continuous file, and summary information that provides details about the data being
collected. The data is displayed using the show logging onboard command. The message “No historical
data to display” is seen when historical data is not available.
Temperature
Temperatures surrounding hardware modules can exceed recommended safe operating ranges and cause
system problems such as packet drops. Higher than recommended operating temperatures can also
accelerate component degradation and affect device reliability. Monitoring temperatures is important for
maintaining environmental control and system reliability. Once a temperature sample is logged, the
sample becomes the base value for the next record. From that point on, temperatures are recorded either
when there are changes from the previous record or if the maximum storage time is exceeded.
Temperatures are measured and recorded in degrees Celsius.
Temperature Example
Switch# sh logging onboard temperature
--------------------------------------------------------------------------------
TEMPERATURE SUMMARY INFORMATION
--------------------------------------------------------------------------------
Number of sensors : 7
Sampling frequency : 1 minutes
Maximum time of storage : 10 minutes
--------------------------------------------------------------------------------
Sensor | ID | Maximum Temperature 0C
--------------------------------------------------------------------------------
Stub A 0 43
Stub B 1 37
XPP 2 51
VFE 3 61
NFE 4 50
CPU 5 55
FPGA 6 44
--------------------------------------
Temp Sensor ID
0C 1 2 3 4 5 6 7
--------------------------------------
1 9y 9y 9y 9y 9y 9y 9y
15 0m 71h 0m 0m 0m 0m 0m
16 0m 183h 0m 0m 0m 0m 0m
--------------------------------------
Temp Sensor ID
0C 1 2 3 4 5 6 7
--------------------------------------
17 0m 142m 0m 0m 0m 0m 0m
18 0m 190m 0m 0m 0m 0m 0m
19 0m 30m 0m 0m 0m 0m 0m
20 113h 0m 0m 0m 0m 0m 0m
21 37h 0m 0m 0m 0m 0m 101h
22 107h 0m 0m 0m 0m 0m 106h
23 110m 12m 0m 0m 0m 0m 47h
24 10m 122m 0m 0m 0m 0m 182m
25 0m 0m 0m 0m 0m 0m 120m
26 0m 56h 0m 0m 0m 0m 30m
27 0m 368h 0m 0m 0m 0m 0m
28 0m 8y 0m 0m 0m 0m 0m
29 134m 8y 0m 0m 139h 0m 0m
30 0m 682h 83h 0m 116h 0m 0m
31 90m 738h 31h 0m 200m 0m 95m
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
OL-27597-01 48-3
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Information About OBFL
32 209h 935h 138h 0m 120m 141h 258h
33 331h 934h 192m 0m 0m 113h 316h
34 579h 8y 190m 0m 0m 182m 432h
35 17y 149h 80m 0m 0m 150m 8y
36 914h 20m 0m 0m 0m 10m 8y
37 838h 270m 0m 140h 26m 0m 8y
38 47d 0m 0m 102h 108m 0m 790h
39 8y 0m 0m 948m 20m 0m 421h
--------------------------------------
Temp Sensor ID
0C 1 2 3 4 5 6 7
--------------------------------------
40 414h 0m 2m 100m 78h 0m 288h
41 74h 0m 113h 40m 340h 134m 113h
42 10m 0m 380h 0m 198h 0m 446m
43 270m 0m 8y 0m 373h 0m 0m
44 0m 0m 8y 0m 683h 45h 10m
45 0m 0m 8y 2m 17y 274h 0m
46 0m 0m 897h 105m 64d 257h 0m
47 0m 0m 785h 27m 8y 169h 0m
48 0m 0m 639h 4m 319h 666h 0m
49 0m 0m 379h 92h 786m 17y 0m
50 0m 0m 94h 330h 270m 61d 0m
51 0m 0m 106m 192h 0m 48d 0m
52 0m 0m 0m 190h 0m 8y 0m
53 0m 0m 0m 573h 0m 227h 0m
54 0m 0m 0m 736h 0m 180m 0m
55 0m 0m 0m 716h 0m 260m 0m
56 0m 0m 0m 902h 0m 0m 0m
57 0m 0m 0m 8y 0m 0m 0m
58 0m 0m 0m 8y 0m 0m 0m
59 0m 0m 0m 8y 0m 0m 0m
60 0m 0m 0m 226h 0m 0m 0m
61 0m 0m 0m 629m 0m 0m 0m
Switch#
To interpret this data:
• Number of sensors is the total number of temperature sensors that will be recorded. A column for
each sensor is displayed with temperatures listed under the number of each sensor, as available.
• Sampling frequency is the time between measurements.
• Maximum time of storage determines the maximum amount of time, in minutes, that can pass when
the temperature remains unchanged and the data is not saved to storage media. After this time, a
temperature record will be saved even if the temperature has not changed.
• The Sensor column lists the name of the sensor.
• The ID column lists an assigned identifier for the sensor.
• Maximum Temperature 0C shows the highest recorded temperature per sensor.
• Temp indicates a recorded temperature in degrees Celsius in the historical record. Columns
following show the total time each sensor has recorded that temperature.
• Sensor ID is an assigned number, so that temperatures for the same sensor can be stored together.
Operational Uptime
The operational uptime tracking begins when the module is powered on, and information is retained for
the life of the module.
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
48-4 OL-27597-01
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Information About OBFL
Operational Uptime Example
Switch# sh logging onboard uptime detail
--------------------------------------------------------------------------------
UPTIME SUMMARY INFORMATION
--------------------------------------------------------------------------------
First customer power on : 04/13/2010 19:45:08
Total uptime : 1 years 34 weeks 3 days 12 hours 50 minutes
Total downtime : 1 years 7 weeks 3 days 18 hours 12 minutes
Number of resets : 1409
Number of slot changes : 19
Current reset reason : 0x0
Current reset timestamp : 01/29/2013 21:56:43
Current slot : 5
Current subslot : 0
Current uptime : 0 years 0 weeks 0 days 0 hours 20 minutes
--------------------------------------------------------------------------------
Reset | |
Reason | Count |
--------------------------------------------------------------------------------
No historical data to display
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
UPTIME CONTINUOUS INFORMATION
--------------------------------------------------------------------------------
Time Stamp | Reset | Uptime
MM/DD/YYYY HH:MM:SS | Reason | years weeks days hours minutes
--------------------------------------------------------------------------------
04/13/2010 19:45:08 0x0 0 0 0 0 0
04/13/2010 22:26:50 0x9 0 0 0 2 0
04/14/2010 18:54:42 0x9 0 0 0 20 0
04/14/2010 21:31:00 0x9 0 0 0 2 0
04/14/2010 22:04:15 0x9 0 0 0 0 25
04/14/2010 22:22:20 0x9 0 0 0 0 5
04/14/2010 23:05:58 0x9 0 0 0 0 5
04/15/2010 19:03:11 0x9 0 0 0 19 0
04/15/2010 21:29:22 0x9 0 0 0 2 0
04/15/2010 21:49:49 0x8 0 0 0 0 10
04/16/2010 18:46:03 0x9 0 0 0 20 0
04/16/2010 19:25:37 0x9 0 0 0 0 25
04/16/2010 19:34:59 0x9 0 0 0 0 0
04/16/2010 19:46:06 0x9 0 0 0 0 0
04/16/2010 19:57:16 0x9 0 0 0 0 5
04/16/2010 20:17:55 0x9 0 0 0 0 0
--------------------------------------------------------------------------------
Time Stamp | Reset | Uptime
MM/DD/YYYY HH:MM:SS | Reason | years weeks days hours minutes
--------------------------------------------------------------------------------
04/16/2010 20:31:28 0x9 0 0 0 0 0
04/16/2010 20:50:07 0x9 0 0 0 0 10
04/16/2010 22:45:15 0x9 0 0 0 0 0
04/18/2010 19:55:25 0x9 0 0 0 0 0
04/18/2010 20:01:52 0x9 0 0 0 0 0
04/19/2010 00:21:42 0x9 0 0 0 0 0
04/19/2010 01:20:33 0x0 0 0 0 0 30
04/19/2010 19:25:04 0x9 0 0 0 15 0
04/19/2010 20:05:04 0x9 0 0 0 0 15
04/19/2010 20:55:43 0x9 0 0 0 0 0
04/19/2010 21:11:52 0x9 0 0 0 0 0
04/19/2010 21:20:35 0x9 0 0 0 0 0
04/19/2010 21:39:45 0x9 0 0 0 0 10
04/19/2010 21:54:50 0x9 0 0 0 0 5
04/19/2010 22:11:48 0x9 0 0 0 0 5
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
OL-27597-01 48-5
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Information About OBFL
04/19/2010 22:35:38 0x9 0 0 0 0 5
04/19/2010 22:49:41 0x9 0 0 0 0 0
04/19/2010 23:12:58 0x9 0 0 0 0 10
04/20/2010 00:36:04 0x9 0 0 0 1 0
04/20/2010 00:49:19 0x9 0 0 0 0 5
04/20/2010 00:58:29 0x9 0 0 0 0 0
04/20/2010 16:51:06 0x9 0 0 0 15 0
Switch#
The operational uptime application tracks the following events:
• Date and time the customer first powered on a component.
• Total uptime and downtime for the component in years, weeks, days, hours, and minutes.
• Total number of component resets.
• Total number of slot (module) changes.
• Current reset timestamp to include the date and time.
• Current slot (module) number of the component.
• Current uptime in years, weeks, days, hours, and minutes.
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
48-6 OL-27597-01
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Information About OBFL
Interrupts
Interrupts are generated by system components that require attention from the CPU such as ASICs and
NMIs. Interrupts are generally related to hardware limit conditions or errors that need to be corrected.
The continuous format records each time a component is interrupted, and this record is stored and used
as base information for subsequent records. Each time the list is saved, a timestamp is added. Time
differences from the previous interrupt are counted, so that technical personnel can gain a complete
record of the component’s operational history when an error occurs.
Interrupts Example
Switch# sh logging onboard interrupt detail
--------------------------------------------------------------------------------
INTERRUPT SUMMARY INFORMATION
--------------------------------------------------------------------------------
Name | ID | Offset | Bit | Count
--------------------------------------------------------------------------------
dropped 2 0x0004 0 27323
ipp 6 0x5A00 0 983763
ipp high 10 0x700A 0 34105
ipp low 11 0x9000 0 30211
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
CONTINUOUS INTERRUPT INFORMATION
--------------------------------------------------------------------------------
MM/DD/YYYY HH:MM:SS mmm | Name | ID | Offset | Bit
--------------------------------------------------------------------------------
12/12/2011 16:06:43 0 ipp high 10 0x7AEA 7
12/12/2011 16:06:43 0 dropped 2 0x0006 0
12/12/2011 16:06:46 0 ipp high 10 0x7AEC 0
12/12/2011 16:06:46 0 ipp high 10 0x7AEC 1
12/12/2011 16:06:46 0 ipp high 10 0x7AEC 4
12/12/2011 16:06:46 0 ipp high 10 0x7AEC 5
12/12/2011 16:06:46 0 ipp low 11 0xC000 0
12/12/2011 16:06:46 0 ipp low 11 0xC000 1
12/12/2011 16:06:46 0 ipp low 11 0xC000 4
12/12/2011 16:06:46 0 ipp low 11 0xC000 5
12/12/2011 16:06:46 0 ipp high 10 0x7AEA 0
12/12/2011 16:06:46 0 ipp high 10 0x7AEA 2
12/12/2011 16:06:46 0 ipp high 10 0x7AEA 3
12/12/2011 16:06:46 0 ipp high 10 0x7AEA 4
12/12/2011 16:06:46 0 ipp high 10 0x7AEA 6
12/12/2011 16:06:46 0 ipp high 10 0x7AEA 7
12/12/2011 16:06:46 0 dropped 2 0x0006 0
12/12/2011 16:06:49 0 ipp high 10 0x7AEC 0
12/12/2011 16:06:49 0 ipp high 10 0x7AEC 1
--------------------------------------------------------------------------------
Switch#
To interpret this data:
• Name is a description of the component including its position in the device.
• ID is an assigned field for data storage.
• Offset is the register offset from a component register’s base address.
• Bit is the interrupt bit number recorded from the component’s internal register.
• The timestamp shows the date and time that an interrupt occurred down to the millisecond.
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
OL-27597-01 48-7
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Information About OBFL
Message Logging
The OBFL feature logs standard system messages. Instead of displaying the message to a terminal, the
message is written to and stored in a file, so the message can be accessed and read at a later time. System
messages range from level 1 alerts to level 7 debug messages, and these levels can be specified in the
hw module logging onboard command.
Error Message Log Example
Switch# sh logging onboard message det
--------------------------------------------------------------------------------
ERROR MESSAGE SUMMARY INFORMATION
--------------------------------------------------------------------------------
Facility-Sev-Name | Count | Persistence Flag
MM/DD/YYYY HH:MM:SS
--------------------------------------------------------------------------------
%CAT4K-3-DIAGNOSTICS_PASSED : 22 LAST
11/24/2010 15:46:20 module passed diagnostics
%CAT4K-2-DIAGNOSTIC_STATUS : 22 LAST
11/24/2010 15:46:20 diagnostic Packet memory Skipped
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
ERROR MESSAGE CONTINUOUS INFORMATION
--------------------------------------------------------------------------------
MM/DD/YYYY HH:MM:SS Facility-Sev-Name
--------------------------------------------------------------------------------
12/15/2010 11:32:39 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/15/2010 11:32:39 %CAT4K-2-DIAGNOSTIC_STATUS : diagnostic Packet memory Skipped
12/15/2010 13:03:41 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/15/2010 13:03:41 %CAT4K-2-DIAGNOSTIC_STATUS : diagnostic Packet memory Skipped
12/15/2010 13:25:02 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/15/2010 13:25:02 %CAT4K-2-DIAGNOSTIC_STATUS : diagnostic Packet memory Skipped
12/15/2010 13:45:34 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/15/2010 13:45:34 %CAT4K-2-DIAGNOSTIC_STATUS : diagnostic Packet memory Skipped
12/15/2010 14:05:01 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/15/2010 14:05:01 %CAT4K-2-DIAGNOSTIC_STATUS : diagnostic Packet memory Skipped
12/15/2010 14:35:51 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/15/2010 14:35:51 %CAT4K-2-DIAGNOSTIC_STATUS : diagnostic Packet memory Skipped
--------------------------------------------------------------------------------
Switch#
To interpret this data:
• A timestamp shows the date and time the message was logged.
• Facility-Sev-Name is a coded naming scheme for a system message, as follows:
– The Facility code consists of two or more uppercase letters that indicate the hardware device
(facility) to which the message refers.
– Sev is a single-digit code from 1 to 7 that reflects the severity of the message.
– Name is one or two code names separated by a hyphen that describe the part of the system from
where the message is coming.
• The error message follows the Facility-Sev-Name codes. For more information about system
messages, see the Cisco IOS System and Error Messages guide.
• Count indicates the number of instances of this message that is allowed in the history file. Once that
number of instances has been recorded, the oldest instance will be removed from the history file to
make room for new ones.
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
48-8 OL-27597-01
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Default Settings for OBFL
• The Persistence Flag gives a message priority over others that do not have the flag set.
Default Settings for OBFL
The OBFL feature is enabled by default. Because of the valuable information this feature offers technical
personnel, it should not be disabled.
Enabling OBFL
To enable OBFL, perform this task:
Command or Action Purpose
Step 1 Router> enable Enables privileged EXEC mode (enter your password if
prompted).
Step 2 Router# configure terminal Enters global configuration mode.
Step 3 Router(config)# hw-module module module-number Enables OBFL on the specified hardware module.
logging onboard [message level {1-7}]
Note By default, all system messages sent to a device are
logged by the OBFL feature. You can define a
specific message level (only level 1 messages, as an
example) to be logged using the message level
keywords.
Step 4 Router(config)# end Ends global configuration mode.
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
OL-27597-01 48-9
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Configuration Examples for OBFL
Configuration Examples for OBFL
The important OBFL feature is the information that is displayed by the show logging onboard module
privileged EXEC command. This section provides the following examples of how to enable and display
OBFL records.
• Enabling OBFL Message Logging: Example
• OBFL Message Log: Example
• OBFL Component Uptime Report: Example
• OBFL Report for a Specific Time: Example
Enabling OBFL Message Logging: Example
The following example shows how to configure OBFL message logging at level 3:
Router(config)# hw-module module 1 logging onboard message level 3
OBFL Message Log: Example
The following example shows how to display the system messages that are being logged for module 2:
Switch# show logging onboard module 2 message continuous
-----------------------------------------------------------------------------
---
ERROR MESSAGE CONTINUOUS INFORMATION
-----------------------------------------------------------------------------
---
MM/DD/YYYY HH:MM:SS Facility-Sev-Name
-----------------------------------------------------------------------------
---
12/13/2012 18:12:32 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/14/2012 17:50:55 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/20/2012 17:45:55 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/20/2012 19:55:27 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/20/2012 20:37:27 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/21/2012 16:09:15 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/07/2013 02:43:06 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/07/2013 04:59:38 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/16/2013 15:36:34 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/17/2013 12:41:44 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/18/2013 14:03:24 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/18/2013 14:16:09 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/18/2013 14:21:59 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/18/2013 15:23:04 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/18/2013 15:41:29 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/22/2013 14:59:10 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/24/2013 11:47:27 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/24/2013 16:40:58 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
-----------------------------------------------------------------------------
Switch#
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
48-10 OL-27597-01
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Configuration Examples for OBFL
OBFL Component Uptime Report: Example
The following example shows how to display a summary report for component uptimes for module 2:
Switch# show logging onboard module 2 uptime
-----------------------------------------------------------------------------
---
UPTIME SUMMARY INFORMATION
-----------------------------------------------------------------------------
---
First customer power on : 12/13/2012 18:12:53
Total uptime : 0 years 0 weeks 4 days 15 hours 55 minutes
Total downtime : 0 years 6 weeks 0 days 12 hours 18 minutes
Number of resets : 20
Number of slot changes : 1
Current reset reason : 0x0
Current reset timestamp : 01/29/2013 21:56:18
Current slot : 2
Current subslot : 0
Current uptime : 0 years 0 weeks 0 days 0 hours 30 minutes
-----------------------------------------------------------------------------
---
Reset | |
Reason | Count |
-----------------------------------------------------------------------------
---
No historical data to display
-------------------------------------------------------------------------
Switch#
OBFL Report for a Specific Time: Example
The following example shows how to display continuous reports for all components during a specific
time period:
Switch# show logging onboard module 2 continuous start 18:12:32 13 Dec 2012 end 16:40:58
24 Jan 2013
PID: WS-C4510R+E , VID: 6 , SN: FOX1503GL5V
--------------------------------------------------------------------------------
UPTIME CONTINUOUS INFORMATION
--------------------------------------------------------------------------------
Time Stamp | Reset | Uptime
MM/DD/YYYY HH:MM:SS | Reason | years weeks days hours minutes
--------------------------------------------------------------------------------
12/13/2012 18:12:53 0x0 0 0 0 0 0
12/14/2012 17:51:14 0x0 0 0 0 23 0
12/20/2012 17:45:52 0x0 0 0 0 1 0
12/20/2012 19:55:22 0x0 0 0 0 2 0
12/20/2012 20:37:26 0x0 0 0 0 0 40
12/21/2012 16:09:14 0x0 0 0 0 0 10
01/07/2013 02:43:04 0x0 0 0 0 2 0
01/07/2013 04:59:35 0x0 0 0 0 2 0
01/16/2013 15:36:32 0x0 0 0 1 17 0
01/17/2013 12:41:42 0x0 0 0 0 3 0
01/18/2013 14:03:21 0x0 0 0 1 1 0
01/18/2013 14:16:08 0x0 0 0 0 0 10
01/18/2013 14:21:58 0x0 0 0 0 0 0
01/18/2013 15:23:02 0x0 0 0 0 1 0
01/18/2013 15:41:25 0x0 0 0 0 0 15
01/22/2013 14:59:05 0x0 0 0 0 3 0
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
OL-27597-01 48-11
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Configuration Examples for OBFL
--------------------------------------------------------------------------------
Time Stamp | Reset | Uptime
MM/DD/YYYY HH:MM:SS | Reason | years weeks days hours minutes
--------------------------------------------------------------------------------
01/24/2013 11:47:25 0x0 0 0 0 3 0
01/24/2013 16:40:56 0x0 0 0 0 3 0
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
ENVIRONMENT CONTINUOUS INFORMATION
--------------------------------------------------------------------------------
MM/DD/YYYY HH:MM:SS Device Name IOS Version F/W Ver RAM(KB) Event
------------------------------------------------------------
VID PID TAN Serial No
--------------------------------------------------------------------------------
12/13/2012 18:12:57 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
12/14/2012 17:50:55 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
12/20/2012 17:45:55 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
12/20/2012 19:55:27 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
12/20/2012 20:37:27 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
12/21/2012 16:09:15 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/07/2013 02:43:06 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/07/2013 04:59:38 slot-2: NA NA 0 Inserted
--------------------------------------------------------------------------------
ENVIRONMENT CONTINUOUS INFORMATION
--------------------------------------------------------------------------------
MM/DD/YYYY HH:MM:SS Device Name IOS Version F/W Ver RAM(KB) Event
------------------------------------------------------------
VID PID TAN Serial No
--------------------------------------------------------------------------------
Cis WS-C4510R+E NA FOX1503GL5V
01/16/2013 15:36:34 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/17/2013 12:41:44 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/18/2013 14:03:24 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/18/2013 14:16:09 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/18/2013 14:21:59 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/18/2013 15:23:04 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/18/2013 15:41:29 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/22/2013 14:59:10 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/24/2013 11:47:27 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
01/24/2013 16:40:58 slot-2: NA NA 0 Inserted
Cis WS-C4510R+E NA FOX1503GL5V
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
TEMPERATURE CONTINUOUS INFORMATION
--------------------------------------------------------------------------------
Sensor | ID |
--------------------------------------------------------------------------------
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
48-12 OL-27597-01
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Configuration Examples for OBFL
Air inlet 0
Air inlet remote 1
Air outlet 2
Air outlet remote 3
--------------------------------------------
Time Stamp |Sensor Temperature 0C
MM/DD/YYYY HH:MM:SS | 0 1 2 3
--------------------------------------------
01/18/2013 12:18:59 32 23 33 27
01/18/2013 12:28:59 32 23 33 27
01/18/2013 12:38:59 32 23 33 27
01/18/2013 12:48:00 32 23 33 27
01/18/2013 12:58:00 32 23 33 27
01/18/2013 13:08:00 32 23 33 27
01/18/2013 13:18:00 32 23 33 27
01/18/2013 13:28:00 32 23 33 27
01/18/2013 13:38:00 32 23 33 27
01/18/2013 13:48:00 32 23 33 27
01/18/2013 13:58:00 32 23 33 27
01/18/2013 14:03:21 30 23 31 27
01/18/2013 14:12:22 32 23 33 27
01/18/2013 14:16:08 30 23 31 27
01/18/2013 14:21:58 30 23 31 26
01/18/2013 14:31:58 32 23 33 28
01/18/2013 14:40:59 32 23 33 28
--------------------------------------------
Time Stamp |Sensor Temperature 0C
MM/DD/YYYY HH:MM:SS | 0 1 2 3
--------------------------------------------
01/18/2013 14:47:04 26 23 26 25
01/18/2013 14:57:04 24 22 24 23
01/18/2013 15:07:04 24 22 24 23
01/18/2013 15:17:04 24 22 24 23
01/18/2013 15:23:03 25 22 26 23
01/18/2013 15:25:03 30 22 31 25
01/18/2013 15:35:03 32 23 33 27
01/18/2013 15:41:25 30 23 31 26
01/18/2013 15:51:25 32 23 33 27
01/18/2013 16:00:27 32 23 33 27
01/18/2013 16:10:27 32 23 33 27
01/18/2013 16:20:27 32 23 33 28
01/18/2013 16:30:27 32 23 33 27
01/18/2013 16:40:27 32 23 33 27
01/18/2013 16:50:27 32 23 33 27
01/18/2013 17:00:27 31 23 33 27
01/18/2013 17:10:27 32 23 33 27
01/18/2013 17:20:27 32 23 33 27
01/18/2013 17:30:27 31 23 33 27
01/18/2013 17:40:27 31 23 33 27
01/18/2013 17:50:27 31 23 33 28
01/18/2013 18:00:27 32 24 34 30
01/18/2013 18:09:28 32 24 34 31
--------------------------------------------
Time Stamp |Sensor Temperature 0C
MM/DD/YYYY HH:MM:SS | 0 1 2 3
--------------------------------------------
01/18/2013 18:19:28 33 24 35 32
01/18/2013 18:29:28 33 25 35 33
01/18/2013 18:39:28 32 25 36 34
01/18/2013 18:49:28 32 25 36 34
01/18/2013 18:54:28 34 26 39 39
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
OL-27597-01 48-13
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Configuration Examples for OBFL
01/18/2013 19:04:28 35 27 42 44
01/18/2013 19:14:28 35 27 42 44
01/22/2013 14:59:05 25 22 26 22
01/22/2013 15:02:05 30 23 31 26
01/22/2013 15:09:06 32 24 34 31
01/22/2013 15:12:06 33 26 37 36
01/22/2013 15:15:06 34 27 40 41
01/22/2013 15:25:06 36 28 43 46
01/22/2013 15:35:06 36 28 43 46
01/22/2013 15:45:06 36 28 43 46
01/22/2013 15:55:06 36 28 44 46
01/22/2013 16:05:06 36 28 43 46
01/22/2013 16:14:07 36 28 43 46
01/22/2013 16:24:07 35 28 43 46
01/22/2013 16:34:07 36 28 44 46
01/22/2013 16:44:07 36 28 43 46
01/22/2013 16:54:07 36 28 43 46
01/22/2013 16:58:07 34 26 41 41
--------------------------------------------
Time Stamp |Sensor Temperature 0C
MM/DD/YYYY HH:MM:SS | 0 1 2 3
--------------------------------------------
01/22/2013 17:00:07 32 24 37 34
01/22/2013 17:10:07 31 24 34 32
01/22/2013 17:20:07 31 23 34 30
01/22/2013 17:30:07 32 24 35 33
01/22/2013 17:40:07 32 24 35 33
01/22/2013 17:49:08 32 24 35 33
01/22/2013 17:59:08 32 24 35 33
01/24/2013 11:47:25 26 22 26 23
01/24/2013 11:49:25 30 24 31 28
01/24/2013 11:56:25 33 25 35 33
01/24/2013 12:06:25 32 25 35 33
01/24/2013 12:16:25 33 25 35 33
01/24/2013 12:26:25 33 25 35 33
01/24/2013 12:36:25 33 25 36 33
01/24/2013 12:46:25 33 25 36 33
01/24/2013 12:56:25 34 27 39 38
01/24/2013 13:01:25 35 28 42 43
01/24/2013 13:11:25 36 29 44 46
01/24/2013 13:21:25 37 29 45 47
01/24/2013 13:30:26 37 29 45 47
01/24/2013 13:40:26 37 29 45 47
01/24/2013 13:50:26 37 29 45 47
01/24/2013 14:00:26 36 29 45 47
--------------------------------------------
Time Stamp |Sensor Temperature 0C
MM/DD/YYYY HH:MM:SS | 0 1 2 3
--------------------------------------------
01/24/2013 14:10:26 37 29 45 47
01/24/2013 14:20:26 37 29 45 47
01/24/2013 14:30:26 36 28 43 45
01/24/2013 14:32:26 34 26 39 39
01/24/2013 14:38:26 33 25 36 33
01/24/2013 14:48:26 34 26 37 36
01/24/2013 14:58:26 34 26 38 36
01/24/2013 15:08:26 34 26 38 37
01/24/2013 15:17:27 34 26 38 37
01/24/2013 15:27:27 34 26 38 37
01/24/2013 16:40:56 26 22 27 24
--------------------------------------------
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
48-14 OL-27597-01
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Configuration Examples for OBFL
--------------------------------------------------------------------------------
ERROR MESSAGE CONTINUOUS INFORMATION
--------------------------------------------------------------------------------
MM/DD/YYYY HH:MM:SS Facility-Sev-Name
--------------------------------------------------------------------------------
12/13/2012 18:12:32 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/14/2012 17:50:55 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/20/2012 17:45:55 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/20/2012 19:55:27 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/20/2012 20:37:27 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
12/21/2012 16:09:15 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/07/2013 02:43:06 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/07/2013 04:59:38 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/16/2013 15:36:34 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/17/2013 12:41:44 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/18/2013 14:03:24 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/18/2013 14:16:09 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/18/2013 14:21:59 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/18/2013 15:23:04 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/18/2013 15:41:29 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/22/2013 14:59:10 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
01/24/2013 11:47:27 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
--------------------------------------------------------------------------------
ERROR MESSAGE CONTINUOUS INFORMATION
--------------------------------------------------------------------------------
MM/DD/YYYY HH:MM:SS Facility-Sev-Name
--------------------------------------------------------------------------------
01/24/2013 16:40:58 %CAT4K-3-DIAGNOSTICS_PASSED : module passed diagnostics
--------------------------------------------------------------------------------
Switch#
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
OL-27597-01 48-15
Chapter 48 Configuring Onboard Failure Logging (OBFL)
Configuration Examples for OBFL
Software Configuration Guide—Release IOS XE 3.4.0SG and IOS 15.1(2)SG
48-16 OL-27597-01
CH A P T E R 49
Configuring SNMP
This chapter describes how to configure the Simple Network Management Protocol (SNMP) on the
Catalyst 4500 series switch.
This chapter consists of these sections:
• About SNMP, page 49-1
• Configuring SNMP, page 49-5
• Displaying SNMP Status, page 49-17
Note For complete syntax and usage information for the commands used in this chapter, see the
Cisco IOS Configuration Fundamentals Command Reference
http://www.cisco.com/en/US/docs/ios/fundamentals/command/reference/cf_book.html
and related publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
About SNMP
SNMP is an application-layer protocol that provides a message format for communication between
managers and agents. The SNMP system consists of an SNMP manager, an SNMP agent, and a MIB.
The SNMP manager can be part of a network management system (NMS) such as CiscoWorks. The
agent and MIB reside on the switch. To configure SNMP on the switch, you define the relationship
between the manager and the agent.
The SNMP agent contains MIB variables whose values the SNMP manager can request or change. A
manager can get a value from an agent or store a value into the agent. The agent gathers data from the
MIB, the repository for information about device parameters and network data. The agent can also
respond to a manager’s requests to get or set data.
An agent can send unsolicited traps to the manager. Traps are messages alerting the SNMP manager to
a condition on the network. Traps can mean improper user authentication, restarts, link status (up or
down), MAC address tracking, closing of a Transmission Control Protocol (TCP) connection, loss of
connection to a neighbor, or other significant events.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 49-1
Chapter 49 Configuring SNMP
About SNMP
This section includes information about these topics:
• SNMP Versions, page 49-2
• SNMP Manager Functions, page 49-3
• SNMP Agent Functions, page 49-4
• SNMP Community Strings, page 49-4
• Using SNMP to Access MIB Variables, page 49-4
• SNMP Notifications, page 49-5
SNMP Versions
The Catalyst 4500 series switch supports these SNMP versions:
• SNMPv1—The Simple Network Management Protocol, a Full Internet Standard, defined in
RFC 1157.
• SNMPv2C replaces the Party-based Administrative and Security Framework of SNMPv2Classic
with the community-string-based Administrative Framework of SNMPv2C while retaining the bulk
retrieval and improved error handling of SNMPv2Classic. It has these features:
– SNMPv2—Version 2 of the Simple Network Management Protocol, a Draft Internet Standard,
defined in RFCs 1902 through 1907.
– SNMPv2C—The community-string-based Administrative Framework for SNMPv2, an
Experimental Internet Protocol defined in RFC 1901.
• SNMPv3—Version 3 of the SNMP is an interoperable standards-based protocol defined in RFCs
2273 to 2275. SNMPv3 provides secure access to devices by authenticating and encrypting packets
over the network and includes these security features:
– Message integrity—ensuring that a packet was not tampered with in transit
– Authentication—determining that the message is from a valid source
– Encryption—mixing the contents of a package to prevent it from being read by an unauthorized
source.
Note To select encryption, enter the priv keyword. This keyword is available only when the
crypto (encrypted) software image is installed.
Both SNMPv1 and SNMPv2C use a community-based form of security. The community of managers
able to access the agent’s MIB is defined by an IP address access control list and password.
SNMPv2C includes a bulk retrieval mechanism and more detailed error message reporting to
management stations. The bulk retrieval mechanism retrieves tables and large quantities of information,
minimizing the number of round-trips required. The SNMPv2C improved error-handling includes
expanded error codes that distinguish different kinds of error conditions; these conditions are reported
through a single error code in SNMPv1. Error return codes in SNMPv2C report the error type.
SNMPv3 provides for both security models and security levels. A security model is an authentication
strategy set up for a user and the group within which the user resides. A security level is the permitted
level of security within a security model. A combination of the security level and the security model
determine which security mechanism is used when handling an SNMP packet. Available security models
are SNMPv1, SNMPv2C, and SNMPv3.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
49-2 OL-22250-01
Chapter 49 Configuring SNMP
About SNMP
The following table identifies the characteristics of the different combinations of security models and
levels.
Model Level Authentication Encryption Result
SNMPv1 noAuthNoPriv Community string No Uses a community string match for authentication.
SNMPv2C noAuthNoPriv Community string No Uses a community string match for authentication.
SNMPv3 noAuthNoPriv Username No Uses a username match for authentication.
SNMPv3 authNoPriv MD5 or SHA No Provides authentication based on the HMAC-MD5
or HMAC-SHA algorithms.
SNMPv3 authPriv MD5 or SHA DES Provides authentication based on the HMAC-MD5
(requires the or HMAC-SHA algorithms.
cryptographic software Provides DES 56-bit encryption in addition to
image) authentication based on the CBC-DES (DES-56)
standard.
You must configure the SNMP agent to use the SNMP version supported by the management station.
Because an agent can communicate with multiple managers, you can configure the software to support
communications using SNMPv1, and SNMPv2C, and SNMPv3 protocols.
SNMP Manager Functions
The SNMP manager uses information in the MIB to perform the operations described in Table 49-1.
Table 49-1 SNMP Operations
Operation Description
get-request Retrieves a value from a specific variable.
get-next-request Retrieves a value from a variable within a table.1
get-bulk-request2 Retrieves large blocks of data, such as multiple rows in a table, that would
otherwise require the transmission of many small blocks of data.
get-response Replies to a get-request, get-next-request, and set-request sent by an NMS.
set-request Stores a value in a specific variable.
trap An unsolicited message sent by an SNMP agent to an SNMP manager when some
event has occurred.
1. With this operation, an SNMP manager does not need to know the exact variable name. A sequential search is performed to
find the needed variable from within a table.
2. The get-bulk command only works with SNMPv2 or later.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 49-3
Chapter 49 Configuring SNMP
About SNMP
SNMP Agent Functions
The SNMP agent responds to SNMP manager requests as follows:
• Get a MIB variable—The SNMP agent begins this function in response to a request from the NMS.
The agent retrieves the value of the requested MIB variable and responds to the NMS with that
value.
• Set a MIB variable—The SNMP agent begins this function in response to a message from the NMS.
The SNMP agent changes the value of the MIB variable to the value requested by the NMS.
The SNMP agent also sends unsolicited trap messages to notify an NMS that a significant event has
occurred on the agent. Examples of trap conditions include, but are not limited to, when a port or module
goes up or down, when spanning-tree topology changes occur, and when authentication failures occur.
SNMP Community Strings
SNMP community strings authenticate access to MIB objects and function as embedded passwords. In
order for the NMS to access the switch, the community string definitions on the NMS must match at least
one of the three community string definitions on the switch.
A community string can have one of these attributes:
• Read-only (RO)—Gives read access to authorized management stations to all objects in the MIB
except the community strings, but does not allow write access
• Read-write (RW)—Gives read and write access to authorized management stations to all objects in
the MIB, but does not allow access to the community strings
• Read-write-all—Gives read and write access to authorized management stations to all objects in the
MIB, including the community strings
Using SNMP to Access MIB Variables
An example of an NMS is the CiscoWorks network management software. CiscoWorks 2000 software
uses the switch MIB variables to set device variables and to poll devices on the network for specific
information. The results of a poll can be displayed as a graph and analyzed to troubleshoot
internetworking problems, increase network performance, verify the configuration of devices, monitor
traffic loads, and more.
As shown in Figure 49-1, the SNMP agent gathers data from the MIB. The agent can send traps, or
notification of certain events, to the SNMP manager, which receives and processes the traps. Traps alert
the SNMP manager to a condition on the network such as improper user authentication, restarts, link
status (up or down), MAC address tracking, and so forth. The SNMP agent also responds to MIB-related
queries sent by the SNMP manager in get-request, get-next-request, and set-request format.
Figure 49-1 SNMP Network
NMS Get-request, Get-next-request, Network device
Get-bulk, Set-request
43581
Get-response, traps MIB
SNMP Manager SNMP Agent
Software Configuration Guide—Release IOS-XE 3.1.0 SG
49-4 OL-22250-01
Chapter 49 Configuring SNMP
Configuring SNMP
SNMP Notifications
SNMP allows the switch to send notifications to SNMP managers when particular events occur. SNMP
notifications can be sent as traps or inform requests. In command syntax, unless there is an option in the
command to select either traps or informs, the keyword traps refers to either traps or informs, or both.
Use the snmp-server host command to specify whether to send SNMP notifications as traps or informs.
Note SNMPv1 does not support informs.
Traps are unreliable because the receiver does not send an acknowledgment when it receives a trap, and
the sender cannot determine if the trap was received. When an SNMP manager receives an inform
request, it acknowledges the message with an SNMP response protocol data unit (PDU). If the sender
does not receive a response, the inform request can be sent again. Because they can be re-sent, informs
are more likely than traps to reach their intended destination.
The characteristics that make informs more reliable than traps also consume more resources in the switch
and in the network. Unlike a trap, which is discarded as soon as it is sent, an inform request is held in
memory until a response is received or the request times out. Traps are sent only once, but an inform
might be re-sent or retried several times. The retries increase traffic and contribute to a higher overhead
on the network. Therefore, traps and informs require a trade-off between reliability and resources. If it
is important that the SNMP manager receive every notification, use inform requests. If traffic on the
network or memory in the switch is a concern and notification is not required, use traps.
Configuring SNMP
This section describes how to configure SNMP on your switch. It contains this configuration
information:
• Default SNMP Configuration, page 49-5
• SNMP Configuration Guidelines, page 49-6
• Disabling the SNMP Agent, page 49-7
• Configuring Community Strings, page 49-7
• Configuring SNMP Groups and Users, page 49-9
• Configuring SNMP Notifications, page 49-11
• Setting the Agent Contact and Location Information, page 49-15
• Limiting TFTP Servers Used Through SNMP, page 49-15
• SNMP Examples, page 49-16
Default SNMP Configuration
Table 49-2 shows the default SNMP configuration.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 49-5
Chapter 49 Configuring SNMP
Configuring SNMP
Table 49-2 Default SNMP Configuration
Feature Default Setting
SNMP agent Enabled
SNMP trap receiver None configured
SNMP traps None enabled except the trap for TCP connections (tty), and licensing.
SNMP version If no version keyword is present, the default is Version 1.
SNMPv3 authentication If no keyword is entered, the default is the noauth (noAuthNoPriv)
security level.
SNMP notification type If no type is specified, all notifications are sent.
SNMP Configuration Guidelines
An SNMP group is a table that maps SNMP users to SNMP views. An SNMP user is a member of an
SNMP group. An SNMP host is the recipient of an SNMP trap operation. An SNMP engine ID is a name
for the local or remote SNMP engine.
When configuring SNMP, follow these guidelines:
• When configuring an SNMP group, do not specify a notify view. The snmp-server host global
configuration command autogenerates a notify view for the user and then adds it to the group
associated with that user. Modifying the group's notify view affects all users associated with that
group. For information about when you should configure notify views, see the Cisco IOS
Configuration Fundamentals Command Reference, Release 12.2.
• To configure a remote user, specify the IP address or port number for the remote SNMP agent of the
device where the user resides.
• Before you configure remote users for a particular agent, configure the SNMP engine ID, using the
snmp-server engineID global configuration with the remote option. The remote agent's SNMP
engine ID and user password are used to compute the authentication and privacy digests. If you do
not configure the remote engine ID first, the configuration command fails.
• When configuring SNMP informs, you need to configure the SNMP engine ID for the remote agent
in the SNMP database before you can send proxy requests or informs to it.
• If a local user is not associated with a remote host, the switch does not send informs for the auth
(authNoPriv) and the priv (authPriv) authentication levels.
• Changing the value of the SNMP engine ID has important side effects. A user's password (entered
on the command line) is converted to an MD5 or SHA security digest based on the password and the
local engine ID. The command-line password is then destroyed, as required by RFC 2274. Because
of this deletion, if the value of the engine ID changes, the security digests of SNMPv3 users become
invalid, and you need to reconfigure SNMP users by using the snmp-server user username global
configuration command. Similar restrictions require the reconfiguration of community strings when
the engine ID changes.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
49-6 OL-22250-01
Chapter 49 Configuring SNMP
Configuring SNMP
Disabling the SNMP Agent
To disable the SNMP agent, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# no snmp-server Disables the SNMP agent operation.
Step 3 Switch(config)# end Returns to privileged EXEC mode.
Step 4 Switch# show running-config Verifies your entries.
Step 5 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
The no snmp-server global configuration command disables all running versions (Version 1,
Version 2C, and Version 3) on the device. No specific IOS command exists to enable SNMP. The first
snmp-server global configuration command that you enter enables all versions of SNMP.
Configuring Community Strings
You use the SNMP community string to define the relationship between the SNMP manager and the
agent. The community string acts like a password to permit access to the agent on the switch. Optionally,
you can specify one or more of these characteristics associated with the string:
• An access list of IP addresses of the SNMP managers that are permitted to use the community string
to gain access to the agent
• A MIB view, which defines the subset of all MIB objects accessible to the given community
• Read and write or read-only permission for the MIB objects accessible to the community
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 49-7
Chapter 49 Configuring SNMP
Configuring SNMP
To configure a community string on the switch, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# [no] snmp-server Configures the community string.
community string [view view-name] [ro |
rw] [access-list-number] • For string, specify a string that acts like a password and
permits access to the SNMP protocol. You can configure one
or more community strings up to 117 characters.
• (Optional) For view, specify the view record accessible to the
community.
• (Optional) Specify either read-only (ro) if you want
authorized management stations to retrieve MIB objects, or
specify read-write (rw) if you want authorized management
stations to retrieve and modify MIB objects. By default, the
community string permits read-only access to all objects.
• (Optional) For access-list-number, enter an IP standard access
list numbered from 1 to 99 and 1300 to 1999.
To remove a specific community string, use the
no snmp-server community string global configuration
command.
Step 3 Switch(config)# access-list (Optional) If you specified an IP standard access list number in
access-list-number {deny | permit} source Step 2, create the list, repeating the command as many times as
[source-wildcard]
necessary.
• For access-list-number, enter the access list number specified
in Step 2.
• The deny keyword denies access if the conditions are
matched. The permit keyword permits access if the conditions
are matched.
• For source, enter the IP address of the SNMP managers that
are permitted to use the community string to gain access to the
agent.
• (Optional) For source-wildcard, enter the wildcard bits in
dotted decimal notation to be applied to the source. Place ones
in the bit positions that you want to ignore.
Recall that the access list is always terminated by an implicit deny
statement for everything.
Step 4 Switch(config)# end Returns to privileged EXEC mode.
Step 5 Switch# show running-config Verifies your entries.
Step 6 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Note To disable access for an SNMP community, set the community string for that community to the null
string (do not enter a value for the community string).
Software Configuration Guide—Release IOS-XE 3.1.0 SG
49-8 OL-22250-01
Chapter 49 Configuring SNMP
Configuring SNMP
Note The snmp-server enable informs command is not supported. To enable the sending of SNMP inform
notifications, use the snmp-server enable traps command combined with the snmp-server host
host-addr informs command.
This example shows how to assign the string comaccess to SNMP, to allow read-only access, and to
specify that IP access list 4 can use the community string to gain access to the switch SNMP agent:
Switch(config)# snmp-server community comaccess ro 4
Configuring SNMP Groups and Users
You can specify an identification name (engine ID) for the local or remote SNMP server engine on the
switch. You can configure an SNMP server group that maps SNMP users to SNMP views, and you can
add new users to the SNMP group.
To configure SNMP on the switch, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# snmp-server engineID Configures a name for either the local or remote copy of SNMP.
{local engineid-string | remote
ip-address [udp-port port-number] • The engineid-string is a 24-character ID string with the name of
engineid-string} the copy of SNMP. You need not specify the entire 24-character
engine ID if it has trailing zeros. Specify only the portion of the
engine ID up to the point where only zeros remain in the value.
For example, to configure an engine ID of
123400000000000000000000, you can enter this:
snmp-server engineID local 1234
• If you select remote, specify the ip-address of the device that
contains the remote copy of SNMP and the optional UDP port on
the remote device. The default is 162.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 49-9
Chapter 49 Configuring SNMP
Configuring SNMP
Command Purpose
Step 3 Switch(config)# snmp-server group Configures a new SNMP group on the remote device.
groupname {v1 | v2c | v3 [auth | noauth
| priv]} [read readview] [write • For groupname, specify the name of the group.
writeview] [notify notifyview] [access
access-list]
• Specify a security model:
– v1 is the least secure of the possible security models.
– v2c is the second least secure model. It allows transmission
of informs and integers twice the normal width.
– v3, the most secure, requires you to select an authentication
level:
auth—Enables the Message Digest 5 (MD5) and the Secure
Hash Algorithm (SHA) packet authentication.
noauth—The noAuthNoPriv security level. This is the
default if no keyword is specified.
priv—Enables Data Encryption Standard (DES) packet
encryption (also called privacy).
Note The priv keyword is available only when the crypto software
image is installed.
• (Optional) Enter read readview with a string (not to exceed 64
characters) that is the name of the view in which you can only
view the contents of the agent.
• (Optional) Enter write writeview with a string (not to exceed 64
characters) that is the name of the view in which you enter data
and configure the contents of the agent.
• (Optional) Enter notify notifyview with a string (not to exceed 64
characters) that is the name of the view in which you specify a
notify, inform, or trap.
• (Optional) Enter access access-list with a string (not to exceed 64
characters) that is the name of the access list.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
49-10 OL-22250-01
Chapter 49 Configuring SNMP
Configuring SNMP
Command Purpose
Step 4 Switch(config)# snmp-server user Configures a new user to an SNMP group.
username groupname [remote host
[udp-port port]] {v1 | v2c | v3 [auth • The username is the name of the user on the host that connects to
{md5 | sha} auth-password]} [encrypted] the agent.
[access access-list]
• The groupname is the name of the group to which the user is
associated.
• (Optional) Enter remote to specify a remote SNMP entity to
which the user belongs and the hostname or IP address of that
entity with the optional UDP port number. The default is 162.
• Enter the SNMP version number (v1,or v2c, or v3). If you enter
v3, you have these additional options:
– auth is an authentication level setting session, which can be
either the HMAC-MD5-96 or the HMAC-SHA-96
authentication level, and requires a password string (not to
exceed 64 characters).
– encrypted specifies that the password appears in encrypted
format.
• (Optional) Enter access access-list with a string (not to exceed 64
characters) that is the name of the access list.
Step 5 Switch(config)# end Returns to privileged EXEC mode.
Step 6 Switch# show running-config Verifies your entries.
Step 7 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Configuring SNMP Notifications
A trap manager is a management station that receives and processes traps. Traps are system alerts that
the switch generates when certain events occur. By default, no trap manager is defined, and no traps are
sent. Switches running IOS Cisco IOS Release 12.2(31)SG and later releases can have an unlimited
number of trap managers.
Note Many commands use the word traps in the command syntax. Unless there is an option in the command
to select either traps or informs, the keyword traps refers to either traps, informs, or both. Use the
snmp-server host command to specify whether to send SNMP notifications as traps or informs.
Table 49-3 describes the supported switch traps (notification types). You can enable any or all of these
traps and configure a trap manager to receive them.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 49-11
Chapter 49 Configuring SNMP
Configuring SNMP
Table 49-3 Switch Notification Types
Notification Type
Keyword Description
auth-framework Enables SNMP CISCO-AUTH-FRAMEWORK-MIB traps.
bgp Generates BGP state change traps.
Note This option is only available when the enhanced multilayer image is
installed.
bridge Generates STP bridge MIB traps.
bulkstat Enables. Data-Collection-MIB Collection notifications
call-home Enables SNMP CISCO-CALLHOME-MIB traps.
cef Enables SNMP CEF traps.
config Generates a trap for SNMP configuration changes.
config-copy Generates a trap for SNMP copy configuration changes.
cpu-threshold Allows CPU utilization threshold violation traps.
dot1x Enables SNMP 802.1X traps.
eigrp Enable EIBGP traps.
Note This option is only available when the enhanced multilayer image is
installed.
energywise Enables SNMP ENERGYWISE traps.
entity Generates a trap for SNMP entity changes.
entity-diag Enables SNMP CISCO-ENTITY-DIAG-MIB traps.
envmon Generates environmental monitor traps. You can enable any or all of these
environmental traps: fan, shutdown, supply, temperature.
ether-oam Enables SNMP ethernet oam traps.
ethernet Enables SNMP Ethernet traps.
event-manager Enables SNMP Embedded Event Manager traps.
flash Generates SNMP FLASH notifications.
fru-ctrl Enable SNMP entity FRU control traps.
hsrp Generates a trap for Hot Standby Router Protocol (HSRP) changes.
ipmulticast Generates a trap for IP multicast routing changes.
isis Enable IS-IS traps.
Note This option is only available when the enhanced multilayer image is
installed.
license Enables license traps.
mac-notification Generates a trap for MAC address notifications.
memory Enables MEMORY traps.
msdp Generates a trap for Multicast Source Discovery Protocol (MSDP) changes.
Note This option is only available when the enhanced multilayer image is
installed.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
49-12 OL-22250-01
Chapter 49 Configuring SNMP
Configuring SNMP
Table 49-3 Switch Notification Types (continued)
Notification Type
Keyword Description
ospf Generates a trap for Open Shortest Path First (OSPF) changes. You can enable
any or all of these traps: Cisco specific, errors, link-state advertisement, rate
limit, retransmit, and state changes.
Note This option is only available when the enhanced multilayer image is
installed.
pim Generates a trap for Protocol-Independent Multicast (PIM) changes. You can
enable any or all of these traps: invalid PIM messages, neighbor changes, and
rendezvous point (RP)-mapping changes.
port-security Generates SNMP port security traps. You can also set a maximum trap rate
per second. The range is from 0 to 1000; the default is 0, which means that
there is no rate limit.
power-ethernet Enables SNMP power ethernet traps.
rep Enables SNMP Resilient Ethernet Protocol Traps.
rf Enable all SNMP traps defined in Cisco-RF-MIB.
rtr Enables SNMP Response Time Reporter traps.
Note It sends Service Assurance Agent RTR (RTR) notifications (from the
CISCO-RTTMON-MIB).
snmp Generates a trap for SNMP-type notifications for authentication, cold start,
warm start, link up or link down.
storm-control Generates a trap for SNMP storm-control. You can also set a maximum trap
rate per second. The range is from 0 to 1000; the default is 0 (no limit is
imposed; a trap is sent at every occurrence).
stpx Generates SNMP STP Extended MIB traps.
syslog Generates SNMP syslog traps.
transceiver Enables SNMP transceiver traps.
tty Generates a trap for TCP connections. This trap is enabled by default.
vlan-membership Generates a trap for SNMP VLAN membership changes.
vlancreate Generates SNMP VLAN created traps.
vlandelete Generates SNMP VLAN deleted traps.
vtp Generates a trap for VLAN Trunking Protocol (VTP) changes.
You can use the snmp-server host global configuration command to a specific host to receive the
notification types listed in Table 49-3.
To configure the switch to send traps or informs to a host, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# snmp-server Specifies the engine ID for the remote host.
engineID remote ip-address
engineid-string
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 49-13
Chapter 49 Configuring SNMP
Configuring SNMP
Command Purpose
Step 3 Switch(config)# snmp-server user Configures an SNMP user to be associated with the remote host created
username groupname remote host in Step 2.
[udp-port port] {v1 | v2c | v3
[auth {md5 | sha} auth-password]} Note You cannot configure a remote user for an address without first
[encrypted] [access access-list] configuring the engine ID for the remote host. If you try to
configure the user before configuring the remote engine ID, you
receive an error message, and the command is not executed.
Step 4 Switch(config)# snmp-server host Specifies the recipient of an SNMP trap operation.
host-addr [traps | informs]
[version {1 | 2c | 3 [auth | noauth | • For host-addr, specify the name or Internet address of the host (the
priv]}] community-string [udp-port targeted recipient).
port] [notification-type]
• (Optional) Enter traps (the default) to send SNMP traps to the host.
• (Optional) Enter informs to send SNMP informs to the host.
• (Optional) Specify the SNMP version (1, 2c, or 3). SNMPv1 does
not support informs.
• (Optional) For Version 3, select authentication level auth, noauth, or
priv.
Note The priv keyword is available only when the crypto software
image is installed.
• For community-string, enter the password-like community string sent
with the notification operation.
• (Optional) For udp-port port, enter the remote device UDP port.
• (Optional) For notification-type, use the keywords listed in
Table 49-3 on page 49-12. If no type is specified, all notifications are
sent.
Step 5 Switch(config)# snmp-server enable Enables the switch to send traps or informs and specify the type of
traps notification-types notifications to be sent. For a list of notification types, see Table 49-3 on
page 49-12, or enter this: snmp-server enable traps ?
To enable multiple types of traps, you must enter a separate snmp-server
enable traps command for each trap type.
Step 6 Switch(config)# snmp-server (Optional) Specifies the source interface, which provides the IP address
trap-source interface-id for the trap message. This command also sets the source IP address for
informs.
Step 7 Switch(config)# snmp-server (Optional) Establishes the message queue length for each trap host. The
queue-length length range is 1 to 5000; the default is 1000.
Step 8 Switch(config)# snmp-server (Optional) Defines how often to resend trap messages. The range is 1 to
trap-timeout seconds 1000; the default is 30 seconds.
Step 9 Switch(config)# end Returns to privileged EXEC mode.
Step 10 Switch# show running-config Verifies your entries.
Step 11 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Software Configuration Guide—Release IOS-XE 3.1.0 SG
49-14 OL-22250-01
Chapter 49 Configuring SNMP
Configuring SNMP
The snmp-server host command specifies which hosts receive the notifications. The
snmp-server enable trap command globally enables the mechanism for the specified notification (for
traps and informs). To enable a host to receive an inform, you must configure an
snmp-server host informs command for the host and globally enable informs by using the
snmp-server enable traps command.
To remove the specified host from receiving traps, use the no snmp-server host host global
configuration command. The no snmp-server host command with no keywords disables traps, but not
informs, to the host. To disable informs, use the no snmp-server host informs global configuration
command. To disable a specific trap type, use the no snmp-server enable traps notification-types global
configuration command.
Setting the Agent Contact and Location Information
To set the system contact and location of the SNMP agent so that these descriptions can be accessed
through the configuration file, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# snmp-server contact Sets the system contact string.
text
For example:
snmp-server contact Dial System Operator at beeper 21555.
Step 3 Switch(config)# snmp-server location Sets the system location string.
text
For example:
snmp-server location Building 3/Room 222
Step 4 Switch(config)# end Returns to privileged EXEC mode.
Step 5 Switch# show running-config Verifies your entries.
Step 6 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
Limiting TFTP Servers Used Through SNMP
To limit the TFTP servers used for saving and loading configuration files through SNMP to the servers
specified in an access list, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters global configuration mode.
Step 2 Switch(config)# snmp-server Limits TFTP servers used for configuration file copies through
tftp-server-list access-list-number SNMP to the servers in the access list.
For access-list-number, enter an IP standard access list numbered
from 1 to 99 and 1300 to 1999.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 49-15
Chapter 49 Configuring SNMP
Configuring SNMP
Command Purpose
Step 3 Switch(config)# access-list Creates a standard access list, repeating the command as many
access-list-number {deny | permit} times as necessary.
source [source-wildcard]
• For access-list-number, enter the access list number specified
in Step 2.
• The deny keyword denies access if the conditions are matched.
The permit keyword permits access if the conditions are
matched.
• For source, enter the IP address of the TFTP servers that can
access the switch.
• (Optional) For source-wildcard, enter the wildcard bits, in
dotted decimal notation, to be applied to the source. Place ones
in the bit positions that you want to ignore.
Recall that the access list is always terminated by an implicit deny
statement for everything.
Step 4 Switch(config)# end Returns to privileged EXEC mode.
Step 5 Switch# show running-config Verifies your entries.
Step 6 Switch# copy running-config (Optional) Saves your entries in the configuration file.
startup-config
SNMP Examples
This example shows how to enable all versions of SNMP. The configuration permits any SNMP manager
to access all objects with read-only permissions using the community string public. This configuration
does not cause the switch to send any traps.
Switch(config)# snmp-server community public
This example shows how to permit any SNMP manager to access all objects with read-only permission
using the community string public. The switch also sends VTP traps to the hosts 192.180.1.111 and
192.180.1.33 using SNMPv1 and to the host 192.180.1.27 using SNMPv2C. The community string
public is sent with the traps.
Switch(config)# snmp-server community public
Switch(config)# snmp-server enable traps vtp
Switch(config)# snmp-server host 192.180.1.27 version 2c public
Switch(config)# snmp-server host 192.180.1.111 version 1 public
Switch(config)# snmp-server host 192.180.1.33 public
This example shows how to allow read-only access for all objects to members of access list 4 that use
the comaccess community string. No other SNMP managers have access to any objects. SNMP
Authentication Failure traps are sent by SNMPv2C to the host cisco.com using the community string
public.
Switch(config)# snmp-server community comaccess ro 4
Switch(config)# snmp-server enable traps snmp authentication
Switch(config)# snmp-server host cisco.com version 2c public
This example shows how to send Entity MIB traps to the host cisco.com. The community string is
restricted. The first line enables the switch to send Entity MIB traps in addition to any traps previously
enabled. The second line specifies the destination of these traps and overwrites any previous
snmp-server host commands for the host cisco.com.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
49-16 OL-22250-01
Chapter 49 Configuring SNMP
Displaying SNMP Status
Switch(config)# snmp-server enable traps entity
Switch(config)# snmp-server host cisco.com restricted entity
This example shows how to enable the switch to send all traps to the host myhost.cisco.com using the
community string public:
Switch(config)# snmp-server enable traps
Switch(config)# snmp-server host myhost.cisco.com public
This example shows how to associate a user with a remote host and to send auth (authNoPriv)
authentication-level informs when the user enters global configuration mode:
Switch(config)# snmp-server engineID remote 192.180.1.27 00000063000100a1c0b4011b
Switch(config)# snmp-server group authgroup v3 auth
Switch(config)# snmp-server user authuser authgroup remote 192.180.1.27 v3 auth md5
mypassword
Switch(config)# snmp-server user authuser authgroup v3 auth md5 mypassword
Switch(config)# snmp-server host 192.180.1.27 informs version 3 auth authuser config
Switch(config)# snmp-server enable traps
Switch(config)# snmp-server inform retries 0
Displaying SNMP Status
To display SNMP input and output statistics, including the number of illegal community string entries,
errors, and requested variables, use the show snmp privileged EXEC command.You can also use the
other privileged EXEC commands in Table 49-4 to display SNMP information. For information about
the fields in the output displays, see the Cisco IOS Configuration Fundamentals Command Reference,
Release 12.4.
Table 49-4 Commands for Displaying SNMP Information
Feature Default Setting
show snmp Displays SNMP statistics.
show snmp chassis Displays chasis-id.
show snmp community Displays SNMP community string and access pri.
show snmp contact Displays SNMP contacts.
show snmp context Displays contexts.
show snmp engineID Displays information on the local SNMP engine and all
remote engines that have been configured on the device.
show snmp group Displays information on each SNMP group on the network.
show snmp host Displays information on each SNMP hosts configured.
show snmp location Displays information on location configured.
show snmp mib Displays information on mib objects present.
show snmp pending Displays information on pending SNMP requests.
show snmp sessions Displays information on the current SNMP sessions.
show snmp user Displays information on each SNMP user name in the
SNMP users table.
show snmp view Displays information on SNMP views.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 49-17
Chapter 49 Configuring SNMP
Displaying SNMP Status
Software Configuration Guide—Release IOS-XE 3.1.0 SG
49-18 OL-22250-01
CH A P T E R 50
Configuring Cisco IOS IP SLAs Operations
This chapter describes how to use Cisco IOS IP Service Level Agreements (SLAs) on the switch. Cisco
IP SLAs is a part of Cisco IOS software that allows Cisco customers to analyze IP service levels for IP
applications and services by using active traffic monitoring—the generation of traffic in a continuous,
reliable, and predictable manner—for measuring network performance. With Cisco IOS IP SLAs,
service provider customers can measure and provide service level agreements, and enterprise customers
can verify service levels, verify outsourced service level agreements, and understand network
performance. Cisco IOS IP SLAs can perform network assessments, verify quality of service (QoS), ease
the deployment of new services, and assist with network troubleshooting. Unless otherwise noted, the
term switch refers to a standalone switch and to a switch stack.
Note Switches running the IP base image support only IP SLAs responder functionality and must be
configured with another device that supports full IP SLAs functionality, for example, a switch.
For more information about IP SLAs, see the Cisco IOS IP SLAs Configuration Guide, Release 12.4T at
this URL:
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/12_4t/sla_12_4t_book.html
This chapter consists of these sections:
• Command Table, page 50-2
• About Cisco IOS IP SLAs, page 50-2
• Configuring IP SLAs Operations, page 50-7
• Monitoring IP SLAs Operations, page 50-13
Note Refer to Cisco IOS XE IP SLAs Features in Cisco IOS XE 3.1.0 SG, page 50-14 for new software
available in Cisco IOS XE 3.1.0.SG but not documented in this chapter. There you will find links to the
item s in the Cisco IOS library.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 50-1
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Command Table
Command Table
This table lists the commands most commonly used with Cisco IP SLAs.
Command Purpose Location
ip sla responder {tcp-connect | Configures the switch as an IP SLAs Configuring the IP SLAs Responder,
udp-echo} ipaddress ip-address port responder. page 50-8
port-number
ip sla operation-number Creates an IP SLAs operation, and Analyzing IP Service Levels by
enter IP SLAs configuration mode. Using the UDP Jitter Operation,
page 50-9
udp-jitter {destination-ip-address Configures the IP SLAs operation as Analyzing IP Service Levels by
| destination-hostname} a UDP jitter operation, and enter Using the UDP Jitter Operation,
destination-port [source-ip
{ip-address | hostname}]
UDP jitter configuration mode. page 50-9
[source-port port-number] [control
{enable | disable}] [num-packets
number-of-packets] [interval
interpacket-interval]
frequency seconds (Optional) Sets the rate at which a Analyzing IP Service Levels by
specified IP SLAs operation repeats. Using the UDP Jitter Operation,
page 50-9
ip sla monitor schedule Configures the scheduling Analyzing IP Service Levels by
operation-number [life {forever | parameters for an individual IP SLAs Using the UDP Jitter Operation,
seconds}] [start-time {hh:mm [:ss]
[month day | day month] | pending
operation. page 50-9
| now | after hh:mm:ss] [ageout Analyzing IP Service Levels by
seconds] [recurring]
Using the ICMP Echo Operation,
page 50-11
icmp-echo {destination-ip-address Configures the IP SLAs operation as Analyzing IP Service Levels by
| destination-hostname} [source-ip an ICMP Echo operation and enter Using the ICMP Echo Operation,
{ip-address | hostname} |
source-interface interface-id]
ICMP echo configuration mode. page 50-11
frequency seconds (Optional) Sets the rate at which a Analyzing IP Service Levels by
specified IP SLAs operation repeats. Using the ICMP Echo Operation,
page 50-11
About Cisco IOS IP SLAs
Cisco IOS IP SLAs sends data across the network to measure performance between multiple network
locations or across multiple network paths. It simulates network data and IP services and collects
network performance information in real time. Cisco IOS IP SLAs generates and analyzes traffic either
between Cisco IOS devices or from a Cisco IOS device to a remote IP device such as a network
application server. Measurements provided by the various Cisco IOS IP SLAs operations can be used for
troubleshooting, for problem analysis, and for designing network topologies.
Depending on the specific Cisco IOS IP SLAs operation, various network performance statistics are
monitored within the Cisco device and stored in both command-line interface (CLI) and Simple Network
Management Protocol (SNMP) MIBs. IP SLAs packets have configurable IP and application layer
Software Configuration Guide—Release IOS-XE 3.1.0 SG
50-2 OL-22250-01
Chapter 50 Configuring Cisco IOS IP SLAs Operations
About Cisco IOS IP SLAs
options such as source and destination IP address, User Datagram Protocol (UDP)/TCP port numbers, a
type of service (ToS) byte (including Differentiated Services Code Point [DSCP] and IP Prefix bits),
Virtual Private Network (VPN) routing/forwarding instance (VRF), and URL web address.
Because Cisco IP SLAs is Layer 2 transport independent, you can configure end-to-end operations over
disparate networks to best reflect the metrics that an end user is likely to experience. IP SLAs collects a
unique subset of these performance metrics:
• Delay (both round-trip and one-way)
• Jitter (directional)
• Packet loss (directional)
• Packet sequencing (packet ordering)
• Path (per hop)
• Connectivity (directional)
• Server or website download time
Because Cisco IOS IP SLAs is SNMP-accessible, it can also be used by performance-monitoring
applications like CiscoWorks Internetwork Performance Monitor (IPM) and other third-party Cisco
partner performance management products. You can find more details about network management
products that use Cisco IOS IP SLAs at this URL: http://www.cisco.com/go/ipsla
Using IP SLAs can provide these benefits:
• Service-level agreement monitoring, measurement, and verification.
• Network performance monitoring
– Measures the jitter, latency, or packet loss in the network.
– Provides continuous, reliable, and predictable measurements.
• IP service network health assessment to verify that the existing QoS is sufficient for new IP services.
• Edge-to-edge network availability monitoring for proactive verification and connectivity testing of
network resources (for example, shows the network availability of an NFS server used to store
business critical data from a remote site).
• Troubleshooting of network operation by providing consistent, reliable measurement that
immediately identifies problems and saves troubleshooting time.
This section includes this information about IP SLAs functionality:
• Using Cisco IOS IP SLAs to Measure Network Performance, page 50-3
• IP SLAs Responder and IP SLAs Control Protocol, page 50-4
• Response Time Computation for IP SLAs, page 50-5
• IP SLAs Operation Scheduling, page 50-6
• IP SLAs Operation Threshold Monitoring, page 50-6
Using Cisco IOS IP SLAs to Measure Network Performance
Use IP SLAs to monitor the performance between any area in the network—core, distribution, and
edge—without deploying a physical probe. It uses generated traffic to measure network performance
between two networking devices. Figure 50-1 shows how IP SLAs begins when the source device sends
a generated packet to the destination device. After the destination device receives the packet, depending
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 50-3
Chapter 50 Configuring Cisco IOS IP SLAs Operations
About Cisco IOS IP SLAs
on the type of IP SLAs operation, it responds with time-stamp information for the source to make the
calculation on performance metrics. An IP SLAs operation performs a network measurement from the
source device to a destination in the network using a specific protocol such as UDP.
Figure 50-1 Cisco IOS IP SLAs Operation
Performance
Any IP device management
application
IP SLA measurement
and IP SLA responder to
IP SLA Responder SNMP
IP SLA IP SLA
IP network
121381
IP SLA responder IP SLA source
IP SLA measurement
and IP SLA responder to
IP SLA Responder
To implement IP SLAs network performance measurement, you need to perform these tasks:
1. Enable the IP SLAs responder, if required.
2. Configure the required IP SLAs operation type.
3. Configure any options available for the specified operation type.
4. Configure threshold conditions, if required.
5. Schedule the operation to run, then let the operation run for a period of time to gather statistics.
6. Display and interpret the results of the operation using the Cisco IOS CLI or a network
management system (NMS) system with SNMP.
For more information about IP SLAs operations, see the operation-specific chapters in the Cisco IOS IP
SLAs Configuration Guide, Release 12.4T at this URL:
http://www.cisco.com/en/US/docs/ios/12_4/ip_sla/configuration/guide/hsla_c.html
The switch does not support Voice over IP (VoIP) service levels using the gatekeeper registration delay
operations measurements. Before configuring any IP SLAs application, use the show ip sla application
privileged EXEC command to verify that the operation type is supported on your software image.
IP SLAs Responder and IP SLAs Control Protocol
The IP SLAs responder is a component embedded in the destination Cisco device that allows the system
to anticipate and respond to IP SLAs request packets. The responder provides accurate measurements
without the need for dedicated probes. The responder uses the Cisco IOS IP SLAs Control Protocol to
provide a mechanism through which it can be notified on which port it should listen and respond. Only
a Cisco IOS device can be a source for a destination IP SLAs Responder.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
50-4 OL-22250-01
Chapter 50 Configuring Cisco IOS IP SLAs Operations
About Cisco IOS IP SLAs
Note The IP SLAs responder can be a Cisco IOS Layer 2, responder-configurable switch, such as a
Catalyst 4500 running the IP base image. The responder does not need to support full IP SLAs
functionality.
Figure 50-1 shows where the Cisco IOS IP SLAs responder fits in the IP network. The responder listens
on a specific port for control protocol messages sent by an IP SLAs operation. Upon receipt of the
control message, it enables the specified UDP or TCP port for the specified duration. During this time,
the responder accepts the requests and responds to them. It disables the port after it responds to the IP
SLAs packet, or when the specified time expires. MD5 authentication for control messages is available
for added security.
You do not need to enable the responder on the destination device for all IP SLAs operations. For
example, a responder is not required for services that are already provided by the destination router (such
as Telnet or HTTP). You cannot configure the IP SLAs responder on non-Cisco devices and Cisco IOS
IP SLAs can send operational packets only to services native to those devices.
Response Time Computation for IP SLAs
Switches and routers can take tens of milliseconds to process incoming packets due to other high priority
processes. This delay affects the response times because the test-packet reply might be in a queue while
waiting to be processed. In this situation, the response times would not accurately represent true network
delays. IP SLAs minimizes these processing delays on the source device as well as on the target device
(if the responder is being used) to determine true round-trip times. IP SLAs test packets use time
stamping to minimize the processing delays.
When the IP SLAs responder is enabled, it allows the target device to take time stamps when the packet
arrives on the interface at interrupt level and again just as it is leaving, eliminating the processing time.
This time stamping is made with a granularity of sub-milliseconds (ms).
Figure 50-2 demonstrates how the responder works. Four time stamps are taken to make the calculation
for round-trip time. At the target router, with the responder functionality enabled, time stamp 2 (TS2) is
subtracted from time stamp 3 (TS3) to produce the time spent processing the test packet as represented
by delta. This delta value is then subtracted from the overall round-trip time. Notice that the same
principle is applied by IP SLAs on the source router where the incoming time stamp 4 (TS4) is also taken
at the interrupt level to allow for greater accuracy.
Figure 50-2 Cisco IOS IP SLAs Responder Time Stamping
Source router Target router
T2 Responder
T1 T3
T4
=T3-T2
121380
RTT (Round-trip time) = T4 (Time stamp 4) - T1 (Time stamp 1) -
An additional benefit of the two time stamps at the target device is the ability to track one-way delay,
jitter, and directional packet loss. Because much network behavior is asynchronous, it is critical to have
these statistics. However, to capture one-way delay measurements, you must configure both the source
router and target router with Network Time Protocol (NTP) so that the source and target are
synchronized to the same clock source. One-way jitter measurements do not require clock
synchronization.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 50-5
Chapter 50 Configuring Cisco IOS IP SLAs Operations
About Cisco IOS IP SLAs
IP SLAs Operation Scheduling
For more details about the IP SLAs multioperations scheduling functionality, see the “IP
SLAs—Multiple Operation Scheduling” chapter of the Cisco IOS IP SLAs Configuration Guide at this
URL:
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/12_4t/sla_12_4t_book.html
When you configure an IP SLAs operation, you must schedule the operation to begin capturing statistics
and collecting error information. You can schedule an operation to start immediately or to start at a
certain month, day, and hour. Use the pending option to set the operation to start at a later time. The
pending option is an internal state of the operation that is visible through SNMP. The pending state is
also used when an operation is a reaction (threshold) operation waiting to be triggered. You can schedule
a single IP SLAs operation or a group of operations at one time.
You can schedule several IP SLAs operations by using a single command through the Cisco IOS CLI or
the CISCO RTTMON-MIB. Scheduling the operations to run at evenly distributed times allows you to
control the amount of IP SLAs monitoring traffic. This distribution of IP SLAs operations helps
minimize the CPU utilization and thus improves network scalability.
IP SLAs Operation Threshold Monitoring
For details on using thresholds with Cisco IOS IP SLAs operations, see the “IP SLAs—Proactive
Threshold Monitoring” chapter of the Cisco IOS IP SLAs Configuration Guide at this URL:
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/12_4t/sla_12_4t_book.html
To support successful service level agreement monitoring, you must have mechanisms that notify you
immediately of any possible violation. IP SLAs can send SNMP traps that are triggered by events such
as these:
• Connection loss
• Timeout
• Round-trip time threshold
• Average jitter threshold
• One-way packet loss
• One-way jitter
• One-way mean opinion score (MOS)
• One-way latency
An IP SLAs threshold violation can also trigger another IP SLAs operation for further analysis. For
example, the frequency could be increased or an ICMP path echo or ICMP path jitter operation could be
initiated for troubleshooting.
Determining the type of threshold and the level to set can be complex, and depends on the type of IP
service being used in the network.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
50-6 OL-22250-01
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Configuring IP SLAs Operations
Configuring IP SLAs Operations
Note This section does not include configuration information for all available operations as the configuration
information details are included in the Cisco IOS IP SLAs Configuration Guide. It does include several
operations as examples, including configuring the responder, configuring UDP jitter operation, which
requires a responder, and configuring ICMP echo operation, which does not require a responder. A
switch running the IP base image supports only IP SLAs responder functionality. The switch must be
running the IP services image for full IP SLAs functionality.
For details about configuring other operations, see he Cisco IOS IP SLAs Configuration Guide at this
URL
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/12_4t/sla_12_4t_book.html
This section includes this information:
• Default Configuration, page 50-7
• Configuration Guidelines, page 50-7
• Configuring the IP SLAs Responder, page 50-8
• Analyzing IP Service Levels by Using the UDP Jitter Operation, page 50-9
• Analyzing IP Service Levels by Using the ICMP Echo Operation, page 50-11
Default Configuration
No IP SLAs operations are configured.
Configuration Guidelines
For detailed descriptions and configuration procedures, see the Cisco IOS IP SLAs Configuration Guide,
Release 12.4T at this URL:
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/12_4t/sla_12_4t_book.html
Note that not all of the IP SLAs commands or operations described in this guide are supported on the
switch. The switch supports IP service level analysis by using UDP jitter, UDP echo, HTTP, TCP
connect, ICMP echo, ICMP path echo, ICMP path jitter, FTP, DNS, and DHCP, as well as multiple
operation scheduling and proactive threshold monitoring. It does not support VoIP service levels using
the gatekeeper registration delay operations measurements.
Before configuring any IP SLAs application, use the show ip sla application privileged EXEC
command to verify that the operation type is supported on your software image.
This is an example of the output from the command:
Switch# show ip sla application
IP SLAs
Version: 2.2.0 Round Trip Time MIB, Infrastructure Engine-II
Time of last change in whole IP SLAs: 22:17:39.117 UTC Fri Jun
Estimated system max number of entries: 15801
Estimated number of configurable operations: 15801
Number of Entries configured : 0
Number of active Entries : 0
Number of pending Entries : 0
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 50-7
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Configuring IP SLAs Operations
Number of inactive Entries : 0
Supported Operation Types
Type of Operation to Perform: 802.1agEcho
Type of Operation to Perform: 802.1agJitter
Type of Operation to Perform: dhcp
Type of Operation to Perform: dns
Type of Operation to Perform: echo
Type of Operation to Perform: ftp
Type of Operation to Perform: http
Type of Operation to Perform: jitter
Type of Operation to Perform: pathEcho
Type of Operation to Perform: pathJitter
Type of Operation to Perform: tcpConnect
Type of Operation to Perform: udpEcho
IP SLAs low memory water mark: 21741224
Configuring the IP SLAs Responder
The IP SLAs responder is available only on Cisco IOS software-based devices, including some Layer 2
switches that do not support full IP SLAs functionality, such as the Cisco ME 2400 switch.
To configure the IP SLAs responder on the target device (the operational target), follow these steps:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 ip sla responder {tcp-connect | Configures the switch as an IP SLAs responder.
udp-echo} ipaddress ip-address port
port-number The optional keywords have these meanings:
• tcp-connect—Enable the responder for TCP connect operations.
• udp-echo—Enable the responder for User Datagram Protocol (UDP)
echo or jitter operations.
• ipaddress ip-address—Enter the destination IP address.
• port port-number—Enter the destination port number.
Note The IP address and port number must match those configured on
the source device for the IP SLAs operation.
Step 3 end Returns to privileged EXEC mode.
Step 4 show ip sla responder Verifies the IP SLAs responder configuration on the device.
Step 5 copy running-config startup-config (Optional) Saves your entries in the configuration file.
To disable the IP SLAs responder, enter the no ip sla responder global configuration command. This
example shows how to configure the device as a responder for the UDP jitter IP SLAs operation in the
next procedure:
Switch(config)# ip sla responder udp-echo 172.29.139.134 5000
Software Configuration Guide—Release IOS-XE 3.1.0 SG
50-8 OL-22250-01
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Configuring IP SLAs Operations
Analyzing IP Service Levels by Using the UDP Jitter Operation
Jitter means interpacket delay variance. When multiple packets are sent consecutively 10 ms apart from
source to destination, if the network is behaving correctly, the destination should receive them 10 ms
apart. But if there are delays in the network (like queuing, arriving through alternate routes, and so on)
the arrival delay between packets might be more than or less than 10 ms with a positive jitter value
meaning that the packets arrived more than 10 ms apart. If the packets arrive 12 ms apart, positive jitter
is 2 ms; if the packets arrive 8 ms apart, negative jitter is 2 ms. For delay-sensitive networks, positive
jitter values are undesirable, and a jitter value of 0 is ideal.
In addition to monitoring jitter, the IP SLAs UDP jitter operation can be used as a multipurpose data
gathering operation. The packets IP SLAs generates carry packet sending and receiving sequence
information and sending and receiving time stamps from the source and the operational target. Based on
these, UDP jitter operations measure this data:
• Per-direction jitter (source to destination and destination to source)
• Per-direction packet-loss
• Per-direction delay (one-way delay)
• Round-trip delay (average round-trip time)
Because the paths for the sending and receiving of data can be different (asymmetric), use the
per-direction data to more readily identify where congestion or other problems are occurring in the
network.
The UDP jitter operation generates synthetic (simulated) UDP traffic and sends a number of UDP
packets, each of a specified size, sent a specified number of milliseconds apart, from a source router to
a target router, at a given frequency. By default, ten packet-frames, each with a payload size of 10 bytes
are generated every 10 ms, and the operation is repeated every 60 seconds. You can configure each of
these parameters to best simulate the IP service you want to provide.
Note The IP SLA precision microsecond feature does not provide microsecond accuracy; it provides only
microsecond granularity of the timestamps.
To provide accurate one-way delay (latency) measurements, time synchronization, such as that provided
by NTP, is required between the source and the target device. Time synchronization is not required for
the one-way jitter and packet loss measurements. If the time is not synchronized between the source and
target devices, one-way jitter and packet loss data is returned, but values of 0 are returned for the
one-way delay measurements provided by the UDP jitter operation.
Note Before you configure a UDP jitter operation on the source device, you must enable the IP SLAs
responder on the target device (the operational target).
To configure UDP jitter operation on the source device, follow these steps:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 ip sla operation-number Creates an IP SLAs operation, and enter IP SLAs configuration mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 50-9
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Configuring IP SLAs Operations
Command Purpose
Step 3 udp-jitter Configures the IP SLAs operation as a UDP jitter operation, and enter UDP
{destination-ip-address | jitter configuration mode.
destination-hostname}
destination-port [source-ip • destination-ip-address | destination-hostname—Specify the destination IP
{ip-address | hostname}] address or hostname.
[source-port port-number]
[control {enable | disable}] • destination-port—Specify the destination port number in the range from 1
[num-packets to 65535.
number-of-packets] [interval
interpacket-interval] • (Optional) source-ip {ip-address | hostname}—Specify the source IP
address or hostname. When a source IP address or hostname is not
specified, IP SLAs chooses the IP address nearest to the destination
• (Optional) source-port port-number—Specify the source port number in
the range from 1 to 65535. When a port number is not specified, IP SLAs
chooses an available port.
• (Optional) control—Enable or disable sending of IP SLAs control
messages to the IP SLAs responder. By default, IP SLAs control messages
are sent to the destination device to establish a connection with the IP
SLAs responder
• (Optional) num-packets number-of-packets—Enter the number of
packets to be generated. The range is 1 to 6000; the default is 10.
• (Optional) interval inter-packet-interval—Enter the interval between
sending packets in milliseconds. The range is 1 to 6000; the default value
is 20 ms.
Step 4 frequency seconds (Optional) Sets the rate at which a specified IP SLAs operation repeats. The
range is from 1 to 604800 seconds; the default is 60 seconds.
Step 5 exit Exits UDP jitter configuration mode, and return to global configuration mode.
Step 6 ip sla monitor schedule Configures the scheduling parameters for an individual IP SLAs operation.
operation-number [life
{forever | seconds}] • operation-number—Enter the RTR entry number.
[start-time {hh:mm [:ss]
[month day | day month] |
• (Optional) life—Set the operation to run indefinitely (forever) or for a
pending | now | after specific number of seconds. The range is from 0 to 2147483647. The
hh:mm:ss] [ageout seconds] default is 3600 seconds (1 hour).
[recurring]
• (Optional) start-time—Enter the time for the operation to begin collecting
information:
– To start at a specific time, enter the hour, minute, second (in 24-hour
notation), and day of the month. If no month is entered, the default is
the current month.
– Enter pending to select no information collection until a start time is
selected.
– Enter now to start the operation immediately.
– Enter after hh:mm:ss to show that the operation should start after the
entered time has elapsed.
• (Optional) ageout seconds—Enter the number of seconds to keep the
operation in memory when it is not actively collecting information. The
range is 0 to 2073600 seconds, the default is 0 seconds (never ages out).
• (Optional) recurring—Set the operation to automatically run every day.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
50-10 OL-22250-01
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Configuring IP SLAs Operations
Command Purpose
Step 7 end Returns to privileged EXEC mode.
Step 8 show ip sla configuration (Optional) Displays configuration values, including all defaults for all IP SLAs
[operation-number] operations or a specified operation.
Step 9 copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To disable the IP SLAs operation, enter the no ip sla operation-number global configuration command.
This example shows how to configure a UDP jitter IP SLAs operation:
Switch(config)# ip sla 10
Switch(config-ip-sla)# udp-jitter 172.29.139.134 5000
Switch(config-ip-sla-jitter)# frequency 30
Switch(config-ip-sla-jitter)# exit
Switch(config)# ip sla schedule 5 start-time now life forever
Switch(config)# end
Switch# show ip sla configuration 10
IP SLAs, Infrastructure Engine-II.
Entry number: 10
Owner:
Tag:
Type of operation to perform: udp-jitter
Target address/Source address: 1.1.1.1/0.0.0.0
Target port/Source port: 2/0
Request size (ARR data portion): 32
Operation timeout (milliseconds): 5000
Packet Interval (milliseconds)/Number of packets: 20/10
Type Of Service parameters: 0x0
Verify data: No
Vrf Name:
Control Packets: enabled
Schedule:
Operation frequency (seconds): 30
Next Scheduled Start Time: Pending trigger
Group Scheduled : FALSE
Randomly Scheduled : FALSE
Life (seconds): 3600
Entry Ageout (seconds): never
Recurring (Starting Everyday): FALSE
Status of entry (SNMP RowStatus): notInService
Threshold (milliseconds): 5000
Distribution Statistics:
Number of statistic hours kept: 2
Number of statistic distribution buckets kept: 1
Statistic distribution interval (milliseconds): 20
Enhanced History:
Analyzing IP Service Levels by Using the ICMP Echo Operation
The ICMP echo operation measures end-to-end response time between a Cisco device and any devices
using IP. Response time is computed by measuring the time taken between sending an ICMP echo
request message to the destination and receiving an ICMP echo reply. Many customers use IP SLAs
ICMP-based operations, in-house ping testing, or ping-based dedicated probes for response time
measurements between the source IP SLAs device and the destination IP device. The IP SLAs ICMP
echo operation conforms to the same specifications as ICMP ping testing, and the two methods result in
the same response times.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 50-11
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Configuring IP SLAs Operations
Note This operation does not require the IP SLAs responder to be enabled.
To configure an ICMP echo operation on the source device, follow these steps:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 ip sla operation-number Creates an IP SLAs operation and enter IP SLAs configuration mode.
Step 3 icmp-echo Configures the IP SLAs operation as an ICMP Echo operation and enter ICMP
{destination-ip-address | echo configuration mode.
destination-hostname}
[source-ip {ip-address | • destination-ip-address | destination-hostname—Specify the destination IP
hostname} | source-interface address or hostname.
interface-id]
• (Optional) source-ip {ip-address | hostname}—Specify the source IP
address or hostname. When a source IP address or hostname is not
specified, IP SLAs chooses the IP address nearest to the destination
• (Optional) source-interface interface-id—Specify the source interface for
the operation.
Step 4 frequency seconds (Optional) Sets the rate at which a specified IP SLAs operation repeats. The
range is from 1 to 604800 seconds; the default is 60 seconds.
Step 5 exit Exits UDP jitter configuration mode, and return to global configuration mode.
Step 6 ip sla schedule Configures the scheduling parameters for an individual IP SLAs operation.
operation-number [life
{forever | seconds}] • operation-number—Enter the RTR entry number.
[start-time {hh:mm [:ss]
[month day | day month] |
• (Optional) life—Set the operation to run indefinitely (forever) or for a
pending | now | after specific number of seconds. The range is from 0 to 2147483647. The
hh:mm:ss] [ageout seconds] default is 3600 seconds (1 hour)
[recurring]
• (Optional) start-time—Enter the time for the operation to begin collecting
information:
– To start at a specific time, enter the hour, minute, second (in 24-hour
notation), and day of the month. If no month is entered, the default is
the current month.
– Enter pending to select no information collection until a start time is
selected.
– Enter now to start the operation immediately.
– Enter after hh:mm:ss to indicate that the operation should start after
the entered time has elapsed.
• (Optional) ageout seconds—Enter the number of seconds to keep the
operation in memory when it is not actively collecting information. The
range is 0 to 2073600 seconds; the default is 0 seconds (never ages out).
• (Optional) recurring—Set the operation to automatically run every day.
Step 7 end Returns to privileged EXEC mode.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
50-12 OL-22250-01
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Monitoring IP SLAs Operations
Command Purpose
Step 8 show ip sla configuration (Optional) Displays configuration values including all defaults for all IP SLAs
[operation-number] operations or a specified operation.
Step 9 copy running-config (Optional) Saves your entries in the configuration file.
startup-config
To disable the IP SLAs operation, enter the no ip sla operation-number global configuration command.
This example shows how to configure an ICMP echo IP SLAs operation:
Switch(config)# ip sla 12
Switch(config-ip-sla)# icmp-echo 172.29.139.134
Switch(config-ip-sla-echo)# frequency 30
Switch(config-ip-sla-echo)# exit
Switch(config)# ip sla schedule 5 start-time now life forever
Switch(config)# end
Switch# show ip sla configuration 22
IP SLAs, Infrastructure Engine-II.
Entry number: 12
Owner:
Tag:
Type of operation to perform: echo
Target address: 2.2.2.2
Source address: 0.0.0.0
Request size (ARR data portion): 28
Operation timeout (milliseconds): 5000
Type Of Service parameters: 0x0
Verify data: No
Vrf Name:
Schedule:
Operation frequency (seconds): 60
Next Scheduled Start Time: Pending trigger
Group Scheduled : FALSE
Randomly Scheduled : FALSE
Life (seconds): 3600
Entry Ageout (seconds): never
Recurring (Starting Everyday): FALSE
Status of entry (SNMP RowStatus): notInService
Threshold (milliseconds): 5000
Distribution Statistics:
Number of statistic hours kept: 2
Number of statistic distribution buckets kept: 1
Statistic distribution interval (milliseconds): 20
History Statistics:
Number of history Lives kept: 0
Number of history Buckets kept: 15
History Filter Type: None
Enhanced History:
Monitoring IP SLAs Operations
To display IP SLAs operations configuration and results, use the commands listed in Table 50-1.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 50-13
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Cisco IOS XE IP SLAs Features in Cisco IOS XE 3.1.0 SG
Table 50-1 Monitoring IP SLAs Operations
Command Purpose
show ip sla application Displays global information about Cisco IOS IP SLAs.
show ip sla authentication Displays IP SLAs authentication information.
show ip sla configuration [entry-number] Displays configuration values including all defaults for
all IP SLAs operations or a specific operation.
show ip sla enhanced-history {collection-statistics | Displays enhanced history statistics for collected
distribution statistics} [entry-number] history buckets or distribution statistics for all IP SLAs
operations or a specific operation.
show ip sla ethernet-monitor configuration [entry-number] Displays IP SLAs automatic Ethernet configuration.
show ip sla group schedule [schedule-entry-number] Displays IP SLAs group scheduling configuration and
details.
show ip sla history [entry-number | full | tabular] Displays history collected for all IP SLAs operations
show ip sla mpls-lsp-monitor {collection-statistics | Displays MPLS label switched path (LSP) Health
configuration | ldp operational-state | scan-queue | Monitor operations,
summary [entry-number] | neighbors}
show ip sla reaction-configuration [entry-number] Displays the configured proactive threshold monitoring
settings for all IP SLAs operations or a specific
operation.
show ip sla reaction-trigger [entry-number] Displays the reaction trigger information for all IP
SLAs operations or a specific operation.
show ip sla responder Displays information about the IP SLAs responder.
show ip sla statistics [entry-number | aggregated | Displays current or aggregated operational status and
details] statistics.
Cisco IOS XE IP SLAs Features in Cisco IOS XE 3.1.0 SG
The following IP SLAs features are Supervisor Engine 7-E specific features
IP SLAs - DHCP Operation
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_dhcp.html
IP SLAs - Distribution of Statistics
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_overview.html
IP SLAs - DNS Operation
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_dns.html
IP SLAs - FTP Operation
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_ftp.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
50-14 OL-22250-01
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Cisco IOS XE IP SLAs Features in Cisco IOS XE 3.1.0 SG
IP SLAs - HTTP Operation
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_http.html
IP SLAs - ICMP Echo Operation
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_icmp_echo.html
IP SLAs - ICMP Path Echo Operation
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_icmp_pathecho.html
IP SLAs - MPLS VPN Awareness
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_overview.html
IP SLAs - Multi Operation Scheduler
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_multi_scheduler.html
IP SLAs - One Way Measurement
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_overview.html
IP SLAs - Path Jitter Operation
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_icmp_pathjitter.html
IP SLAs - Reaction Threshold
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_threshold_mon.html
IP SLAs - Scheduler
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_overview.html
IP SLAs - TCP Connect Operation
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_tcp.html
IP SLAs - UDP Echo Operation
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_udp_echo.html
IP SLAs - UDP Jitter Operation
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_udp_jitter.html
IP SLAs Random Scheduler
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_multi_scheduler.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 50-15
Chapter 50 Configuring Cisco IOS IP SLAs Operations
Cisco IOS XE IP SLAs Features in Cisco IOS XE 3.1.0 SG
IPv6 - IP SLAs (UDP Jitter, UDP Echo, ICMP Echo, TCP Connect)
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_udp_jitter.html
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_udp_echo.html
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_icmp_echo.html
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_tcp.html
The following IP SLAs features are NOT K10-specific features
IP SLAs - History Statistics
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_overview.html
IP SLAs - LSP Health Monitor
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_lsp_mon_autodisc.html
IP SLAs - LSP Health Monitor with LSP Discovery
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_lsp_mon_autodisc.html
IP SLAs - Probe Enhancements
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_overview.html
IP SLAs - SNA LU2 Echo
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_dlsw.html
IP SLAs - SNMP Support
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_overview.html
IP SLAs for MPLS Pseudo Wire (PWE3) via VCCV
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_lsp_mon_autodisc.html
IP SLAs Responder
http://www.cisco.com/en/US/docs/ios/ipsla/configuration/guide/sla_overview.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
50-16 OL-22250-01
CH A P T E R 51
Configuring RMON
This chapter describes how to configure Remote Network Monitoring (RMON) on your Catalyst 4500
series switch. RMON is a standard monitoring specification that defines a set of statistics and functions
that can be exchanged between RMON-compliant console systems and network probes. RMON provides
you with comprehensive network-fault diagnosis, planning, and performance-tuning information.
Note For complete syntax and usage information for the commands used in this chapter, see the
Cisco IOS Configuration Fundamentals Command Reference
http://www.cisco.com/en/US/docs/ios/fundamentals/command reference/cf_book.html
and related publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
This chapter consists of these sections:
• About RMON, page 51-1
• Configuring RMON, page 51-3
• Displaying RMON Status, page 51-6
About RMON
RMON is an Internet Engineering Task Force (IETF) standard monitoring specification that allows
various network agents and console systems to exchange network monitoring data. You can use the
RMON feature with the Simple Network Management Protocol (SNMP) agent in the switch to monitor
all the traffic flowing among switches on all connected LAN segments.
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 51-1
Chapter 51 Configuring RMON
About RMON
Figure 51-1 Remote Monitoring Example
Network management station with
generic RMON console application
Catalyst 4500
switch
RMON alarms and events
configured. SNMP configured.
RMON history
and statistic
collection enabled.
Catalyst 4500 Catalyst 4500
switch switch
133836
Workstations Workstations
Network management station with
generic RMON console application
Catalyst 3550 switch
RMON alarms and events
configured. SNMP configured.
RMON history
and statistic
collection enabled.
92428
BladeCenter BladeCenter
The switch supports these RMON groups (defined in RFC 1757):
• Statistics (RMON group 1)—Collects Ethernet, Fast Ethernet, and Gigabit Ethernet statistics on an
interface.
• History (RMON group 2)—Collects a history group of statistics on Ethernet, Fast Ethernet, and
Gigabit Ethernet interfaces for a specified polling interval.
Software Configuration Guide—Release 12.2(52)SG
51-2 OL-16048-01
Chapter 51 Configuring RMON
Configuring RMON
• Alarm (RMON group 3)—Monitors a specific MIB object for a specified interval, triggers an alarm
at a specified value (rising threshold), and resets the alarm at another value (falling threshold).
Alarms can be used with events; the alarm triggers an event, which can generate a log entry or an
SNMP trap.
• Event (RMON group 9)—Determines the action to take when an event is triggered by an alarm. The
action can be to generate a log entry or an SNMP trap.
Because switches supported by Cisco IOS Release 12.2(31)SG use hardware counters for RMON data
processing, the monitoring is more efficient, and little processing power is required.
Configuring RMON
This section describes how to configure RMON on your switch. It contains this configuration
information:
• Default RMON Configuration, page 51-3
• Configuring RMON Alarms and Events, page 51-3
• Configuring RMON Collection on an Interface, page 51-5
Default RMON Configuration
RMON is disabled by default; no alarms or events are configured.
Only RMON 1 is supported on the switch.
Configuring RMON Alarms and Events
You can configure your switch for RMON by using the command-line interface (CLI) or an
SNMP-compatible network management station. We recommend that you use a generic RMON console
application on the network management station (NMS) to take advantage of RMON’s network
management capabilities. You must also configure SNMP on the switch to access RMON MIB objects.
For more information, see Chapter 49, “Configuring SNMP.”
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 51-3
Chapter 51 Configuring RMON
Configuring RMON
To enable RMON alarms and events, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 rmon alarm number variable interval {absolute | delta} Sets an alarm on a MIB object.
rising-threshold value [event-number]
falling-threshold value [event-number] • For number, specify the alarm number. The
[owner string] range is 1 to 65535.
• For variable, specify the MIB object to
monitor.
• For interval, specify the time in seconds the
alarm monitors the MIB variable. The range is
1 to 4294967295 seconds.
• Specify the absolute keyword to test each MIB
variable directly; specify the delta keyword to
test the change between samples of a MIB
variable.
• For value, specify a number at which the alarm
is triggered and one for when the alarm is reset.
The range for the rising threshold and falling
threshold values is -2147483648 to
2147483647.
• (Optional) For event-number, specify the event
number to trigger when the rising or falling
threshold exceeds its limit.
• (Optional) For owner string, specify the owner
of the alarm.
Step 3 rmon event number [description string] [log] [owner Adds an event in the RMON event table that is
string] [trap community] associated with an RMON event number.
• For number, assign an event number. The range
is 1 to 65535.
• (Optional) For description string, specify a
description of the event.
• (Optional) Use the log keyword to generate an
RMON log entry when the event is triggered.
• (Optional) For owner string, specify the owner
of this event.
• (Optional) For community, enter the SNMP
community string used for this trap.
Step 4 end Returns to privileged EXEC mode.
Step 5 show running-config Verifies your entries.
Step 6 copy running-config startup-config (Optional) Saves your entries in the configuration
file.
Software Configuration Guide—Release 12.2(52)SG
51-4 OL-16048-01
Chapter 51 Configuring RMON
Configuring RMON
To disable an alarm, use the no rmon alarm number global configuration command on each alarm you
configured. You cannot disable at once all the alarms that you configured. To disable an event, use the
no rmon event number global configuration command. To learn more about alarms and events and how
they interact with each other, see RFC 1757.
You can set an alarm on any MIB object. The following example configures RMON alarm number 10
by using the rmon alarm command. The alarm monitors the MIB variable ifEntry.20.1 once every 20
seconds until the alarm is disabled and checks the change in the variable’s rise or fall. If the ifEntry.20.1
value shows a MIB counter increase of 15 or more, such as from 100000 to 100015, the alarm is
triggered. The alarm in turn triggers event number 1, which is configured with the rmon event
command. Possible events can include a log entry or an SNMP trap. If the ifEntry.20.1 value changes
by 0, the alarm is reset and can be triggered again.
Switch(config)# rmon alarm 10 ifEntry.20.1 20 delta rising-threshold 15 1
falling-threshold 0 owner jjohnson
The following example creates RMON event number 1 by using the rmon event command. The event
is defined as High ifOutErrors and generates a log entry when the event is triggered by the alarm. The
user jjones owns the row that is created in the event table by this command. This example also generates
an SNMP trap when the event is triggered.
Switch(config)# rmon event 1 log trap eventtrap description “High ifOutErrors” owner
jjones
Configuring RMON Collection on an Interface
You must first configure RMON alarms and events to display collection information.
To collect group history statistics on an interface, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 interface interface-id Specifies the interface on which to collect history, and enter
interface configuration mode.
Step 3 rmon collection history index Enables history collection for the specified number of buckets
[buckets bucket-number] [interval seconds] and time period.
[owner ownername]
• For index, identify the RMON group of statistics The range
is 1 to 65535.
• (Optional) For buckets bucket-number, specify the
maximum number of buckets desired for the RMON
collection history group of statistics. The range is 1 to
65535. The default is 50 buckets.
• (Optional) For interval seconds, specify the number of
seconds in each polling cycle.
• (Optional) For owner ownername, enter the name of the
owner of the RMON group of statistics.
To disable history collection, use the no rmon collection
history index interface configuration command.
Step 4 end Returns to privileged EXEC mode.
Step 5 show running-config Verifies your entries.
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 51-5
Chapter 51 Configuring RMON
Displaying RMON Status
Command Purpose
Step 6 show rmon history Displays the contents of the switch history table.
Step 7 copy running-config startup-config (Optional) Saves your entries in the configuration file.
To collect group Ethernet statistics on an interface, perform this task:
Command Purpose
Step 1 configure terminal Enters global configuration mode.
Step 2 interface interface-id Specifies the interface on which to collect statistics, and enter
interface configuration mode.
Step 3 rmon collection stats index [owner Enables RMON statistic collection on the interface.
ownername]
• For index, specify the RMON group of statistics. The range
is from 1 to 65535.
• (Optional) For owner ownername, enter the name of the
owner of the RMON group of statistics.
To disable the collection of group Ethernet statistics, use the no
rmon collection stats index interface configuration command.
Step 4 end Returns to privileged EXEC mode.
Step 5 show running-config Verifies your entries.
Step 6 show rmon statistics Displays the contents of the switch statistics table.
Step 7 copy running-config startup-config (Optional) Saves your entries in the configuration file.
Displaying RMON Status
To display the RMON status, use one or more of the privileged EXEC commands in Table 51-1:
Table 51-1 Commands for Displaying RMON Status
Command Purpose
show rmon Displays general RMON statistics.
show rmon alarms Displays the RMON alarm table.
show rmon events Displays the RMON event table.
show rmon history Displays the RMON history table.
show rmon statistics Displays the RMON statistics table.
Software Configuration Guide—Release 12.2(52)SG
51-6 OL-16048-01
C H A P T E R 52
Configuring Call Home
This chapter describes how to configure the Call Home feature in Catalyst 4500 Series Switch.
Note For complete syntax and usage information for the switch commands used in this chapter, refer to the
Catalyst 4500 Series Switch Cisco IOS Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
This chapter includes the following sections:
• About Call Home, page 52-1
• Obtaining Smart Call Home, page 52-2
• Configuring Call Home, page 52-3
• Configuring Contact Information, page 52-4
• Configuring Destination Profiles, page 52-5
• Subscribing to Alert Groups, page 52-6
• Configuring General E-Mail Options, page 52-9
• Enabling Call Home, page 52-10
• Disabling Call Home, page 52-10
• Testing Call Home Communications, page 52-10
• Configuring and Enabling Smart Call Home, page 52-13
• Displaying Call Home Configuration Information, page 52-14
• Default Settings, page 52-18
• Alert Group Trigger Events and Commands, page 52-18
• Message Contents, page 52-21
About Call Home
Call Home provides e-mail-based and web-based notification of critical system events. A versatile range
of message formats are available for optimal compatibility with pager services, standard e-mail, or
XML-based automated parsing applications. Common uses of this feature may include direct paging of
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-1
Chapter 52 Configuring Call Home
About Call Home
a network support engineer, e-mail notification to a Network Operations Center, XML delivery to a
support website, and utilization of Cisco Smart Call Home services for direct case generation with the
Cisco Systems Technical Assistance Center (TAC).
The Call Home feature can deliver alert messages containing information on configuration, diagnostics,
environmental conditions, inventory, and syslog events.
The Call Home feature can deliver alerts to multiple recipients, referred to as Call Home destination
profiles, each with configurable message formats and content categories. A predefined destination
profile is provided for sending alerts to the Cisco TAC ([email protected]), and you also can define
your own destination profiles.
Flexible message delivery and format options make it easy to integrate specific support requirements.
The Call Home feature offers the following advantages:
• Multiple message-format options:
– Short Text—Suitable for pagers or printed reports.
– Plain Text—Full formatted message information suitable for human reading.
– XML—Matching readable format using Extensible Markup Language (XML) and Adaptive
Markup Language (AML) document type definitions (DTDs). The XML format enables
communication with the Cisco TAC.
• Multiple concurrent message destinations.
• Multiple message categories including configuration, diagnostics, environmental conditions,
inventory, and syslog events.
• Filtering of messages by severity and pattern matching.
• Scheduling of periodic message sending.
Obtaining Smart Call Home
If you have a service contract directly with Cisco Systems, you can register your devices for the Smart
Call Home service. Smart Call Home provides fast resolution of system problems by analyzing Call
Home messages sent from your devices and providing background information and recommendations.
For issues that can be identified as known, particularly GOLD diagnostics failures, Automatic Service
Requests will be generated with the Cisco TAC.
Smart Call Home offers the following features:
• Boot-up diagnostics alerts for linecards & supervisor in the chassis.
• Analysis of Call Home messages from your device, and where appropriate Automatic Service
Request generation, routed to the appropriate TAC team, including detailed diagnostic information
to speed problem resolution.
• Secure message transport directly from your device or through a downloadable Transport Gateway
(TG) aggregation point. You can use a TG aggregation point in cases requiring support for multiple
devices or in cases where security requirements mandate that your devices may not be connected
directly to the Internet.
• Web-based access to Call Home messages and recommendations, inventory and configuration
information for all Call Home devices. Provides access to associated field notices, Security
Advisories, and End-of-Life information.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-2 OL-22250-01
Chapter 52 Configuring Call Home
Configuring Call Home
You need to register the following items:
• The SMARTnet contract number for your switch
• Your e-mail address
• Your Cisco.com ID
For detailed information on Smart Call Home, refer to the Smart Call Home page at this URL:
http://www.cisco.com/en/US/products/ps7334/serv_home.html
Configuring Call Home
How you configure Call Home depends on how you intend to use the feature. Consider the following
information before you configure Call Home:
• At least one destination profile (predefined or user-defined) must be configured. The destination
profile(s) used depends on whether the receiving entity is a pager, e-mail, or automated service such
as Cisco Smart Call Home.
– If the destination profile uses e-mail message delivery, you must specify a Simple Mail Transfer
Protocol (SMTP) server.
– If the destination profile uses secure HTTP (HTTPS) message transport, you must configure a
trustpoint certificate authority (CA).
• The contact e-mail, phone, and street address information should be configured so that the receiver
can determine the origin of messages received.
• The switch must have IP connectivity to an e-mail server or the destination HTTP server using the
ip domain name command.
• If Cisco Smart Call Home is used, an active service contract must cover the device being configured.
Note No version of the call-home command will remove the config setting.
To configure Call Home, follow these steps:
Step 1 Configure your site’s contact information.
Step 2 Configure destination profiles for each of your intended recipients.
Step 3 Subscribe each destination profile to one or more alert groups, and set alert options.
Step 4 Configure e-mail settings or HTTPS settings (including CA certificate), depending on the transport
method.
Step 5 Enable the Call Home feature.
Step 6 Test Call Home messages.
Tip From the Smart Call Home web application, you can download a basic configuration script to assist you
in the configuration of the Call Home feature for use with Smart Call Home and the Cisco TAC. The
script will also assist in configuring the trustpoint CA for secure communications with the Smart Call
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-3
Chapter 52 Configuring Call Home
Configuring Call Home
Home service. The script, provided on an as-is basis, can be downloaded from this URL:
http://www.cisco.com/en/US/products/ps7334/serv_home.html
Configuring Contact Information
Each switch must include a contact e-mail address. You can optionally include a phone number, street
address, contract ID, customer ID, and site ID.
To assign the contact information, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# call-home Enters the Call Home configuration submode.
Note No version of this command will re move
the settings.
Step 3 Switch(cfg-call-home)# contact-email-addr Assigns the customer’s e-mail address. Enter up
email-address to 200 characters in e-mail address format with
no spaces.
Step 4 Switch(cfg-call-home)# phone-number (Optional) Assigns the customer’s phone
+phone-number number.
Note The number must begin with a plus (+)
prefix, and may contain only dashes (-)
and numbers. Enter up to 16 characters.
If you include spaces, you must enclose
your entry in quotes (“”).
Step 5 Switch(cfg-call-home)# street-address (Optional) Assigns the customer’s street address
street-address where RMA equipment can be shipped. Enter up
to 200 characters. If you include spaces, you
must enclose your entry in quotes (“”).
Step 6 Switch(cfg-call-home)# customer-id text (Optional) Identifies the customer ID. Enter up to
64 characters. If you include spaces, you must
enclose your entry in quotes (“”).
Step 7 Switch(cfg-call-home)# site-id text (Optional) Identifies the customer site ID. Enter
up to 200 characters. If you include spaces, you
must enclose your entry in quotes (“”).
Step 8 Switch(cfg-call-home)# contract-id text (Optional) Identifies the customer’s contract ID
for the switch. Enter up to 64 characters. If you
include spaces, you must enclose your entry in
quotes (“”).
This example shows the configuration of contact information:
Switch# configure terminal
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-4 OL-22250-01
Chapter 52 Configuring Call Home
Configuring Call Home
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# call-home
Switch(cfg-call-home)# contact-email-addr [email protected]
Switch(cfg-call-home)# phone-number +1-800-555-4567
Switch(cfg-call-home)# street-address “1234 Picaboo Street, Any city, Any state, 12345”
Switch(cfg-call-home)# customer-id Customer1234
Switch(cfg-call-home)# site-id Site1ManhattanNY
Switch(cfg-call-home)# contract-id Company1234
Switch(cfg-call-home)# exit
Switch(config)#
Configuring Destination Profiles
A destination profile contains the required delivery information for an alert notification. At least one
destination profile is required. You can configure multiple destination profiles of one or more types.
You can use the predefined destination profile or define a desired profile. If you define a new destination
profile, you must assign a profile name.
Note If you use the Cisco Smart Call Home service, the destination profile must use the XML message format.
You can configure the following attributes for a destination profile:
• Profile name—A string that uniquely identifies each user-defined destination profile. The profile
name is limited to 31 characters and is not case-sensitive. You cannot use all as a profile name.
• Transport method—The transport mechanism, either e-mail or HTTP (including HTTPS), for
delivery of alerts.
– For user-defined destination profiles, e-mail is the default, and you can enable either or both
transport mechanisms. If you disable both methods, e-mail will be enabled.
– For the predefined Cisco TAC profile, you can enable either transport mechanism, but not both.
• Destination address—The actual address related to the transport method to which the alert should
be sent.
• Message formatting—The message format used for sending the alert.
– For user-defined destination profiles, the format options are long-text, short-text, or XML. The
default is XML.
– For the predefined Cisco TAC profile, only XML is allowed.
• Message size—The maximum destination message size. The valid range is 50 to 3,145,728 bytes
and the default is 3,145,728 bytes.
To create and configure a destination profile, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# call-home Enters the Call Home configuration submode.
Step 3 Switch(cfg-call-home)# profile name Enters the Call Home destination profile configuration
submode for the specified destination profile. If the
specified destination profile does not exist, it is created.
Step 4 Switch(cfg-call-home-profile)# [no] (Optional) Enables the message transport method. The no
destination transport-method {email option disables the method.
| http}
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-5
Chapter 52 Configuring Call Home
Configuring Call Home
Command Purpose
Step 5 Switch(cfg-call-home-profile)# Configures the destination e-mail address or URL to which
destination address {email Call Home messages will be sent.
email-address | http url}
Note When entering a destination URL, include either
http:// or https://, depending on whether the server
is a secure server. If the destination is a secure
server, you must also configure a trustpoint CA.
Step 6 Switch(cfg-call-home-profile)# (Optional) Configures a preferred message format. The
destination preferred-msg-format default is XML.
{long-text | short-text | xml}
Step 7 Switch(cfg-call-home-profile)# (Optional) Configures a maximum destination message size
destination message-size-limit bytes for the destination profile.
Step 8 Switch(cfg-call-home-profile)# Enables the destination profile. By default, the profile is
active enabled when it is created.
Step 9 Switch(cfg-call-home-profile)# exit Exits the Call Home destination profile configuration
submode and returns to the Call Home configuration
submode.
Step 10 Switch(cfg-call-home)# end Returns to privileged EXEC mode.
Step 11 Switch# show call-home profile {name Displays the destination profile configuration for a
| all} specified profile or all configured profiles.
Copying a Destination Profile
To create a new destination profile by copying an existing profile, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# call-home Enters the Call Home configuration submode.
Step 3 Switch(cfg-call-home)# copy profile Creates a new destination profile with the same
source-profile target-profile configuration settings as the existing destination
profile.
Subscribing to Alert Groups
An alert group is a predefined subset of Call Home alerts supported on the switch. Different types of
Call Home alerts are grouped into different alert groups depending on their type. These alert groups are
available:
• Configuration
• Diagnostic
• Environment
• Inventory
• Syslog
The triggering events for each alert group are listed in the “Alert Group Trigger Events and Commands”
section on page 52-18, and the contents of the alert group messages are listed in the “Message Contents”
section on page 52-21.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-6 OL-22250-01
Chapter 52 Configuring Call Home
Configuring Call Home
You can select one or more alert groups to be received by a destination profile.
Note A Call Home alert is only sent to destination profiles that have subscribed to the alert group containing
that Call Home alert. In addition, the alert group must be enabled.
To subscribe a destination profile to an alert group, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# call-home Enters Call Home configuration submode.
Step 3 Switch(cfg-call-home)# alert-group Enables the specified alert group. Use the
{all|configuration|diagnostic| keyword all to enable all alert groups. By
environment|inventory|syslog}
default, all alert groups are enabled.
Step 4 Switch(cfg-call-home)# profile name Enters the Call Home destination profile
configuration submode for the specified
destination profile.
Step 5 Switch(cfg-call-home-profile)# Subscribes this destination profile to the
subscribe-to-alert-group configuration Configuration alert group. The Configuration
[periodic {daily hh:mm | monthly date hh:mm |
weekly day hh:mm}]
alert group can be configured for periodic
notification, as described in the “Configuring
Periodic Notification” section on page 52-8.
Switch(cfg-call-home-profile)# Subscribes to all available alert groups.
subscribe-to-alert-group all
Step 6 Switch(cfg-call-home-profile)# Subscribes this destination profile to the
subscribe-to-alert-group diagnostic Diagnostic alert group. The Diagnostic alert
[severity catastrophic|disaster|
fatal|critical|major|minor|warning|
group can be configured to filter messages based
notification|normal|debugging] on severity, as described in the “Configuring
Message Severity Threshold” section on
page 52-8.
Step 7 Switch(cfg-call-home-profile)# Subscribes this destination profile to the
subscribe-to-alert-group environment Environment alert group. The Environment alert
[severity catastrophic|disaster|
fatal|critical|major|minor|warning|
group can be configured to filter messages based
notification|normal|debugging] on severity, as described in the “Configuring
Message Severity Threshold” section on
page 52-8.
Step 8 Switch(cfg-call-home-profile)# Subscribes this destination profile to the
subscribe-to-alert-group inventory Inventory alert group. The Inventory alert group
[periodic {daily hh:mm | monthly date hh:mm |
weekly day hh:mm}]
can be configured for periodic notification, as
described in the “Configuring Periodic
Notification” section on page 52-8.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-7
Chapter 52 Configuring Call Home
Configuring Call Home
Command Purpose
Step 9 Switch(cfg-call-home-profile)# Subscribes this destination profile to the Syslog
subscribe-to-alert-group syslog alert group. The Syslog alert group can be
[severity catastrophic|disaster|
fatal|critical|major|minor|warning|
configured to filter messages based on severity,
notification|normal|debugging] as described in the “Configuring Message
[pattern string] Severity Threshold” section on page 52-8. You
can specify a pattern to be matched in the syslog
message. If the pattern contains spaces, you
must enclose it in quotes (“”).
Step 10 Switch(cfg-call-home-profile)# exit Exits the Call Home destination profile
configuration submode.
Configuring Periodic Notification
When you subscribe a destination profile to either the Configuration or the Inventory alert group, you
can choose to receive the alert group messages asynchronously or periodically at a specified time. The
sending period can be one of the following:
• Daily—Specify the time of day to send, using an hour:minute format hh:mm, with a 24-hour clock
(for example, 14:30).
• Weekly—Specify the day of the week and time of day in the format day hh:mm, where the day of
the week is spelled out (for example, monday).
• Monthly—Specify the numeric date, from 1 to 31, and the time of day, in the format date hh:mm.
Configuring Message Severity Threshold
When you subscribe a destination profile to the Diagnostic, Environment, or Syslog alert group, you can
set a threshold for sending alert group messages based on the message’s level of severity. Any message
with a value lower than the threshold is not sent to the destination.
The severity threshold is configured using the keywords in Table 52-1, and ranges from catastrophic
(level 9, highest level of urgency) to debugging (level 0, lowest level of urgency). If no severity threshold
is configured, the default is normal (level 1).
Note Call Home severity levels differ from the system message logging severity levels.
Table 52-1 Severity and Syslog Level Mapping
Level Keyword Syslog Level Description
9 catastrophic N/A Network-wide catastrophic failure
8 disaster N/A Significant network impact
7 fatal Emergency (0) System unusable
6 critical Alert (1) Critical conditions, immediate attention needed
5 major Critical (2) Major conditions
4 minor Error (3) Minor conditions
3 warning Warning (4) Warning conditions
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-8 OL-22250-01
Chapter 52 Configuring Call Home
Configuring Call Home
Table 52-1 Severity and Syslog Level Mapping (continued)
Level Keyword Syslog Level Description
2 notification Notice (5) Basic notification and informational messages;
possibly independently insignificant
1 normal Information (6) Normal event signifying return to normal state
0 debugging Debug (7) Debugging messages
Configuring Syslog Pattern Matching
When you subscribe a destination profile to the Syslog alert group, you can optionally specify a text
pattern to be matched within each syslog message. If you configure a pattern, a Syslog alert group
message will be sent only if it contains the specified pattern and meets the severity threshold. If the
pattern contains spaces, you must enclose it in quotes (“”) when configuring it. You can specify up to
five patterns for each destination profile.
Configuring General E-Mail Options
To use the e-mail message transport, you must configure at least one Simple Mail Transfer Protocol
(SMTP) e-mail server address. You can configure the from and reply-to e-mail addresses, and you can
specify up to four backup e-mail servers. You can also set a rate limit on e-mail or HTTP messages.
To configure general e-mail options, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# call-home Enters Call Home configuration submode.
Step 3 Switch(cfg-call-home)# mail-server Assigns an e-mail server address and its relative priority
{ipv4-address | name} priority number among configured e-mail servers.
Provide either of these:
• The e-mail server’s IP address
• The e-mail server’s fully qualified domain name
(FQDN) of 64 characters or less.
Assign a priority number between 1 (highest priority) and
100 (lowest priority).
Step 4 Switch(cfg-call-home)# sender from (Optional) Assigns the e-mail address that will appear in
email-address the from field in Call Home e-mail messages. If no
address is specified, the contact e-mail address is used.
Step 5 Switch(cfg-call-home)# sender (Optional) Assigns the e-mail address that will appear in
reply-to email-address the reply-to field in Call Home e-mail messages.
Step 6 Switch(cfg-call-home)# rate-limit (Optional) Specifies a limit on the number of messages
number sent per minute, from 1 to 60. The default is 20.
Step 7 Switch(cfg-call-home)# vrf vrf-name (Optional) Specifies the VRF instance to send Call Home
e-mail messages. If no VRF is specified, the global
routing table is used.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-9
Chapter 52 Configuring Call Home
Configuring Call Home
The following notes apply when configuring general e-mail options:
• Backup e-mail servers can be defined by repeating the mail-server command using different
priority numbers.
• The mail-server priority number parameter can be configured from 1 to 100. The server with the
highest priority (lowest priority number) will be tried first.
This example shows the configuration of general e-mail parameters, including a primary and secondary
e-mail server:
Switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# call-home
Switch(cfg-call-home)# mail-server smtp.example.com priority 1
Switch(cfg-call-home)# mail-server 192.168.0.1 priority 2
Switch(cfg-call-home)# sender from [email protected]
Switch(cfg-call-home)# sender reply-to [email protected]
Switch(cfg-call-home)# exit
Switch(config)#
Enabling Call Home
To enable or disable the Call Home feature, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# service call-home Enables the Call Home feature.
Disabling Call Home
To disenable or disable the Call Home feature, perform this task:
Command Purpose
Step 1 Switch# configure terminal Enters configuration mode.
Step 2 Switch(config)# no service call-home Enables the Call Home feature.
Testing Call Home Communications
You can test Call Home communications by sending messages manually using two command types.
• To send a user-defined Call Home test message, use the call-home test command.
• To send a specific alert group message, use the call-home send command.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-10 OL-22250-01
Chapter 52 Configuring Call Home
Configuring Call Home
Sending a Call Home Test Message Manually
To manually send a Call Home test message, perform this task:
Command Purpose
Step 1 Switch# call-home test [“test-message”] Sends a test message to the specified destination
profile name profile. The user-defined test message text is optional,
but must be enclosed in quotes (“”) if it contains
spaces. If no user-defined message is configured, a
default message will be sent.
This example shows how to manually send a Call Home test message:
Switch# call-home test “test of the day” profile Ciscotac1
Sending a Call Home Alert Group Message Manually
To manually trigger a Call Home alert group message, perform this task:
Command Purpose
Step 1 Switch# call-home send alert-group Sends a configuration alert group message to one
configuration [profile name] destination profile if specified, or to all subscribed
destination profiles.
Switch# call-home send alert-group Sends a diagnostic alert group message to the
diagnostic {module number | slot/subslot configured destination profile if specified, or to all
| slot/bay} [profile name]
subscribed destination profiles. You must specify the
module or port whose diagnostic information should
be sent.
Switch# call-home send alert-group Sends an inventory alert group message to one
inventory [profile name] destination profile if specified, or to all subscribed
destination profiles.
When manually sending Call Home alert group messages, note the following guidelines:
• You can only manually send the configuration, diagnostic, and inventory alert groups.
• When you manually trigger a configuration, diagnostic, or inventory alert group message and you
specify a destination profile name, a message is sent to the destination profile regardless of the
profile’s active status, subscription status, or severity setting.
• When you manually trigger a configuration or inventory alert group message and do not specify a
destination profile name, a message is sent to all active profiles that have either a normal or periodic
subscription to the specified alert group.
• When you manually trigger a diagnostic alert group message and do not specify a destination profile
name, the command will cause the following actions:
– For any active profile that subscribes to diagnostic events with a severity level of less than
minor, a message is sent regardless of whether the module or interface has observed a diagnostic
event.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-11
Chapter 52 Configuring Call Home
Configuring Call Home
– For any active profile that subscribes to diagnostic events with a severity level of minor or
higher, a message is sent only if the specified module or interface has observed a diagnostic
event of at least the subscribed severity level; otherwise, no diagnostic message is sent to the
destination profile.
This example shows how to send the configuration alert-group message to the destination profile:
Switch# call-home send alert-group configuration
This example shows how to send the diagnostic alert-group message to the destination profile for a
specific module, slot/subslot, or slot/bay number.
Switch# call-home send alert-group diagnostic module 3 5/2
This example shows how to send the diagnostic alert-group message to all destination profiles for a
specific module, slot/subslot, or slot/bay number.
Switch# call-home send alert-group diagnostic module 3 5/2 profile Ciscotac1
This example shows how to send the inventory call-home message:
Switch# call-home send alert-group inventory
Sending a Request for an Analysis and Report
You can use the call-home request command to submit information about your system to Cisco in order
to receive helpful information specific to your system. You can request a variety of reports, including
security alerts, known bugs, best practices, and command references.
To submit a request for report and analysis information from the Cisco Output Interpreter tool, perform
this task:
Command Purpose
Step 1 Switch# call-home request Sends the output of the specified show command for
output-analysis “show-command” analysis. The show command must be contained in
[profile name] [ccoid user-id]
quotes (“”).
Switch# call-home request {config-sanity Sends the output of a predetermined set of commands
| bugs-list | command-reference | for analysis such as show running-config all, show
product-advisory}
[profile name] [ccoid user-id]
version, or show module commands. In addition, the
call-home request product-advisory command
includes all inventory alert group commands.
The keyword specified after the call home request
command specifies the type of report required.
When manually sending a Call Home report and analysis request, note the following guidelines:
• If you specify a profile name value, the request is sent to the profile. If you do not specify a profile
name, the request is sent to the Cisco TAC profile. The recipient profile does not need to be enabled
for the Call Home request. The profile should specify the e-mail address where the transport
gateway is configured so that the request message can be forwarded to the Cisco TAC and the user
can receive the reply from the Smart Call Home service.
• The ccoid user-id value is the registered identifier of the Smart Call Home user. If you specify a
user-id, the response is sent to the e-mail address of the registered user. If do not specify a user-id,
the response is sent to the contact e-mail address of the device.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-12 OL-22250-01
Chapter 52 Configuring Call Home
Configuring Call Home
• Based on the keyword specifying the type of report requested, the following information is returned:
– config-sanity—Information on best practices as related to the current running configuration
– bugs-list—Known bugs in the running version and in the currently applied features
– command-reference—Reference links to all commands in the running configuration
– product-advisory—Product Security Incident Response Team (PSIRT) notices, End of Life
(EOL) or End of Sales (EOS) notices, or field notices (FN) that may affect devices in your
network
This example shows a request for analysis of a user-specified show command:
Switch# call-home request output-analysis "show diagnostic result module all" profile TG
Sending the Output of a Command
You can use the call-home send command to execute a CLI command and e-mail the command output
to Cisco or to an e-mail address that you specify.
To execute a CLI command and e-mail the command output, perform this task:
Command Purpose
Step 1 Switch# call-home send “command” Executes the specified CLI command and e-mails the
[email email-addr] [service-number SR] output.
When sending the output of a command, note the following guidelines:
• The specified CLI command can be any run command, including commands for all modules. The
command must be contained in quotes (“”).
• If an e-mail address is specified, the command output will be sent to that address. If no e-mail
address is specified, the output will be sent to the Cisco TAC ([email protected]). The e-mail will
be sent in long text format with the service number, if specified, in the subject line.
• The service number is required only if no e-mail address is specified, or if a Cisco TAC e-mail
address is specified.
This example shows how to send the output of a CLI command to a user-specified e-mail address:
Switch# call-home send "show diagnostic result module all" email [email protected]
Configuring and Enabling Smart Call Home
For application and configuration information of the Cisco Smart Call Home service, see the “FastStart”
section of the Smart Call Home User Guide at this location:
http://www.cisco.com/go/smartcall/
The user guide includes configuration examples for sending Smart Call Home messages directly from
your device or through a transport gateway (TG) aggregation point. You can use a TG aggregation point
in cases requiring support for multiple devices or in cases where security requirements mandate that your
devices may not be connected directly to the Internet.
Because the Smart Call Home service uses HTTPS as the transport method, you must also configure its
CA as a trustpoint, as described in the Smart Call Home User Guide.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-13
Chapter 52 Configuring Call Home
Displaying Call Home Configuration Information
Displaying Call Home Configuration Information
To display the configured Call Home information, perform these tasks:
Command Purpose
Switch# show call-home Displays the Call Home configuration in summary.
Switch# show call-home detail Displays the Call Home configuration in detail.
Switch# show call-home alert-group Displays the available alert groups and their status.
Switch# show call-home mail-server status Checks and displays the availability of the
configured e-mail server(s).
Switch# show call-home profile {all | name} Displays the configuration of the specified
destination profile. Use the keyword all to display
the configuration of all destination profiles.
Switch# show call-home statistics Displays the statistics of Call Home events.
Examples 52-1 to 52-7 show the results when using different options of the show call-home command.
Example 52-1 Configured Call Home Information
Switch# show call-home
Current call home settings:
call home feature : disable
call home message's from address: [email protected]
call home message's reply-to address: [email protected]
vrf for call-home messages: Not yet set up
contact person's email address: [email protected]
contact person's phone number: +1-408-555-1234
street address: 1234 Picaboo Street, Any city, Any state, 12345
customer ID: ExampleCorp
contract ID: X123456789
site ID: SantaClara
Mail-server[1]: Address: smtp.example.com Priority: 1
Mail-server[2]: Address: 192.168.0.1 Priority: 2
Rate-limit: 20 message(s) per minute
Available alert groups:
Keyword State Description
------------------------ ------- -------------------------------
configuration Disable configuration info
diagnostic Disable diagnostic info
environment Disable environmental info
inventory Enable inventory info
syslog Disable syslog info
Profiles:
Profile Name: campus-noc
Profile Name: CiscoTAC-1
Switch#
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-14 OL-22250-01
Chapter 52 Configuring Call Home
Displaying Call Home Configuration Information
Example 52-2 Configured Call Home Information in Detail
Switch# show call-home detail
Current call home settings:
call home feature : disable
call home message's from address: [email protected]
call home message's reply-to address: [email protected]
vrf for call-home messages: Not yet set up
contact person's email address: [email protected]
contact person's phone number: +1-408-555-1234
street address: 1234 Picaboo Street, Any city, Any state, 12345
customer ID: ExampleCorp
contract ID: X123456789
site ID: SantaClara
Mail-server[1]: Address: smtp.example.com Priority: 1
Mail-server[2]: Address: 192.168.0.1 Priority: 2
Rate-limit: 20 message(s) per minute
Available alert groups:
Keyword State Description
------------------------ ------- -------------------------------
configuration Disable configuration info
diagnostic Disable diagnostic info
environment Disable environmental info
inventory Enable inventory info
syslog Disable syslog info
Profiles:
Profile Name: campus-noc
Profile status: ACTIVE
Preferred Message Format: long-text
Message Size Limit: 3145728 Bytes
Transport Method: email
Email address(es): [email protected]
HTTP address(es): Not yet set up
Alert-group Severity
------------------------ ------------
inventory normal
Syslog-Pattern Severity
------------------------ ------------
N/A N/A
Profile Name: CiscoTAC-1
Profile status: ACTIVE
Preferred Message Format: xml
Message Size Limit: 3145728 Bytes
Transport Method: email
Email address(es): [email protected]
HTTP address(es): https://tools.cisco.com/its/service/oddce/services/DDCEService
Periodic configuration info message is scheduled every 1 day of the month at 09:27
Periodic inventory info message is scheduled every 1 day of the month at 09: 12
Alert-group Severity
------------------------ ------------
diagnostic minor
environment warning
inventory normal
Syslog-Pattern Severity
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-15
Chapter 52 Configuring Call Home
Displaying Call Home Configuration Information
------------------------ ------------
.* major
Switch#
Example 52-3 Available Call Home Alert Groups
Switch# show call-home alert-group
Available alert groups:
Keyword State Description
------------------------ ------- -------------------------------
configuration Disable configuration info
diagnostic Disable diagnostic info
environment Disable environmental info
inventory Enable inventory info
syslog Disable syslog info
Switch#
Example 52-4 E-Mail Server Status Information
Switch# show call-home mail-server status
Please wait. Checking for mail server status ...
Translating "smtp.example.com"
Mail-server[1]: Address: smtp.example.com Priority: 1 [Not Available]
Mail-server[2]: Address: 192.168.0.1 Priority: 2 [Not Available]
Switch#
Example 52-5 Information for All Destination Profiles (Predefined and User-Defined)
Switch# show call-home profile all
Profile Name: campus-noc
Profile status: ACTIVE
Preferred Message Format: long-text
Message Size Limit: 3145728 Bytes
Transport Method: email
Email address(es): [email protected]
HTTP address(es): Not yet set up
Alert-group Severity
------------------------ ------------
inventory normal
Syslog-Pattern Severity
------------------------ ------------
N/A N/A
Profile Name: CiscoTAC-1
Profile status: ACTIVE
Preferred Message Format: xml
Message Size Limit: 3145728 Bytes
Transport Method: email
Email address(es): [email protected]
HTTP address(es): https://tools.cisco.com/its/service/oddce/services/DDCEService
Periodic configuration info message is scheduled every 1 day of the month at 09:27
Periodic inventory info message is scheduled every 1 day of the month at 09:12
Alert-group Severity
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-16 OL-22250-01
Chapter 52 Configuring Call Home
Displaying Call Home Configuration Information
------------------------ ------------
diagnostic minor
environment warning
inventory normal
Syslog-Pattern Severity
------------------------ ------------
.* major
Switch#
Example 52-6 Information for a User-Defined Destination Profile
Switch# show call-home profile CiscoTAC-1
Profile Name: CiscoTAC-1
Profile status: INACTIVE
Preferred Message Format: xml
Message Size Limit: 3145728 Bytes
Transport Method: email
Email address(es): [email protected]
HTTP address(es): https://tools.cisco.com/its/service/oddce/services/DDCEService
Periodic configuration info message is scheduled every 11 day of the month at 11:25
Periodic inventory info message is scheduled every 11 day of the month at 11:10
Alert-group Severity
------------------------ ------------
diagnostic minor
environment warning
inventory normal
Syslog-Pattern Severity
------------------------ ------------
.* major
Example 52-7 Call Home Statistics
Switch# show call-home statistics
Message Types Total Email HTTP
------------- -------------------- -------------------- ------------------
Total Success 0 0 0
Config 0 0 0
Diagnostic 0 0 0
Environment 0 0 0
Inventory 0 0 0
SysLog 0 0 0
Test 0 0 0
Request 0 0 0
Send-CLI 0 0 0
Total In-Queue 0 0 0
Config 0 0 0
Diagnostic 0 0 0
Environment 0 0 0
Inventory 0 0 0
SysLog 0 0 0
Test 0 0 0
Request 0 0 0
Send-CLI 0 0 0
Total Failed 0 0 0
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-17
Chapter 52 Configuring Call Home
Default Settings
Config 0 0 0
Diagnostic 0 0 0
Environment 0 0 0
Inventory 0 0 0
SysLog 0 0 0
Test 0 0 0
Request 0 0 0
Send-CLI 0 0 0
Total Ratelimit
-dropped 0 0 0
Config 0 0 0
Diagnostic 0 0 0
Environment 0 0 0
Inventory 0 0 0
SysLog 0 0 0
Test 0 0 0
Request 0 0 0
Send-CLI 0 0 0
Last call-home message sent time: n/a
Default Settings
Table 52-2 lists the default Call Home settings.
Table 52-2 Default Call Home Settings
Parameters Default
Call Home feature status Disabled
User-defined profile status Active
Predefined Cisco TAC profile status Inactive
Transport method E-mail
Message format type XML
Destination message size for a message sent in long text, short text, or XML format 3,145,728
Alert group status Enabled
Call Home message severity threshold 1 (normal)
Message rate limit for messages per minute 20
Alert Group Trigger Events and Commands
Call Home trigger events are grouped into alert groups, with each alert group assigned CLI commands
to execute when an event occurs. The CLI command output is included in the transmitted message.
Table 52-3 lists the trigger events included in each alert group, including the severity level of each event
and the executed CLI commands for the alert group.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-18 OL-22250-01
Chapter 52 Configuring Call Home
Alert Group Trigger Events and Commands
Table 52-3 Call Home Alert Groups, Events, and Actions
Call Home
Alert Group Trigger Event Syslog Event Severity Description and CLI Commands Executed
Syslog Event logged to syslog. (Only sent to TAC if syslog
level 0, 1, or 2)
CLI commands executed:
show logging
show inventory
SYSLOG LOG_EMERG 7 System is unusable.
SYSLOG LOG_ALERT 6 Action must be taken immediately.
SYSLOG LOG_CRIT 5 Critical conditions.
SYSLOG LOG_ERR 4 Error conditions.
SYSLOG LOG_WARNING 3 Warning conditions.
SYSLOG LOG_NOTICE 2 Normal but signification condition.
SYSLOG LOG_INFO 1 Informational.
SYSLOG LOG_DEBUG 0 Debug-level messages.
Environmental Events related to power, fan, and environment sensing
elements, such as temperature alarms. (Sent to TAC.)
CLI commands executed:
show module
show environment
show logging
show power
show inventory
TEMP_FAILU TempHigh 5 The temperature of the chassis is above the normal
RE threshold.
TEMP_FAILU Critical Temp 5 The temperature of the chassis has risen above the
RE critical threshold.
TEMP_FAILU Shutdown Temp 5 The temperature of the chassis is very high and the
RE system will be shut down.
TEMP_FAILU Some Temp Sensors 3 Some of the temperature sensors have failed.
RE Failed
TEMP_FAILU All Temp Sensors 5 All temperature sensors have failed.
RE Failed
TEMP_RECO TempOk 5 The temperature of the chassis is normal.
VER
POWER_FAIL PowerSupplyBad 5 A power supply has failed or has been turned off.
URE
POWER_REC PowerSupplyGood 5 A failed power supply has been fixed.
OVERY
POWER_FAIL PowerSupplyFanBad 3 A power supply fan has failed.
URE
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-19
Chapter 52 Configuring Call Home
Alert Group Trigger Events and Commands
Table 52-3 Call Home Alert Groups, Events, and Actions (continued)
Call Home
Alert Group Trigger Event Syslog Event Severity Description and CLI Commands Executed
POWER_ PowerSupplyFanGood 3 A failed power supply fan has been fixed.
RECOVERY
POWER_REC PowerSupplyOutputInc 3 A power supply output has increased.
OVERY reased
POWER_FAIL PowerSupplyOutputDe 3 A powet supply output has decreased.
URE creased
POWER_FAIL InlinePowerSupplyBad 3 Inline power source from a power supply has failed or
URE turned off.
POWER_FAIL MixedPowerSupplyInC 3 Mixed power supplies have been detected in the
URE hassis chassis.
POWER_FAIL NotEnoughPowerChass 6 There is insufficient power to support the system. The
URE is system might shut down.
POWER_ InlinePowerSupplyGoo 3 A failed source for inline power has been fixed.
RECOVERY d
FANTRAY_FA FanTrayPartialFailure 3 Either a fan or thermistors in system fan tray has
ILURE failed.
FANTRAY_FA FanTrayMismatch 3 The fantray, supervisor, chassis combination is
ILURE disallowed.
FANTRAY_FA FanTrayBad 5 Fan tray has failed.
ILURE
FANTRAY_ FanTrayGood 3/5 Failed fan tray has been fixed.The severity of the
RECOVERY notification depends on the failure which has been
recovered from.
FANTRAY_ InsufficientFantray 6 There are not enough FanTray to support the system.
FAILURE This may be followed by a system shut down.
CLOCK_ALA ClockSwitchover 2 Clock module has switched over to another clock.
RM
CLOCK_ALA Clock Faulty 3 The clock module has been found to be faulty.
RM
Inventory Inventory status should be provided whenever a unit is
cold-booted, or when FRUs are inserted or removed.
it is considered a noncritical event, and the
information is used for status and entitlement.
CLI commands executed:
show module
show version
show inventory oid
show idprom all
show power
INSERTION Module 1 A linecard or supervisor engine has been inserted into
a slot.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-20 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
Table 52-3 Call Home Alert Groups, Events, and Actions (continued)
Call Home
Alert Group Trigger Event Syslog Event Severity Description and CLI Commands Executed
REMOVAL Module 1 A linecard or supervisor engine has been removed
from a slot.
Diagnostic 1/3/4/5 Events related to standard or intelligent line cards.
Failure
CLI commands executed:
show module
show version
show inventory
show buffers
show logging
show diagnostic result module x detail
show diagnostic result module all
Test TEST 1 User-generated test message.
CLI commands executed:
show module
show version
show inventory
Configuration 1 User-generated request for configuration.
CLI commands executed:
show module
show inventory
show version
show running-config all
show startup-config
Message Contents
The following tables display the content formats of alert group messages:
• Table 52-4 describes the content fields of a short text message.
• Table 52-5 describes the content fields that are common to all long text and XML messages. The
fields specific to a particular alert group message are inserted at a point between the common fields.
The insertion point is identified in the table.
• Table 52-6 describes the inserted content fields for reactive messages (system failures that require a
TAC case) and proactive messages (issues that might result in degraded system performance).
• Table 52-7 describes the inserted content fields for an inventory message.
Table 52-4 Format for a Short Text Message
Data Item Description
Device identification Configured device name
Date/time stamp Time stamp of the triggering event
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-21
Chapter 52 Configuring Call Home
Message Contents
Table 52-4 Format for a Short Text Message (continued)
Data Item Description
Error isolation message Plain English description of triggering event
Alarm urgency level Error level such as that applied to a system message
Table 52-5 Common Fields for All Long Text and XML Messages
Data Item Description XML Tag
(Plain Text and XML) (Plain Text and XML) (XML Only)
Time stamp Date/timestamp of event in ISO time notation: CallHome/EventTime
YYYY-MM-DDTHH:MM:SS
Note the T in between date and time, and note that the timezone/dst
offset from UTC has already been added or subtracted.
Message name Name of message. For short text message only
Message type Specifically "Call Home". CallHome/Event/Type
Message group Specifically "reactive". Optional in this case because default is CallHome/Event/SubType
"reactive".
Severity level Severity level of message. Body/Block/Severity
Source ID This field is used to identify the product type for routing through the For long test mtessage only
workflow engine. This is typically the product family name.
Device ID Unique Device Identifier (UDI) for end device generating message. CallHome/Customer Data/
This field should empty if the message is nonspecific to a fabric switch. ContractData/ DeviceId
Format: type@Sid@serial
Where
@:Separator character
• Type: If WS-C4503-E, product model number from backplane
SEEPROM.
• Sid: "C" identifying serial ID as a chassis serial number.
• Serial: The serial number as identified by the Sid field.
Example: "WS-C4503-E@C@SPE4465329F"
Customer ID Optional user-configurable field used for contract information or other CallHome/Customer Data/
ID by any support service. ContractData/ CustomerId
Contract ID Optional user-configurable field used for contract information or other /CallHome/ Customer Data/
ID by any support service. ContractData/ ContractId
Site ID Optional user-configurable field used for Cisco-supplied site ID or CallHome/ CustomerData/
other data meaningful to alternate support service. ContractData/ SiteId
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-22 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
Table 52-5 Common Fields for All Long Text and XML Messages (continued)
Data Item Description XML Tag
(Plain Text and XML) (Plain Text and XML) (XML Only)
Server ID If message is generated from fabric switch, UDI of switch. If message For long text message only
is proxied or originated by MA, the MA should overwrite this field with
the MA UDI.
Format is type@Sid@serial
Where
@: Separator character
• Type: If WS-C4510R, product model number from backplane
SEEPROM.
• Sid: "C" identifying serial ID as a chassis serial number
• Serial: The serial number as identified by the Sid field.
Example: " WS-C4510R@C@CAT234765XR"
Message description Short text describing the error. CallHome/
MessageDescription
Device name Node that experienced the event. This is the host name of the device. CallHome/ CustomerData/
SystemInfo/ Name
Contact name Name of person to contact for issues associated with the node CallHome/CustomerData/Syst
experiencing the event. emInfo/Contact
Contact e-mail E-mail address of person identified as contact for this unit. CallHome/CustomerData/Syst
emInfo/ContactEmail
Contact phone Phone number of the person identified as the contact for this unit. CallHome/CustomerData/Syst
number emInfo/ContactPhoneNumber
Street address Optional field containing street address for RMA part shipments CallHome/CustomerData/Syst
associated with this unit. emInfo/StreetAddress
Model name Model name of the unit (such as WS-C4503). This is the specific model CallHome/ Device/
as part of a product family name. Cisco_Chassis/Model
Serial number Chassis serial number of the unit. CallHome/ Device/
Cisco_Chassis/ SerialNumber
Chassis part number Top assembly number of the chassis as read from SEEPROM (such as CallHome/Device/Cisco_Chas
WS-C4503 = 73-10558). sis/AdditionalInformation/
AD@name="PartNumber"
System Description Describes the IOS version run on the system . CallHome/Device/Cisco_Cha
ssis/AdditionalInformation/A
D@name="SystemDescriptio
n"
SystemObjectId Specifies the object ID associated with this system . CallHome/Device/Cisco_Cha
ssis/AdditionalInformation/A
D@name="SystemObjectId"
Fields specific to a particular alert group message are inserted here.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-23
Chapter 52 Configuring Call Home
Message Contents
Table 52-5 Common Fields for All Long Text and XML Messages (continued)
Data Item Description XML Tag
(Plain Text and XML) (Plain Text and XML) (XML Only)
The following fields may be repeated if multiple CLI commands are executed for this alert group.
Command output The exact command that was run (such as the show running-config /aml/attachments/attachment/
name command). name
Attachment type Specifically command output. /aml/Attachments/attachment
@type
MIME type Normally text/plain or encoding type. /aml/Attachments/Attachment
/Data@encoding
Table 52-6 Inserted Fields for a Reactive or Proactive Event Message
Data Item Description XML Tag
(Plain Text and XML) (Plain Text and XML) (XML Only)
Chassis hardware Hardware version of chassis CallHome/Device/Cisco_Chas
version sis/HardwareVersion
Supervisor module Top-level software version CallHome/Device/Cisco_Chas
software version sis/AdditionalInformation/AD
@name="SoftwareVersion"
Affected FRU name Name of the affected FRU generating the event message CallHome/Device/Cisco_Chas
sis/Cisco_Card/Model
Affected FRU serial Serial number of affected FRU CallHome/Device/Cisco_Chas
number sis/Cisco_Card/SerialNumber
Affected FRU part Part number of affected FRU CallHome/Device/Cisco_Chas
number sis/Cisco_Card/PartNumber
FRU slot Slot number of FRU generating the event message CallHome/Device/Cisco_Chas
sis/Cisco_Card/LocationWithi
nContainer
FRU hardware Hardware version of affected FRU CallHome/Device/Cisco_Chas
version sis/Cisco_Card/HardwareVers
ion
FRU software Software version(s) running on affected FRU CallHome/Device/Cisco_Chas
version sis/Cisco_Card/SoftwareIdent
ity/VersionString
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-24 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
Table 52-7 Inserted Fields for an Inventory Event Message
Data Item Description XML Tag
(Plain Text and XML) (Plain Text and XML) (XML Only)
Chassis hardware Hardware version of chassis CallHome/Device/Cisco_Cha
version ssis/HardwareVersion
Supervisor module Top-level software version CallHome/Device/Cisco_Cha
software version ssis/AdditionalInformation/A
D@name="SoftwareVersion"
Affected FRU name Name of the affected FRU generating the event message CallHome/Device/Cisco_Cha
ssis/Cisco_Card/Model
Affected FRU s/n Serial number of affected FRU CallHome/Device/Cisco_Cha
ssis/Cisco_Card/SerialNumbe
r
Affected FRU part Part number of affected FRU CallHome/Device/Cisco_Cha
number ssis/Cisco_Card/PartNumber
FRU slot Slot number of FRU generating the event message CallHome/Device/Cisco_Cha
ssis/Cisco_Card/LocationWit
hinContainer
FRU hardware Hardware version of affected FRU CallHome/Device/Cisco_Cha
version ssis/Cisco_Card/HardwareVer
sion
FRU software Software version(s) running on affected FRU CallHome/Device/Cisco_Cha
version ssis/Cisco_Card/SoftwareIde
ntity/VersionString
Sample Syslog Alert Notification in Long-Text Format
TimeStamp : 2010-08-05 21:00 GMT+17:00
Message Name : syslog
Message Type : Call Home
Message Group : reactive
Severity Level : 2
Source ID : Cat4500/4900
Device ID : WS-C4507R-E@C@FOX1310GHG7
Customer ID : cis1
Contract ID : cisco123
Site ID : hsr-sec-7
Server ID : WS-C4507R-E@C@FOX1310GHG7
Event Description : *Aug 5 21:00:34.675 PDT: %LINEPROTO-5-UPDOWN: Line protocol on
Interface GigabitEthernet1/9, changed state to down System Name : Callista-4507E Contact
Email : [email protected] Contact Phone : +919901233008 Street Address : 9th Main, HSR,
Bangalore, 560034 Affected Chassis : WS-C4507R-E Affected Chassis Serial Number :
FOX1310GHG7 Affected Chassis Part No : 73-9975-04 Affected Chassis Hardware Version : 1.1
Supervisor Software Version : 15.0(100)XO(1.43) Command Output Name : show logging
Attachment Type : command output MIME Type : text/plain Command Output Text :
Syslog logging: enabled (0 messages dropped, 1 messages rate-limited, 0 flushes, 0
overruns, xml disabled, filtering disabled)
No Active Message Discriminator.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-25
Chapter 52 Configuring Call Home
Message Contents
No Inactive Message Discriminator.
Console logging: level debugging, 404 messages logged, xml disabled,
filtering disabled
Monitor logging: level debugging, 0 messages logged, xml disabled,
filtering disabled
Buffer logging: level debugging, 404 messages logged, xml disabled,
filtering disabled
Exception Logging: size (8192 bytes)
Count and timestamp logging messages: disabled
Persistent logging: disabled
No active filter modules.
Trap logging: level informational, 109 message lines logged
Log Buffer (32768 bytes):
onsole
*Aug 5 02:08:06.742 PDT: %SYS-5-CONFIG_I: Configured from console by console *Aug 5
02:19:04.237 PDT: %SYS-5-CONFIG_I: Configured from console by console *Aug 5 02:19:18.438
PDT: CALL-HOME-TRACE: call_home_mode_cmd() is called *Aug 5 02:19:21.902 PDT:
CALL-HOME-TRACE: Received event: 1 *Aug 5 02:19:21.902 PDT: CALL-HOME-TRACE: Cleared rate
limit counter *Aug 5 02:19:24.852 PDT: CALL-HOME-TRACE: call_home_profile_mode_cmd() is
called *Aug 5 02:19:24.852 PDT: CALL-HOME-TRACE: call_home_get_profile() is entered
profile atul
*Aug 5 02:19:24.852 PDT: CALL-HOME-TRACE: profile_id = -2034087768 *Aug 5 02:19:34.728
PDT: CALL-HOME-TRACE: cfg_call_home_profile_addr_func() is called, address
[email protected]
*Aug 5 02:19:34.728 PDT: CALL-HOME-TRACE: is_modifying_tac_profile() is entered *Aug 5
02:19:34.728 PDT: CALL-HOME-TRACE: atul Profile's destination address: [email protected]
*Aug 5 02:19:34.728 PDT: CALL-HOME-TRACE: call_home_add_profile_destination(): atul, 1,
[email protected], 0, 14
*Aug 5 02:19:43.584 PDT: CALL-HOME-TRACE: cfg_call_home_profile_addr_func() is called,
address [email protected]
*Aug 5 02:19:43.584 PDT: CALL-HOME-TRACE: is_modifying_tac_profile() is entered *Aug 5
02:19:43.584 PDT: CALL-HOME-TRACE: atul Profile's destination address: [email protected]
*Aug 5 02:19:43.584 PDT: CALL-HOME-TRACE: call_home_remove_profile_destination() profile
atul, dest_addr [email protected], snmp_index 0
*Aug 5 02:19:43.584 PDT: CALL-HOME-TRACE: call_home_is_profile_destination_set() is
entered *Aug 5 02:19:43.584 PDT: CALL-HOME-TRACE: call_home_is_profile_destination_set():
http count 1, transport 3, http enable 1, email count 0 *Aug 5 02:19:51.560 PDT:
CALL-HOME-TRACE: cfg_call_home_profile_addr_func() is called, address [email protected]
*Aug 5 02:19:51.560 PDT: CALL-HOME-TRACE: is_modifying_tac_profile() is entered *Aug 5
02:19:51.560 PDT: CALL-HOME-TRACE: atul Profile's destination address: [email protected]
*Aug 5 02:19:51.560 PDT: CALL-HOME-TRACE: call_home_add_profile_destination(): atul, 1,
[email protected], 0, 14
*Aug 5 02:19:51.560 PDT: CALL-HOME-TRACE: call_home_can_create_events() is entered,
profile atul, type 1 *Aug 5 02:19:51.560 PDT: CALL-HOME-TRACE: call_home_ha_incr_sync: is
entered *Aug 5 02:19:51.560 PDT: CALL-HOME-TRACE: call_home_ha_incr_sync: Send from
active to standy
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-26 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
*Aug 5 02:19:51.560 PDT: CALL-HOME-TRACE: chkpt_call_home_issu_ha_msg_send() entered,
opcode 1 *Aug 5 02:20:21.902 PDT: CALL-HOME-TRACE: Received event: 1 *Aug 5 02:20:21.902
PDT: CALL-HOME-TRACE: Cleared rate limit counter *Aug 5 02:20:40.902 PDT:
CALL-HOME-TRACE: call_home_profile_save_func() is called *Aug 5 02:20:40.902 PDT:
%SYS-5-CONFIG_I: Configured from console by console *Aug 5 02:20:45.311 PDT:
CALL-HOME-TRACE: Retrieved mail-server <64.104.123.94> priority 1 *Aug 5 02:20:45.311
PDT: CALL-HOME-TRACE: Connect status for mail server 64.104.123.94 is -1 *Aug 5
02:20:45.311 PDT: CALL-HOME-TRACE: Retrieved mail-server <64.104.193.198> priority 2 *Aug
5 02:20:45.456 PDT: CALL-HOME-TRACE: socket_recv status 11: Resource unavailable, try
again
*Aug 5 02:20:45.456 PDT: CALL-HOME-TRACE: call_home_can_connect_to_mail_server:
connection established *Aug 5 02:21:15.742 PDT: CALL-HOME-TRACE:
cfg_service_call_home_func() is entered
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: call_home_mode_cmd() is called *Aug 5
02:21:15.745 PDT: CALL-HOME-TRACE: call_home_is_all_default_config(): is entered!
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: call_home_is_database_default_config(): is
entered!
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE:
call_home_get_reply_to_address(): reply_to_address [email protected]
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.745 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.746 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.746 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.746 PDT: CALL-HOME-TRACE: Retrieved mail-server <64.104.123.94> priority
1 *Aug 5 02:21:15.746 PDT: CALL-HOME-TRACE: Retrieved mail-server <64.104.193.198>
priority 2 *Aug 5 02:21:15.746 PDT: CALL-HOME-TRACE: cfg_call_home_nvgen() is called.
*Aug 5 02:21:15.746 PDT: CALL-HOME-TRACE: call_home_profile_mode_cmd() is called *Aug 5
02:21:15.746 PDT: CALL-HOME-TRACE: call_home_is_profile_default_config is called *Aug 5
02:21:15.746 PDT: CALL-HOME-TRACE: call_home_get_default_transport_method is called *Aug
5 02:21:15.746 PDT: CALL-HOME-TRACE: call_home_get_periodic_info() is entered *Aug 5
02:21:15.746 PDT: CALL-HOME-TRACE: Index of selected periodic timer 0 *Aug 5 02:21:15.746
PDT: CALL-HOME-TRACE: call_home_get_periodic_info() is entered *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_profile_exit_submode() is entered *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_profile_exit_submode() is called *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_is_profile_default_config is called *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_get_default_transport_method is called *Aug 5 02:21:15.746
PDT: CALL-HOME-TRACE: call_home_get_periodic_info() is entered *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: Index of selected periodic timer 0 *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_get_periodic_info() is entered *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_profile_exit_submode() is entered *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_profile_exit_submode() is called *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_is_profile_default_config is called *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: GaliosCallHome_platformGetTacDefault is called *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_get_default_transport_method is called *Aug 5 02:21:15.746
PDT: CALL-HOME-TRACE: GaliosCallHome_platformGetTacDefault is called *Aug 5 02:21:15.746
PDT: CALL-HOME-TRACE: call_home_get_periodic_info() is entered *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: Index of selected periodic timer 1 *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_get_periodic_info() is entered *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: Index of selected periodic timer 0 *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_profile_exit_submode() is entered *Aug 5 02:21:15.746 PDT:
CALL-HOME-TRACE: call_home_profile_exit_submode() is called *Aug 5 02:21:17.244 PDT:
%C4K_REDUNDANCY-5-CONFIGSYNC: The bootvar has been successfully synchronized to the
standby supervisor *Aug 5 02:21:17.445 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The
private-config has been successfully synchronized to the standby supervisor *Aug 5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-27
Chapter 52 Configuring Call Home
Message Contents
02:21:21.902 PDT: CALL-HOME-TRACE: Received event: 1 *Aug 5 02:21:21.902 PDT:
CALL-HOME-TRACE: Cleared rate limit counter *Aug 5 02:21:26.931 PDT:
%C4K_REDUNDANCY-3-COMMUNICATION: Communication with the peer Supervisor has been lost *Aug
5 02:21:26.956 PDT: %C4K_REDUNDANCY-3-SIMPLEX_MODE: The peer Supervisor has been lost *Aug
5 02:21:26.965 PDT: CALL-HOME-TRACE: call_home_event_callback: context 0x892BED30 timer
0x88E15DA8, callback 0x10DC2F60 *Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE: Callhome event
callback invoked *Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE: call_home_event_callback: info
0x87353318 *Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE: Event callback TYPE 141 ID 3 SEV 2
SN 0 *Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE: Non-Insert OIR Event (2) during boot *Aug
5 02:21:26.965 PDT: CALL-HOME-TRACE: call_home_get_profile_id() is entered *Aug 5
02:21:26.965 PDT: CALL-HOME-TRACE: Found profile id (-2034087768) for event (3) *Aug 5
02:21:26.965 PDT: CALL-HOME-TRACE: call_home_get_alert_group_id() is entered *Aug 5
02:21:26.965 PDT: CALL-HOME-TRACE: Found alert group id (3) for event (3) *Aug 5
02:21:26.965 PDT: CALL-HOME-TRACE: get_general_info(): is entered!
*Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE: The subtype is delta *Aug 5 02:21:26.965 PDT:
CALL-HOME-TRACE: Time zome NAME=PDT, offset=61200, display=+17:00 *Aug 5 02:21:26.965
PDT: CALL-HOME-TRACE: Date/time is <2010-08-05 02:21:26 GMT+17:00> (fmt len=29, strlen=29)
*Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE:
get_reply_to_address(): reply_to_address [email protected]
*Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE: call_home_get_transport_info() is entered,
transport 3 *Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE: call_home_get_recipient_list_for()
is entered, profile id 0x86C248A8, type 1 *Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE:
call_home_get_transport_info(): profile id 2260879528, dest [email protected], result 0
*Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE: call_home_get_recipient_list_for() is entered,
profile id 0x86C248A8, type 2 *Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE:
call_home_get_transport_info() result1 0, http
https://172.17.46.17/its/service/oddce/services/DDCEService
*Aug 5 02:21:26.965 PDT: CALL-HOME-TRACE:
call_home_increment_inqueue_event_counter_profile() is entered *Aug 5 02:21:26.965 PDT:
CALL-HOME-TRACE: call_home_increment_inqueue_call_home_event_counter is entered *Aug 5
02:21:26.965 PDT: CALL-HOME-TRACE: call_home_sync_statistics() is entered *Aug 5
02:21:26.965 PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5
02:21:26.965 PDT: CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:26.965
PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:26.965 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:26.965 PDT:
CALL-HOME-TRACE: call_home_increment_inqueue_call_home_event_counter is entered *Aug 5
02:21:26.965 PDT: CALL-HOME-TRACE: call_home_sync_statistics() is entered *Aug 5
02:21:26.965 PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5
02:21:26.965 PDT: CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:26.965
PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:26.965 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:26.966 PDT:
CALL-HOME-TRACE: Have {4} to convert to int *Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE:
is_stdby_oir_insert_event_after_bootup() slot 4, et 141 *Aug 5 02:21:26.966 PDT:
CALL-HOME-TRACE: is_stdby_oir_insert_event_after_bootup() RETURN FALSE *Aug 5
02:21:26.966 PDT: CALL-HOME-TRACE: Creating long text msg for Alert Group inventory (3)
*Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE: Have {4} to convert to int *Aug 5 02:21:26.966
PDT: CALL-HOME-TRACE: call_home_get_event_src_slot: slot for given event is 4 *Aug 5
02:21:26.966 PDT: CALL-HOME-TRACE: Time zome NAME=PDT, offset=61200, display=+17:00 *Aug
5 02:21:26.966 PDT: CALL-HOME-TRACE: Date/time is <2010-08-05 02:21 GMT+17:00> (fmt
len=26, strlen=26) *Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE: Event 141 for alert-group 3
at index 1 is not inventory *Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE: Have {4} to convert
to int *Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE: collector:Total alloted entries =1 *Aug
5 02:21:26.966 PDT: CALL-HOME-TRACE: collector: frus value is =1 *Aug 5 02:21:26.966
PDT: CALL-HOME-TRACE: GaliosCallHome_platformSpecificSlotString(): vslot=4, module=4.
*Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE: Event 141 description <Module 4: Unknown is
removed> *Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE: Unable to get SNMP contact string *Aug
5 02:21:26.966 PDT: CALL-HOME-TRACE: SNMP Contact is <?> *Aug 5 02:21:26.966 PDT:
CALL-HOME-TRACE: call_home_collect_card_info() is entered *Aug 5 02:21:26.966 PDT:
CALL-HOME-TRACE: Have {4} to convert to int *Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE:
collector:Total alloted entries =1 *Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE: collector:
frus value is =1 *Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE: Have OIR FRU data (1) for
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-28 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
slot 4 *Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE: Collector has 1 FRUs *Aug 5
02:21:26.966 PDT: CALL-HOME-TRACE: GaliosCallHome_platformSpecificSlotString(): vslot=4,
module=4.
*Aug 5 02:21:26.966 PDT: CALL-HOME-TRACE: Collected card information for 1 slots *Aug 5
02:21:26.966 PDT: CALL-HOME-TRACE: Attempting to run 5 commands *Aug 5 02:21:26.966 PDT:
CALL-HOME-TRACE: Making sure system ready before processing CLI commands *Aug 5
02:21:26.967 PDT: CALL-HOME-TRACE: Opened console for CLI commands (3:0) *Aug 5
02:21:26.967 PDT: CALL-HOME-TRACE: call_home_event_callback: context 0x8A79EDD0 timer
0x88E160B4, callback 0x10DC2F60 *Aug 5 02:21:26.967 PDT: CALL-HOME-TRACE: Callhome event
callback invoked *Aug 5 02:21:26.967 PDT: CALL-HOME-TRACE: call_home_event_callback: info
0x87359348 *Aug 5 02:21:26.968 PDT: CALL-HOME-TRACE: Event callback TYPE 141 ID 8 SEV 2
SN 0 *Aug 5 02:21:26.968 PDT: CALL-HOME-TRACE: Non-Insert OIR Event (2) during boot *Aug
5 02:21:26.968 PDT: CALL-HOME-TRACE: call_home_get_profile_id() is entered *Aug 5
02:21:26.968 PDT: CALL-HOME-TRACE: Found profile id (-2035082968) for event (8) *Aug 5
02:21:26.968 PDT: CALL-HOME-TRACE: call_home_get_alert_group_id() is entered *Aug 5
02:21:26.968 PDT: CALL-HOME-TRACE: Found alert group id (3) for event (8) *Aug 5
02:21:26.968 PDT: CALL-HOME-TRACE: get_general_info(): is entered!
*Aug 5 02:21:26.968 PDT: CALL-HOME-TRACE: The subtype is delta *Aug 5 02:21:26.968 PDT:
CALL-HOME-TRACE: Time zome NAME=PDT, offset=61200, display=+17:00 *Aug 5 02:21:26.968
PDT: CALL-HOME-TRACE: Date/time is <2010-08-05 02:21:26 GMT+17:00> (fmt len=29, strlen=29)
*Aug 5 02:21:26.968 PDT: CALL-HOME-TRACE:
get_reply_to_address(): reply_to_address [email protected]
*Aug 5 02:21:26.968 PDT: CALL-HOME-TRACE: call_home_get_transport_info() is entered,
transport 1 *Aug 5 02:21:26.968 PDT: CALL-HOME-TRACE: call_home_get_recipient_list_for()
is entered, profile id 0x86B31928, type 1 *Aug 5 02:21:26.968 PDT: CALL-HOME-TRACE:
call_home_get_transport_info(): profile id 2259884328, dest [email protected], result 0
*Aug 5 02:21:26.968 PDT: CALL-HOME-TRACE:
call_home_increment_inqueue_event_counter_profile() is entered *Aug 5 02:21:26.968 PDT:
CALL-HOME-TRACE: call_home_increment_inqueue_call_home_event_counter is entered *Aug 5
02:21:26.968 PDT: CALL-HOME-TRACE: call_home_sync_statistics() is entered *Aug 5
02:21:26.968 PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5
02:21:26.968 PDT: CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:26.968
PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:26.968 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:26.968 PDT:
CALL-HOME-TRACE: Have {4} to convert to int *Aug 5 02:21:26.968 PDT: CALL-HOME-TRACE:
is_stdby_oir_insert_event_after_bootup() slot 4, et 141 *Aug 5 02:21:26.968 PDT:
CALL-HOME-TRACE: is_stdby_oir_insert_event_after_bootup() RETURN FALSE *Aug 5
02:21:26.987 PDT: CALL-HOME-TRACE: Sent 'enable' to prepare for CLI commands *Aug 5
02:21:26.987 PDT: CALL-HOME-TRACE: GaliosCallHome_platformShowSystemCommand() is entered
*Aug 5 02:21:26.987 PDT: CALL-HOME-TRACE: Running CLI action show module *Aug 5
02:21:27.000 PDT: CALL-HOME-TRACE: sleeping for 500 ms to avoid high CPU *Aug 5
02:21:27.498 PDT: CALL-HOME-TRACE: Running CLI action show version *Aug 5 02:21:27.612
PDT: CALL-HOME-TRACE: sleeping for 500 ms to avoid high CPU *Aug 5 02:21:28.110 PDT:
CALL-HOME-TRACE: Running CLI action show inventory oid *Aug 5 02:21:28.125 PDT:
CALL-HOME-TRACE: sleeping for 500 ms to avoid high CPU *Aug 5 02:21:28.622 PDT:
CALL-HOME-TRACE: Running CLI action show idprom all *Aug 5 02:21:28.638 PDT:
CALL-HOME-TRACE: sleeping for 500 ms to avoid high CPU *Aug 5 02:21:29.135 PDT:
CALL-HOME-TRACE: Running CLI action show power *Aug 5 02:21:29.149 PDT: CALL-HOME-TRACE:
sleeping for 500 ms to avoid high CPU *Aug 5 02:21:29.646 PDT: CALL-HOME-TRACE: Closed
CLI connection *Aug 5 02:21:29.647 PDT: CALL-HOME-TRACE: Allocated 25682 bytes for long
message body *Aug 5 02:21:29.647 PDT: CALL-HOME-TRACE: Long text msg created (25682) *Aug
5 02:21:29.648 PDT: CALL-HOME-TRACE: call_home_send_msg() is entered, transport 3,
httpc_enabled 1 *Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE: xml args: <?xml version="1.0"
encoding="UTF-8"?><fh_smtp_args><fh_smtp_vrf_name>vrf1</fh_smtp_vrf_name></fh_smtp_args>
*Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE: call_home_send_msg triggering http messages to
url https://172.17.46.17/its/service/oddce/services/DDCEService
*Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE: call_home_httpc_post() url
https://172.17.46.17/its/service/oddce/services/DDCEService, sid 2, len 25682 *Aug 5
02:21:29.648 PDT: CALL-HOME-TRACE: call_home_httpc_post() sid 2, tid 1, mime_type
SOAPAction: "urn:ddce"
*Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE: call_home_wait_for_httpc_resp : is entered *Aug
5 02:21:29.648 PDT: CALL-HOME-TRACE: call_home_add_httpc_resp_node : is entered *Aug 5
02:21:29.648 PDT: CALL-HOME-TRACE: call_home_add_httpc_resp_node: create new resp node
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-29
Chapter 52 Configuring Call Home
Message Contents
call_home_tid is 1 call_home_httpc_resp_recvd false, resp_status 128 *Aug 5 02:21:29.648
PDT: CALL-HOME-TRACE: call_home_wait_for_httpc_resp insert the current httpc response
recvd status is (128) *Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE: Creating XML msg for
Alert Group inventory (3) *Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE:
call_home_collect_card_info() is entered *Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE: Have
{4} to convert to int *Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE: collector:Total alloted
entries =1 *Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE: collector: frus value is =1 *Aug 5
02:21:29.648 PDT: CALL-HOME-TRACE: Have OIR FRU data (1) for slot 4 *Aug 5 02:21:29.648
PDT: CALL-HOME-TRACE: Collector has 1 FRUs *Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE:
GaliosCallHome_platformSpecificSlotString(): vslot=4, module=4.
*Aug 5 02:21:29.648 PDT: CALL-HOME-TRACE: Collected card information for 1 slots *Aug 5
02:21:29.648 PDT: CALL-HOME-TRACE: Attempting to run 5 commands *Aug 5 02:21:29.648 PDT:
CALL-HOME-TRACE: Making sure system ready before processing CLI commands *Aug 5
02:21:29.649 PDT: CALL-HOME-TRACE: call_home_http_resp_data(): Received response for
0x8894E16C tid 1 sid 2 status 1 *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE: HTTP req data
free *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
RESPONSE DATA STARTS HERE
*Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE: call_home_http_resp_data() status = 1 *Aug 5
02:21:29.649 PDT: CALL-HOME-TRACE: call_home_set_httpc_resp_status: is entered. tid (1),
status (106), err_string () *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
call_home_http_resp_data : set tid (1) resp status to (106) *Aug 5 02:21:29.649 PDT:
CALL-HOME-TRACE: call_home_wait_for_httpc_resp : unblocked wait for tid (1), status is
(106)err string is (Unkown) *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
call_home_remove_httpc_resp_node : is entered *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
call_home_httpc_resp_stat_clean_up is entered *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
http resp from https://172.17.46.17/its/service/oddce/services/DDCEService failed, tid
(1), response status (106), err string (Unkown) *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
call_home_sync_statistics() is entered *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
call_home_get_statistics() is entered *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
call_home_ha_incr_sync: is entered *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
call_home_get_statistics() is entered *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
call_home_ha_incr_sync: is entered *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE:
call_home_decrement_inqueue_call_home_event_counter is entered *Aug 5 02:21:29.649 PDT:
CALL-HOME-TRACE: call_home_sync_statistics() is entered *Aug 5 02:21:29.649 PDT:
CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:29.649 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:29.649 PDT:
CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:29.649 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:29.649 PDT:
%CALL_HOME-3-HTTP_REQUEST_FAILED: failed to send HTTP request to :
https://172.17.46.17/its/service/oddce/services/DDCEService
(ERR 106 : Unkown)
*Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE: Sending message to [[email protected]]
(size=25682) *Aug 5 02:21:29.649 PDT: CALL-HOME-TRACE: mail servers 0 round retry *Aug 5
02:21:29.649 PDT: CALL-HOME-TRACE: Retrieved mail-server <64.104.123.94> priority 1 *Aug
5 02:21:29.651 PDT: CALL-HOME-TRACE: Opened console for CLI commands (8:0) *Aug 5
02:21:29.662 PDT: CALL-HOME-TRACE: Sent 'enable' to prepare for CLI commands *Aug 5
02:21:29.662 PDT: CALL-HOME-TRACE: GaliosCallHome_platformShowSystemCommand() is entered
*Aug 5 02:21:29.662 PDT: CALL-HOME-TRACE: Running CLI action show module *Aug 5
02:21:29.776 PDT: CALL-HOME-TRACE: sleeping for 500 ms to avoid high CPU *Aug 5
02:21:29.847 PDT: CALL-HOME-TRACE: Retrieved mail-server <64.104.193.198> priority 2 *Aug
5 02:21:30.274 PDT: CALL-HOME-TRACE: Running CLI action show version *Aug 5 02:21:30.288
PDT: CALL-HOME-TRACE: sleeping for 500 ms to avoid high CPU *Aug 5 02:21:30.787 PDT:
CALL-HOME-TRACE: Running CLI action show inventory oid *Aug 5 02:21:30.906 PDT:
CALL-HOME-TRACE: sleeping for 500 ms to avoid high CPU *Aug 5 02:21:31.406 PDT:
CALL-HOME-TRACE: Running CLI action show idprom all *Aug 5 02:21:31.520 PDT:
CALL-HOME-TRACE: sleeping for 500 ms to avoid high CPU *Aug 5 02:21:32.018 PDT:
CALL-HOME-TRACE: Running CLI action show power *Aug 5 02:21:32.034 PDT: CALL-HOME-TRACE:
sleeping for 500 ms to avoid high CPU *Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: Closed
CLI connection *Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: Event 141 for alert-group 3 at
index 1 is not inventory *Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE:
create_element_table_from_templates: Created table to hold XML info (228) *Aug 5
02:21:32.535 PDT: CALL-HOME-TRACE: Time zome NAME=PDT, offset=61200, display=+17:00 *Aug
5 02:21:32.535 PDT: CALL-HOME-TRACE: Date/time is <2010-08-05 02:21:32 GMT+17:00> (fmt
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-30 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
len=29, strlen=29) *Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: Have {4} to convert to int
*Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: call_home_get_event_src_slot: slot for given
event is 4 *Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: Time zome NAME=PDT, offset=61200,
display=+17:00 *Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: Date/time is <2010-08-05
02:21:26 GMT+17:00> (fmt len=29, strlen=29) *Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE:
Have {4} to convert to int *Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: collector:Total
alloted entries =1 *Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: collector: frus value is =1
*Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: GaliosCallHome_platformSpecificSlotString():
vslot=4, module=4.
*Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: Event 141 description <Module 4: Unknown is
removed> *Aug 5 02:21:32.535 PDT: CALL-HOME-TRACE: Unable to get SNMP contact string *Aug
5 02:21:32.536 PDT: CALL-HOME-TRACE: call_home_make_xml: Formatting XML message body
(29004) *Aug 5 02:21:32.537 PDT: CALL-HOME-TRACE: call_home_send_msg() is entered,
transport 1, httpc_enabled 1 *Aug 5 02:21:32.537 PDT: CALL-HOME-TRACE: xml args: <?xml
version="1.0"
encoding="UTF-8"?><fh_smtp_args><fh_smtp_vrf_name>vrf1</fh_smtp_vrf_name></fh_smtp_args>
*Aug 5 02:21:32.537 PDT: CALL-HOME-TRACE: Sending message to [[email protected]]
(size=29004) *Aug 5 02:21:32.537 PDT: CALL-HOME-TRACE: mail servers 0 round retry *Aug 5
02:21:32.537 PDT: CALL-HOME-TRACE: Retrieved mail-server <64.104.123.94> priority 1 *Aug
5 02:21:32.734 PDT: CALL-HOME-TRACE: Retrieved mail-server <64.104.193.198> priority 2
*Aug 5 02:21:36.893 PDT: CALL-HOME-TRACE: Mail sent successfully *Aug 5 02:21:36.893
PDT: CALL-HOME-TRACE: call_home_increment_success_call_home_event_counter is entered *Aug
5 02:21:36.893 PDT: CALL-HOME-TRACE: call_home_sync_statistics() is entered *Aug 5
02:21:36.893 PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5
02:21:36.893 PDT: CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:36.893
PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:36.893 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:36.893 PDT:
CALL-HOME-TRACE: call_home_decrement_inqueue_call_home_event_counter is entered *Aug 5
02:21:36.893 PDT: CALL-HOME-TRACE: call_home_sync_statistics() is entered *Aug 5
02:21:36.893 PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5
02:21:36.893 PDT: CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:36.893
PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:36.893 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:36.893 PDT:
CALL-HOME-TRACE: call_home_set_test_result_with_lock is entered *Aug 5 02:21:36.893 PDT:
CALL-HOME-TRACE: call_home_sync_statistics() is entered *Aug 5 02:21:36.893 PDT:
CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:36.893 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:36.893 PDT:
CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:36.893 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:36.893 PDT:
CALL-HOME-TRACE: call_home_event_callback context 0x892BED30, info 0x87353318 *Aug 5
02:21:36.893 PDT: CALL-HOME-TRACE: Callback done TYPE 141 ID 3 SEV 2 SN 0 *Aug 5
02:21:36.893 PDT: CALL-HOME-TRACE:
clean_up_notification_info() is entered....
*Aug 5 02:21:39.716 PDT: CALL-HOME-TRACE: Mail sent successfully *Aug 5 02:21:39.716
PDT: CALL-HOME-TRACE: call_home_increment_success_call_home_event_counter is entered *Aug
5 02:21:39.716 PDT: CALL-HOME-TRACE: call_home_sync_statistics() is entered *Aug 5
02:21:39.716 PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5
02:21:39.716 PDT: CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:39.716
PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:39.716 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:39.716 PDT:
CALL-HOME-TRACE: call_home_decrement_inqueue_call_home_event_counter is entered *Aug 5
02:21:39.716 PDT: CALL-HOME-TRACE: call_home_sync_statistics() is entered *Aug 5
02:21:39.716 PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5
02:21:39.716 PDT: CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:39.716
PDT: CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:39.716 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:39.716 PDT:
CALL-HOME-TRACE: call_home_set_test_result_with_lock is entered *Aug 5 02:21:39.716 PDT:
CALL-HOME-TRACE: call_home_sync_statistics() is entered *Aug 5 02:21:39.716 PDT:
CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:39.716 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:39.716 PDT:
CALL-HOME-TRACE: call_home_get_statistics() is entered *Aug 5 02:21:39.716 PDT:
CALL-HOME-TRACE: call_home_ha_incr_sync: is entered *Aug 5 02:21:39.716 PDT:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-31
Chapter 52 Configuring Call Home
Message Contents
CALL-HOME-TRACE: call_home_event_callback context 0x8A79EDD0, info 0x87359348 *Aug 5
02:21:39.716 PDT: CALL-HOME-TRACE: Callback done TYPE 141 ID 8 SEV 2 SN 0 *Aug 5
02:21:39.716 PDT: CALL-HOME-TRACE:
clean_up_notification_info() is entered....
*Aug 5 02:25:18.597 PDT: %C4K_REDUNDANCY-6-DUPLEX_MODE: The peer Supervisor has been
detected *Aug 5 02:25:57.514 PDT: %C4K_IOSMODPORTMAN-6-MODULEONLINE: Module 4
(WS-X45-SUP7-E S/N: CAT1351L02E Hw: 0.6) is online *Aug 5 02:25:57.523 PDT:
%C4K_REDUNDANCY-6-MODE: ACTIVE supervisor initializing for sso mode *Aug 5 02:25:57.568
PDT: %C4K_REDUNDANCY-3-COMMUNICATION: Communication with the peer Supervisor has been
established *Aug 5 02:26:01.578 PDT: %CALL_HOME-3-HTTP_REQUEST_FAILED: failed to send
HTTP request to :
https://172.17.46.17/its/service/oddce/services/DDCEService
(ERR 106 : Unkown)
*Aug 5 02:26:10.286 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The bootvar has been successfully
synchronized to the standby supervisor *Aug 5 02:26:10.286 PDT:
%C4K_REDUNDANCY-5-CONFIGSYNC: The config-reg has been successfully synchronized to the
standby supervisor *Aug 5 02:26:10.287 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The
startup-config has been successfully synchronized to the standby supervisor *Aug 5
02:26:10.706 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The private-config has been successfully
synchronized to the standby supervisor *Aug 5 02:26:11.953 PDT:
%C4K_REDUNDANCY-5-CONFIGSYNC_RATELIMIT: The vlan database has been successfully
synchronized to the standby supervisor *Aug 5 02:26:20.713 PDT:
%CALL_HOME-3-HTTP_REQUEST_FAILED: failed to send HTTP request to :
https://172.17.46.17/its/service/oddce/services/DDCEService
(ERR 106 : Unkown)
*Aug 5 02:26:22.769 PDT: %XDR-6-ISSUCLIENTABSENT: XDR client IPv6 table broker absent on
slot 4. Client functionality may be affected.
*Aug 5 02:26:43.464 PDT: %HA_CONFIG_SYNC-6-BULK_CFGSYNC_SUCCEED: Bulk Sync succeeded *Aug
5 02:26:43.464 PDT: %RF-5-RF_TERMINAL_STATE: Terminal state reached for (SSO) *Aug 5
02:26:40.009 PDT: %SSH-5-DISABLED: STANDBY:SSH 1.99 has been disabled *Aug 5 02:26:40.011
PDT: %SSH-5-ENABLED: STANDBY:SSH 1.99 has been enabled *Aug 5 02:30:30.694 PDT:
%SYS-5-CONFIG_I: Configured from console by console *Aug 5 03:12:19.647 PDT:
%C4K_REDUNDANCY-5-CONFIGSYNC: The private-config has been successfully synchronized to the
standby supervisor *Aug 5 03:12:20.082 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The
startup-config has been successfully synchronized to the standby supervisor *Aug 5
03:19:57.822 PDT: %SPANTREE-2-ROOTGUARD_CONFIG_CHANGE: Root guard enabled on port
GigabitEthernet1/1.
*Aug 5 03:19:58.268 PDT: %SPANTREE-2-ROOTGUARD_BLOCK: Root guard blocking port
GigabitEthernet1/1 on VLAN0005.
*Aug 5 03:19:58.532 PDT: %SPANTREE-5-TOPOTRAP: Topology Change Trap for vlan 3 *Aug 5
03:19:58.193 PDT: %SPANTREE-2-ROOTGUARD_CONFIG_CHANGE: STANDBY:Root guard enabled on port
GigabitEthernet1/1.
*Aug 5 03:20:27.822 PDT: %SPANTREE-5-TOPOTRAP: Topology Change Trap for vlan 3 *Aug 5
03:21:00.304 PDT: %SPANTREE-2-ROOTGUARD_CONFIG_CHANGE: Root guard disabled on port
GigabitEthernet1/1.
*Aug 5 03:21:00.304 PDT: %SPANTREE-2-ROOTGUARD_UNBLOCK: Root guard unblocking port
GigabitEthernet1/1 on VLAN0003.
*Aug 5 03:21:00.596 PDT: %SPANTREE-5-ROOTCHANGE: Root Changed for vlan 306: New Root Port
is GigabitEthernet1/1. New Root Mac Address is 001b.d474.ec80 *Aug 5 03:21:00.361 PDT:
%SPANTREE-2-ROOTGUARD_CONFIG_CHANGE: STANDBY:Root guard disabled on port
GigabitEthernet1/1.
*Aug 5 03:21:01.710 PDT: %SPANTREE-5-ROOTCHANGE: Root Changed for vlan 1523: New Root
Port is GigabitEthernet1/1. New Root Mac Address is 001b.d474.ec80 *Aug 5 03:21:02.238
PDT: %SPANTREE-5-TOPOTRAP: Topology Change Trap for vlan 3 *Aug 5 03:21:30.606 PDT:
%SPANTREE-5-TOPOTRAP: Topology Change Trap for vlan 306 *Aug 5 03:21:31.719 PDT:
%SPANTREE-5-TOPOTRAP: Topology Change Trap for vlan 1523 *Aug 5 03:23:22.289 PDT:
%SYS-5-CONFIG_I: Configured from console by console *Aug 5 03:23:24.801 PDT:
%C4K_REDUNDANCY-5-CONFIGSYNC: The private-config has been successfully synchronized to the
standby supervisor *Aug 5 03:23:25.230 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The
startup-config has been successfully synchronized to the standby supervisor *Aug 5
03:24:10.410 PDT: %SYS-5-CONFIG_I: Configured from console by console *Aug 5 03:24:12.641
PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The private-config has been successfully synchronized
to the standby supervisor *Aug 5 03:24:13.077 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The
startup-config has been successfully synchronized to the standby supervisor *Aug 5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-32 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
21:00:05.302 PDT: %SYS-5-CONFIG_I: Configured from console by console *Aug 5 21:00:24.989
PDT: %SYS-5-CONFIG_I: Configured from console by console *Aug 5 21:00:33.674 PDT:
%LINK-5-CHANGED: Interface GigabitEthernet1/9, changed state to administratively down *Aug
5 21:00:34.675 PDT: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet1/9,
changed state to down Callista-4507E# Command Output Name : show inventory Attachment Type
: command output MIME Type : text/plain Command Output Text : NAME: "Switch System",
DESCR: "Cisco Systems, Inc. WS-C4507R-E 7 slot switch "
PID: WS-C4507R-E , VID: V01 , SN: FOX1310GHG7
NAME: "Clock Module", DESCR: "Clock Module"
PID: WS-X4K-CLOCK-E , VID: V01 , SN: JAE130627GH
NAME: "Mux Buffer 1 ", DESCR: "Mux Buffers for Redundancy Logic"
PID: WS-X4590-EX= , VID: , SN: JAE13093YQZ
NAME: "Mux Buffer 2 ", DESCR: "Mux Buffers for Redundancy Logic"
PID: WS-X4590-EX= , VID: , SN: JAE13093YV4
NAME: "Mux Buffer 5 ", DESCR: "Mux Buffers for Redundancy Logic"
PID: WS-X4590-EX= , VID: , SN: JAE13093YSP
NAME: "Mux Buffer 6 ", DESCR: "Mux Buffers for Redundancy Logic"
PID: WS-X4590-EX= , VID: , SN: JAE13093YRI
NAME: "Mux Buffer 7 ", DESCR: "Mux Buffers for Redundancy Logic"
PID: WS-X4590-EX= , VID: , SN: JAE13093YSJ
NAME: "Linecard(slot 1)", DESCR: "10/100/1000BaseT (RJ45)V with 48 10/100/1000 baseT voice
power ports (Cisco/IEEE)"
PID: WS-X4548-GB-RJ45V , VID: V08 , SN: JAE1121HUQ8
NAME: "Linecard(slot 2)", DESCR: "10/100/1000BaseT (RJ45)+V E Series with 48 10/100/1000
baseT Premium PoE ports (Cisco/IEEE)"
PID: WS-X4748-RJ45V+E , VID: V00 , SN: CAT1418L03K
NAME: "Linecard(slot 3)", DESCR: "Sup 7-E 10GE (SFP+), 1000BaseX (SFP) with 4 SFP+ Ports"
PID: WS-X45-SUP7-E , VID: V00 , SN: CAT1351L02Q
NAME: "TenGigabitEthernet3/1", DESCR: "SFP-10Gbase-SR"
PID: SFP-10G-SR , VID: V02 , SN: ECL132001XE
NAME: "Linecard(slot 4)", DESCR: "Sup 7-E 10GE (SFP+), 1000BaseX (SFP) with 4 SFP+ Ports"
PID: WS-X45-SUP7-E , VID: V00 , SN: CAT1351L02E
NAME: "TenGigabitEthernet4/1", DESCR: "1000BaseSX"
PID: Unspecified , VID: , SN: OPA10365002
NAME: "Linecard(slot 5)", DESCR: "10/100/1000BaseT (RJ45)+V E Series with 48 10/100/1000
baseT Premium PoE ports (Cisco/IEEE)"
PID: WS-X4748-RJ45V+E , VID: V00 , SN: CAT1340L01T
NAME: "Linecard(slot 6)", DESCR: "10/100/1000BaseT (RJ45)V with 48 10/100/1000 baseT voice
power ports (Cisco/IEEE)"
PID: WS-X4548-GB-RJ45V , VID: V08 , SN: JAE1120HNVZ
NAME: "Linecard(slot 7)", DESCR: "10GE SFP+ with 12 SFP+ ports"
PID: WS-X4712-SFP+E , VID: V00 , SN: CAT1348L00J
NAME: "TenGigabitEthernet7/2", DESCR: "SFP-10Gbase-SR"
PID: SFP-10G-SR , VID: V02 , SN: ECL1321003H
NAME: "TenGigabitEthernet7/3", DESCR: "SFP-10Gbase-SR"
PID: SFP-10G-SR , VID: V02 , SN: AGD12344196
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-33
Chapter 52 Configuring Call Home
Message Contents
NAME: "Fan", DESCR: "FanTray"
PID: WS-X4597-E , VID: V01 , SN: FOX1309HCYF
NAME: "Power Supply 1", DESCR: "Power Supply ( AC 1400W )"
PID: PWR-C45-1400AC , VID: V04 , SN: DTH11177255
NAME: "Power Supply 2", DESCR: "Power Supply ( AC 1300W )"
PID: PWR-C45-1300ACV , VID: V05 , SN: DTM123900VH
Sample Syslog Alert Notification in XML Format
<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://www.w3.org/2003/05/soap-envelope">
<soap-env:Header>
<aml-session:Session xmlns:aml-session="http://www.cisco.com/2004/01/aml-session"
soap-env:mustUnderstand="true"
soap-env:role="http://www.w3.org/2003/05/soap-envelope/role/next">
<aml-session:To>http://tools.cisco.com/neddce/services/DDCEService</aml-session:To>
<aml-session:Path>
<aml-session:Via>http://www.cisco.com/appliance/uri</aml-session:Via>
</aml-session:Path>
<aml-session:From>http://www.cisco.com/appliance/uri</aml-session:From>
<aml-session:MessageId>M0:FOX1310GHG7:D0038D3D</aml-session:MessageId>
</aml-session:Session>
</soap-env:Header>
<soap-env:Body>
<aml-block:Block xmlns:aml-block="http://www.cisco.com/2004/01/aml-block">
<aml-block:Header>
<aml-block:Type>http://www.cisco.com/2005/05/callhome/syslog</aml-block:Type>
<aml-block:CreationDate>2010-08-04 23:54:53 GMT+17:00</aml-block:CreationDate>
<aml-block:Builder>
<aml-block:Name>Cat4500/4900</aml-block:Name>
<aml-block:Version>2.0</aml-block:Version>
</aml-block:Builder>
<aml-block:BlockGroup>
<aml-block:GroupId>G1:FOX1310GHG7:D0038D3D</aml-block:GroupId>
<aml-block:Number>0</aml-block:Number>
<aml-block:IsLast>true</aml-block:IsLast>
<aml-block:IsPrimary>true</aml-block:IsPrimary>
<aml-block:WaitForPrimary>false</aml-block:WaitForPrimary>
</aml-block:BlockGroup>
<aml-block:Severity>4</aml-block:Severity>
</aml-block:Header>
<aml-block:Content>
<ch:CallHome xmlns:ch="http://www.cisco.com/2005/05/callhome" version="1.0">
<ch:EventTime>2010-08-04 23:54:52 GMT+17:00</ch:EventTime> <ch:MessageDescription>*Aug 4
23:54:52.350 PDT: %LINK-3-UPDOWN: Interface GigabitEthernet1/9, changed state to
down</ch:MessageDescription> <ch:Event> <ch:Type>syslog</ch:Type>
<ch:SubType></ch:SubType> <ch:Brand>Cisco Systems</ch:Brand> <ch:Series>Cat4500 Series
Switches</ch:Series> </ch:Event> <ch:CustomerData> <ch:UserData>
<ch:Email>[email protected]</ch:Email>
</ch:UserData>
<ch:ContractData>
<ch:CustomerId>cis1</ch:CustomerId>
<ch:SiteId>hsr-sec-7</ch:SiteId>
<ch:ContractId>cisco123</ch:ContractId>
<ch:DeviceId>WS-C4507R-E@C@FOX1310GHG7</ch:DeviceId>
</ch:ContractData>
<ch:SystemInfo>
<ch:Name>Callista-4507E</ch:Name>
<ch:Contact></ch:Contact>
<ch:ContactEmail>[email protected]</ch:ContactEmail>
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-34 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
<ch:ContactPhoneNumber>+919901233008</ch:ContactPhoneNumber>
<ch:StreetAddress>9th Main, HSR, Bangalore, 560034</ch:StreetAddress> </ch:SystemInfo>
<ch:CCOID></ch:CCOID> </ch:CustomerData> <ch:Device> <rme:Chassis
xmlns:rme="http://www.cisco.com/rme/4.0">
<rme:Model>WS-C4507R-E</rme:Model>
<rme:HardwareVersion>1.1</rme:HardwareVersion>
<rme:SerialNumber>FOX1310GHG7</rme:SerialNumber>
<rme:AdditionalInformation>
<rme:AD name="PartNumber" value="73-9975-04" /> <rme:AD name="SoftwareVersion"
value="15.0(100)XO(1.42)" /> <rme:AD name="SystemObjectId" value="1.3.6.1.4.1.9.1.876" />
<rme:AD name="SystemDescription" value="Cisco IOS Software, Catalyst 4500 L3 Switch
Software (cat4500e-UNIVERSALK9-M), Version 15.0(100)XO(1.42), INTERIM SOFTWARE Copyright
(c) 1986-2010 by Cisco Systems, Inc.
Compiled Sun 01-Aug-10 02:58 by gsbuprod" /> </rme:AdditionalInformation> </rme:Chassis>
</ch:Device> </ch:CallHome> </aml-block:Content> <aml-block:Attachments>
<aml-block:Attachment type="inline"> <aml-block:Name>show logging</aml-block:Name>
<aml-block:Data encoding="plain"> <![CDATA[ Syslog logging: enabled (9172 messages
dropped, 1 messages rate-limited, 161 flushes, 0 overruns, xml disabled, filtering
disabled)
No Active Message Discriminator.
No Inactive Message Discriminator.
Console logging: level debugging, 2082 messages logged, xml disabled,
filtering disabled
Monitor logging: level debugging, 0 messages logged, xml disabled,
filtering disabled
Buffer logging: level debugging, 1905 messages logged, xml disabled,
filtering disabled
Exception Logging: size (8192 bytes)
Count and timestamp logging messages: disabled
Persistent logging: disabled
No active filter modules.
Trap logging: level informational, 111 message lines logged
Log Buffer (32768 bytes):
ableid:FFFFFFFF vrfid:FFFF tid:0 name:}
*Aug 4 22:38:57.564 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.564 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.564 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.564 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.564 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.564 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.564 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.564 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.564 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.564 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.564 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.564 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.564 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-35
Chapter 52 Configuring Call Home
Message Contents
*Aug 4 22:38:57.564 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.564 PDT: EIGRP(parser):
CGC__intf_summ_nvgens: CTX{vrid:0 afi:2 as:3 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.564 PDT: EIGRP(parser): FIND:(119) CTX{vrid:FFFF afi:2 as:0 tableid:0 vrfid:0
tid:0 name:} *Aug 4 22:38:57.564 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.565 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:3
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.565 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:3 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.565 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.565 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.567 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:3
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:3 tableid:2 vrfid:2 tid:0 name:} *Aug 4
22:38:57.567 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.567 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:3
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:3 tableid:2 vrfid:2 tid:0 name:} *Aug 4
22:38:57.567 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.567 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:3
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:3 tableid:2 vrfid:2 tid:0 name:} *Aug 4
22:38:57.567 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.567 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:3
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:3 tableid:2 vrfid:2 tid:0 name:} *Aug 4
22:38:57.567 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.567 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:3
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:3 tableid:2 vrfid:2 tid:0 name:} *Aug 4
22:38:57.567 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.567 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:3
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.567 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:3 tableid:2 vrfid:2 tid:0 name:} *Aug 4
22:38:57.567 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.568 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.568 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:3
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.568 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:3 tableid:2 vrfid:2 tid:0 name:} *Aug 4
22:38:57.568 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.568 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.568 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:3
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.568 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:3 tableid:2 vrfid:2 tid:0 name:} *Aug 4
22:38:57.568 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.568 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.568 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:1
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.568 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:1 tableid:2 vrfid:2 tid:0 name:} *Aug 4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-36 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
22:38:57.568 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.568 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.568 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:1
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.568 PDT: EIGRP(parser):
CGC__intf_summ_nvgens: CTX{vrid:0 afi:1 as:1 tableid:2 vrfid:2 tid:0 name:} *Aug 4
22:38:57.568 PDT: EIGRP(parser): FIND:(119) CTX{vrid:FFFF afi:1 as:0 tableid:2 vrfid:2
tid:0 name:} *Aug 4 22:38:57.568 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.569 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.569 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug
4 22:38:57.569 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.570 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug
4 22:38:57.570 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.570 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug
4 22:38:57.570 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.570 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug
4 22:38:57.570 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.570 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug
4 22:38:57.570 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.570 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug
4 22:38:57.570 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.570 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug
4 22:38:57.570 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.570 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug
4 22:38:57.570 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.570 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug
4 22:38:57.570 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-37
Chapter 52 Configuring Call Home
Message Contents
*Aug 4 22:38:57.570 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug
4 22:38:57.570 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.570 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:3
tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser):
CGC__intf_summ_nvgens: CTX{vrid:0 afi:2 as:3 tableid:1E000001 vrfid:2 tid:0 name:} *Aug 4
22:38:57.570 PDT: EIGRP(parser): FIND:(119) CTX{vrid:FFFF afi:2 as:0 tableid:1E000001
vrfid:2 tid:0 name:} *Aug 4 22:38:57.570 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.571 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:3
tableid:2 vrfid:2 tid:0 name:} *Aug 4 22:38:57.571 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:3 tableid:2 vrfid:2 tid:0 name:} *Aug 4
22:38:57.571 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.571 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.575 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.575 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.575 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.575 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.579 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.579 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.579 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.579 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.585 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.585 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.585 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.585 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.589 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.589 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.589 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.589 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.593 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.593 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.593 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.593 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.593 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.593 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.593 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-38 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
22:38:57.593 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.593 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.593 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.593 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.593 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.593 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.593 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.593 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.593 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.593 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.594 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:1
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.594 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.594 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.594 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.594 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:1
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.594 PDT: EIGRP(parser):
CGC__intf_summ_nvgens: CTX{vrid:0 afi:1 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.594 PDT: EIGRP(parser): FIND:(119) CTX{vrid:FFFF afi:1 as:0 tableid:0 vrfid:0
tid:0 name:} *Aug 4 22:38:57.594 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.595 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.595 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.595 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.595 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0
afi:2 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.595 PDT: EIGRP(parser):
FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF vrfid:FFFF tid:0 name:} *Aug 4
22:38:57.595 PDT: EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.595 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.595 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.595 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.595 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0
afi:2 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.595 PDT: EIGRP(parser):
FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF vrfid:FFFF tid:0 name:} *Aug 4
22:38:57.595 PDT: EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.596 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0
afi:2 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF vrfid:FFFF tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-39
Chapter 52 Configuring Call Home
Message Contents
*Aug 4 22:38:57.596 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0
afi:2 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF vrfid:FFFF tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.596 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0
afi:2 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF vrfid:FFFF tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.596 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0
afi:2 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF vrfid:FFFF tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.596 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0
afi:2 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF vrfid:FFFF tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.596 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0
afi:2 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF vrfid:FFFF tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.596 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0
afi:2 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF vrfid:FFFF tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.596 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0
afi:2 as:1 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.596 PDT: EIGRP(parser):
FIND:(106) CTX{vrid:0 afi:2 as:0 tableid:FFFFFFFF vrfid:FFFF tid:0 name:} *Aug 4
22:38:57.596 PDT: EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.596 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.597 PDT: EIGRP(parser):
CGC__intf_summ_nvgens: CTX{vrid:0 afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.597 PDT: EIGRP(parser): FIND:(119) CTX{vrid:FFFF afi:2 as:0 tableid:0 vrfid:0
tid:0 name:} *Aug 4 22:38:57.597 PDT: EIGRP(parser): FIND:(119) CTX{vrid:FFFF afi:2 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.597 PDT: EIGRP(parser): FIND:(119)
CTX{vrid:FFFF afi:2 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.597 PDT:
EIGRP(parser): rc/hotice_rc: PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-40 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
*Aug 4 22:38:57.597 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.597 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.598 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.598 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.601 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.601 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.601 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.601 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.601 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.601 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.601 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.601 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.601 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.601 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.601 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.601 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser): rc/hotice_rc:
PASS_NOCHANGE/CONFIG_RC_OK_NO_CHANGE
*Aug 4 22:38:57.601 PDT: EIGRP(parser): CSC_classic_int_csb2ctx: CTX{vrid:0 afi:1 as:0
tableid:0 vrfid:0 tid:0 name:} *Aug 4 22:38:57.601 PDT: EIGRP(parser):
CGC_classic_intf_nvgen: CTX{vrid:0 afi:1 as:0 tableid:0 vrfid:0 tid:0 name:} *Aug 4
22:38:57.601 PDT: EIGRP(parser): FIND:(106) CTX{vrid:0 afi:1 as:0 tableid:FFFFFFFF
vrfid:FFFF tid:0 name:} *Aug 4 22:38:59.467 PDT: %SYS-3-LOGGER_DROPPED: System dropped
9172 console debug messages.
*Aug 4 22:43:57.163 PDT: %SYS-5-CONFIG_I: Configured from console by console *Aug 4
23:26:05.141 PDT: %SYS-5-CONFIG_I: Configured from console by console *Aug 4 23:28:15.251
PDT: %IOSXE-5-PLATFORM: 4 %SYSTEM-3-SYSTEM_SHELL_LOG: Shell started:
*Aug 4 23:29:16.074 PDT: %IOSXE-5-PLATFORM: 4 %SYSTEM-3-SYSTEM_SHELL_LOG: Shell ended:
*Aug 4 23:29:16.078 PDT: %IOSXE-5-PLATFORM: 4 %SYSTEM-3-SYSTEM_SHELL_LOG: Log:
bootflash:tracelogs/system_shell.log.20100804232815
*Aug 4 23:29:16.093 PDT: %IOSXE-5-PLATFORM: 4 %SYSTEM-3-SYSTEM_SHELL_LOG: (fingerprint:
4d8f4f1753ac61d9ef63a264fe7b5e50) *Aug 4 23:29:33.122 PDT: %IOSXE-5-PLATFORM: STANDBY:3
%SYSTEM-3-SYSTEM_SHELL_LOG: Shell started:
*Aug 4 23:29:52.479 PDT: %IOSXE-6-PLATFORM: STANDBY:3 sshd[3866]: Did not receive
identification string from 10.64.71.85 *Aug 4 23:29:52.616 PDT: %IOSXE-6-PLATFORM:
STANDBY:3 sshd[3871]: Did not receive identification string from 10.64.71.49 *Aug 4
23:29:52.775 PDT: %IOSXE-6-PLATFORM: STANDBY:3 sshd[3876]: Did not receive identification
string from 10.64.71.80 *Aug 4 23:29:53.006 PDT: %IOSXE-6-PLATFORM: STANDBY:3 sshd[3881]:
Did not receive identification string from 10.64.71.40 *Aug 4 23:29:53.290 PDT:
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-41
Chapter 52 Configuring Call Home
Message Contents
%IOSXE-6-PLATFORM: STANDBY:3 sshd[3886]: Did not receive identification string from
10.64.71.39 *Aug 4 23:32:18.027 PDT: %IOSXE-5-PLATFORM: STANDBY:3
%SYSTEM-3-SYSTEM_SHELL_LOG: Shell ended:
*Aug 4 23:32:18.029 PDT: %IOSXE-5-PLATFORM: STANDBY:3 %SYSTEM-3-SYSTEM_SHELL_LOG: Log:
bootflash:tracelogs/system_shell.log.20100804232933
*Aug 4 23:32:18.036 PDT: %IOSXE-5-PLATFORM: STANDBY:3 %SYSTEM-3-SYSTEM_SHELL_LOG:
(fingerprint: ad3f9da7b85e2de2c6d1b4375bc222ad) *Aug 4 23:38:24.689 PDT: %SYS-5-CONFIG_I:
Configured from console by console *Aug 4 23:38:26.896 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC:
The private-config has been successfully synchronized to the standby supervisor *Aug 4
23:38:27.348 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The startup-config has been successfully
synchronized to the standby supervisor *Aug 4 23:42:26.473 PDT: %SYS-5-CONFIG_I:
Configured from console by console *Aug 4 23:42:28.562 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC:
The private-config has been successfully synchronized to the standby supervisor *Aug 4
23:42:28.995 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The startup-config has been successfully
synchronized to the standby supervisor *Aug 4 23:44:25.813 PDT: %SYS-5-CONFIG_I:
Configured from console by console *Aug 4 23:48:37.729 PDT: %SYS-5-CONFIG_I: Configured
from console by console *Aug 4 23:49:05.825 PDT: %SYS-5-CONFIG_I: Configured from console
by console *Aug 4 23:51:24.813 PDT: %SYS-5-CONFIG_I: Configured from console by console
*Aug 4 23:51:47.705 PDT: %SYS-5-CONFIG_I: Configured from console by console *Aug 4
23:52:44.909 PDT: %SYS-5-CONFIG_I: Configured from console by console *Aug 4 23:52:47.190
PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The private-config has been successfully synchronized
to the standby supervisor *Aug 4 23:52:47.655 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The
startup-config has been successfully synchronized to the standby supervisor *Aug 4
23:53:40.201 PDT: %SYS-5-CONFIG_I: Configured from console by console *Aug 4 23:53:42.482
PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The private-config has been successfully synchronized
to the standby supervisor *Aug 4 23:53:42.882 PDT: %C4K_REDUNDANCY-5-CONFIGSYNC: The
startup-config has been successfully synchronized to the standby supervisor
Callista-4507E#]]></aml-block:Data>
</aml-block:Attachment>
<aml-block:Attachment type="inline">
<aml-block:Name>show inventory</aml-block:Name> <aml-block:Data encoding="plain">
<![CDATA[NAME: "Switch System", DESCR: "Cisco Systems, Inc. WS-C4507R-E 7 slot switch "
PID: WS-C4507R-E , VID: V01 , SN: FOX1310GHG7
NAME: "Clock Module", DESCR: "Clock Module"
PID: WS-X4K-CLOCK-E , VID: V01 , SN: JAE130627GH
NAME: "Mux Buffer 1 ", DESCR: "Mux Buffers for Redundancy Logic"
PID: WS-X4590-EX= , VID: , SN: JAE13093YQZ
NAME: "Mux Buffer 2 ", DESCR: "Mux Buffers for Redundancy Logic"
PID: WS-X4590-EX= , VID: , SN: JAE13093YV4
NAME: "Mux Buffer 5 ", DESCR: "Mux Buffers for Redundancy Logic"
PID: WS-X4590-EX= , VID: , SN: JAE13093YSP
NAME: "Mux Buffer 6 ", DESCR: "Mux Buffers for Redundancy Logic"
PID: WS-X4590-EX= , VID: , SN: JAE13093YRI
NAME: "Mux Buffer 7 ", DESCR: "Mux Buffers for Redundancy Logic"
PID: WS-X4590-EX= , VID: , SN: JAE13093YSJ
NAME: "Linecard(slot 1)", DESCR: "10/100/1000BaseT (RJ45)V with 48 10/100/1000 baseT voice
power ports (Cisco/IEEE)"
PID: WS-X4548-GB-RJ45V , VID: V08 , SN: JAE1121HUQ8
NAME: "Linecard(slot 2)", DESCR: "10/100/1000BaseT (RJ45)+V E Series with 48 10/100/1000
baseT Premium PoE ports (Cisco/IEEE)"
PID: WS-X4748-RJ45V+E , VID: V00 , SN: CAT1418L03K
NAME: "Linecard(slot 3)", DESCR: "Sup 7-E 10GE (SFP+), 1000BaseX (SFP) with 4 SFP+ Ports"
PID: WS-X45-SUP7-E , VID: V00 , SN: CAT1351L02Q
NAME: "TenGigabitEthernet3/1", DESCR: "SFP-10Gbase-SR"
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-42 OL-22250-01
Chapter 52 Configuring Call Home
Message Contents
PID: SFP-10G-SR , VID: V02 , SN: ECL132001XE
NAME: "Linecard(slot 4)", DESCR: "Sup 7-E 10GE (SFP+), 1000BaseX (SFP) with 4 SFP+ Ports"
PID: WS-X45-SUP7-E , VID: V00 , SN: CAT1351L02E
NAME: "TenGigabitEthernet4/1", DESCR: "1000BaseSX"
PID: Unspecified , VID: , SN: OPA10365002
NAME: "Linecard(slot 5)", DESCR: "10/100/1000BaseT (RJ45)+V E Series with 48 10/100/1000
baseT Premium PoE ports (Cisco/IEEE)"
PID: WS-X4748-RJ45V+E , VID: V00 , SN: CAT1340L01T
NAME: "Linecard(slot 6)", DESCR: "10/100/1000BaseT (RJ45)V with 48 10/100/1000 baseT voice
power ports (Cisco/IEEE)"
PID: WS-X4548-GB-RJ45V , VID: V08 , SN: JAE1120HNVZ
NAME: "Linecard(slot 7)", DESCR: "10GE SFP+ with 12 SFP+ ports"
PID: WS-X4712-SFP+E , VID: V00 , SN: CAT1348L00J
NAME: "TenGigabitEthernet7/2", DESCR: "SFP-10Gbase-SR"
PID: SFP-10G-SR , VID: V02 , SN: ECL1321003H
NAME: "TenGigabitEthernet7/3", DESCR: "SFP-10Gbase-SR"
PID: SFP-10G-SR , VID: V02 , SN: AGD12344196
NAME: "Fan", DESCR: "FanTray"
PID: WS-X4597-E , VID: V01 , SN: FOX1309HCYF
NAME: "Power Supply 1", DESCR: "Power Supply ( AC 1400W )"
PID: PWR-C45-1400AC , VID: V04 , SN: DTH11177255
NAME: "Power Supply 2", DESCR: "Power Supply ( AC 1300W )"
PID: PWR-C45-1300ACV , VID: V05 , SN: DTM123900VH
Callista-4507E#]]></aml-block:Data>
</aml-block:Attachment>
</aml-block:Attachments>
</aml-block:Block>
</soap-env:Body>
</soap-env:Envelope>
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 52-43
Chapter 52 Configuring Call Home
Message Contents
Software Configuration Guide—Release IOS-XE 3.1.0 SG
52-44 OL-22250-01
CH A P T E R 53
Performing Diagnostics
You can use diagnostics to test and verify the functionality of the hardware components of your system
(chassis, supervisor engines, modules, and ASICs) while your Catalyst 4500 series switch is connected
to a live network. Diagnostics consists of packet-switching tests that test hardware components and
verify the data path and control signals.
Online diagnostics are categorized as bootup, on-demand, schedule, or health-monitoring diagnostics.
Bootup diagnostics run during bootup; on-demand diagnostics run from the CLI; scheduled diagnostics
run at user-designated intervals or specified times when the switch is connected to a live network; and
health-monitoring runs in the background.
This chapter consists of these sections:
• Configuring Online Diagnostics, page 53-1
• Performing Diagnostics, page 53-2
• Power-On Self-Test Diagnostics, page 53-9
Note For complete syntax and usage information for the switch commands used in this chapter, refer to the
Catalyst 4500 Series Switch Cisco IOS Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Configuring Online Diagnostics
These sections describe how to configure online diagnostics:
• Configuring On-Demand Online Diagnostics, page 53-1
• Scheduling Online Diagnostics, page 53-2
Configuring On-Demand Online Diagnostics
You can run on-demand online diagnostic tests from the CLI. You can set the execution action to either
stop or continue the test when a failure is detected, or to stop the test after a specific number of failures
occur with the failure count setting. The iteration setting allows you to configure a test to run multiple
times.
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 53-1
Chapter 53 Performing Diagnostics
To schedule online diagnostics, perform this task:
{
Command Purpose
Switch# diagnostic ondemand Configures on-demand diagnostic tests to run, how many
{iteration iteration_count} | times to run (iterations), and what action to take when errors
{action-on-error {continue | stop}
[error_count]}
are found.
This example shows how to set the on-demand testing iteration count:
Switch# diagnostic ondemand iterations 3
Switch#
This example shows how to set the execution action when an error is detected:
Switch# diagnostic ondemand action-on-fAilure continue 2
Switch#
Scheduling Online Diagnostics
You can schedule online diagnostics to run at a designated time of day or on a daily, weekly, or monthly
basis. You can schedule tests to run only once or to repeat at an interval. Use the no form of this
command to remove the scheduling.
To configure online diagnostics, perform this task:
Command Purpose
Switch(config)# diagnostic Schedules on-demand diagnostic tests on the specified
schedule module number test module for a specific date and time, how many times to run
{test_id | test_id_range | all}
[port {num | num_range | all} {on
(iterations), and what action to take when errors are found.
mm dd yyyy hh:mm} | {daily hh:mm}
| {weekly day_of_week hh:mm}}
This example shows how to schedule diagnostic testing on a specific date and time for a specific port on
module 6:
Switch(config)# diagnostic schedule module 6 test 2 port 3 on may 23 2009 23:32
Switch(config)#
This example shows how to schedule diagnostic testing to occur daily:
Switch(config)# diagnostic schedule module 6 test 2 port 3 daily 12:34
Switch(config)#
This example shows how to schedule diagnostic testing to occur weekly:
Switch(config)# diagnostic schedule module 6 test 2 port 3 weekly friday 09:23
Switch(config)#
Performing Diagnostics
After you configure online diagnostics, you can start or stop diagnostic tests or display the test results.
You can also see which tests are configured and what diagnostic tests have already run.
Software Configuration Guide—Release 12.2(52)SG
53-2 OL-16048-01
Chapter 53 Performing Diagnostics
These sections describe how to run online diagnostic tests after they have been configured:
• Starting and Stopping Online Diagnostic Tests, page 53-3
• Displaying Online Diagnostic Tests and Test Results, page 53-4
• Line card Online Diagnostics, page 53-7
• Troubleshooting with Online Diagnostics, page 53-7
Note Before you enable any online diagnostics tests, enable the logging console or monitor to observe all
warning messages.
Note When running disruptive tests, only run them when you are connected through the console. When
disruptive tests complete, a warning message on the console will recommend that you reload the system
to return to normal operation. Strictly follow this warning.
Starting and Stopping Online Diagnostic Tests
After you configure diagnostic tests, you can use the start and stop keywords to begin or end a test.
To start or stop an online diagnostic command, perform one of these tasks:
Command Purpose
Switch# diagnostic start module Starts a diagnostic test on a port or range of ports on the
number test {test_id | specified module.
test_id_range | minimal | complete
| basic | per-port |
non-disruptive | all} [port {num |
port#_range | all}]
Switch# diagnostic stop module Stops a diagnostic test on the specified module.
number
This example shows how to start a diagnostic test on module 6:
Switch# diagnostic start module 6 test 2
Diagnostic[module 6]: Running test(s) 2 Run interface level cable diags
Diagnostic[module 6]: Running test(s) 2 may disrupt normal system operation
Do you want to continue? [no]: yes
Switch#
*May 14 21:11:46.631: %DIAG-6-TEST_RUNNING: module 6: Running online-diag-tdr{ID=2} ...
*May 14 21:11:46.631: %DIAG-6-TEST_OK: module 6: online-diag-tdr{ID=2} has completed
successfully
Switch#
This example shows how to stop a diagnostic test on module 6:
Switch# diagnostic stop module 6
Diagnostic[module 6]: Diagnostic is not active.
The message indicates no active diagnostic on module 6
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 53-3
Chapter 53 Performing Diagnostics
Displaying Online Diagnostic Tests and Test Results
You can display the configured online diagnostic tests and check the results of the tests with the show
diagnostic command.
To display the configured diagnostic tests, perform this task:
Command Purpose
Switch# show diagnostic content [ Displays diagnostic test information for a module.
module { num | all } ]
Switch# show diagnostic Displays test description for a given test on a module.
description module num [ test
test_id ]
Switch# show diagnostic events Displays diagnostic event log.
Switch# show diagnostic ondemand Displays ondemand test configuration.
settings
Switch# show diagnostic result Shows diagnostic test results.
module { num | all } [ detail |
failure | xml | test { test_id |
test_range | all } [ detail ] ]
Switch# show diagnostic schedule Shows diagnostic schedule for module.
module { num | all }
Switch# show diagnostic status Shows status of currently running diagnostic tests.
This example shows how to display the online diagnostics configured on module 1:
Switch# show diagnostic content module 6
module 6:
Diagnostics test suite attributes:
M/C/* - Minimal bootup level test / Complete bootup level test / NA
B/* - Basic ondemand test / NA
P/V/* - Per port test / Per device test / NA
D/N/* - Disruptive test / Non-disruptive test / NA
S/* - Only applicable to standby unit / NA
X/* - Not a health monitoring test / NA
F/* - Fixed monitoring interval test / NA
E/* - Always enabled monitoring test / NA
A/I - Monitoring is active / Monitoring is inactive
cable-tdr/* - Interface cable diags / NA
o/* - Ongoing test, always active / NA
Test Interval Thre-
ID Test Name Attributes day hh:mm:ss.ms shold
==== ================================== ============ =============== =====
1) linecard-online-diag ------------> M**D****I** not configured n/a
2) online-diag-tdr -----------------> **PD****Icable- not configured n/a
This example shows how to display the test description for a given test on a module:
Switch# show diagnostic description module 6 test 1
linecard-online-diag :
Linecard online-diagnostics run after the system boots up but
before it starts passing traffic. Each linecard port is placed in
loopback, and a few packets are injected into the switching fabric
from the cpu to the port. If the packets are successfully
received by the cpu, the port passes the test. Sometimes one port
Software Configuration Guide—Release 12.2(52)SG
53-4 OL-16048-01
Chapter 53 Performing Diagnostics
or a group of ports sharing common components fail. The linecard
is then placed in partial faulty mode. If no ports can loop back
traffic, the board is placed in faulty state.
Switch#
This example shows how to display the online diagnostic results for module 6:
Switch# show diagnostic result module 6
Current bootup diagnostic level: minimal
module 6: SerialNo : JAB0815059L
Overall Diagnostic Result for module 6 : PASS
Diagnostic level at card bootup: minimal
Test results: (. = Pass, F = Fail, U = Untested)
1) linecard-online-diag ------------> .
2) online-diag-tdr:
Port 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
----------------------------------------------------------------------------
U U . U U U U U U U U U U U U U U U U U U U U U
Switch#
This example shows how to display the online diagnostic results details for module 6:
Switch# show diagnostic result module 6 detail
Current bootup diagnostic level: minimal
module 6: SerialNo : JAB0815059L
Overall Diagnostic Result for module 6 : PASS
Diagnostic level at card bootup: minimal
Test results: (. = Pass, F = Fail, U = Untested)
___________________________________________________________________________
1) linecard-online-diag ------------> .
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 1
Last test testing type ------> n/a
Last test execution time ----> Jun 01 2009 11:19:36
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Jun 01 2009 11:19:36
Total failure count ---------> 0
Consecutive failure count ---> 0
Slot Ports Card Type Diag Status Diag Details
---- ----- -------------------------------------- ---------------- ------------
6 24 10/100/1000BaseT (RJ45)V, Cisco/IEEE Passed None
Detailed Status
---------------
. = Pass U = Unknown
L = Loopback failure S = Stub failure
P = Port failure
E = SEEPROM failure G = GBIC integrity check failure
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 53-5
Chapter 53 Performing Diagnostics
Ports 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
. . . . . . . . . . . . . . . .
Ports 17 18 19 20 21 22 23 24
. . . . . . . .
___________________________________________________________________________
2) online-diag-tdr:
Port 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
----------------------------------------------------------------------------
U U . U U U U U U U U U U U U U U U U U U U U U
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 1
Last test testing type ------> OnDemand
Last test execution time ----> Jun 03 2009 05:39:00
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Jun 03 2009 05:39:00
Total failure count ---------> 0
Consecutive failure count ---> 0
Detailed Status
---------------
Interface Speed Local pair Cable length Remote channel Status
Gi6/3 1Gbps 1-2 N/A Unknown Terminated
3-6 N/A Unknown Terminated
4-5 N/A Unknown Terminated
7-8 N/A Unknown Terminated
___________________________________________________________________________
Switch#
This example shows how to display diagnostic events:
Switch# show diagnostic events
Diagnostic events (storage for 500 events, 3 events recorded)
Number of events matching above criteria = 3
Event Type (ET): I - Info, W - Warning, E - Error
Time Stamp ET [Card] Event Message
------------------ -- ------ --------------------------------------------------
02/03 04:17:45.063 I [1] stub-rx-errors Passed
02/03 04:17:45.095 I [1] stub-rx-errors Passed
02/03 04:17:45.127 I [1] stub-rx-errors Passed
This example shows how to display ondemand test settings:
Switch# show diagnostic ondemand settings
Test iterations = 3
Action on test failure = continue until test failure limit reaches 5
This example shows how to display the test schedule for a module:
Switch# show diagnostic schedule module 1
Current Time = 07:10:53 UTC Sat Feb 3 2001
Diagnostic for module 1 is not scheduled.
Software Configuration Guide—Release 12.2(52)SG
53-6 OL-16048-01
Chapter 53 Performing Diagnostics
This example shows how to display the status of currently running tests
Switch# show diagnostic status
<BU> - Bootup Diagnostics, <HM> - Health Monitoring Diagnostics,
<OD> - OnDemand Diagnostics, <SCH> - Scheduled Diagnostics
====== ================================= =============================== ======
Card Description Current Running Test Run by
------ --------------------------------- ------------------------------- ------
1 N/A N/A
====== ================================= =============================== ======
Line card Online Diagnostics
A line card online diagnostic test verifies that all ports on a line card are working correctly. The test can
detect whether the path to the front panel port on the line card is broken. The test cannot indicate where
along the path that the problem occurred.
Note This test is run only for line cards that have stub chips.
Line card online diagnostics runs only once, when the line cards boot. This situation can happen when
you insert a linecard or power up a chassis.
Line card online diagnostics are performed by sending a packet from the CPU to every port on the line
card. Because this packet is marked loopback, the CPU expects to see this packet return from the port.
The packet first traverses the ASICs on the supervisor engine card, then travels via the chassis backplane
and the stub chip on the line cards to the PHYs. The PHY sends it back down the same path.
Note The packet does not reach or exit the front panel port.
Troubleshooting with Online Diagnostics
A faulty line card occurs if any of the following conditions occurs.
• All ports fail
• All ports on a stub chip fail
• Only one port fails
For all of these situations, the output of the show module command would display the status of the line
card as faulty:
Switch# show mod
Chassis Type : WS-C4507R
Power consumed by backplane : 40 Watts
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 53-7
Chapter 53 Performing Diagnostics
Mod Ports Card Type Model Serial No.
---+-----+--------------------------------------+------------------+-----------
1 6 Sup II+10GE 10GE (X2), 1000BaseX (SFP) WS-X4013+10GE JAB091502G0
2 6 Sup II+10GE 10GE (X2), 1000BaseX (SFP) WS-X4013+10GE JAB091502FC
3 48 100BaseX (SFP) WS-X4248-FE-SFP JAB093305RP
4 48 10/100BaseTX (RJ45)V WS-X4148-RJ45V JAE070717E5
5 48 10/100BaseTX (RJ45)V WS-X4148-RJ45V JAE061303U3
6 48 10/100BaseTX (RJ45)V WS-X4148-RJ45V JAE061303WJ
7 24 10/100/1000BaseT (RJ45)V, Cisco/IEEE WS-X4524-GB-RJ45V JAB0815059Q
M MAC addresses Hw Fw Sw Status
--+--------------------------------+---+------------+----------------+---------
1 000b.5f27.8b80 to 000b.5f27.8b85 0.2 12.2(27r)SG( 12.2(37)SG Ok
2 000b.5f27.8b86 to 000b.5f27.8b8b 0.2 12.2(27r)SG( 12.2(37)SG Ok
3 0005.9a80.6810 to 0005.9a80.683f 0.4 Ok
4 000c.3016.aae0 to 000c.3016.ab0f 2.6 Ok
5 0008.a3a3.4e70 to 0008.a3a3.4e9f 1.6 Ok
6 0008.a3a3.3fa0 to 0008.a3a3.3fcf 1.6 Faulty
7 0030.850e.3e78 to 0030.850e.3e8f 1.0 Ok
Mod Redundancy role Operating mode Redundancy status
----+-------------------+-------------------+----------------------------------
1 Active Supervisor SSO Active
2 Standby Supervisor SSO Standby hot
To troubleshoot a faulty line card, do the following:
Step 1 Enter the command show diagnostic result module 3.
If a faulty line card was inserted in the chassis, it will fail the diagnostics and the output will be similar
to the following:
Current bootup diagnostic level: minimal
module 3: SerialNo : JAB093305RP
Overall Diagnostic Result for module 3 : MAJOR ERROR
Diagnostic level at card bootup: minimal
Test results: (. = Pass, F = Fail, U = Untested)
1) linecard-online-diag ------------> F
Switch#
Issue an RMA for the line card, contact TAC, and skip steps 2 and 3.
The output may display the following:
module 3:
Overall diagnostic result: PASS
Test results: (. = Pass, F = Fail, U = Untested)
1) linecard-online-diag --------------------> .
The message indicates that the line card passed online diagnostics either when it was inserted into the
chassis the last time or when the switch was powered up (as reported by the “.”). You need to obtain
additional information to determine the cause.
Software Configuration Guide—Release 12.2(52)SG
53-8 OL-16048-01
Chapter 53 Performing Diagnostics
Step 2 Insert a different supervisor engine card and reinsert the line card.
If the linecard passes the test, it suggests that the supervisor engine card is defective.
Issue an RMA for the supervisor engine, contact TAC, and skip step 3.
Because online diagnostics does not run on the supervisor engine card, you cannot use the
#show diagnostic module 1 command to test whether the supervisor engine card is faulty.
Step 3 Reinsert the linecard in a different chassis.
If the linecard passes the test, the problem is associated with the chassis.
Issue an RMA for the chassis and contact TAC.
Power-On Self-Test Diagnostics
The following topics are discussed:
• Overview, page 53-9
• Sample POST Results, page 53-10
• Power-On Self-Test Results for Supervisor Engine V-10GE, page 53-14
• Troubleshooting the Test Failures, page 53-20
Overview
All Catalyst 4500 series switches have power-on self-test (POST) diagnostics that run whenever a
supervisor engine boots. POST tests the basic hardware functionality for the supervisor switching
engine, its associated packet memory and other on-board hardware components. The results of the POST
impacts how the switch boots, because the health of the supervisor engine is critical to the operation of
the switch. The switch might boot in a marginal or faulty state.
POST is currently supported on the following supervisor engines:
• WS-X4014
• WS-X4515
• WS-X4516
• WS-X4516-10GE
• WS-X4013+
• WS-X4013+TS
• WS-X4013+10GE
• WS-C4948G
• WS-C4948G-10GE
• ME-4924-10GE
• WS-X45-SUP6-E
• WS-X45-SUP6L-E
The POST results are indicated with a period (.) or a Pass for Pass, an F for a Fail and a U for Untested.
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 53-9
Chapter 53 Performing Diagnostics
Note A supervisor engine runs POST during boot up (insertion or power on). In a redundant topology, both
supervisor engines run POST individually. Switchovers are allowed only after both supervisor engines
have booted. During a switchover, the standby supervisor engine does not run POST again because it
has already booted.
Sample POST Results
For all the supervisor engines, POST performs CPU, traffic, system, system memory, and feature tests.
For CPU tests, POST verifies appropriate activity of the supervisor SEEPROM, temperature sensor, and
Ethernet end-of-band channel (EOBC), when used.
The following example illustrates the output of a CPU subsystem test on all supervisor engines except
the WS-X4013+TS:
[..]
Cpu Subsystem Tests ...
seeprom: . temperature_sensor: . eobc: .
[..]
The following example illustrates the output of a CPU subsystem test on a WS-X4013+TS supervisor
engine.
[..]
Cpu Subsystem Tests ...
seeprom: . temperature_sensor: .
[..]
For traffic tests, POST sends packets from the CPU to the switch. These packets loop several times
within the switch core and validate the switching, the Layer 2 and the Layer 3 functionality. To isolate
the hardware failures accurately, the loop back is done both inside and outside the switch ports.
The following example illustrates the output of a Layer 2 traffic test at the switch ports on the supervisor
engines WS-X4516, WS-X4516-10GE, WS-X4013+10GE, WS-C4948G-10GE:
Port Traffic: L2 Serdes Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: .
36: . 37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: .
The following example illustrates the output of a Layer 2 traffic test at the switch ports on the supervisor
engines WS-X4013+TS, WS-X4515, WS-X4013+, WS-X4014, WS-C4948G:
Port Traffic: L2 Serdes Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31:
POST also performs tests on the packet and system memory of the switch. These are numbered
dynamically in ascending order starting with 1 and represent different memories.
The following example illustrates the output from a system memory test:
Switch Subsystem Memory ...
1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: . 12: .
13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: . 24: .
25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: . 36: .
37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: . 48: .
49: . 50: . 51: . 52: . 53: . 54: . 55: .
Software Configuration Guide—Release 12.2(52)SG
53-10 OL-16048-01
Chapter 53 Performing Diagnostics
POST also tests the NetFlow services card (Supervisor Engine IV and Supervisor Engine V) and the
NetFlow services feature (Supervisor Engine V -10GE). Failures from these tests are treated as marginal,
as they do not impact functionality of the switch (except for the unavailability of the NetFlow features):
Netflow Services Feature ...
se: . cf: . 52: . 53: . 54: . 55: . 56: . 57: . 58: . 59: . 60: . 61: .
62: . 63: . 64: . 65: .
Note Supervisor Engine VI-E retains most of the previous supervisor engines’ POST features including the
CPU subsystem tests, Layer 3 and Layer 2 traffic tests, and memory tests. Redundant ports on redundant
systems are not tested. All POST diagnostics are local to the supervisor engine running the tests.
The following example shows the output for a WS-X4516 supervisor engine:
Switch# show diagnostic result module 2 detail
module 2:
Overall diagnostic result: PASS
Test results: (. = Pass, F = Fail, U = Untested)
___________________________________________________________________________
1) supervisor-bootup -----------------------> .
Error code --------------------------> 0 (DIAG_SUCCESS)
Total run count ---------------------> 1
Last test execution time ------------> Jul 20 2005 14:15:52
First test failure time -------------> n/a
Last test failure time --------------> n/a
Last test pass time -----------------> Jul 20 2005 14:15:52
Total failure count -----------------> 0
Consecutive failure count -----------> 0
Power-On-Self-Test Results for ACTIVE Supervisor
Power-on-self-test for Module 2: WS-X4516
Port/Test Status: (. = Pass, F = Fail, U = Untested)
Reset Reason: PowerUp RemoteDebug
Cpu Subsystem Tests ...
seeprom: . temperature_sensor: . eobc: .
Port Traffic: L2 Serdes Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: .
36: . 37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: .
Port Traffic: L2 Asic Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: .
36: . 37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: .
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 53-11
Chapter 53 Performing Diagnostics
Port Traffic: L3 Asic Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: .
36: . 37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: .
Switch Subsystem Memory ...
1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: . 12: .
13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: . 24: .
25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: . 36: .
37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: . 48: .
49: . 50: . 51: . 52: . 53: . 54: . 55: .
Module 2 Passed
___________________________________________________________________________
2) packet-memory-bootup --------------------> U
Error code --------------------------> 0 (DIAG_SUCCESS)
Total run count ---------------------> 0
Last test execution time ------------> n/a
First test failure time -------------> n/a
Last test failure time --------------> n/a
Last test pass time -----------------> n/a
Total failure count -----------------> 0
Consecutive failure count -----------> 0
packet buffers on free list: 64557 bad: 0 used for ongoing tests: 979
Exhaustive packet memory tests did not run at bootup.
Bootup test results:5
No errors.
___________________________________________________________________________
3) packet-memory-ongoing -------------------> U
Error code --------------------------> 0 (DIAG_SUCCESS)
Total run count ---------------------> 0
Last test execution time ------------> n/a
First test failure time -------------> n/a
Last test failure time --------------> n/a
Last test pass time -----------------> n/a
Total failure count -----------------> 0
Consecutive failure count -----------> 0
packet buffers on free list: 64557 bad: 0 used for ongoing tests: 979
Packet memory errors: 0 0
Current alert level: green
Per 5 seconds in the last minute:
0 0 0 0 0 0 0 0 0 0
0 0
Per minute in the last hour:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Software Configuration Guide—Release 12.2(52)SG
53-12 OL-16048-01
Chapter 53 Performing Diagnostics
0 0 0 0 0 0 0 0 0 0
Per hour in the last day:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0
Per day in the last 30 days:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Direct memory test failures per minute in the last hour:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Potential false positives: 0 0
Ignored because of rx errors: 0 0
Ignored because of cdm fifo overrun: 0 0
Ignored because of oir: 0 0
Ignored because isl frames received: 0 0
Ignored during boot: 0 0
Ignored after writing hw stats: 0 0
Ignored on high gigaport: 0
Ongoing diag action mode: Normal
Last 1000 Memory Test Failures:
Last 1000 Packet Memory errors:
First 1000 Packet Memory errors:
___________________________________________________________________________
Switch#
The following example shows the output for a WS-X45-SUP6-E supervisor engine:
Switch# show diagnostic result module 3 detail
module 3: SerialNo : XXXXXXXXXXX
Overall diagnostic result: PASS
Test results: (. = Pass, F = Fail, U = Untested)
___________________________________________________________________________
1) supervisor-bootup --------------->
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 1
Last test execution time ----> Oct 01 2007 17:37:04
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Oct 01 2007 17:37:04
Total failure count ---------> 0
Consecutive failure count ---> 0
Power-On-Self-Test Results for ACTIVE Supervisor
prod: WS-X45-SUP6-E part: XXXXXXXXX serial: XXXXXXXXXX
Power-on-self-test for Module 3: WS-X45-SUP6-E
Test Status: (. = Pass, F = Fail, U = Untested)
CPU Subsystem Tests ...
seeprom: Pass
Traffic: L3 Loopback ...
Test Results: Pass
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 53-13
Chapter 53 Performing Diagnostics
Traffic: L2 Loopback ...
Test Results: Pass
Switching Subsystem Memory ...
Packet Memory Test Results: Pass
Module 3 Passed
___________________________________________________________________________
2) linecard-online-diag ------------>
Error code ------------------> 0 (DIAG_SUCCESS)
Total run count -------------> 1
Last test execution time ----> Oct 01 2007 17:37:04
First test failure time -----> n/a
Last test failure time ------> n/a
Last test pass time ---------> Oct 01 2007 17:37:04
Total failure count ---------> 0
Consecutive failure count ---> 0
Slot Ports Card Type Diag Status Diag Details
---- ----- -------------------------------------- ---------------- ------------
3 6 Sup 6-E 10GE (X2), 1000BaseX (SFP) Skipped Packet memory
Detailed Status
---------------
. = Pass U = Unknown
L = Loopback failure S = Stub failure
P = Port failure
E = SEEPROM failure G = GBIC integrity check failure
Ports 1 2 3 4 5 6
. . . . . .
___________________________________________________________________________
Switch#
Power-On Self-Test Results for Supervisor Engine V-10GE
For the Supervisor Engine V-10GE (WS-X4516-10GE), POST tests extra redundancy features on the
10-Gigabit ports.
The following topics are discussed:
• POST on the Active Supervisor Engine, page 53-14
• Sample POST Results on an Active Supervisor Engine, page 53-15
• POST on a Standby Supervisor Engine, page 53-17
• Sample Display of the POST on a Standby Supervisor Engine, page 53-17
POST on the Active Supervisor Engine
The active supervisor engine tests the remote redundant 10-Gigabit ports on the standby supervisor
engine if it is present when the active supervisor engine is booting. The status of the port is displayed as
“Remote TenGigabit Port Status.” If no standby supervisor engine is present, the remote port status is
always displayed as Untested. This situation persists even after a new standby supervisor engine is
inserted. The remaining tests are conducted using only the Gigabit ports’ configuration.
After the active supervisor engine has completed the bootup diagnostics, if the standby supervisor
engine is now removed, the remote port status is changed to Untested in the overall diagnostic results.
Software Configuration Guide—Release 12.2(52)SG
53-14 OL-16048-01
Chapter 53 Performing Diagnostics
Sample POST Results on an Active Supervisor Engine
Switch# show diagnostic result module 1 detail
module 1:
Overall diagnostic result: PASS
Test results: (. = Pass, F = Fail, U = Untested)
___________________________________________________________________________
1) supervisor-bootup -----------------------> .
Error code --------------------------> 0 (DIAG_SUCCESS)
Total run count ---------------------> 1
Last test execution time ------------> Jul 19 2005 13:28:16
First test failure time -------------> n/a
Last test failure time --------------> n/a
Last test pass time -----------------> Jul 19 2005 13:28:16
Total failure count -----------------> 0
Consecutive failure count -----------> 0
Power-On-Self-Test Results for ACTIVE Supervisor
Power-on-self-test for Module 1: WS-X4516-10GE
Port/Test Status: (. = Pass, F = Fail, U = Untested)
Reset Reason: Software/User
Cpu Subsystem Tests ...
seeprom: . temperature_sensor: . eobc: .
Port Traffic: L3 Serdes Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: .
36: . 37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: .
Local 10GE Port 62: .
Local 10GE Port 63: .
Port Traffic: L2 Serdes Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: .
36: . 37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: .
48: . 49: . 50: . 51: .
Port Traffic: L2 Asic Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: .
36: . 37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: .
48: . 49: . 50: . 51: .
Switch Subsystem Memory ...
1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: . 12: .
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 53-15
Chapter 53 Performing Diagnostics
13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: . 24: .
25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: . 36: .
37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: . 48: .
49: . 50: . 51: .
Netflow Services Feature ...
se: . cf: . 52: . 53: . 54: . 55: . 56: . 57: . 58: . 59: . 60: . 61: .
62: . 63: . 64: . 65: .
Module 1 Passed
Remote TenGigabitPort status: Passed
___________________________________________________________________________
2) packet-memory-bootup --------------------> U
Error code --------------------------> 0 (DIAG_SUCCESS)
Total run count ---------------------> 0
Last test execution time ------------> n/a
First test failure time -------------> n/a
Last test failure time --------------> n/a
Last test pass time -----------------> n/a
Total failure count -----------------> 0
Consecutive failure count -----------> 0
packet buffers on free list: 64557 bad: 0 used for ongoing tests: 979
Exhaustive packet memory tests did not run at bootup.
Bootup test results:5
No errors.
___________________________________________________________________________
3) packet-memory-ongoing -------------------> U
Error code --------------------------> 0 (DIAG_SUCCESS)
Total run count ---------------------> 0
Last test execution time ------------> n/a
First test failure time -------------> n/a
Last test failure time --------------> n/a
Last test pass time -----------------> n/a
Total failure count -----------------> 0
Consecutive failure count -----------> 0
packet buffers on free list: 64557 bad: 0 used for ongoing tests: 979
Packet memory errors: 0 0
Current alert level: green
Per 5 seconds in the last minute:
0 0 0 0 0 0 0 0 0 0
0 0
Per minute in the last hour:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Per hour in the last day:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Software Configuration Guide—Release 12.2(52)SG
53-16 OL-16048-01
Chapter 53 Performing Diagnostics
0 0 0 0
Per day in the last 30 days:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Direct memory test failures per minute in the last hour:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Potential false positives: 0 0
Ignored because of rx errors: 0 0
Ignored because of cdm fifo overrun: 0 0
Ignored because of oir: 0 0
Ignored because isl frames received: 0 0
Ignored during boot: 0 0
Ignored after writing hw stats: 0 0
Ignored on high gigaport: 0
Ongoing diag action mode: Normal
Last 1000 Memory Test Failures:
Last 1000 Packet Memory errors:
First 1000 Packet Memory errors:
___________________________________________________________________________
Switch#
POST on a Standby Supervisor Engine
Ports 62 and 63 of the supervisor engine always remain Untested (U). Because the standby supervisor
engine never tests the remote 10-Gigabit port on the active supervisor engine, the remote 10-Gigabit port
status on the standby supervisor engine is always Untested. The supervisor engine performs the
remaining tests using the Gigabit ports’ configuration.
Note On a redundant chassis, concurrent POST is supported on supervisor engines that are already inserted.
However, if a second supervisor engine is inserted while the first one is loading, you might boot the first
supervisor engine in a faulty IOS state (POST will abort and some of the POST’s tests will be bypassed).
This situation only happens during concurrent bootup of the supervisor engines. You should not insert
any additional supervisor engines in the empty supervisor engine slot while an already seated supervisor
engine is running POST. The POST sequence is completed when the “Exiting to ios...” message is
displayed.
Sample Display of the POST on a Standby Supervisor Engine
Switch# show diagnostic result module 2 detail
module 2:
Overall diagnostic result: PASS
Test results: (. = Pass, F = Fail, U = Untested)
___________________________________________________________________________
1) supervisor-bootup -----------------------> .
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 53-17
Chapter 53 Performing Diagnostics
Error code --------------------------> 0 (DIAG_SUCCESS)
Total run count ---------------------> 1
Last test execution time ------------> Jul 19 2005 13:29:44
First test failure time -------------> n/a
Last test failure time --------------> n/a
Last test pass time -----------------> Jul 19 2005 13:29:44
Total failure count -----------------> 0
Consecutive failure count -----------> 0
Power-On-Self-Test Results for ACTIVE Supervisor
Power-on-self-test for Module 2: WS-X4516-10GE
Port/Test Status: (. = Pass, F = Fail, U = Untested)
Reset Reason: OtherSupervisor Software/User
Cpu Subsystem Tests ...
seeprom: . temperature_sensor: . eobc: .
Port Traffic: L3 Serdes Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: .
36: . 37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: .
Local 10GE Port 62: U
Local 10GE Port 63: U
Port Traffic: L2 Serdes Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: .
36: . 37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: .
48: . 49: . 50: . 51: .
Port Traffic: L2 Asic Loopback ...
0: . 1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: .
12: . 13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: .
24: . 25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: .
36: . 37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: .
48: . 49: . 50: . 51: .
Switch Subsystem Memory ...
1: . 2: . 3: . 4: . 5: . 6: . 7: . 8: . 9: . 10: . 11: . 12: .
13: . 14: . 15: . 16: . 17: . 18: . 19: . 20: . 21: . 22: . 23: . 24: .
25: . 26: . 27: . 28: . 29: . 30: . 31: . 32: . 33: . 34: . 35: . 36: .
37: . 38: . 39: . 40: . 41: . 42: . 43: . 44: . 45: . 46: . 47: . 48: .
49: . 50: . 51: .
Netflow Services Feature ...
se: . cf: . 52: . 53: . 54: . 55: . 56: . 57: . 58: . 59: . 60: . 61: .
62: . 63: . 64: . 65: .
Module 2 Passed
Remote TenGigabitPort status: Untested
Software Configuration Guide—Release 12.2(52)SG
53-18 OL-16048-01
Chapter 53 Performing Diagnostics
___________________________________________________________________________
2) packet-memory-bootup --------------------> U
Error code --------------------------> 0 (DIAG_SUCCESS)
Total run count ---------------------> 0
Last test execution time ------------> n/a
First test failure time -------------> n/a
Last test failure time --------------> n/a
Last test pass time -----------------> n/a
Total failure count -----------------> 0
Consecutive failure count -----------> 0
packet buffers on free list: 64557 bad: 0 used for ongoing tests: 979
Exhaustive packet memory tests did not run at bootup.
Bootup test results:5
No errors.
___________________________________________________________________________
3) packet-memory-ongoing -------------------> U
Error code --------------------------> 0 (DIAG_SUCCESS)
Total run count ---------------------> 0
Last test execution time ------------> n/a
First test failure time -------------> n/a
Last test failure time --------------> n/a
Last test pass time -----------------> n/a
Total failure count -----------------> 0
Consecutive failure count -----------> 0
packet buffers on free list: 64557 bad: 0 used for ongoing tests: 979
Packet memory errors: 0 0
Current alert level: green
Per 5 seconds in the last minute:
0 0 0 0 0 0 0 0 0 0
0 0
Per minute in the last hour:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Per hour in the last day:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0
Per day in the last 30 days:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Direct memory test failures per minute in the last hour:
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
Potential false positives: 0 0
Ignored because of rx errors: 0 0
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 53-19
Chapter 53 Performing Diagnostics
Ignored because of cdm fifo overrun: 0 0
Ignored because of oir: 0 0
Ignored because isl frames received: 0 0
Ignored during boot: 0 0
Ignored after writing hw stats: 0 0
Ignored on high gigaport: 0
Ongoing diag action mode: Normal
Last 1000 Memory Test Failures:
Last 1000 Packet Memory errors:
First 1000 Packet Memory errors:
___________________________________________________________________________
Switch#
Note To ensure that the maximum number of ports are tested, ensure that both supervisor engines are present
on power-up.
Troubleshooting the Test Failures
A failure of any of the POST tests reflects a problem with the hardware on the supervisor engine.
Cisco IOS boots the supervisor engine with limited functionality, allowing the user to evaluate and
display the diagnostic test results. To determine the failure cause, do one of the following:
• Evaluate whether the hardware failure is persistent by power cycling the supervisor engine to rerun
the POST tests.
• Remove and reinsert the supervisor engine into the chassis to ensure that the seating is correct.
Please call the Cisco Systems customer support team for more information.
Note On a redundant chassis, concurrent POST is supported on supervisor engines that are already inserted.
However, if a second supervisor engine is inserted while the first one is loading, you might boot the first
supervisor engine in a faulty Cisco IOS state (POST will abort, and some of the POST”s tests will be
bypassed). This situation only happens during concurrent bootup of the supervisor engines. You should
not insert any additional supervisor engines in the empty supervisor engine slot while an already seated
supervisor engine is running POST. The POST sequence is completed when the “Exiting to ios...”
message is displayed.
Software Configuration Guide—Release 12.2(52)SG
53-20 OL-16048-01
CH A P T E R 54
ROM Monitor
This appendix describes the Cisco Catalyst 4500 switch ROM monitor (also called the bootloader
program). The ROM monitor firmware runs when the switch is powered up or reset. The firmware helps
to initialize the hardware and boot the operating system software. Use the ROM monitor to perform
certain configuration tasks, such as recovering a lost password, booting an IOS image on the on-board
flash/removeable storage media/management port, and upgrading the Rommon image itself. If there is
no Cisco IOS software image loaded on the switch, the ROM monitor runs the switch.
This appendix contains the following sections:
• Entering the ROM Monitor, page 54-1
• ROM Monitor Commands, page 54-2
• Command Descriptions, page 54-2
• Configuration Register, page 54-3
• Exiting the ROM Monitor, page 54-5
• Digital Signing, page 54-6
Note For complete syntax and usage information for the switch commands used in this chapter, refer to the
Catalyst 4500 Series Switch Cisco IOS Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Entering the ROM Monitor
To use the ROM monitor, you must be using a terminal or PC that is connected to the switch over the
console port. Refer to the installation chapter in the Cisco Catalyst 4500 Switch Hardware Installation
Guide that came with the switch to connect the router to a PC or terminal..
Perform these steps to configure the switch to boot up in ROM monitor mode the next time it is rebooted.
Command Task
Step 1 enable Enters privileged EXEC mode.
Step 2 configure terminal Enters global configuration mode.
Step 3 config-reg 0x0 Resets the configuration register.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 54-1
Chapter 54 ROM Monitor
ROM Monitor Commands
Command Task
Step 4 exit Exits global configuration mode.
Step 5 reload Reboots the switch with the new
configuration register value. The router
remains in ROM monitor and does not boot
the Cisco IOS software.
As long as the configuration value is 0x0, you
must manually boot the operating system
from the console. See the boot command in
the “Command Descriptions” section in this
appendix.
After the switch reboots, it is in ROM monitor
mode. The number in the prompt increments
with each new line.
ROM Monitor Commands
Enter ? or help at the ROM monitor prompt to display a list of available commands and options, as
follows (commands are case sensitive):
rommon 1 >?
alias set and display aliases command
boot boot up an external process
clear clear configurations, use 'clear help' for more info
confreg configuration register utility
dev list the device table with physical device information
dir list filesystem information
gdb break into GDB debugger
help monitor builtin command help
history monitor command history
macstats print management port MAC statistics counters
meminfo main memory information
ping ping utility to determine network connectivity
repeat repeat a monitor command
reset system reset
set show/set environment vars, use 'set help' for more info
sprom serial eprom operations
unalias unset an alias
unset unset a monitor variable
version display Rom Monitor version information
rommon 2 >
Command Descriptions
Table 54-1 describes the most commonly used ROM monitor commands.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
54-2 OL-22250-01
Chapter 54 ROM Monitor
Configuration Register
Table 54-1 Most Commonly Used ROM Monitor Commands
Command Description
reset or i Resets and initializes the router, similar to a power up.
dev Lists boot device identifications on the switch; for example:
rommon 1 > dev
Device Table
============
Logical Physical Partition Status Begin Size Drive
Number Number Number sector in Kb Name
------- -------- --------- ------ -------- -------- --------
0 0 0 1 3f 16384 flash0:
1 0 1 1 81f0 824832 flash1:
2 0 2 1 19afa0 16384 flash2:
3 0 3 1 1a3190 142336 flash3:
4 0 4 0 0 0 flash4:
5 0 5 0 0 0 flash5:
6 1 0 0 0 0 slot0:
7 2 0 0 0 0 usb0:
rommon 2 >
dir device: Lists the files on the named device; flash, for example:
rommon 1 > dir bootflash:
Date Time Attribute Size Name
========== ===== ========== ========== ================
2010/04/14 18:15 lrwxrwxrwx 12 USER -> /flash1/USER
2010/04/16 17:54 drwxrwxrwx 4096 .rollback_timer
2010/04/14 18:16 drwxrwxrwx 4096 .compatibility
2010/04/15 17:54 -rw-rw-rw- 129168608 test.bin
Total space = 808548 KB
Available = 685644 KB
rommon 2 >
boot commands For more information about the ROM monitor boot commands, refer to the
Cisco IOS Configuration Guide and the Cisco IOS Command Reference.
b Boots the first image in Flash memory.
Configuration Register
The virtual configuration register is in nonvolatile RAM (NVRAM) and has the same functionality as
other Cisco switches/routers. You can view or modify the virtual configuration register from either the
ROM monitor or the operating system software. Within ROM monitor, you can change the configuration
register by allowing the ROM monitor to prompt you for the setting of each bit.
Entering the confreg command without an argument displays the contents of the virtual configuration
register and a prompt to alter the contents by describing the meaning of each bit. The new virtual
configuration register value is written into NVRAM but does not take effect until you reset or reboot the
switch.
The configuration register can be used to control the following things:
• Baud rate of the console part
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 54-3
Chapter 54 ROM Monitor
Configuration Register
• Autoboot settings
• Ignore IOS system configuration (useful for password recovery)
• Enabling/disabling the "break" character sequence (ie. Ctrl-C)
• Enabling/disabling of diagnostics mode
• Various other network connectivity settings
The following display shows an example of entering the confreg command:
rommon 1 > confreg
Configuration Summary :
=> console baud: 9600
=> autoboot from: autoboot disabled
do you wish to change the configuration? y/n [n]: y
enable "diagnostic mode"? y/n [n]:
enable "use net in IP bcast address"? y/n [n]:
enable "load rom after netboot fails"? y/n [n]:
enable "use all zero broadcast"? y/n [n]:
enable "break/abort has effect"? y/n [n]:
enable "ignore system config info"? y/n [n]:
change console baud rate? y/n [n]: y
enter rate:
0 = 9600, 1 = 4800, 2 = 1200, 3 = 2400
4 = 19200, 5 = 38400, 6 = 57600 [0]: 5
change the boot characteristics? y/n [n]: y
enter to boot:
0 = disable autoboot
1 = the first file from internal flash device
2 = commands specified in 'BOOT' environment variable
[0]: 2
Configuration Summary :
=> console baud: 38400
=> autoboot from: commands specified in 'BOOT' environment variable
do you wish to save this configuration? y/n [n]: y
You must reset or power cycle for new configuration to take effect
rommon 2 >
Debug Commands
The following ROM monitor commands can be useful during debugging:
• meminfo-displays the size main memory and the size of NVRAM; for example:
rommon 1 > meminfo
Main memory size: 2048 MB.
NVRAM size: 512KB
rommon 2 >
• ping—verifies network connectivity of the management interface port, as follows:
rommon 3 > ping 172.25.60.31
Software Configuration Guide—Release IOS-XE 3.1.0 SG
54-4 OL-22250-01
Chapter 54 ROM Monitor
Exiting the ROM Monitor
Host 172.25.60.31 is alive
rommon 4 >
• sprom—displays the contensts of various EEPROMs on the switch; as follows:
rommon 5 > sprom ?
Usage:sprom read sup
sprom read linecard <modnum> [submodule]
sprom read chassis
sprom read clock
sprom read fan
sprom read muxbuffer <modnum>
sprom read powersupply <1..2>
(modnum = 1..5)
rommon 6 >
• version—displays the version of the ROM monitor on the switch, as follows:
rommon 7 > version
Rom Monitor Program Version 15.0(1r)XO(SG1)
Compiled Sat 10-Apr-10 00:59 by BLD-k10_rommon.15.0_1r_SG1
Supervisor: WS-X45-SUP7-E Chassis: WS-C4507R-E
CPU Rev: 1.1, Board Rev: 8, Board Type: 101
CPLD Moka Rev: 7.0x2643.0x5956 Installed memory: 2048 MBytes
rommon 8 >
Exiting the ROM Monitor
You must configure the boot characteristics of the configuration register to boot a Cisco IOS image
from flash memory upon startup or reloading. You can either boot the first file from internal flash
memory or form an image specified in the 'BOOT' IOS environment variable (which is set when you
enter the IOS boot system filename command).
The following example shows how to modify the configuration register and cause the switch to boot the
first Cisco IOS image stored in flash memory:
rommon 1 > confreg
Configuration Summary :
=> console baud: 9600
do you wish to change the configuration? y/n [n]: y
enable "diagnostic mode"? y/n [n]: n
enable "use net in IP bcast address"? y/n [n]:
enable "load rom after netboot fails"? y/n [n]:
enable "use all zero broadcast"? y/n [n]:
enable "break/abort has effect"? y/n [n]:
enable "ignore system config info"? y/n [n]:
change console baud rate? y/n [n]:
change the boot characteristics? y/n [n]: y
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 54-5
Chapter 54 ROM Monitor
Digital Signing
enter to boot:
0 = disable autoboot
1 = the first file from internal flash device
2 = commands specified in 'BOOT' environment variable
[0]: 1
Configuration Summary :
=> console baud: 9600
=> autoboot from: the first file from internal flash device
do you wish to save this configuration? y/n [n]: y
You must reset or power cycle for new configuration to take effect
rommon 7 >
You must reset or power cycle for new config to take effect
rommon 2 >reset
Then, the switch boots the first Cisco IOS image in Flash memory.
Digital Signing
All bootable images (Rommon, Rommon upgrade utilities, IOS, offline diags, etc) are cryptographically
signed to guard against tampering as per the FIPS 140-3 standard. When an image is booted, this
signature is inspected. If the signature is valid, the image is allowed to boot. Otherwise, a suitable error
message is displayed and the image is not allowed to boot. The most common reason for signatures to
fail verification is due to image corruption caused by FTP'ing an image in ASCII mode or e-mailing the
image (some e-mail clients have been known to alter the contents of binary files). Other reasons include
a corrupted image and an image that has intentionally been tampered with or counterfeited.
An example of booting an image with a successful signature verification looks like this:
rommon 2 > boot bootflash:cat4500e-universalk9.SSA.03.00.00.1.63.150.1.XO.bin
loading image
Checking digital signature
bootflash:/cat4500e-universal.SSA.03.00.00.1.63.150.1.XO.bin: Digitally Signed Release
Software with key version A
An example of booting an image with a failed signature verification looks like this:
rommon 2 > boot bootflash:cat4500e-universalk9.SSA.03.00.00.1.63.150.1.XO.bin
loading image
Checking digital signature
Verification FAILED for image
bootflash:/cat4500e-universal.SSA.03.00.00.1.63.150.1.XO.bin, REASON: [reason string]
For more detailed information on Digital Signing, refer to the following URLs:
Configuration Fundamentals Configuration Guide, Cisco IOS XE Release 3S
http://www.cisco.com/en/US/docs/ios/ios_xe/fundamentals/configuration/guide/xe_3s/cf_xe_3s_book.
html
Cisco IOS Configuration Fundamentals Command Reference
http://www.cisco.com/en/US/docs/ios/fundamentals/command/reference/cf_book.html
Software Configuration Guide—Release IOS-XE 3.1.0 SG
54-6 OL-22250-01
CH A P T E R 55
Configuring MIB Support
This chapter describes how to configure SNMP and MIB support for the Catalyst 4500 series switch. It
includes the following sections:
• Determining MIB Support for Cisco IOS Releases, page 55-1
• Using Cisco IOS MIB Tools, page 55-2
• Downloading and Compiling MIBs, page 55-2
• Enabling SNMP Support, page 55-4
Note For complete syntax and usage information for the switch commands used in this chapter, look at the
Cisco Catalyst 4500 Series Switch Command Reference and related publications at this location:
http://www.cisco.com/en/US/products/hw/switches/ps4324/index.html
If the command is not found in the Catalyst 4500 Command Reference, it is located in the larger Cisco
IOS library. Refer to the Catalyst 4500 Series Switch Cisco IOS Command Reference and related
publications at this location:
http://www.cisco.com/en/US/products/ps6350/index.html
Determining MIB Support for Cisco IOS Releases
Follow these steps to determine which MIBs are included in the Cisco IOS release running on the
Catalyst 4500 series switch:
Step 1 Go to the Cisco MIBs Support page:
http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml
Step 2 Under Cisco LAN Switches, select a Cisco 4000 IOS to display a list of MIBs supported on the Cisco
4500 switches.
Step 3 Scroll through the list to find the release you are interested in.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 55-1
Chapter 55 Configuring MIB Support
Using Cisco IOS MIB Tools
Using Cisco IOS MIB Tools
This section describes how to access the Cisco MIB tools page. The MIB Locator finds MIBs in
Cisco IOS software releases. You can find general MIB information, instructions about how to use the
SNMP Object Navigator which translates SNMP object identifiers (OIDs) into SNMP names, and how
to load Cisco MIBs.
Follow these steps to access the Cisco IOS MIB tools site:
Step 1 Go to the Cisco Products and Services page:
http://tools.cisco.com/ITDIT/MIBS/servlet/index
Step 2 Click Cisco IOS MIB Locator to launch the application. The locator application allows you to find a
MIB in the following three ways.
From the Cisco IOS MIB Locator page, you can:
a. Click the drop-down menu and select the desired Cisco IOS software release.
b. From the Platform Family menu, select CAT4500-SUP7-E.
c. From the Feature Set menu, select from the following:
UNIVERSAL SSH, UNIVERSAL W/O CRYPTO, UNIVERSAL LITE SSH, UNIVERSAL
LITE W/O CRYPTO
Step 3 From the MIB Locator page, you can search by image name. For example, enter the following and click
the Submit button:
cat4500e-ipbasek9-mz.122-53.SG2.bin
Step 4 From the MIB Locator page, you can search for the MIB from the list of MIBs in the menu. You can
select one, or for multiple selections, hold down the CTRL key, then click the Submit button.
Note After you make a selection, follow the links and instructions.
Downloading and Compiling MIBs
The following sections provide information about how to download and compile MIBs for the
Catalyst 4500 series switch:
• Considerations for Working with MIBs
• Downloading MIBs
• Compiling MIBs
Considerations for Working with MIBs
While working with MIBs, consider the following:
Mismatches on Datatype Definitions
Software Configuration Guide—Release IOS-XE 3.1.0 SG
55-2 OL-22250-01
Chapter 55 Configuring MIB Support
Downloading and Compiling MIBs
• Mismatches on datatype definitions might cause compiler errors or warning messages. Although
Cisco MIB datatype definitions are not mismatched, some standard RFC MIBs do mismatch. For
example:
MIB A defines: SomeDatatype ::= INTEGER(0..100)
MIB B defines: SomeDatatype ::= INTEGER(1..50)
This example is considered to be a trivial error and the MIB loads successfully with a warning
message.
The next example is considered as a nontrivial error (even though the two definitions are essentially
equivalent), and the MIB is not successfully parsed.
MIB A defines: SomeDatatype ::= DisplayString
MIB B defines: SomeDatatype ::= OCTET STRING (SIZE(0..255))
If your MIB compiler treats these as errors, or you want to delete the warning messages, edit one of
the MIBs that define this same datatype so that the definitions match.
• Many MIBs import definitions from other MIBs. If your management application requires MIBs to
be loaded, and you experience problems with undefined objects, you might want to load the
following MIBs in this order:
SNMPv2-SMI.my
SNMPv2-TC.my
SNMPv2-MIB.my
RFC1213-MIB.my
IF-MIB.my
CISCO-SMI.my
CISCO-PRODUCTS-MIB.my
CISCO-TC.my
• For a list of SNMP OIDs assigned to MIB objects, go to the following URL and click on
SNMP Object Navigator and follow the links:
http://tools.cisco.com/ITDIT/MIBS/servlet/index
Note You must have a Cisco CCO name and password to access the MIB Locator.
• For information about how to download and compile Cisco MIBs, go to the following URL:
http://www.cisco.com/en/US/tech/tk648/tk362/technologies_tech_note09186a00800b4cee.shtml
Downloading MIBs
Follow these steps to download the MIBs onto your system if they are not already there:
Step 1 Review the considerations in the previous section (“Considerations for Working with MIBs”).
Step 2 Go to one of the following Cisco URLs. If the MIB you want to download is not there, try the other URL;
otherwise, go to one of the URLs in Step 5.
ftp://ftp.cisco.com/pub/mibs/v2
ftp://ftp.cisco.com/pub/mibs/v1
Step 3 Click the link for a MIB to download that MIB to your system.
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 55-3
Chapter 55 Configuring MIB Support
Enabling SNMP Support
Step 4 Select File > Save or File > Save As to save the MIB on your system.
Step 5 You can download industry-standard MIBs from the following URL:
• http://www.oidview.com/mibs/0/md-0-1.html
Compiling MIBs
If you plan to integrate the Catalyst 4500 series switch with an SNMP-based management application,
then you must also compile the MIBs for that platform. For example, if you are running HP OpenView
on a UNIX operating system, you must compile Catalyst 4500 series switch MIBs with the HP
OpenView Network Management System (NMS). For instructions, see the NMS documentation.
Enabling SNMP Support
The following procedure summarizes how to configure the Catalyst 4500 series switch for SNMP
support.
For detailed information about SNMP commands, see the following Cisco documents:
• Cisco IOS Release 12.3 Configuration Fundamentals and Network Management Configuration
Guide, “Monitoring the Router and Network” section, available at the following URL:
http://www.cisco.com/en/US/docs/ios/12_3/featlist/cfun_vcg.html
• Cisco IOS Release 12.3 Configuration Fundamentals and Network Management Command
Reference, Part 3: System Management Commands, “Router and Network Configuration
Commands” section, available at the the following URL:
http://www.cisco.com/en/US/docs/ios/12_3/configfun/command/reference/fun_r.html
To configure the Catalyst 4500 series switch for SNMP support, follow these steps:
Step 1 Set up your basic SNMP configuration through the command line interface (CLI) on the router. Note
that these basic configuration commands are issued for SNMP version 2c. For SNMP version 3, you
must also set up SNMP users and groups. (See the preceding list of documents for command and setup
information.)
a. Define SNMP read-only and read-write communities:
Router (config)# snmp-server community Read_Only_Community_Name ro
Router (config)# snmp-server community Read_Write_Community_Name rw
b. Configure SNMP views (to limit the range of objects accessible to different SNMP user groups):
Router (config)# snmp-server view view_name oid-tree {included | excluded}
Step 2 Identify (by IP address) the host to receive SNMP notifications from the router:
Router (config)# snmp-server host host
Step 3 Configure the router to generate notifications. You can use keywords to limit the number and types of
messages generated.
Router (config)# snmp-server enable traps [notification-type] [notification-option]
Software Configuration Guide—Release IOS-XE 3.1.0 SG
55-4 OL-22250-01
Chapter 55 Configuring MIB Support
Enabling SNMP Support
Step 4 Optional. Configure the router to generate SNMP notifications released to field replaceable units
(FRUs):
Router (config)# snmp-server enable traps fru-ctrl
Step 5 Optional. Configure the router to generate SNMP notifications related to environmental monitoring:
Router (config)# snmp-server enable traps envmon
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 55-5
Chapter 55 Configuring MIB Support
Enabling SNMP Support
Software Configuration Guide—Release IOS-XE 3.1.0 SG
55-6 OL-22250-01
A P P E N D I X A
Acronyms and Abbreviations
Table A-1 defines the acronyms and abbreviations used in this publication.
Table A-1 Acronyms
Acronym Expansion
ACE access control entry
ACL access control list
AFI authority and format identifier
Agport aggregation port
ALPS Airline Protocol Support
AMP Active Monitor Present
APaRT Automated Packet Recognition and Translation
ARP Address Resolution Protocol
AV attribute value
AVVID Architecture for Voice, Video and Integrated Data
BDD binary decision diagrams
BECN backward explicit congestion notification
BGP Border Gateway Protocol
BPDU bridge protocol data unit
BRF bridge relay function
BSC Bisync
BSTUN Block Serial Tunnel
BUS broadcast and unknown server
BVI bridge-group virtual interface
CAM content-addressable memory
CAR committed access rate
CCA circuit card assembly
CDP Cisco Discovery Protocol
CEF Cisco Express Forwarding
CGMP Cisco Group Management Protocol
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 A-1
Appendix A Acronyms and Abbreviations
Table A-1 Acronyms (continued)
Acronym Expansion
CHAP Challenge Handshake Authentication Protocol
CIR committed information rate
CIST Common and Internal Spanning Tree
CLI command-line interface
CLNS Connection-Less Network Service
CMNS Connection-Mode Network Service
COPS Common Open Policy Server
COPS-DS Common Open Policy Server Differentiated Services
CoS class of service
CPLD Complex Programmable Logic Device
CRC cyclic redundancy check
CRF concentrator relay function
CST Common Spanning Tree
CUDD University of Colorado Decision Diagram
DBL Dynamic Buffer Limiting
DCC Data Country Code
dCEF distributed Cisco Express Forwarding
DDR dial-on-demand routing
DE discard eligibility
DEC Digital Equipment Corporation
DFI Domain-Specific Part Format Identifier
DFP Dynamic Feedback Protocol
DISL Dynamic Inter-Switch Link
DLC Data Link Control
DLSw Data Link Switching
DMP data movement processor
DNS Domain Name System
DoD Department of Defense
DOS denial of service
DRAM dynamic RAM
DSAP destination service access point
DSCP differentiated services code point
DSPU downstream SNA Physical Units
DTP Dynamic Trunking Protocol
DTR data terminal ready
DXI data exchange interface
Software Configuration Guide—Release 12.2(52)SG
A-2 OL-16048-01
Appendix A Acronyms and Abbreviations
Table A-1 Acronyms (continued)
Acronym Expansion
EAP Extensible Authentication Protocol
EARL Enhanced Address Recognition Logic
EEPROM electrically erasable programmable read-only memory
EHSA enhanced high system availability
EHT Explicit Host Tracking
EIA Electronic Industries Association
ELAN Emulated Local Area Network
EOBC Ethernet out-of-band channel
ESI end-system identifier
FECN forward explicit congestion notification
FM feature manager
FRU field replaceable unit
FSM feasible successor metrics
GARP General Attribute Registration Protocol
GMRP GARP Multicast Registration Protocol
GVRP GARP VLAN Registration Protocol
HSRP Hot Standby Routing Protocol
ICC Inter-card Communication
ICD International Code Designator
ICMP Internet Control Message Protocol
IDB interface descriptor block
IDP initial domain part or Internet Datagram Protocol
IFS IOS File System
IGMP Internet Group Management Protocol
IGRP Interior Gateway Routing Protocol
ILMI Integrated Local Management Interface
IP Internet Protocol
IPC interprocessor communication
IPX Internetwork Packet Exchange
ISL Inter-Switch Link
ISO International Organization of Standardization
LAN local area network
LANE LAN Emulation
LAPB Link Access Procedure, Balanced
LDA Local Director Acceleration
LCP Link Control Protocol
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 A-3
Appendix A Acronyms and Abbreviations
Table A-1 Acronyms (continued)
Acronym Expansion
LEC LAN Emulation Client
LECS LAN Emulation Configuration Server
LEM link error monitor
LER link error rate
LES LAN Emulation Server
LLC Logical Link Control
LTL Local Target Logic
MAC Media Access Control
MACL MAC Access Control
MD5 Message Digest 5
MFD multicast fast drop
MIB Management Information Base
MII media-independent interface
MLS Multilayer Switching
MLSE maintenance loop signaling entity
MOP Maintenance Operation Protocol
MOTD message-of-the-day
MLSE maintenance loops signaling entity
MRM multicast routing monitor
MSDP Multicast Source Discovery Protocol
MST Multiple Spanning Tree
MSTI MST instance
MTU maximum transmission unit
MVAP multiple VLAN access port
NBP Name Binding Protocol
NCIA Native Client Interface Architecture
NDE NetFlow Data Export
NET network entity title
NetBIOS Network Basic Input/Output System
NFFC NetFlow Feature Card
NMP Network Management Processor
NSAP network service access point
NTP Network Time Protocol
NVRAM nonvolatile RAM
OAM Operation, Administration, and Maintenance
ODM order dependent merge
Software Configuration Guide—Release 12.2(52)SG
A-4 OL-16048-01
Appendix A Acronyms and Abbreviations
Table A-1 Acronyms (continued)
Acronym Expansion
OSI Open System Interconnection
OSPF open shortest path first
PACL Port Access Control List
PAE port access entity
PAgP Port Aggregation Protocol
PBD packet buffer daughterboard
PBR Policy Based Routing
PC Personal Computer
PCM pulse code modulation
PCR peak cell rate
PDP policy decision point
PDU protocol data unit
PEP policy enforcement point
PGM Pragmatic General Multicast
PHY physical sublayer
PIB policy information base
PIM Protocol Independent Multicast
PoE Power over Internet
PPP Point-to-Point Protocol
PRID Policy Rule Identifiers
PVST+ Per VLAN Spanning Tree+
QM QoS manager
QoS quality of service
RADIUS Remote Access Dial-In User Service
RAM random-access memory
RCP Remote Copy Protocol
RGMP Router-Ports Group Management Protocol
RIB routing information base
RIF Routing Information Field
RMON remote network monitor
ROM read-only memory
ROMMON ROM monitor
RP route processor or rendezvous point
RPC remote procedure call
RPF reverse path forwarding
RPR Route Processor Redundancy
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 A-5
Appendix A Acronyms and Abbreviations
Table A-1 Acronyms (continued)
Acronym Expansion
RSPAN remote SPAN
RST reset
RSVP ReSerVation Protocol
SAID Security Association Identifier
SAP service access point
SCM service connection manager
SCP Switch-Module Configuration Protocol
SDLC Synchronous Data Link Control
SGBP Stack Group Bidding Protocol
SIMM single in-line memory module
SLB server load balancing
SLCP Supervisor Line-Card Processor
SLIP Serial Line Internet Protocol
SMDS Software Management and Delivery Systems
SMF software MAC filter
SMP Standby Monitor Present
SMRP Simple Multicast Routing Protocol
SMT Station Management
SNAP Subnetwork Access Protocol
SNMP Simple Network Management Protocol
SPAN Switched Port Analyzer
SSTP Cisco Shared Spanning Tree
STP Spanning Tree Protocol
SVC switched virtual circuit
SVI switched virtual interface
TACACS+ Terminal Access Controller Access Control System Plus
TARP Target Identifier Address Resolution Protocol
TCAM Ternary Content Addressable Memory
TCL table contention level
TCP/IP Transmission Control Protocol/Internet Protocol
TFTP Trivial File Transfer Protocol
TIA Telecommunications Industry Association
TopN Utility that allows the user to analyze port traffic by reports
TOS type of service
TLV type-length-value
TTL Time To Live
Software Configuration Guide—Release 12.2(52)SG
A-6 OL-16048-01
Appendix A Acronyms and Abbreviations
Table A-1 Acronyms (continued)
Acronym Expansion
TVX valid transmission
UDLD UniDirectional Link Detection Protocol
UDP User Datagram Protocol
UNI User-Network Interface
UTC Coordinated Universal Time
VACL VLAN access control list
VCC virtual channel circuit
VCI virtual circuit identifier
VCR Virtual Configuration Register
VINES Virtual Network System
VLAN virtual LAN
VMPS VLAN Membership Policy Server
VPN virtual private network
VRF VPN routing and forwarding
VTP VLAN Trunking Protocol
VVID voice VLAN ID
WFQ weighted fair queueing
WRED weighted random early detection
WRR weighted round-robin
XNS Xerox Network System
Software Configuration Guide—Release 12.2(52)SG
OL-16048-01 A-7
Appendix A Acronyms and Abbreviations
Software Configuration Guide—Release 12.2(52)SG
A-8 OL-16048-01
INDEX
with port security 36-16
ACLs with VLAN assignment 36-9
applying IPv6 ACLs to a Layer 3 interface 42-16 with voice VLAN ports 36-19
802.1X Host Mode 36-6
multiauthentication mode 36-8
Numerics
multidomain authentication mode 36-7
10/100 autonegotiation feature, forced 7-11 single-host 36-7
10-Gigabit Ethernet or Gigabit Ethernet ports 802.3ad
deploy on WS-X4606-10GE-E and Sup 6-E 7-7 See LACP
10-Gigabit Ethernet port
deploy with Gigabit Ethernet SFP ports 7-7
A
1400 W DC Power supply
special considerations 10-16 AAA 39-1
1400 W DC SP Triple Input power supply AAA (authentication, authorization, and accounting). See
also port-based authentication. 37-1
special considerations 10-17
abbreviating commands 2-5
802.10 SAID (default) 12-5
access control entries
802.1Q
See ACEs
trunks 16-6
access control entries and lists 39-1
802.1Q VLANs
encapsulation access-group mode, configuring on Layer 2
14-3
interface 42-30
trunk restrictions 14-5
access-group mode, using PACL with 42-29
802.1s
access list filtering, SPAN enhancement 46-13
See MST
access ports
802.1w
configure port security 38-7, 38-22
See MST
configuring 14-8
802.1X
access VLANs 14-6
See port-based authentication
accounting
802.1X authentication
with TACACS+ 3-16, 3-21
for Critical Authentication 36-13
ACEs
for guest VLANs 36-10
ACLs 42-2
for MAC Authentication Bypass 36-11
IP 42-2
for Wake-on-LAN 36-14
Layer 4 operation restrictions 42-9
web-based authentication 36-13
ACEs and ACLs 39-1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-1
Index
ACL assignments, port-based authentication 36-17 learning 4-20
ACL assignments and redirect URLs, configure 36-32 removing 4-22
ACLs IPv6 43-2
ACEs 42-2 MAC, discovering 4-30
and SPAN 46-5 See MAC addresses
and TCAM programming for Sup II-Plus thru static
V-10GE 42-6 adding and removing 4-27
applying on routed packets 42-26
defined 4-19
applying on switched packets 42-25
address resolution 4-30
compatibility on the same switch 42-3
adjacency tables
configuring with VLAN maps 42-25
description 27-2
CPU impact 42-11
displaying statistics 27-9
downloadable 37-7
advertisements
hardware and software support 42-5
LLDP 1-4, 23-2
IP, matching criteria for port ACLs 42-4
advertisements, VTP
MAC extended 42-12
See VTP advertisements
matching criteria for router ACLs 42-3
aggregation switch, enabling DHCP snooping 40-9
port aging time
and voice VLAN 42-4
MAC address table 4-21
defined 42-3
All Auth manager sessions, displaying summary 36-68
limitations 42-5
All Auth manager sessions on the switch authorized for a
processing 42-11 specified authentication method 36-68
selecting mode of capturing control packets 42-7 applying IPv6 ACLs to a Layer 3 interface 42-16
troubleshooting high CPU 42-6 AQM via DBL, QoS on Sup 6-E 33-32
types supported 42-3 ARP
understanding 42-2 defined 4-30
VLAN maps 42-5 table
ACLs and VLAN maps, examples 42-19 address resolution 4-30
acronyms, list of A-1 managing 4-30
action drivers, marking 33-19 authentication
active queue management 33-9 NTP associations 4-4
active queue management via DBL, QoS on Sup See also port-based authentication
6-E 33-32
TACACS+
active traffic monitoring, IP SLAs 50-1
defined 3-16
addresses key 3-18
displaying the MAC address table 4-30
login 3-19
dynamic
Authentication, Authorization, and Accounting
changing the aging time 4-21 (AAA) 39-1
defined 4-19 Authentication Failed VLAN assignment
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-2 OL-22250-01
Index
configure with 802.1X 36-53 message-of-the-day login 4-18
Authentication methods registered with the Auth manager, default configuration 4-18
determining 36-67
when displayed 4-17
authentication open comand 36-8
b command 54-3
authentication proxy web pages 37-4
BGP 1-11
authentication server
routing session with multi-VRF CE 31-11
defined 36-3
blocking packets 44-1
RADIUS server 36-3
blocking state (STP)
Auth manager session for an interface, verifying 36-68
RSTP comparisons (table) 16-24
Auth manager summary, displaying 36-67
boot bootldr command 3-31
authoritative time source, described 4-2
boot command 3-28
authorization
boot commands 54-3
with TACACS+ 3-16, 3-21
boot fields
authorized and unauthorized ports 36-4
See configuration register boot fields
authorized ports with 802.1X 36-4
boot system command 3-26, 3-31
autoconfiguration 3-2
boot system flash command 3-28
Auto-MDIX on a port Border Gateway Protocol
configuring 7-22
See BGP
displaying the configuration 7-22
boundary ports
overview 7-21
description 16-27
autonegotiation feature BPDU Guard
forced 10/100Mbps 7-11
and MST 16-23
auto-sync command 5-8
configuring 18-16
overview 18-8
B BPDUs
and media speed 16-2
Baby Giants
pseudobridges and 16-25
interacting with 7-20
what they contain 16-3
BackboneFast
bridge ID
adding a switch (figure) 18-4
See STP bridge ID
and MST 16-23
bridge priority (STP) 16-16
configuring 18-16
bridge protocol data units
link failure (figure) 18-14, 18-15
See BPDUs
not supported MST 16-23
Broadcast Storm Control
understanding 18-14
disabling 45-5
See also STP
enabling 45-3
banners
configuring
login 4-19
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-3
Index
Unicast RPF
C
BGP optional attributes 28-5
Call Home cautions for passwords
description 1-16, 52-1 encrypting 3-22
message format options 52-2 CDP
messages configuration 20-2
format options 52-2 defined with LLDP 23-1
call home 52-1 displaying configuration 20-3
alert groups 52-6 enabling on interfaces 20-3
configuring e-mail options 52-9 host presence detection 36-8
contact information 52-4 maintaining 20-3
default settings 52-18 monitoring 20-3
destination profiles 52-5 overview 1-2, 20-1
displaying information 52-14 cdp enable command 20-3
mail-server priority 52-10 CEF
pattern matching 52-9 adjacency tables 27-2
periodic notification 52-8 and NSF with SSO 9-4
rate limit messages 52-9 configuring load balancing 27-7
severity threshold 52-8 displaying statistics 27-8
smart call home feature 52-2 enabling 27-6, 53-2
SMTP server 52-9 hardware switching 27-4
testing communications 52-10 load balancing 27-6
call home alert groups overview 27-2
configuring 52-6 software switching 27-4
description 52-6 certificate authority (CA) 52-3
subscribing 52-7 CGMP
call home contacts overview 21-1
assigning information 52-4 channel-group group command 19-8, 19-10
call home destination profiles Cisco 7600 series Internet router
attributes 52-5 enabling SNMP 55-4, 55-5
configuring 52-5 Cisco Discovery Protocol
description 52-5 See CDP
displaying 52-16 Cisco Express Forwarding
call home notifications See CEF
full-txt format for syslog 52-25 Cisco Group Management Protocol
XML format for syslog 52-34 See CGMP
Capturing control packets Cisco IOS IP SLAs 50-2
selecting mode 42-7 Cisco IOS NSF-aware
cautions support 9-2
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-4 OL-22250-01
Index
Cisco IOS NSF-capable support 9-2 reset 54-3
Cisco IP Phones ROM monitor 54-2 to ??
configuring 34-3 SNMP 55-4
sound quality 34-1 common and internal spanning tree
CiscoWorks 2000 49-4 See CIST
CIST common spanning tree
description 16-22 See CST
civic location 23-3 community ports 35-4
class level, configure in a service policy 33-29 community strings
class of service configuring 49-7
See CoS overview 49-4
clear cdp counters command 20-4 community VLANs 35-3, 35-4
clear cdp table command 20-3 and SPAN features 35-12
clear counters command 7-25 configure as a PVLAN 35-13
clearing compiling MIBs 55-4
IP multicast table entries 29-26 config-register command 3-29
clear ip eigrp neighbors command 26-17 config terminal command 3-9
CLI configurable leave timer,IGMP 21-4
accessing 2-2 configuration examples
backing out one level 2-5 SNMP 49-16
getting commands 2-5 configuration files
history substitution 2-4 limiting TFTP server access 49-15
modes 2-5 obtaining with DHCP 3-6
monitoring environments 46-1 saving 3-10
ROM monitor 2-7 system contact and location information 49-15
software basics 2-4 configuration guidelines
clients SNMP 49-6
in 802.1X authentication 36-3 configuration register
clock boot fields
See system clock listing value 3-29
command-line processing 2-3 modifying 3-28
command modes 2-5 changing from ROM monitor 54-3
commands changing settings 3-28 to 3-29
b 54-3 configuring 3-26
boot 54-3 settings at startup 3-27
dev 54-3 configure class-level queue-limit in a service policy 33-29
dir device 54-3 configure terminal command 3-29, 7-2
i 54-3 configuring access-group mode on Layer 2
interface 42-30
listing 2-5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-5
Index
configuring flow control 7-14 counters
configuring interface link and trunk status envents 7-26 clearing MFIB 29-26
configuring named IPv6 ACLs 42-15 clearing on interfaces 7-25
configuring named MAC extended ACLs 42-12, 42-14 CPU, impact of ACL processing 42-11
configuring unicast MAC address filtering 42-12 CPU port sniffing 46-10
configuring VLAN maps 42-17 crashinfo
console configuration mode 2-5 kernel file 3-34
console port process core dump file 3-34
disconnecting user sessions 8-7 process file 3-33
monitoring user sessions 8-6 crashinfo, configuring
contact information commands 3-35
assigning for call home 52-4 default 3-35
control plane policing determining the process that crashed 3-39
See CoPP enabling generation of process core dump 3-38
control protocol, IP SLAs 50-4 saving files to a secondary device 3-39
CoPP show commands 3-36
applying QoS service policy to control plane 39-3 Critical Authentication
configuring configure with 802.1X 36-50
ACLs to match traffic 39-3 CST
enabling MLS QoS 39-3 description 16-25
packet classification criteria 39-3 IST and 16-22
service-policy map 39-3 MST and 16-22
control plane configuration mode customer edge devices 31-2
entering 39-3
displaying
D
dynamic information 39-7
number of conforming bytes and packets 39-7 database agent
rate information 39-7 configuration examples 40-15
entering control plane configuration mode 39-3 enabling the DHCP Snooping 40-12
monitoring statistics 39-7 daylight saving time 4-13
overview 39-2 default configuration
copy running-config startup-config command 3-10 802.1X 36-23
copy system:running-config nvram:startup-config banners 4-18
command 3-31 DNS 4-16
CoS IGMP filtering 21-20
definition 33-3 IGMP snooping 22-5, 22-6
figure 33-2 IP SLAs 50-7
overriding on Cisco IP Phones 34-5 IPv6 43-7
priority 34-5 LLDP 23-3
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-6 OL-22250-01
Index
MAC address table 4-21 client side 3-3
multi-VRF CE 31-3 DNS 3-5
NTP 4-4 relay device 3-5
private VLANs 35-11 server-side 3-4
resetting the interface 7-28 TFTP server 3-4
RMON 51-3 example 3-7
SNMP 49-5 lease options
SPAN and RSPAN 46-6 for IP address information 3-4
system message logging 47-3 for receiving the configuration file 3-4
TACACS+ 3-18 overview 3-2
default gateway relationship to BOOTP 3-3
configuring 3-11 DHCP option 82
verifying configuration 3-11 overview 40-4
default settings, erase commad 3-32 DHCP Snooping
default web-based authentication configuration enabling, and Option 82 40-10
802.1X 37-6 DHCP snooping
denial-of-service attacks accepting untrusted packets form edge switch 40-10
IP address spoofing, mitigating 28-5 configuring 40-6
Unicast RPF, deploying 28-5 default configuration 40-7
denying access to a server on another VLAN 42-23 displaying binding tables 40-18
deploying 10-Gigabit Ethernet and a Gigabit Ethernet SFP displaying configuration 40-19
ports 7-7
displaying information 40-18
deploying 10-Gigabit Ethernet and a Gigabit Ethernet SFP enabling 40-7
ports on WS-X4606-10GE-E and Sup 6-E 7-7
enabling on private VLAN 40-11
description command 7-14
enabling on the aggregation switch 40-9
detecting unidirectional links 24-1
enabling the database agent 40-12
dev command 54-3
message exchange process 40-4
device discovery protocol 23-1
monitoring 40-23
device IDs
option 82 data insertion 40-4
call home format 52-21, 52-22
overview 40-1
DHCP
Snooping database agent 40-2
configuring
DHCP Snooping Database Agent
rate limit for incoming packets 40-13
adding to the database (example) 40-18
denial-of-service attacks, preventing 40-13
enabling (example) 40-15
rate limiting of packets
overview 40-2
configuring 40-13
reading from a TFTP file (example) 40-16
DHCP-based autoconfiguration
Diagnostics
client request message exchange 3-3
online 53-1
configuring
troubleshooting 53-7
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-7
Index
Power-On-Self-Test DSCP values
causes of failure 53-20 definition 33-4
how it works 53-9 IP precedence 33-2
overview 53-9 DTP
Power-On-Self-Test for Supervisor Engine VLAN trunks and 14-3
V-10GE 53-14
duplex command 7-13
Differentiated Services Code Point values
duplex mode
See DSCP values
configuring interface 7-11
DiffServ architecture, QoS 33-2
dynamic ARP inspection
Digital optical monitoring transceiver support 7-10
ARP cache poisoning 41-2
Digital Signing 54-6
configuring
dir device command 54-3
ACLs for non-DHCP environments 41-11
disabled state in DHCP environments 41-5
RSTP comparisons (table) 16-24
log buffer 41-14
disabling rate limit for incoming ARP packets 41-16
broadcast storm control 45-5
denial-of-service attacks, preventing 41-16
disabling multicast storm control 45-6
interface trust state, security coverage 41-3
disconnect command 8-7
log buffer
displaying configuring 41-14
Auth Manager sumary for an interface 36-67
logging of dropped packets 41-4
MAB details 36-70
overview 41-1
summary of all Auth manager sessions 36-68
port channels, their behavior 41-5
summary of all Auth manager sessions on the switch priority of static bindings 41-4
authorized for a specified authentication
method 36-68 purpose of 41-2
displaying EtherChannel to a Virtual Switch rate limiting of ARP packets 41-4
System 19-14 configuring 41-16
displaying storm control 45-6 validation checks, performing 41-19
display PoE consumed by a module 11-7 Dynamic Host Configuration Protocol snooping
DNS See DHCP snooping
and DHCP-based autoconfiguration 3-5 dynamic port VLAN membership
default configuration 4-16 example 12-29
displaying the configuration 4-17 limit on hosts 12-29
overview 4-15 reconfirming 12-26
setting up 4-16 troubleshooting 12-29
domain names Dynamic Trunking Protocol
DNS 4-15 See DTP
Domain Name System
See DNS
downloading MIBs 55-2, 55-3, 55-4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-8 OL-22250-01
Index
overview 4-31
E
emergency alarms on Sup Engine 6-E systems 10-3
EAP frames enable command 3-9, 3-28
changing retransmission time 36-63 enable mode 2-5
exchanging (figure) 36-4, 36-6, 36-12 enabling SNMP 55-4, 55-5
request/identity 36-3 encapsulation types 14-3
response/identity 36-3 Enhanced Interior Gateway Routing Protocol
setting retransmission number 36-64 See EIGRP
EAPOL frames Enhanced PoE support on E-series 11-15
802.1X authentication and 36-3 environmental monitoring
OTP authentication, example (figure) 36-4, 36-12 using CLI commands 10-1
start 36-4 EPM logging 36-70
edge ports EtherChannel
description 16-27 channel-group group command 19-8, 19-10
EGP configuration guidelines 19-5
overview 1-11 configuring 19-6 to 19-14
EIGRP configuring Layer 2 19-9
configuration examples 26-18 configuring Layer 3 19-6
monitoring and maintaining 26-17 displaying to a virtual switch system 19-14
EIGRP (Enhanced IGRP) interface port-channel command 19-7
stub routing lacp system-priority
benefits 26-16 command example 19-12
configuration tasks 26-16 modes 19-3
configuring 26-12 overview 19-1
overview 26-12 PAgP
restrictions 26-16 Understanding 19-3
verifying 26-17 physical interface configuration 19-7
EIGRP (enhanced IGRP) port-channel interfaces 19-2
overview 1-12 port-channel load-balance command 19-13
eigrp stub command 26-17 removing 19-14
EIGRP stub routing, configuring 26-11 removing interfaces 19-13
ELIN location 23-3 EtherChannel guard
e-mail addresses disabling 18-7
assigning for call home 52-4 enabling 18-6
e-mail notifications overview 18-6
Call Home 1-16, 52-1 explicit host tracking
Embedded CiscoView enabling 21-11
displaying information 4-33 extended range VLANs
installing and configuring 4-31 See VLANs
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-9
Index
Extensible Authentication Protocol over LAN 36-2
G
Exterior Gateway Protocol
See EGP gateway
See default gateway
get-bulk-request operation 49-3
F get-next-request operation 49-3, 49-4
Fallback Authentication get-request operation 49-3, 49-4
get-response operation 49-3
configure with 802.1X 36-57 Gigabit Ethernet SFP ports
FastDrop deploy with 10-Gigabit Ethernet 7-7
overview 29-10 global configuration mode 2-5
FIB Guest-VLANs
description 27-2 configure with 802.1X 36-46, 36-54
See also MFIB
Filter-ID ACL and Per-User ACL, configureport-based
H
authentication
configure Per-User ACL and Filter-ID ACL 36-38 hardware and software ACL support 42-5
filtering hardware switching 27-5
in a VLAN 42-17 hello time (STP)
non-IP traffic 42-12, 42-14 configuring 16-17
flags 29-11 high CPU due to ACLs, troubleshooting 42-6
Flash memory history
configuring router to boot from 3-31 CLI 2-4
loading system images from 3-30 history table, level and number of syslog messages 47-9
security precautions 3-31 hop counts
Flexible NetFlow configuring MST bridges 16-28
caveats 32-1 host
defined 1-2, 32-1 limit on dynamic port 12-29
flooded traffic, blocking 44-2 host ports
flowchart, traffic marking procedure 33-19 kinds of 35-4
flow control, configuring 7-14 host presence CDP message 36-8
For 11-13 Hot Standby Routing Protocol
forward-delay time (STP) See HSRP
configuring 16-18 HSRP
forwarding information base description 1-10
See FIB http
//www.cisco.com/en/US/docs/ios/12_4/ip_sla/configu
ration/guide/hsla_c.html 50-1, 50-4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-10 OL-22250-01
Index
//www.cisco.com/en/US/docs/ios/fnetflow/configurat monitoring 21-24
ion/guide/12_4t/fnf_12_4t_book.html 32-1
IGMP groups
//www.cisco.com/en/US/docs/ios/fundamentals/com setting the maximum number 21-23
mand reference/cf_book.html 47-1, 49-1, 51-1
IGMP Immediate Leave
hw-module module num power command 10-18
configuration guidelines 21-9
IGMP profile
I applying 21-22
configuration mode 21-21
ICMP
configuring 21-21
enabling 8-12
IGMP Snooping
ping 8-7
configure
running IP traceroute 8-9
leave timer 21-9
time exceeded messages 8-9
configuring
ICMP Echo operation
Learning Methods 21-7
configuring 50-12
static connection to a multicast router 21-8
IP SLAs 50-11
configuring host statically 21-11
i command 54-3
enabling
IDS
Immediate-Leave processing
using with SPAN and RSPAN 46-3
explicit host tracking 21-11
IEEE 802.1s
suppressing multicast flooding 21-12
See MST
IGMP snooping
IEEE 802.1w
configuration guidelines 21-5
See MST
default configuration 22-5, 22-6
IEEE 802.3ad
enabling
See LACP
globally 21-6
IGMP
on a VLAN 21-6
configurable-leave timer 21-4
enabling and disabling 22-6
description 29-3
IP multicast and 29-4
enabling 29-13
monitoring 21-14, 22-11
explicit host tracking 21-4
overview 21-1
immediate-leave processing 21-3
IGMP Snooping, displaying
leave processing, enabling 22-8
group 21-16
overview 21-1
hot membership 21-15
report suppression
how to 21-15
disabling 22-10
MAC address entries 21-18
IGMP filtering
multicast router interfaces 21-17
configuring 21-21
on a VLAN interface 21-18
default configuration 21-20
Querier information 21-19
described 21-20
IGMPSnooping Querier, configuring 21-10
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-11
Index
Immediate Leave, IGMP Intrusion Detection System
enabling 22-8 See IDS
immediate-leave processing inventory management TLV 23-2, 23-7
enabling 21-8 IP
IGMP configuring default gateway 3-11
See fast-leave processing configuring static routes 3-11
ingress packets, SPAN enhancement 46-12 displaying statistics 27-8
inline power IP addresses
configuring on Cisco IP phones 34-5 128-bit 43-2
Intelligent Power Management 11-4 discovering 4-30
interacting with Baby Giants 7-20 IPv6 43-2
interface command 3-9, 7-2 ip cef command 27-6, 53-2
interface link and trunk status events IP Enhanced IGRP
configuring 7-26 interfaces, displaying 26-17
interface port-channel command 19-7 ip icmp rate-limit unreachable command 8-12
interface range command 7-5 ip igmp profile command 21-21
interface range macro command 7-6 ip igmp snooping tcn flood command 21-13
interfaces ip igmp snooping tcn flood query count command 21-14
adding descriptive name 7-13 ip igmp snooping tcn query solicit command 21-14
clearing counters 7-25 IP information
configuring 7-2 assigned
configuring ranges 7-4 through DHCP-based autoconfiguration 3-2
displaying information about 7-24 ip load-sharing per-destination command 27-7
Layer 2 modes 14-4 ip local policy route-map command 30-8
maintaining 7-24 ip mask-reply command 8-13
monitoring 7-24 IP MTU sizes, configuring 26-8
naming 7-13 IP MTU sizes,configuring 26-8
numbers 7-2 IP multicast
overview 7-2 clearing table entries 29-26
restarting 7-25 configuring 29-12
See also Layer 2 interfaces default configuration 29-12
Internet Control Message Protocol displaying PIM information 29-21
See ICMP displaying the routing table information 29-22
Internet Group Management Protocol enabling dense-mode PIM 29-14
See IGMP enabling sparse-mode 29-14
Internet Protocol version 6 features not supported 29-12
See IPv6 hardware forwarding 29-8
Inter-Switch Link encapsulation IGMP snooping and 21-5, 29-4
See ISL encapsulation overview 29-1
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-12 OL-22250-01
Index
routing protocols 29-2 IP Source Guard
software forwarding 29-8 configuring 40-20
See also Auto-RP; IGMP; PIM; RP; RPF configuring on private VLANs 40-22
IP multicast routing displaying 40-22, 40-23
enabling 29-13 overview 40-19
monitoring and maintaining 29-21 IP statistics
ip multicast-routing command 29-13 displaying 27-8
IP phones IP traceroute
configuring voice ports 34-3 executing 8-9
See Cisco IP Phones 34-1 overview 8-9
ip pim command 29-14 IP unicast
ip pim dense-mode command 29-14 displaying statistics 27-8
ip pim sparse-dense-mode command 29-15 IP Unnumbered support
ip policy route-map command 30-7 configuring on a range of Ethernet VLANs 13-6
ip redirects command 8-13 configuring on LAN and VLAN interfaces 13-5
IP routing tables configuring with connected host polling 13-7
deleting entries 29-26 DHCP Option 82 13-3
IP Service Level Agreements displaying settings 13-8
See IP SLAs format of agent remote ID suboptions 13-3
IP service levels, analyzing 50-1 troubleshooting 13-9
IP SLAs with conected host polling 13-4
benefits 50-3 with DHCP server and Relay agent 13-2
Control Protocol 50-4 ip unreachables command 8-12
default configuration 50-7 IPv6
definition 50-1 addresses 43-2
ICMP echo operation 50-11 default configuration 43-7
measuring network performance 50-3 defined 43-1
monitoring 50-13 Enhanced Interior Gateway Routing Protocol (EIGRP)
IPv6 43-6
multioperations scheduling 50-6
Router ID 43-6
operation 50-4
OSPF 43-5
responder
described IPX
50-4
redistribution of route information with EIGRP 1-12
enabling 50-8
ISL
response time 50-5
encapsulation 14-3
scheduling 50-6
SNMP support 50-3
isolated port 35-4
supported metrics 50-3
isolated VLANs 35-3, 35-4
threshold monitoring 50-6
ISSU
compatibility matrix 6-13
UDP jitter operation 50-9
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-13
Index
compatiblity verification using Cisco Feature
L
Navigator 6-14
NSF overview 6-3 labels, definition 33-3
perform the process LACP
aborting a software upgrade 6-31 system ID 19-4
configuring the rollback timer as a Layer 2 access ports 14-8
safeguard 6-32
Layer 2 frames
displaying a compatibility matrix 6-34
classification with CoS 33-2
loading the new software on the new
standby 6-24 Layer 2 interface, configuring access-mode mode
on 42-30
stopping the rollback timer 6-23
Layer 2 interfaces
switching to the standby 6-21
assigning VLANs 12-7
verify the ISSU state 6-17
configuring 14-5
verify the redundancy mode 6-16
configuring as PVLAN host ports 35-17
verify the software installation 6-15
configuring as PVLAN promiscuous ports 35-16
vload the new software on standby 6-18
configuring as PVLAN trunk ports 35-18
prerequisites 6-2
defaults 14-5
process overview 6-6
disabling configuration 14-9
restrictions 6-2
modes 14-4
SNMP support 6-14
show interfaces command 14-7
SSO overview 6-3
Layer 2 interface type
IST
resetting 35-22
and MST regions 16-22
setting 35-22
description 16-22
Layer 2 switching
master 16-27
overview 14-1
Layer 2 Traceroute
J and ARP 8-11
and CDP 8-10
jumbo frames
host-to-host paths 8-10
and ethernet ports 7-18
IP addresses and subnets 8-11
configuring MTU sizes for 7-19
MAC addresses and VLANs 8-10
ports and linecards that support 7-16
multicast traffic 8-10
understanding MTUs 7-17
multiple devices on a port 8-11
understanding support 7-17
unicast traffic 1-24, 8-10
VLAN interfaces 7-18
usage guidelines 8-10
Layer 2 trunks
K configuring 14-6
overview 14-3
keyboard shortcuts 2-3
Layer 3 interface, applying IPv6 ACLs 42-16
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-14 OL-22250-01
Index
Layer 3 interface counters,configuring 26-9 configuring for CEF 27-7
Layer 3 interface counters,understanding 26-3 configuring for EtherChannel 19-12
Layer 3 interfaces overview 19-5, 27-6
changing from Layer 2 mode 31-7 per-destination 27-7
configuration guidelines 26-4 location service
overview 26-1 configuring 23-9
logical 26-2 location TLV 23-3, 23-7
physical 26-2 logging, EPM 36-70
VLANs as interfaces 26-6 Logical Layer 3 interfaces
Layer 3 packets configuring 26-5
classification methods 33-2 login authentication
Layer 4 port operations with TACACS+ 3-19
configuration guidelines 42-10 login banners 4-17
restrictions 42-9 login timer
Leave timer, enabling 21-9 changing 8-6
link and trunk status events logoutwarning command 8-6
configuring interface 7-26 loop guard
Link Layer Discovery Protocol and MST 16-23
See CDP configuring 18-5
listening state (STP) overview 18-3
RSTP comparisons (table) 16-24
LLDP
M
configuring 23-3
characteristics 23-4 MAC/PHY configuration status TLV 23-2
default configuration 23-3 MAC addresses
disabling and enabling aging time 4-21
globally 23-5 allocating 16-5
on an interface 23-6 and VLAN association 4-20
monitoring and maintaining 23-10 building tables 4-20, 14-2
overview 23-1 convert dynamic to sticky secure 38-5
transmission timer and holdtime, setting 23-4 default configuration 4-21
LLDP-MED discovering 4-30
configuring displaying 4-30, 8-3
procedures 23-3 displaying in DHCP snooping binding table 40-19
TLVs 23-7, 23-8 dynamic
monitoring and maintaining 23-10 learning 4-20
overview 23-1 removing 4-22
supported TLVs 23-2 in ACLs 42-12
load balancing static
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-15
Index
adding 4-28 MLD Done messages and Immediate-leave 22-4
allowing 4-29 MLD messages 22-2
characteristics of 4-27 MLD queries 22-3
dropping 4-29 MLD reports 22-4
removing 4-28 MLD Snooping
sticky 38-4 MLD Done messages and Immediate-leave 22-4
sticky secure, adding 38-5 MLD messages 22-2
MAC Authentication Bypass MLD queries 22-3
configure with 802.1X 36-48 MLD reports 22-4
MAC details, displaying 36-70 Multicast client aging robustness 22-3
MAC extended access lists 42-12 Multicast router discovery 22-3
macros overview 22-1
See Smartports macros Mode of capturing control packets, selecting 42-7
main-cpu command 5-8 modules
management address TLV 23-2 checking status 8-2
management options monitoring
SNMP 49-1 ACL information 42-34
marking IGMP
hardware capabilities 33-21 snooping 22-11
marking action drivers 33-19 IGMP filters 21-24
marking network traffic 33-16 IGMP snooping 21-14
marking support, multi-attribute 33-20 IP SLAs operations 50-13
match ip address command 30-6 multicast router interfaces 22-11
maximum aging time (STP) multi-VRF CE 31-17
configuring 16-18 traffic flowing among switches 51-1
MDA VLAN filters 42-24
configuration guidelines 36-20 to 36-21 VLAN maps 42-24
described 36-20 M-record 16-22
messages, to users through banners 4-17 MST
MFIB and multiple spanning trees 1-5, 16-22
CEF 29-5 boundary ports 16-27
overview 29-11 BPDUs 16-22
MFIB, IP configuration parameters 16-26
displaying 29-24 configuring 16-29
MIBs displaying configurations 16-33
compiling 55-4 edge ports 16-27
downloading 55-2, 55-3, 55-4 enabling 16-29
overview 49-1 hop count 16-28
SNMP interaction with 49-4 instances
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-16 OL-22250-01
Index
configuring parameters 16-32 enabling 45-4
description 16-22 disabling 45-6
number supported 16-26 multidomain authentication
interoperability with PVST+ 16-23 See MDA
link type 16-28 multidomain authentication mode 36-7
master 16-27 multioperations scheduling, IP SLAs 50-6
message age 16-28 Multiple Authentication
regions 16-26 described 36-20
restrictions 16-29 Multiple AuthorizationAuthentication
to-SST interoperability 16-24 configuring 36-29
MSTP Multiple Domain Authentication 36-29
EtherChannel guard multiple forwarding paths 1-5, 16-22
enabling 18-6 multiple-hosts mode 36-7
M-record 16-22 Multiple Spanning Tree
M-tree 16-22 See MST
M-tree 16-22 multiple VPN routing/forwarding
MTUS See multi-VRF CE
understanding 7-17 multi-VRF CE
MTU size components 31-3
configuring 7-19, 7-20, 7-26, 7-27 configuration example 31-12
default 12-5 default configuration 31-3
multiauthentication mode 36-8 defined 31-1
multicast displaying 31-17
See IP multicast monitoring 31-17
Multicast client aging robustness 22-3 network components 31-3
multicast groups packet-forwarding process 31-3
static joins 22-7
multicast packets
N
blocking 44-2
Multicast router discovery 22-3 named IPv6 ACLs, configuring
multicast router interfaces, displaying 21-17 ACLs
multicast router interfaces, monitoring 22-11 configuring named IPv6 ACLs 42-15
multicast router ports, adding 22-7 named MAC extended ACLs
multicast routers ACLs
flood suppression 21-12 configuring named MAC extended 42-12, 42-14
multicast router table native VLAN
displaying 29-22 specifying 14-6
Multicast Storm Control network fault tolerance 1-5, 16-22
network management
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-17
Index
configuring 20-1 authenticating 4-4
RMON 51-1 defined 4-2
SNMP 49-1 enabling broadcast messages 4-7
network performance, measuring with IP SLAs 50-3 peer 4-6
network policy TLV 23-2, 23-7 server 4-6
Network Time Protocol default configuration 4-4
See NTP displaying the configuration 4-11
network traffic, marking 33-16 overview 4-2
New Software Features in Release 7.7 restricting access
TDR 8-3 creating an access group 4-9
Next Hop Resolution Protocol disabling NTP services per interface 4-10
See NHRP source IP address, configuring 4-10
NHRP stratum 4-2
support 1-12 synchronizing devices 4-6
non-IP traffic filtering 42-12, 42-14 time
non-RPF traffic services 4-2
description 29-9 synchronizing 4-2
in redundant configurations (figure) 29-10 NVRAM
Nonstop Forwarding saving settings 3-10
See NSF
nonvolatile random-access memory
O
See NVRAM
normal-range VLANs OIR
See VLANs overview 7-23
NSF Online Diagnostics 53-1
defined 9-1 online insertion and removal
guidelines and restrictions 9-7 See OIR
operation 9-4 Open Shortest Path First
NSF-aware See OSPF
support 9-2 operating system images
NSF-capable See system images
supervisor engines 9-2 Option 82
support 9-2 enabling DHCP Snooping 40-10
NSF with SSO supervisor engine redundancy OSPF
and CEF 9-4 area concept 1-13
overview 9-3 description 1-13
SSO operation 9-3 for IPv6 43-5
NTP
associations
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-18 OL-22250-01
Index
displaying information 29-21
P
displaying statistics 29-25
packets enabling sparse-dense mode 29-14, 29-15
modifying 33-9 overview 29-3
packet type filtering PIM-DM 29-3
overview 46-14 PIM on an interface, enabling 29-13
SPAN enhancement 46-14 PIM-SM 29-4
PACL, using with access-group mode 42-29 PIM-SSM mapping, enabling 29-16
PACL with VLAN maps and router ACLs 42-31 ping
PAgP executing 8-8
understanding 19-3 overview 8-7
passwords ping command 8-8, 29-21
configuring enable password 3-14 PoE 11-7
configuring enable secret password 3-14 configuring power consumption for single
encrypting 3-22 device 11-5
recovering lost enable password 3-25 Enhanced PoE support on E-series 11-15
setting line password 3-14 policing and monitoring 11-11
PBR (policy-based routing) power consumption for powered devices
configuration (example) 30-8 Intelligent Power Management 11-4
enabling 30-6 power management modes 11-3
features 30-2 show interface status 11-6
overview 30-1 PoE policing
route-map processing logic 30-3 configuring errdisable recovery 11-14
route-map processing logic example 30-4 configuring on an interface 11-12
route maps 30-2 displaying on an interface 11-13
when to use 30-5 power modes 11-12
per-port and VLAN Access Control List 40-19 point-to-point
per-port per-VLAN QoS in 802.1X authentication (figure) 36-2
enabling 33-33 policing
overview 33-10 how to implement 33-15
Per-User ACL and Filter-ID ACL, configure 36-38 See QoS policing
Per-VLAN Rapid Spanning Tree 16-6 policing, PoE 11-11
enabling 16-20 policy associations, QoS on Sup 6-E 33-37
overview 16-6 policy-map command 33-14
PE to CE routing, configuring 31-11 policy map marking action, configuring 33-21
Physical Layer 3 interfaces, configuring 26-10 port ACLs
PIM and voice VLAN 42-4
configuring dense mode 29-14 defined 42-3
configuring sparse mode 29-14 limitations 42-5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-19
Index
Port Aggregation Protocol method lists 36-24
see PAgP modes 36-6
port-based authentication multidomain authentication 36-20
802.1X with voice VLAN 36-19 multiple-hosts mode, described 36-7
authentication server port security
defined 37-2 multiple-hosts mode 36-7
changing the quiet period 36-63 ports not supported 36-4
client, defined 36-3, 37-2 pre-authentication open access 36-8
configuration guidelines 36-24, 37-6 resetting to default values 36-66
configure ACL assignments and redirect URLs 36-32 setting retransmission number 36-64
configure switch-to-RADIUS server setting retransmission time 36-63
communication 36-27
switch
configure with Authentication Failed VLAN as proxy 37-2
assignment 36-53
topologies, supported 36-21
configure with Critical Authentication 36-50
using with ACL assignments and redirect
configure with Guest-VLANs 36-46, 36-54
URLs 36-17
configure with MAC Authentication Bypass 36-48
using with port security 36-16
configure with Wake-on-LAN 36-52
with Critical Authentication 36-13
configuring
with Guest VLANs 36-10
Multiple Domain Authentication and Multiple
with MAC Authentication Bypass 36-11
Authorization 36-29
with VLAN assignment 36-9
RADIUS server 37-10
port-channel interfaces
RADIUS server parameters on the switch 37-8
See also EtherChannel
configuring Fallback Authentication 36-57
creating 19-7
configuring Guest-VLAN 36-27
overview 19-2
configuring manual re-authentication of a
client 36-66 port-channel load-balance
controlling authorization state 36-5 command 19-12
default configuration 36-23, 37-6 command example 19-12
described 36-1 port-channel load-balance command 19-13
device roles 36-2, 37-2 port cost (STP)
displaying statistics 36-67, 37-13 configuring 16-15
enabling 36-24 port description TLV 23-2
802.1X authentication 37-8 PortFast
enabling multiple hosts 36-62 and MST 16-23
enabling periodic re-authentication 36-61 BPDU filter, configuring 18-10
encapsulation 36-3 configuring or enabling 18-16
host mode 36-6 overview 18-7
how 802.1X fails on a port 36-21 PortFast BPDU filtering
initiation and message exchange 36-3 and MST 16-23
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-20 OL-22250-01
Index
enabling 18-10 power dc input command 10-17
overview 18-9 power handling for Supervisor Engine II-TS 11-11
port numbering with TwinGig Convertors 7-7 power inline command 11-3
port priority power inline consumption command 11-5
configuring MST instances 16-32 power management
configuring STP 16-13 Catalyst 4500 series 10-5
ports Catalyst 4500 Switch power supplies 10-12
blocking 44-1 configuring combined mode 10-11
checking status 8-2 configuring redundant mode 10-10
dynamic VLAN membership overview 10-1
example 12-29 redundancy 10-5
reconfirming 12-26 power management for Catalyst 4500 Switch
forwarding, resuming 44-3 combined mode 10-7
See also interfaces redundant mode 10-7
port security power management limitations in Catalyst 4500
aging Switch 10-8
38-5
configuring 38-7
power management mode
selecting 10-7
displaying 38-28
guidelines and restrictions 38-33
power management TLV 23-2, 23-7
on access ports 38-7, 38-22
power negotiation
through LLDP 23-8
on private VLAN 38-14
host 38-14
Power-On-Self-Test diagnostics 53-9, 53-20
promiscuous 38-16
Power-On-Self-Test for Supervisor Engine
V-10GE 53-14
topology 38-15, 38-18, 38-32
power redundancy-mode command 10-10
on trunk port 38-17
power supplies
guidelines and restrictions 38-15, 38-18, 38-21, 38-32
available power for Catalyst 4500 Switch 10-12
port mode changes 38-22
fixed 10-6
on voice ports 38-22
variable 10-6
sticky learning 38-5
pre-authentication open access 36-8
using with 802.1X 36-16
pre-authentication open access. See port-based
violations 38-6 authentication.
with 802.1X Authentication 38-32 primary VLANs 35-3, 35-5
with DHCP and IP Source Guard 38-31 associating with secondary VLANs 35-14
with other features 38-33 configuring as a PVLAN 35-13
port states priority
description 16-5 overriding CoS of incoming frames 34-5
port VLAN ID TLV 23-2 priority queuing, QoS on Sup 6-E 33-28
power private VLAN
inline 34-5 configure port security 38-14, 38-15
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-21
Index
enabling DHCP Snooping 40-11 PVLAN promiscuous trunk port
private VLANs configuring 35-2, 35-16, 35-19
across multiple switches 35-5 PVLANs
and SVIs 35-10 802.1q support 35-13
benefits of 35-3 across multiple switches 35-5
community ports 35-4 configuration guidelines 35-11
community VLANs 35-3, 35-4 configure port security 38-14, 38-16, 38-18
default configuration 35-11 configure port security in a wireless setting 38-32
end station access to 35-3 configuring 35-10
isolated port 35-4 configuring a VLAN 35-13
isolated VLANs 35-3, 35-4 configuring promiscuous ports 35-16
ports host ports
community 35-4 configuring a Layer 2 interface 35-17
isolated 35-4 setting 35-22
promiscuous 35-5 overview 35-1
primary VLANs 35-3, 35-5 permitting routing, example 35-21
promiscuous ports 35-5 promiscuous mode
secondary VLANs 35-3 setting 35-22
subdomains 35-3 setting
traffic in 35-9 interface mode 35-22
privileged EXEC mode 2-5
privileges
Q
changing default 3-23
configuring levels 3-23 QoS
exiting 3-24 classification 33-6 to ??
logging in 3-24 definitions 33-3
promiscuous ports enabling per-port per-VLAN 33-33
configuring PVLAN 35-16 overview 33-1
defined 35-5 overview of per-port per-VLAN 33-10
setting mode 35-22 packet modification 33-9
protocol timers 16-4 traffic shaping 33-9
provider edge devices 31-2 See also COS; DSCP values; transmit queues
pruning, VTP QoS active queue management
See VTP pruning tracking queue length 33-9
pseudobridges QoS labels
description 16-25 definition 33-3
PVACL 40-19 QoS marking
PVID (port VLAN ID) description 33-5
and 802.1X with voice VLAN ports 36-19 QoS on Sup 6-E
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-22 OL-22250-01
Index
Active Queue management via DBL 33-32 Quality of service
active queue management via DBL 33-25, 33-32 See QoS
classification 33-13 queueing 33-8
configuring 33-11 queue-limiting, QoS on Sup 6-E 33-29
configuring the policy map marking action 33-21
hardware capabilities for marking 33-21
R
how to implement policing 33-15
marking action drivers 33-19 RADIUS server
marking network traffic 33-16 configure to-Switch communication 36-27
MQC-based QoS configuration 33-11 configuring settings 36-29
multi-attribute marking support 33-20 parameters on the switch 36-27
platform hardware capabilities 33-12 range command 7-5
platform restrictions 33-16 range macros
platform-supported classification criteria and QoS defining 7-6
features 33-11 ranges of interfaces
policing 33-14 configuring 7-4
policy associations 33-37 Rapid Spanning Tree
prerequisites for applying a service policy 33-13 See RSTP
priority queuing 33-28 re-authentication of a client
queue-limiting 33-29 configuring manual 36-66
restrictions for applying a service policy 33-13 enabling periodic 36-61
shaping 33-23 redirect URLs, port-based authentication 36-17
sharing(bandwidth) 33-25 reduced MAC address 16-2
sharing(blandwidth), shapring, and priority redundancy
queuing 33-23
configuring 5-7
software QoS 33-38
guidelines and restrictions 5-6
traffic marking procedure flowchart 33-19
changes made through SNMP 5-11
QoS policing
NSF-aware support 9-2
definition 33-5
NSF-capable support 9-2
described 33-8
overview 5-2
QoS policy
redundancy command 5-8
attaching to interfaces 33-8
understanding synchronization 5-5
QoS service policy
redundancy (NSF) 9-1
prerequisites 33-13
configuring
restrictions for applying 33-13
BGP 9-9
QoS transmit queues
CEF 9-8
burst 33-9
EIGRP 9-12
maximum rate 33-9
OSPF 9-11
sharing link bandwidth 33-9
routing protocols 9-5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-23
Index
redundancy (RPR) RIP
route processor redundancy 5-3 description 1-13
synchronization 5-5 for IPv6 43-5
redundancy (SSO) RMON
redundancy command 9-8 default configuration 51-3
route processor redundancy 5-3 displaying status 51-6
synchronization 5-6 enabling alarms and events 51-3
reload command 3-28, 3-29, 3-40 groups supported 51-2
Remote Network Monitoring overview 51-1
See RMON ROM monitor
rendezvous point, configuring 29-16 boot process and 3-26
rendezvous point, configuring single static 29-19 CLI 2-7
replication commands 54-2 to ??
description 29-8 exiting 54-5
report suppression, IGMP root bridge
disabling 22-10 configuring 16-9
reserved-range VLANs selecting in MST 16-22
See VLANs root guard
reset command 54-3 and MST 16-23
resetting an interface to default configuration 7-28 enabling 18-2
resetting a switch to defaults 3-32 overview 18-2
responder, IP SLAs routed packets
described 50-4 ACLs 42-26
enabling 50-8 route-map (IP) command 30-6
response time, measuring with IP SLAs 50-5 route maps
restricting access defining 30-6
NTP services 4-8 PBR 30-2
TACACS+ 3-15 router ACLs
retransmission number description 42-3
setting in 802.1X authentication 36-64 using with VLAN maps 42-25
retransmission time router ACLs, using PACL with VLAN maps 42-31
changing in 802.1X authentication 36-63 route targets
RFC VPN 31-3
1157, SNMPv1 49-2 Routing Information Protocol
1305, NTP 4-2 See RIP
1757, RMON 51-2 RPF
1901, SNMPv2C 49-2 <Emphasis>See Unicast RPF
1902 to 1907, SNMPv2 49-2 RSPAN
2273-2275, SNMPv3 49-2 configuration guidelines 46-16
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-24 OL-22250-01
Index
destination ports 46-5 description 52-23
IDS 46-3 service policy, configure class-level queue-limit 33-29
monitored ports 46-4 service-policy input command 25-2
monitoring ports 46-5 set default interface command 30-7
received traffic 46-3 set interface command 30-7
sessions set ip default next-hop command 30-7
creating 46-17 set ip next-hop command 30-6
defined 46-3 set-request operation 49-4
limiting source traffic to specific VLANs 46-23 severity levels, defining in system messages 47-8
monitoring VLANs 46-22 shaping, QoS on Sup 6-E 33-23
removing source (monitored) ports 46-21 sharing(bandwidth), QoS on Sup 6-E 33-25
specifying monitored ports 46-17 show adjacency command 27-9
source ports 46-4 show boot command 3-31
transmitted traffic 46-4 show catalyst4000 chassis-mac-address command 16-3
VLAN-based 46-5 show cdp command 20-2, 20-3
RSTP show cdp entry command 20-3
compatibility 16-23 show cdp interface command 20-3
description 16-22 show cdp neighbors command 20-4
port roles 16-23 show cdp traffic command 20-4
port states 16-24 show ciscoview package command 4-33
show ciscoview version command 4-33
show configuration command 7-13
S
show debugging command 20-4
SAID show environment command 10-2
See 802.10 SAID show history command 2-4
scheduling 33-8 show interfaces command 7-19, 7-20, 7-24, 7-26, 7-27
scheduling, IP SLAs operations 50-6 show interfaces status command 8-2
secondary root switch 16-12 show ip cef command 27-8
secondary VLANs 35-3 show ip eigrp interfaces command 26-17
associating with primary 35-14 show ip eigrp neighbors command 26-17
permitting routing 35-21 show ip eigrp topology command 26-17
security show ip eigrp traffic command 26-17
configuring 39-1 show ip interface command 29-21
Security Association Identifier show ip local policy command 30-8
See 802.10 SAID show ip mroute command 29-21
selecting a power management mode 10-7 show ip pim interface command 29-21
selecting X2/TwinGig Convertor Mode 7-8 show lldp traffic command 23-10
sequence numbers in log messages 47-7 show mac-address-table address command 8-3
server IDs show mac-address-table interface command 8-3
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-25
Index
show mls entry command 27-8 defined 15-1
show module command 8-2, 16-5 displaying 15-12
show PoE consumed 11-7 tracing 15-6
show power inline command 11-6 SNMP
show power supplies command 10-10 accessing MIB variables with 49-4
show protocols command 7-24 agent
show running-config command described 49-4
adding description for an interface 7-13 disabling 49-7
checking your settings 3-9 and IP SLAs 50-3
displaying ACLs 42-19, 42-21, 42-28, 42-29, 42-30 authentication level 49-10
show startup-config command 3-10 community strings
show users command 8-6 configuring 49-7
show version command 3-29 overview 49-4
shutdown, command 7-25 configuration examples 49-16
shutting down configuration guidelines 49-6
interfaces 7-25 default configuration 49-5
Simple Network Management Protocol enabling 55-4, 55-5
See SNMP engine ID 49-6
single-host mode 36-7 groups 49-6, 49-9
single spanning tree host 49-6
See SST informs
single static RP, configuring 29-19 and trap keyword 49-11
slot numbers, description 7-2 described 49-5
smart call home 52-1 differences from traps 49-5
description 52-2 enabling 49-15
destination profile (note) 52-5 limiting access by TFTP servers 49-15
registration requirements 52-3 limiting system log messages to NMS 47-9
service contract requirements 52-3 manager functions 49-3
Transport Gateway (TG) aggregation point 52-2 notifications 49-5
SMARTnet overview 49-1, 49-4
smart call home registration 52-3 status, displaying 49-17
Smartports macros system contact and location 49-15
applying global parameter values 15-8 trap manager, configuring 49-13
applying macros 15-8 traps
applying parameter values 15-8 described 49-3, 49-5
configuration guidelines 15-6 differences from informs 49-5
configuring 15-2 enabling 49-11
creating 15-7 enabling MAC address notification 4-22
default configuration 15-3 enabling MAC move notification 4-24
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-26 OL-22250-01
Index
enabling MAC threshold notification 4-26 SPAN enhancements
overview 49-1, 49-4 access list filtering 46-13
types of 49-11 configuration example 46-15
users 49-6, 49-9 CPU port sniffing 46-10
versions supported 49-2 encapsulation configuration 46-12
SNMP commands 55-4 ingress packets 46-12
SNMPv1 49-2 packet type filtering 46-14
SNMPv2C 49-2 spanning-tree backbonefast command 18-16
SNMPv3 49-2 spanning-tree cost command 16-15
software spanning-tree guard root command 18-2
upgrading 5-13 spanning-tree portfast bpdu-guard command 18-9
software configuration register 3-26 spanning-tree portfast command 18-7
software QoS, on Sup 6-E 33-38 spanning-tree port-priority command 16-13
software switching spanning-tree uplinkfast command 18-13
description 27-5 spanning-tree vlan
interfaces 27-6 command 16-9
key data structures used 29-7 command example 16-9
source IDs spanning-tree vlan command 16-8
call home event format 52-22 spanning-tree vlan cost command 16-15
SPAN spanning-tree vlan forward-time command 16-19
and ACLs 46-5 spanning-tree vlan hello-time command 16-17
configuration guidelines 46-7 spanning-tree vlan max-age command 16-18
configuring 46-7 to 46-10 spanning-tree vlan port-priority command 16-13
destination ports 46-5 spanning-tree vlan priority command 16-17
IDS 46-3 spanning-tree vlan root primary command 16-10
monitored port, defined 46-4 spanning-tree vlan root secondary command 16-12
monitoring port, defined 46-5 speed
received traffic 46-3 configuring interface 7-11
sessions speed command 7-12
defined 46-3 SSO
source ports 46-4 configuring 9-8
transmitted traffic 46-4 SSO operation 9-3
VLAN-based 46-5 SST
SPAN and RSPAN description 16-22
concepts and terminology 46-3 interoperability 16-24
default configuration 46-6 static addresses
displaying status 46-24 See addresses
overview 46-2 static routes
session limits 46-6 configuring 3-11
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-27
Index
verifying 3-12 per-VLAN rapid spanning tree 16-6
statistics port cost 16-15
802.1X 37-13 port priority 16-13
displaying 802.1X 36-67 root bridge 16-9
displaying PIM 29-25 stratum, NTP 4-2
LLDP 23-10 stub routing (EIGRP)
LLDP-MED 23-10 benefits 26-16
SNMP input and output 49-17 configuration tasks 26-16
sticky learning configuring 26-12
configuration file 38-5 overview 26-11, 26-12
defined 38-5 restrictions 26-16
disabling 38-5 verifying 26-17
enabling 38-5 subdomains, private VLAN 35-3
saving addresses 38-5 summer time 4-13
sticky MAC addresses supervisor engine
configuring 38-7 accessing the redundant 5-14
defined 38-4 configuring 3-8 to 3-13
Storm Control copying files to standby 5-14
displaying 45-6 default configuration 3-1
enabling Broadcast 45-3 default gateways 3-11
enabling Multicast 45-4 environmental monitoring 10-1
hardware-based, implementing 45-2 redundancy 9-1
overview 45-1 ROM monitor 3-26
software-based, implementing 45-2 startup configuration 3-25
STP static routes 3-11
bridge ID 16-2 synchronizing configurations 5-11
configuring 16-7 to 16-20 Supervisor Engine II-TS
creating topology 16-4 insufficient inline power handling 11-11
defaults 16-6 SVI Autostate Exclude
disabling 16-19 understanding 26-3
enabling 16-7 SVI Autostate exclude
enabling extended system ID 16-8 configuring 26-6
enabling Per-VLAN Rapid Spanning Tree 16-20 switch 43-2
EtherChannel guard switched packets
disabling 18-7 and ACLs 42-25
forward-delay time 16-18 Switched Port Analyzer
hello time 16-17 See SPAN
maximum aging time 16-18 switchport
overview 16-1, 16-3 show interfaces 7-19, 7-20, 7-26, 7-27
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-28 OL-22250-01
Index
switchport access vlan command 14-6, 14-8 system message logging
switchport block multicast command 44-2 default configuration 47-3
switchport block unicast command 44-2 defining error message severity levels 47-8
switchport mode access command 14-8 disabling 47-4
switchport mode dynamic command 14-6 displaying the configuration 47-12
switchport mode trunk command 14-6 enabling 47-4
switch ports facility keywords, described 47-12
See access ports level keywords, described 47-9
switchport trunk allowed vlan command 14-6 limiting messages 47-9
switchport trunk encapsulation command 14-6 message format 47-2
switchport trunk encapsulation dot1q command 14-3 overview 47-1
switchport trunk encapsulation isl command 14-3 sequence numbers, enabling and disabling 47-7
switchport trunk encapsulation negotiate command 14-3 setting the display destination device 47-5
switchport trunk native vlan command 14-6 synchronizing log messages 47-6
switchport trunk pruning vlan command 14-7 timestamps, enabling and disabling 47-7
switch-to-RADIUS server communication UNIX syslog servers
configuring 36-27 configuring the daemon 47-10
system configuring the logging facility 47-11
reviewing configuration 3-10 facilities supported 47-12
settings at startup 3-27 system name
system alarms manual configuration 4-15
on Sup 2+ to V-10GE 10-4 See also DNS
overview 10-4 system name TLV 23-2
system and network statistics, displaying 29-21 system prompt, default setting 4-14
system capabilities TLV 23-2
system clock
T
configuring
daylight saving time 4-13 TACACS+ 39-1
manually 4-11 accounting, defined 3-16
summer time 4-13 authentication, defined 3-16
time zones 4-12 authorization, defined 3-16
displaying the time and date 4-12 configuring
overview 4-2 accounting 3-21
See also NTP authentication key 3-18
system description TLV 23-2 authorization 3-21
system images login authentication 3-19
loading from Flash memory 3-30 default configuration 3-18
modifying boot field 3-27 displaying the configuration 3-22
specifying 3-30 identifying the server 3-18
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-29
Index
limiting the services to the user 3-21 Topology change notification processing
operation of 3-17 MLD Snooping
overview 3-15 Topology change notification processing 22-4
tracking services accessed by user 3-21 TOS
TCAM programming and ACLs 42-7 description 33-4
for Sup II-Plust thru V-10GE 42-6 trace command 8-9
TDR traceroute
checking cable connectivity 8-3 See IP traceroute
enabling and disabling test 8-3 See Layer 2 Traceroute
guidelines 8-3 traceroute mac command 8-11
Telnet traceroute mac ip command 8-11
accessing CLI 2-2 traffic
disconnecting user sessions 8-7 blocking flooded 44-2
executing 8-5 traffic control
monitoring user sessions 8-6 using ACLs (figure) 42-4
telnet command 8-6 using VLAN maps (figure) 42-5
Terminal Access Controller Access Control System Plus traffic marking procedure flowchart 33-19
See TACACS+ traffic shaping 33-9
TFTP translational bridge numbers (defaults) 12-5
configuration files in base directory 3-5 traps
configuring for autoconfiguration 3-4 configuring MAC address notification 4-22
limiting access by servers 49-15 configuring MAC move notification 4-24
threshold monitoring, IP SLAs 50-6 configuring MAC threshold notification 4-26
time configuring managers 49-11
See NTP and system clock defined 49-3
Time Domain Reflectometer enabling 4-22, 4-24, 4-26, 49-11
See TDR notification types 49-11
time exceeded messages 8-9 overview 49-1, 49-4
timer troubleshooting
See login timer with CiscoWorks 49-4
timestamps in log messages 47-7 with system message logging 47-1
time zones 4-12 with traceroute 8-9
TLV troubleshooting high CPU due to ACLs 42-6
host presence detection 36-8 trunk ports
TLVs configure port security 38-17
defined 1-4, 23-2 configuring PVLAN 35-18 to 35-19
LLDP-MED 23-2 trunks
Token Ring 802.1Q restrictions 14-5
media not supported (note) 12-5, 12-9 configuring 14-6
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-30 OL-22250-01
Index
configuring access VLANs 14-6 unicast MAC address filtering, configuring
configuring allowed VLANs 14-6 ACLs
default interface configuration 14-6 configuring unicast MAC address filtering 42-12
different VTP domains 14-3 Unicast RPF (Unicast Reverse Path Forwarding)
enabling to non-DTP device 14-4 applying 28-5
encapsulation 14-3 BGP attributes
specifying native VLAN 14-6 caution 28-5
understanding 14-3 CEF
trustpoint 52-3 requirement 28-2
TwinGig Convertors tables 28-7
port numbering 7-7 configuring 28-9
selecting X2/TwinGig Convertor mode 7-8 (examples) ?? to 28-12
type length value BOOTP 28-8
See TLV DHCP 28-8
type of service enterprise network (figure) 28-6
See TOS prerequisites 28-9
routing table requirements 28-7
tasks 28-9
U
verifying 28-10
UDLD deploying 28-5
default configuration 24-2 description 1-15, 28-2
disabling 24-5 disabling 28-11
enabling 24-4 enterprise network (figure) 28-6
overview 24-1 FIB 28-2
UDP jitter, configuring 50-9 implementing 28-4
UDP jitter operation, IP SLAs 50-9 maintaining 28-11
unauthorized ports with 802.1X 36-4 monitoring 28-11
unicast packets, dropping (figure) 28-4
See IP unicast prerequisites 28-9
unicast flood blocking restrictions
configuring 44-1 basic 28-8
unicast MAC address filtering routing asymmetry 28-7
and adding static addresses 4-29 routing asymmetry (figure) 28-8
and broadcast MAC addresses 4-28 routing table requirements 28-7
and CPU packets 4-29 security policy
and multicast addresses 4-28 applying 28-5
and router MAC addresses 4-28 attacks, mitigating 28-5
configuration guidelines 4-28 deploying 28-5
described 4-28 tunneling 28-5
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-31
Index
source addresses, validating 28-3 See VLANs
(figure) 28-3, 28-4 Virtual Private Network
failure 28-3 See VPN
traffic filtering 28-5 Virtual Switch System(VSS), displaying EtherChannel
to 19-14
tunneling 28-5
VLAN ACLs
validation
See VLAN maps
failure 28-3, 28-4
vlan command 12-6
packets, dropping 28-3
VLAN ID, discovering 4-30
source addresses 28-3
VLAN Management Policy Server
verifying 28-10
See VMPS
unicast traffic
VLAN maps
blocking 44-2
applying to a VLAN 42-21
unidirectional ethernet
enabling 25-2
configuration example 42-22
example of setting 25-2
configuration guidelines 42-18
overview 25-1
configuring 42-17
UniDirectional Link Detection Protocol creating and deleting entries 42-19
See UDLD defined 42-3
UNIX syslog servers denying access example 42-23
daemon configuration 47-10
denying packets 42-19
facilities supported 47-12
displaying 42-24
message logging configuration 47-11
order of entries 42-18
UplinkFast permitting packets 42-19
and MST 16-23
router ACLs and 42-25
enabling 18-16
using (figure) 42-5
MST and 16-23
using in your network 42-22
overview 18-11
VLAN maps, PACL and Router ACLs 42-31
VLANs
user EXEC mode 2-5
allowed on trunk 14-6
user sessions
disconnecting configuration guidelines 12-3
8-7
configuring 12-5
monitoring 8-6
default configuration 12-4
using PACL with access-group mode 42-29
description 1-7
extended range 12-3
V IDs (default) 12-4
VACLs interface assignment 12-7
Layer 4 port operations 42-9 limiting source traffic with RSPAN 46-23
virtual configuration register 54-3 monitoring with RSPAN 46-22
virtual LANs name (default) 12-4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-32 OL-22250-01
Index
normal range 12-3 voice interfaces
overview 12-1 configuring 34-1
reserved range 12-3 Voice over IP
See also PVLANs configuring 34-1
VLAN Trunking Protocol voice ports
See VTP configuring VVID 34-3
VLAN trunks voice traffic 11-2, 34-5
overview 14-3 voice VLAN
VMPS IP phone data traffic, described 34-2
configuration file example 12-32 IP phone voice traffic, described 34-2
configuring dynamic access ports on client 12-25 voice VLAN ports
configuring retry interval 12-27 using 802.1X 36-19
database configuration file 12-32 VPN
dynamic port membership configuring routing in 31-11
example 12-29 forwarding 31-3
reconfirming 12-26 in service provider networks 31-1
reconfirming assignments 12-26 routes 31-2
reconfirming membership interval 12-26 routing and forwarding table
server overview 12-21 See VRF
VMPS client VRF
administering and monitoring 12-28 defining 31-3
configure switch tables 31-1
configure reconfirmation interval 12-26 VRF-aware services
dynamic ports 12-25 ARP 31-6, 31-9
entering IP VMPS address 12-24 configuring 31-6
reconfirmation interval 12-27 ftp 31-8
reconfirm VLAM membership 12-26 ping 31-7
default configuration 12-24 SNMP 31-7
dynamic VLAN membership overview 12-23 syslog 31-8
troubleshooting dynamic port VLAN tftp 31-8
membership 12-29
traceroute 31-8
VMPS server
uRPF 31-7
fall-back VLAN 12-23
VTP
illegal VMPS client requests 12-23
client, configuring 12-16
overview 12-21
configuration guidelines 12-12
security modes default configuration 12-13
multiple 12-22
disabling 12-16
open 12-22
monitoring 12-19
secure 12-22
overview 12-7
Software Configuration Guide—Release IOS-XE 3.1.0 SG
OL-22250-01 IN-33
Index
pruning
configuring 12-15
See also VTP version 2
server, configuring 12-16
statistics 12-19
transparent mode, configuring 12-16
version 2
enabling 12-15
VTP advertisements
description 12-9
VTP domains
description 12-8
VTP modes 12-8
VTP pruning
overview 12-11
VTP versions 2 and 3
overview 12-9
See also VTP
VVID (voice VLAN ID)
and 802.1X authentication 36-19
configuring 34-3
Wake-on-LAN
configure with 802.1X 36-52
web-based authentication
authentication proxy web pages 37-4
description 1-25, 36-13, 37-1
web-based authentication, interactions with other
features 37-4
Software Configuration Guide—Release IOS-XE 3.1.0 SG
IN-34 OL-22250-01
You might also like
- A Discovery of Witches Deborah E. Harkness84% (64)A Discovery of Witches Deborah E. Harkness283 pages
- The Hacker Playbook 1 - Practical Guide To Penetration Testing91% (11)The Hacker Playbook 1 - Practical Guide To Penetration Testing308 pages
- The Baofeng Radio Bible (10 IN 1) The Definitive Guerrilla's Handbook To Master Your Baofeng Radio To Be Prepared For Any... (Cooper Hartman) (Z-Library)100% (2)The Baofeng Radio Bible (10 IN 1) The Definitive Guerrilla's Handbook To Master Your Baofeng Radio To Be Prepared For Any... (Cooper Hartman) (Z-Library)200 pages
- Network Security All-in-one: ASA Firepower WSA Umbrella VPN ISE Layer 2 SecurityFrom EverandNetwork Security All-in-one: ASA Firepower WSA Umbrella VPN ISE Layer 2 SecurityNo ratings yet
- Specifications For Excavation and Earthwork100% (2)Specifications For Excavation and Earthwork78 pages
- COMPTIA Security Plus Master Cheat SheetNo ratings yetCOMPTIA Security Plus Master Cheat Sheet33 pages
- Universal Codes For Cell Phones and Advanced Tricks80% (5)Universal Codes For Cell Phones and Advanced Tricks30 pages
- American Survival Guide, Prepper Survival Field Manual - Spring 2017100% (12)American Survival Guide, Prepper Survival Field Manual - Spring 2017132 pages
- Catalyst 4500 Series Switch Software Configuration Guide, 12.2 (53) SGNo ratings yetCatalyst 4500 Series Switch Software Configuration Guide, 12.2 (53) SG1,358 pages
- Catalyst 4500 Series Switch Cisco IOS Software Config GuideNo ratings yetCatalyst 4500 Series Switch Cisco IOS Software Config Guide570 pages
- Cisco IE 2000 Switch Software Configuration GuideNo ratings yetCisco IE 2000 Switch Software Configuration Guide924 pages
- Catalyst 4500 Series Switch Cisco IOS Software Configuration GuideNo ratings yetCatalyst 4500 Series Switch Cisco IOS Software Configuration Guide608 pages
- Cisco IE 3000 Switch Software Configuration Guide: Cisco IOS Release 12.2 (50) SE March 2009No ratings yetCisco IE 3000 Switch Software Configuration Guide: Cisco IOS Release 12.2 (50) SE March 2009874 pages
- Catalyst 2960 Switch Software Configuration GuideNo ratings yetCatalyst 2960 Switch Software Configuration Guide714 pages
- 4500 Switch Cisco Ios Software Configuration GuideNo ratings yet4500 Switch Cisco Ios Software Configuration Guide438 pages
- Annex 12 - Cisco C2960X Configuration GuideNo ratings yetAnnex 12 - Cisco C2960X Configuration Guide2,198 pages
- B - Sec - 152ex - 2960-X - CG (Catalyst 2960-X Switch Security Configuration Guide)No ratings yetB - Sec - 152ex - 2960-X - CG (Catalyst 2960-X Switch Security Configuration Guide)498 pages
- Catalyst 6500 Release 12.2SXF and Rebuilds Software Configuration GuideNo ratings yetCatalyst 6500 Release 12.2SXF and Rebuilds Software Configuration Guide1,015 pages
- Cisco 4000 Series ISRs Software Configuration GuideNo ratings yetCisco 4000 Series ISRs Software Configuration Guide330 pages
- Cisco Nexus 9000 Series NX-OS Interfaces Configuration Guide, Release 6.xNo ratings yetCisco Nexus 9000 Series NX-OS Interfaces Configuration Guide, Release 6.x254 pages
- Catalyst 6500 Series Switch Cisco IOS Software Configuration Guide Release 12.2 (18) SXFNo ratings yetCatalyst 6500 Series Switch Cisco IOS Software Configuration Guide Release 12.2 (18) SXF1,017 pages
- System Management Configuration Guide, Cisco IOS XE Release 3SE (Catalyst 3650 Switches)No ratings yetSystem Management Configuration Guide, Cisco IOS XE Release 3SE (Catalyst 3650 Switches)362 pages
- B Cisco Nexus 9000 Series NX-OS Interfaces Configuration GuideNo ratings yetB Cisco Nexus 9000 Series NX-OS Interfaces Configuration Guide262 pages
- System Management Configuration Guide, Cisco IOS XE Release 3SE (Catalyst 3850 Switches)No ratings yetSystem Management Configuration Guide, Cisco IOS XE Release 3SE (Catalyst 3850 Switches)364 pages
- Operating Cisco Ios Software: Ethernet LansNo ratings yetOperating Cisco Ios Software: Ethernet Lans18 pages
- Cisco IOS Software Configuration GuideNo ratings yetCisco IOS Software Configuration Guide1,382 pages
- Software Configuration Guide, Cisco IOS XE Bengaluru 17.6.x (Catalyst 9400 Switches)No ratings yetSoftware Configuration Guide, Cisco IOS XE Bengaluru 17.6.x (Catalyst 9400 Switches)28 pages
- Cisco Nexus 7000 Series NX OS ProgrammabNo ratings yetCisco Nexus 7000 Series NX OS Programmab84 pages
- Catalyst 3750 Switch Software Configuration Guide: Cisco IOS Release 12.2 (46) SE August 2008No ratings yetCatalyst 3750 Switch Software Configuration Guide: Cisco IOS Release 12.2 (46) SE August 20081,298 pages
- System Management Configuration Guide, Cisco IOS XE Release 3SE (Catalyst 3650 Switches)No ratings yetSystem Management Configuration Guide, Cisco IOS XE Release 3SE (Catalyst 3650 Switches)368 pages
- ME 3400EG 12CS M Software Configuration GuideNo ratings yetME 3400EG 12CS M Software Configuration Guide1,172 pages
- Cisco Nexus 9000 Series NX-OS Interfaces Configuration Guide, Release 7.xNo ratings yetCisco Nexus 9000 Series NX-OS Interfaces Configuration Guide, Release 7.x368 pages
- Cisco Isr4400 Series Software Installation Guide100% (1)Cisco Isr4400 Series Software Installation Guide304 pages
- Catalyst 3560 Switch Software Configuration Guide: Cisco IOS Release 12.2 (25) SEC July 2005No ratings yetCatalyst 3560 Switch Software Configuration Guide: Cisco IOS Release 12.2 (25) SEC July 20051,034 pages
- Catalyst 3560 Switch Software Configuration Guide: Cisco IOS Release 12.2 (25) SEC July 2005No ratings yetCatalyst 3560 Switch Software Configuration Guide: Cisco IOS Release 12.2 (25) SEC July 20051,034 pages
- Next-Generation switching OS configuration and management: Troubleshooting NX-OS in Enterprise EnvironmentsFrom EverandNext-Generation switching OS configuration and management: Troubleshooting NX-OS in Enterprise EnvironmentsNo ratings yet
- Alcatel-Lucent Network Routing Specialist II (NRS II) Self-Study Guide: Preparing for the NRS II Certification ExamsFrom EverandAlcatel-Lucent Network Routing Specialist II (NRS II) Self-Study Guide: Preparing for the NRS II Certification ExamsNo ratings yet
- CISCO PACKET TRACER LABS: Best practice of configuring or troubleshooting NetworkFrom EverandCISCO PACKET TRACER LABS: Best practice of configuring or troubleshooting NetworkNo ratings yet
- Ham Radio For The New Ham What To Do The Minute You Get Your Amateur Radio License - Stan Merrill50% (2)Ham Radio For The New Ham What To Do The Minute You Get Your Amateur Radio License - Stan Merrill137 pages
- CompTIA Network+ v1.0 (N10-008) - Full Access100% (1)CompTIA Network+ v1.0 (N10-008) - Full Access34 pages
- Ham Radio An Easy Guide For Beginners - Steve Markelo100% (4)Ham Radio An Easy Guide For Beginners - Steve Markelo10 pages
- Practical Guide To Radio-Frequency Analysis and DesignNo ratings yetPractical Guide To Radio-Frequency Analysis and Design49 pages
- The Good Times Schools' Newspaper, South Africa, Dec 13No ratings yetThe Good Times Schools' Newspaper, South Africa, Dec 1336 pages
- Kyle Mcevoy - Test Automation in PythonNo ratings yetKyle Mcevoy - Test Automation in Python144 pages
- Michael L. Clamohoy: School Teacher Learning Area Teaching Date & Time / Grade & SectionsNo ratings yetMichael L. Clamohoy: School Teacher Learning Area Teaching Date & Time / Grade & Sections5 pages
- Anatomy Physiology Book Aniket .... 1st SemNo ratings yetAnatomy Physiology Book Aniket .... 1st Sem295 pages
- Black Box Fairness Testing of Machine Learning ModelsNo ratings yetBlack Box Fairness Testing of Machine Learning Models11 pages
- 04 Chapter 1 The Story of Past Very Imp For LifeNo ratings yet04 Chapter 1 The Story of Past Very Imp For Life3 pages
- Developing and Administering a Child Care and Education Program Dorothy June Sciarra - Download the ebook today and own the complete version100% (1)Developing and Administering a Child Care and Education Program Dorothy June Sciarra - Download the ebook today and own the complete version72 pages
- Foundations of Career Counseling A Case Based Approach 1st Edition Dugger Test Bank100% (1)Foundations of Career Counseling A Case Based Approach 1st Edition Dugger Test Bank38 pages
- A Relativistic Generalization of The Kramers-Henneberger Transformation Madalina BOCA100% (1)A Relativistic Generalization of The Kramers-Henneberger Transformation Madalina BOCA35 pages
- Samsung UN32EH5000FXZA Fast Track TroubleshootingNo ratings yetSamsung UN32EH5000FXZA Fast Track Troubleshooting8 pages
