Cisco Nexus 9000 Series User manual

Cisco Nexus 9000 Series NX-OS System Management Configuration
Guide, Release 6.x
First Published: 2013-11-20
Last Modified: 2014-10-10
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: [phone]
800 553-NETS (6387)
Fax: [phone]

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.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
This product includes cryptographic software written by Eric Young ([email protected]).
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)
This product includes software written by Tim Hudson ([email protected]).
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
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. (1110R)
©2013-2014 Cisco Systems, Inc. All rights reserved.

CONTENTS
Preface Preface xvii
Audience xvii
Document Conventions xvii
Related Documentation for Cisco Nexus 9000 Series Switches xviii
Documentation Feedback xviii
Obtaining Documentation and Submitting a Service Request xix
CHAPTER 1 New and Changed Information 1
New and Changed Information 1
CHAPTER 2 Overview 3
Software Image 4
Cisco NX-OS Device Configuration Methods 4
Configuring with CLI or XML Management Interface 5
Configuring with Cisco DCNM 5
Network Time Protocol 5
Cisco Discovery Protocol 5
System Messages 5
Smart Call Home 6
Rollback 6
Session Manager 6
Scheduler 6
SNMP 6
RMON 6
Online Diagnostics 7
Embedded Event Manager 7
Onboard Failure Logging 7
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
iii

SPAN 7
ERSPAN 7
LLDP 7
SMUs 8
Virtual Device Contexts 8
Troubleshooting Features 8
CHAPTER 3 Configuring NTP 9
About NTP 9
NTP Associations 10
NTP as a Time Server 10
Clock Manager 10
High Availability 10
Virtualization Support 11
Licensing Requirements for NTP 11
Prerequisites for NTP 11
Guidelines and Limitations for NTP 11
Default Settings for NTP 12
Configuring NTP 12
Enabling or Disabling NTP 12
Configuring the Device as an Authoritative NTP Server 13
Configuring an NTP Server and Peer 13
Configuring NTP Authentication 15
Configuring NTP Access Restrictions 16
Configuring the NTP Source IP Address 17
Configuring the NTP Source Interface 18
Configuring NTP Logging 18
Verifying the NTP Configuration 19
Configuration Examples for NTP 19
Additional References 21
Related Documents 21
MIBs 21
CHAPTER 4 Configuring CDP 23
About CDP 23
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
iv
Contents

VTP Feature Support 24
High Availability 24
Virtualization Support 25
Licensing Requirements for CDP 25
Guidelines and Limitations for CDP 25
Default Settings for CDP 25
Configuring CDP 25
Enabling or Disabling CDP Globally 26
Enabling or Disabling CDP on an Interface 26
Configuring Optional CDP Parameters 27
Verifying the CDP Configuration 28
Configuration Example for CDP 28
Additional References 29
MIBs 29
CHAPTER 5 Configuring System Message Logging 31
About System Message Logging 31
Syslog Servers 32
Licensing Requirements for System Message Logging 32
Guidelines and Limitations for System Message Logging 33
Default Settings for System Message Logging 33
Configuring System Message Logging 33
Configuring System Message Logging to Terminal Sessions 33
Logging System Messages to a File 35
Configuring Module and Facility Messages Logging 37
Configuring Syslog Servers 40
Configuring Syslog Servers on a UNIX or Linux System 42
Displaying and Clearing Log Files 43
Verifying the System Message Logging Configuration 44
Configuration Example for System Message Logging 44
Additional References 45
Related Documents 45
CHAPTER 6 Configuring Smart Call Home 47
About Smart Call Home 47
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
v
Contents

Destination Profiles 48
Smart Call Home Alert Groups 48
Smart Call Home Message Levels 51
Obtaining Smart Call Home 52
Database Merge Guidelines 53
High Availability 53
Virtualization Support 53
Licensing Requirements for Smart Call Home 53
Prerequisites for Smart Call Home 54
Guidelines and Limitations for Smart Call Home 54
Default Settings for Smart Call Home 54
Configuring Smart Call Home 55
Configuring Contact Information 55
Creating a Destination Profile 57
Modifying a Destination Profile 58
Associating an Alert Group with a Destination Profile 60
Adding Show Commands to an Alert Group 61
Configuring the Email Server 62
Configuring VRFs To Send Messages Using HTTP 64
Configuring an HTTP Proxy Server 65
Configuring Periodic Inventory Notifications 66
Disabling Duplicate Message Throttling 67
Enabling or Disabling Smart Call Home 68
Testing the Smart Call Home Configuration 69
Verifying the Smart Call Home Configuration 69
Configuration Examples for Smart Call Home 70
Additional References 71
Event Triggers 71
Message Formats 72
Short Text Message Format 73
Common Event Message Fields 73
Alert Group Message Fields 76
Fields for Reactive and Proactive Event Messages 76
Fields for Inventory Event Messages 76
Fields for User-Generated Test Messages 77
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
vi
Contents

Sample Syslog Alert Notification in Full-Text Format 77
Sample Syslog Alert Notification in XML Format 80
MIBs 83
CHAPTER 7 Configuring Rollback 85
About Rollbacks 85
Automatically Generated System Checkpoints 86
High Availability 86
Virtualization Support 86
Licensing Requirements for Rollbacks 87
Prerequisites for Rollbacks 87
Guidelines and Limitations for Rollbacks 87
Default Settings for Rollbacks 88
Configuring Rollbacks 88
Creating a Checkpoint 88
Implementing a Rollback 89
Verifying the Rollback Configuration 89
Configuration Example for Rollback 90
Additional References 90
Related Documents 90
CHAPTER 8 Configuring Session Manager 91
About Session Manager 91
High Availability 92
Licensing Requirements for Session Manager 92
Prerequisites for Session Manager 92
Guidelines and Limitations for Session Manager 92
Configuring Session Manager 92
Creating a Session 93
Configuring ACLs in a Session 93
Verifying a Session 94
Committing a Session 94
Saving a Session 94
Discarding a Session 95
Verifying the Session Manager Configuration 95
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
vii
Contents

Configuration Example for Session Manager 95
Additional References 96
Related Documents 96
CHAPTER 9 Configuring the Scheduler 97
About the Scheduler 97
Remote User Authentication 98
Logs 98
High Availability 98
Licensing Requirements for the Scheduler 98
Prerequisites for the Scheduler 98
Guidelines and Limitations for the Scheduler 99
Default Settings for the Scheduler 99
Configuring the Scheduler 99
Enabling or Disabling the Scheduler 99
Defining the Scheduler Log File Size 100
Configuring Remote User Authentication 100
Defining a Job 101
Deleting a Job 102
Defining a Timetable 103
Clearing the Scheduler Log File 105
Verifying the Scheduler Configuration 105
Configuration Examples for the Scheduler 106
Creating a Scheduler Job 106
Scheduling a Scheduler Job 106
Displaying the Job Schedule 106
Displaying the Results of Running Scheduler Jobs 107
CHAPTER 10 Configuring SNMP 109
About SNMP 109
SNMP Functional Overview 109
SNMP Notifications 110
SNMPv3 111
Security Models and Levels for SNMPv1, v2, v3 111
User-Based Security Model 112
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
viii
Contents

CLI and SNMP User Synchronization 113
Group-Based SNMP Access 114
SNMP and Embedded Event Manager 114
Multiple Instance Support 114
High Availability for SNMP 115
Virtualization Support for SNMP 115
Licensing Requirements for SNMP 115
Guidelines and Limitations for SNMP 115
Default Settings for SNMP 115
Configuring SNMP 116
Configuring SNMP Users 116
Enforcing SNMP Message Encryption 116
Assigning SNMPv3 Users to Multiple Roles 117
Creating SNMP Communities 118
Filtering SNMP Requests 118
Configuring SNMP Notification Receivers 119
Configuring a Source Interface for SNMP Notifications 120
Configuring the Notification Target User 121
Configuring SNMP Notification Receivers with VRFs 122
Configuring SNMP to Send Traps Using an Inband Port 123
Enabling SNMP Notifications 124
Disabling Link Notifications on an Interface 132
Displaying SNMP ifIndex for an Interface 133
Enabling a One-Time Authentication for SNMP over TCP 133
Assigning SNMP Device Contact and Location Information 133
Configuring the Context to Network Entity Mapping 134
Disabling SNMP 135
Modifying the AAA Synchronization Time 136
Verifying SNMP Configuration 136
Configuration Examples for SNMP 137
Additional References 139
Related Documents 139
RFCs 139
MIBs 139
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
ix
Contents

CHAPTER 11 Configuring RMON 141
About RMON 141
RMON Alarms 142
RMON Events 142
High Availability for RMON 143
Virtualization Support for RMON 143
Licensing Requirements for RMON 143
Guidelines and Limitations for RMON 143
Default Settings for RMON 143
Configuring RMON 144
Configuring RMON Alarms 144
Configuring RMON Events 145
Verifying the RMON Configuration 146
Configuration Examples for RMON 146
Additional References 146
MIBs 146
CHAPTER 12 Configuring Online Diagnostics 147
About Online Diagnostics 147
Bootup Diagnostics 148
Runtime or Health Monitoring Diagnostics 148
On-Demand Diagnostics 150
High Availability 150
Virtualization Support 151
Licensing Requirements for Online Diagnostics 151
Guidelines and Limitations for Online Diagnostics 151
Default Settings for Online Diagnostics 151
Configuring Online Diagnostics 152
Setting the Bootup Diagnostic Level 152
Activating a Diagnostic Test 153
Starting or Stopping an On-Demand Diagnostic Test 154
Simulating Diagnostic Results 154
Clearing Diagnostic Results 155
Verifying the Online Diagnostics Configuration 155
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
x
Contents

Configuration Examples for Online Diagnostics 156
CHAPTER 13 Configuring the Embedded Event Manager 157
About EEM 157
Policies 158
Event Statements 159
Action Statements 160
VSH Script Policies 160
Environment Variables 160
EEM Event Correlation 161
High Availability 161
Virtualization Support 161
Licensing Requirements for EEM 161
Prerequisites for EEM 161
Guidelines and Limitations for EEM 161
Default Settings for EEM 162
Configuring EEM 162
Defining an Environment Variable 162
Defining a User Policy Using the CLI 163
Configuring Event Statements 164
Configuring Action Statements 169
Defining a Policy Using a VSH Script 171
Registering and Activating a VSH Script Policy 171
Overriding a Policy 172
Configuring Memory Thresholds 173
Configuring Syslog as EEM Publisher 175
Verifying the EEM Configuration 176
Configuration Examples for EEM 177
CHAPTER 14 Configuring Onboard Failure Logging 179
About OBFL 179
Licensing Requirements for OBFL 180
Prerequisites for OBFL 180
Guidelines and Limitations for OBFL 180
Default Settings for OBFL 180
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
xi
Contents

Configuring OBFL 181
Verifying the OBFL Configuration 182
Configuration Example for OBFL 184
Additional References 184
Related Documents 184
CHAPTER 15 Configuring SPAN 185
About SPAN 185
SPAN Sources 185
Characteristics of Source Ports 186
SPAN Destinations 186
Characteristics of Destination Ports 187
SPAN Sessions 187
Localized SPAN Sessions 187
ACL TCAM Regions 188
High Availability 188
Licensing Requirements for SPAN 188
Prerequisites for SPAN 188
Guidelines and Limitations for SPAN 188
Default Settings for SPAN 190
Configuring SPAN 190
Configuring a SPAN Session 190
Shutting Down or Resuming a SPAN Session 193
Verifying the SPAN Configuration 194
Configuration Examples for SPAN 194
Configuration Example for a SPAN Session 194
Configuration Example for a Unidirectional SPAN Session 195
Configuration Example for a SPAN ACL 196
Additional References 196
Related Documents 196
CHAPTER 16 Configuring ERSPAN 197
About ERSPAN 197
ERSPAN Types 197
ERSPAN Sources 198
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
xii
Contents

ERSPAN Sessions 198
Localized ERSPAN Sessions 198
High Availability 199
Licensing Requirements for ERSPAN 199
Prerequisites for ERSPAN 199
Guidelines and Limitations for ERSPAN 199
Default Settings 200
Configuring ERSPAN 201
Configuring an ERSPAN Source Session 201
Shutting Down or Activating an ERSPAN Session 204
Verifying the ERSPAN Configuration 205
Configuration Examples for ERSPAN 206
Configuration Example for a Unidirectional ERSPAN Session 206
Configuration Example for an ERSPAN ACL 206
Additional References 207
Related Documents 207
CHAPTER 17 Configuring LLDP 209
About LLDP 209
High Availability 210
Virtualization Support 210
Licensing Requirements for LLDP 210
Guidelines and Limitations for LLDP 210
Default Settings for LLDP 211
Configuring LLDP 211
Enabling or Disabling LLDP Globally 211
Enabling or Disabling LLDP on an Interface 212
Configuring Optional LLDP Parameters 213
Verifying the LLDP Configuration 214
Configuration Example for LLDP 215
CHAPTER 18 Performing Software Maintenance Upgrades 217
About SMUs 217
Package Management 218
Impact of Package Activation and Deactivation 218
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
xiii
Contents

Prerequisites for SMUs 219
Guidelines and Limitations for SMUs 219
Performing a Software Maintenance Upgrade for Cisco NX-OS 220
Preparing for Package Installation 220
Downloading the SMU Package File from Cisco.com 221
Copying the Package File to a Local Storage Device or Network Server 221
Adding and Activating Packages 224
Committing the Active Package Set 226
Deactivating and Removing Packages 227
Displaying Installation Log Information 229
Performing a Software Maintenance Upgrade for Guest Shell Bash 231
Additional References 232
Related Documents 232
SMU History 232
APPENDIX A IETF RFCs supported by Cisco NX-OS System Management 235
IETF RFCs Supported by Cisco NX-OS System Management 235
APPENDIX B Embedded Event Manager System Events and Configuration Examples 237
EEM System Policies 237
EEM Events 239
Configuration Examples for EEM Policies 241
Configuration Examples for CLI Events 241
Monitoring Interface Shutdown 241
Monitoring Module Powerdown 241
Adding a Trigger to Initiate a Rollback 241
Configuration Examples to Override (Disable) Major Thresholds 242
Preventing a Shutdown When Reaching a Major Threshold 242
Disabling One Bad Sensor 242
Disabling Multiple Bad Sensors 242
Overriding (Disabling) an Entire Module 243
Overriding (Disabling) Multiple Modules and Sensors 243
Enabling One Sensor While Disabling All Remaining Sensors of All Modules 243
Enabling Multiple Sensors While Disabling All Remaining Sensors of All
Modules 244
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
xiv
Contents

Enabling All Sensors of One Module While Disabling All Sensors of the Remaining
Modules 244
Enabling a Combination of Sensors on Modules While Disabling All Sensors of the
Remaining Modules 244
Configuration Examples to Override (Disable) Shutdown for Fan Tray Removal 245
Overriding (Disabling) a Shutdown for Removal of One or More Fan Trays 245
Overriding (Disabling) a Shutdown for Removal of a Specified Fan Tray 245
Overriding (Disabling) a Shutdown for Removal of Multiple Specified Fan Trays 245
Overriding (Disabling) a Shutdown for Removal of All Fan Trays Except One 246
Overriding (Disabling) a Shutdown for Removal of Fan Trays Except for a Specified Set
of Fan Trays 246
Overriding (Disabling) a Shutdown for Removal of All Fan Trays Except One from a Set
of Fan Trays 246
Configuration Examples to Create a Supplemental Policy 246
Creating a Supplemental Policy for the Fan Tray Absent Event 246
Creating a Supplemental Policy for the Temperature Threshold Event 247
Configuration Examples for the Power Over-Budget Policy 247
Shutting Down Modules 247
Shutting Down a Specified List of Modules 247
Configuration Examples to Select Modules to Shut Down 248
Using the Policy Default to Select Nonoverridden Modules to Shut Down 248
Using Parameter Substitution to Select Nonoverridden Modules to Shut Down 248
Configuration Examples for the Online Insertion Removal Event 248
Configuration Example to Generate a User Syslog 249
Configuration Example to Monitor Syslog Messages 249
Configuration Examples for SNMP Notification 249
Polling an SNMP OID to Generate an EEM Event 249
Sending an SNMP Notification in Response to an Event in the Event Policy 250
Configuration Example for Port Tracking 250
Configuration Example to Register an EEM Policy with the EEM 251
APPENDIX C Configuration Limits for Cisco NX-OS System Management 255
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
xv
Contents

Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
xvi
Contents

Preface
This preface includes the following sections:
•Audience, page xvii
•Document Conventions, page xvii
•Related Documentation for Cisco Nexus 9000 Series Switches, page xviii
•Documentation Feedback, page xviii
•Obtaining Documentation and Submitting a Service Request, page xix
Audience
This publication is for network administrators who install, configure, and maintain Cisco Nexus switches.
Document Conventions
Command descriptions use the following conventions:
DescriptionConvention
Bold text indicates the commands and keywords that you enter literally
as shown.
bold
Italic text indicates arguments for which the user supplies the values.
Italic
Square brackets enclose an optional element (keyword or argument).[x]
Square brackets enclosing keywords or arguments separated by a vertical
bar indicate an optional choice.
[x | y]
Braces enclosing keywords or arguments separated by a vertical bar
indicate a required choice.
{x | y}
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
xvii

DescriptionConvention
Nested set of square brackets or braces indicate optional or required
choices within optional or required elements. Braces and a vertical bar
within square brackets indicate a required choice within an optional
element.
[x {y | z}]
Indicates a variable for which you supply values, in context where italics
cannot be used.
variable
A nonquoted set of characters. Do not use quotation marks around the
string or the string will include the quotation marks.
string
Examples use the following conventions:
DescriptionConvention
Terminal sessions and information the switch displays are in screen font.screen font
Information you must enter is in boldface screen font.boldface screen font
Arguments for which you supply values are in italic screen font.
italic screen font
Nonprinting characters, such as passwords, are in angle brackets.< >
Default responses to system prompts are in square brackets.[ ]
An exclamation point (!) or a pound sign (#) at the beginning of a line
of code indicates a comment line.
!, #
Related Documentation for Cisco Nexus 9000 Series Switches
The entire Cisco Nexus 9000 Series switch documentation set is available at the following URL:
http://www.cisco.com/en/US/products/ps13386/tsd_products_support_series_home.html
Documentation Feedback
To provide technical feedback on this document, or to report an error or omission, please send your comments
to [email protected]. We appreciate your feedback.
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
xviii
Preface
Related Documentation for Cisco Nexus 9000 Series Switches

Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service
request, and gathering additional information, see What's New in Cisco Product Documentation at: http://
www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html.
Subscribe to What's New in Cisco Product Documentation, which lists all new and revised Cisco technical
documentation as an RSS feed and delivers content directly to your desktop using a reader application. The
RSS feeds are a free service.
Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
xix
Preface
Obtaining Documentation and Submitting a Service Request

Cisco Nexus 9000 Series NX-OS System Management Configuration Guide, Release 6.x
xx
Preface
Obtaining Documentation and Submitting a Service Request