Cisco Nexus 3548 series Configuration Manual

Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x

First Published: 2018-06-14
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
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.
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:
https://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. (1721R)
©
2018 Cisco Systems, Inc. All rights reserved.

CONTENTS

PREFACE
CHAPTER 1
CHAPTER 2
CHAPTER 3
Preface xiii
Audience xiii
Document Conventions xiii
Obtaining Documentation and Submitting a Service Request xiv
Documentation Feedback xiv
Related Documentation for Cisco Nexus 3000 Series Switches xiv
New and Changed Information 1
New and Changed Information 1
Overview 3
System Management Features 3
Configuring PTP 7
Information About PTP 7
PTP Device Types 8
PTP Process 9
High Availability for PTP 9
Licensing Requirements for PTP 10
Guidelines and Limitations for PTP 10
Default Settings for PTP 10
Configuring PTP 11
Configuring PTP Globally 11
Configuring PTP on an Interface 13
Configuring Multiple PTP Domains 14
Configuring PTP Grandmaster Clock 17
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
iii
Contents
Configuring PTP Cost Interface 18
Configuring clock Identity 19
Verifying the PTP Configuration 20
CHAPTER 4
Configuring NTP 21
Information About NTP 21
NTP as a Time Server 22
Distributing NTP Using CFS 22
Clock Manager 22
Virtualization Support 22
Licensing Requirements for NTP 23
Guidelines and Limitations for NTP 23
Default Settings 24
Configuring NTP 24
Configuring NTP Server and Peer 24
Configuring NTP Authentication 26
Configuring NTP Access Restrictions 27
Configuring the NTP Source IP Address 28
Configuring the NTP Source Interface 29
Configuring NTP Logging 29
CHAPTER 5
Enabling CFS Distribution for NTP 30
Commiting NTP Configuration Changes 31
Discarding NTP Configuration Changes 31
Releasing the CFS Session Lock 32
Verifying the NTP Configuration 32
Configuration Examples for NTP 33
Related Documents for NTP 34
Feature History for NTP 34
Configuring System Message Logging 35
Information About System Message Logging 35
Syslog Servers 36
Licensing Requirements for System Message Logging 36
Guidelines and Limitations for System Message Logging 36
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
iv
Default Settings for System Message Logging 36
Configuring System Message Logging 37
Configuring System Message Logging to Terminal Sessions 37
Configuring System Message Logging to a File 39
Configuring Module and Facility Messages Logging 41
Configuring Logging Timestamps 42
Configuring Syslog Servers 43
Configuring syslog on a UNIX or Linux System 45
Configuring syslog Server Configuration Distribution 46
Displaying and Clearing Log Files 47
Configuring DOM Logging 48
Enabling DOM Logging 48
Disabling DOM Logging 48
Contents
CHAPTER 6
Verifying the DOM Logging Configuration 48
Verifying the System Message Logging Configuration 49
Configuring Smart Call Home 51
Information About Smart Call Home 51
Smart Call Home Overview 52
Smart Call Home Destination Profiles 52
Smart Call Home Alert Groups 53
Smart Call Home Message Levels 54
Call Home Message Formats 55
Guidelines and Limitations for Smart Call Home 59
Prerequisites for Smart Call Home 59
Default Call Home Settings 59
Configuring Smart Call Home 60
Registering for Smart Call Home 60
Configuring Contact Information 60
Creating a Destination Profile 62
Modifying a Destination Profile 63
Associating an Alert Group with a Destination Profile 65
Adding Show Commands to an Alert Group 65
Configuring E-Mail Server Details 66
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
v
Contents
Configuring Periodic Inventory Notifications 67
Disabling Duplicate Message Throttling 68
Enabling or Disabling Smart Call Home 69
Testing the Smart Call Home Configuration 69
Verifying the Smart Call Home Configuration 70
Sample Syslog Alert Notification in Full-Text Format 70
Sample Syslog Alert Notification in XML Format 71
CHAPTER 7
CHAPTER 8
Configuring Session Manager 75
Information About Session Manager 75
Guidelines and Limitations for Session Manager 75
Configuring Session Manager 76
Creating a Session 76
Configuring ACLs in a Session 76
Verifying a Session 77
Committing a Session 77
Saving a Session 77
Discarding a Session 77
Configuration Example for Session Manager 77
Verifying the Session Manager Configuration 78
Configuring the Scheduler 79
Information About the Scheduler 79
Remote User Authentication 80
Scheduler Log Files 80
Licensing Requirements for the Scheduler 80
Guidelines and Limitations for the Scheduler 80
Default Settings for the Scheduler 81
Configuring the Scheduler 81
Enabling the Scheduler 81
Defining the Scheduler Log File Size 82
Configuring Remote User Authentication 82
Defining a Job 83
Deleting a Job 84
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
vi
Defining a Timetable 84
Clearing the Scheduler Log File 86
Disabling the Scheduler 87
Verifying the Scheduler Configuration 87
Configuration Examples for the Scheduler 88
Creating a Scheduler Job 88
Scheduling a Scheduler Job 88
Displaying the Job Schedule 88
Displaying the Results of Running Scheduler Jobs 88
Standards for the Scheduler 89
Contents
CHAPTER 9
Configuring SNMP 91
Information About SNMP 91
SNMP Functional Overview 91
SNMP Notifications 92
SNMPv3 92
Security Models and Levels for SNMPv1, v2, and v3 92
User-Based Security Model 93
CLI and SNMP User Synchronization 94
Group-Based SNMP Access 95
Licensing Requirements for SNMP 95
Guidelines and Limitations for SNMP 95
Default SNMP Settings 95
Configuring SNMP 96
Configuring SNMP Users 96
Enforcing SNMP Message Encryption 97
Assigning SNMPv3 Users to Multiple Roles 97
Creating SNMP Communities 97
Filtering SNMP Requests 97
Configuring SNMP Notification Receivers 98
Configuring SNMP Notification Receivers with VRFs 99
Filtering SNMP Notifications Based on a VRF 100
Configuring SNMP for Inband Access 101
Enabling SNMP Notifications 102
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
vii
Contents
Configuring Link Notifications 104
Disabling Link Notifications on an Interface 104
Enabling One-Time Authentication for SNMP over TCP 105
Assigning SNMP Switch Contact and Location Information 105
Configuring the Context to Network Entity Mapping 105
Disabling SNMP 106
Verifying the SNMP Configuration 106
CHAPTER 10
CHAPTER 11
Configuring RMON 109
Information About RMON 109
RMON Alarms 109
RMON Events 110
Configuration Guidelines and Limitations for RMON 110
Configuring RMON 110
Configuring RMON Alarms 110
Configuring RMON Events 112
Verifying the RMON Configuration 112
Default RMON Settings 112
Configuring Online Diagnostics 115
Information About Online Diagnostics 115
Bootup Diagnostics 115
Health Monitoring Diagnostics 116
Expansion Module Diagnostics 116
CHAPTER 12
viii
Configuring Online Diagnostics 117
Verifying the Online Diagnostics Configuration 118
Default Settings for Online Diagnostics 118
Configuring Embedded Event Manager 119
About Embedded Event Manager 119
Embedded Event Manager Policies 120
Event Statements 120
Action Statements 121
VSH Script Policies 122
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
Licensing Requirements for Embedded Event Manager 122
Prerequisites for Embedded Event Manager 122
Default Settings for Embedded Event Manager 122
Defining an Environment Variable 122
Defining a User Policy Using the CLI 123
Configuring Event Statements 124
Configuring Action Statements 127
Defining a Policy Using a VSH Script 129
Registering and Activating a VSH Script Policy 129
Overriding a System Policy 130
Configuring Syslog as an EEM Publisher 131
Contents
CHAPTER 13
Configuring SPAN 133
Information About SPAN 133
Guidelines and Limitations for SPAN 133
SPAN Sources 134
Characteristics of Source Ports 134
SPAN Destinations 134
Characteristics of Destination Ports 135
SPAN and ERSPAN Filtering 135
Guidelines and Limitations for SPAN and ERSPAN Filtering 135
SPAN and ERSPAN Control-packet Filtering 136
SPAN and ERSPAN Sampling 136
Guidelines and Limitations for SPAN and ERSPAN Sampling 137
SPAN and ERSPAN Truncation 137
Guidelines and Limitations for SPAN and ERSPAN Truncation 137
Creating or Deleting a SPAN Session 137
Configuring an Ethernet Destination Port 138
Configuring Source Ports 139
Configuring Source Port Channels or VLANs 140
Configuring the Description of a SPAN Session 140
Activating a SPAN Session 141
Suspending a SPAN Session 141
Configuring a SPAN Filter 142
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
ix
Contents
Configuring SPAN Sampling 143
Configuring SPAN Truncation 144
Displaying SPAN Information 145
CHAPTER 14
Configuring ERSPAN 147
Information About ERSPAN 147
ERSPAN Types 147
ERSPAN Sources 147
ERSPAN Destinations 148
ERSPAN Sessions 148
Multiple ERSPAN Sessions 149
ERSPAN Marker Packet 149
High Availability 149
Licensing Requirements for ERSPAN 149
Prerequisites for ERSPAN 150
Guidelines and Limitations for ERSPAN 150
Default Settings for ERSPAN 152
Configuring ERSPAN 152
Configuring an ERSPAN Source Session 152
Configuring an ERSPAN Destination Session 155
CHAPTER 15
Shutting Down or Activating an ERSPAN Session 157
Configuring ERSPAN Filtering 158
Configuring ERSPAN Sampling 160
Configuring ERSPAN Truncation 161
Configuring an ERSPAN Marker Packet 163
Verifying the ERSPAN Configuration 164
Configuration Examples for ERSPAN 164
Configuration Example for an ERSPAN Source Session 164
Configuration Example for an ERSPAN Destination Session 165
Additional References 165
Related Documents 165
Configuring Warp SPAN 167
Information About Warp SPAN 167
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
x
Guidelines and Limitations for Warp Span 168
Configuring Warp SPAN 168
Verifying Warp SPAN Mode Configuration 169
Feature History for Warp SPAN 171
Contents
CHAPTER 16
CHAPTER 17
Configuring DNS 173
Information About DNS Client 173
Name Servers 173
DNS Operation 173
High Availability 174
Prerequisites for DNS Clients 174
Licensing Requirements for DNS Clients 174
Default Settings for DNS Clients 174
Configuring DNS Clients 174
Configuring Traffic Forwarding Modes 177
Information About Warp Mode 177
Guidelines and Limitations for Warp Mode 177
Enabling and Disabling Warp Mode 178
Verifying Warp Mode Status 178
Feature History for Warp Mode 179
CHAPTER 18
CHAPTER 19
Configuring Active Buffer Monitoring 181
Information About Active Buffer Monitoring 181
Active Buffer Monitoring Overview 181
Buffer Histogram Data Access and Collection 182
Configuring Active Buffer Monitoring 182
Displaying Buffer Histogram Data 183
Performing Software Maintenance Upgrades (SMUs) 189
About SMUs 189
Package Management 190
Prerequisites for SMUs 190
Guidelines and Limitations for SMUs 190
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
xi
Contents
Performing a Software Maintenance Upgrade for Cisco NX-OS 191
Preparing for Package Installation 191
Copying the Package File to a Local Storage Device or Network Server 192
Adding and Activating Packages 193
Committing the Active Package Set 194
Deactivating and Removing Packages 194
Displaying Installation Log Information 195
CHAPTER 20
CHAPTER 21
Configuring Rollback 197
Information About Rollbacks 197
Guidelines and Limitations for Rollbacks 197
Creating a Checkpoint 198
Implementing a Rollback 199
Verifying the Rollback Configuration 199
Configuring User Accounts and RBAC 201
Information About User Accounts and RBAC 201
User Roles 201
Rules 202
User Role Policies 202
User Account Configuration Restrictions 203
User Password Requirements 203
Guidelines and Limitations for User Accounts 204
Configuring User Accounts 205
xii
Configuring RBAC 206
Creating User Roles and Rules 206
Creating Feature Groups 207
Changing User Role Interface Policies 208
Changing User Role VLAN Policies 208
Verifying the User Accounts and RBAC Configuration 209
Configuring User Accounts Default Settings for the User Accounts and RBAC 209
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x

Preface

The preface contains the following sections:
Audience, on page xiii
Document Conventions, on page xiii
Obtaining Documentation and Submitting a Service Request, on page xiv
Documentation Feedback, on page xiv
Related Documentation for Cisco Nexus 3000 Series Switches, on page xiv

Audience

This publication is for network administrators who install, configure, and maintain Cisco Nexus switches.

Document Conventions

Command descriptions use the following conventions:
bold
DescriptionConvention
Bold text indicates the commands and keywords that you enter literally as shown.
Italic
[x | y]
{x | y}
[x {y | z}]
Italic text indicates arguments for which the user supplies the values.
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.
Braces enclosing keywords or arguments separated by a vertical bar indicate a required choice.
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.
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
xiii

Obtaining Documentation and Submitting a Service Request

Preface
DescriptionConvention
variable
string
Examples use the following conventions:
italic screen font
!, #
Indicates a variable for which you supply values, in context where italics cannot be used.
A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.
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.
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.
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.

Documentation Feedback

To provide technical feedback on this document, or to report an error or omission, please send your comments to nexus3k-docfeedback@cisco.com. We appreciate your feedback.

Related Documentation for Cisco Nexus 3000 Series Switches

The entire Cisco Nexus 3000 Series switch documentation set is available at the following URL:
https://www.cisco.com/c/en/us/support/switches/nexus-3000-series-switches/ tsd-products-support-series-home.html
xiv
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x

New and Changed Information

This chapter contains the following sections:
New and Changed Information, on page 1

New and Changed Information

The following table provides an overview of the significant changes to this guide for this current release. The table does not provide an exhaustive list of all changes made to the configuration guides or of the new features in this release.
Table 1: New and Changed Features
CHAPTER 1
Release 6.x
DescriptionFeature
Changed in Release
Where DocumentedAdded or
Not applicableNot applicableFirst 7.x release.No updates since Cisco NX-OS
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
1
New and Changed Information
New and Changed Information
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
2

Overview

This chapter contains the following sections:
System Management Features, on page 3

System Management Features

The system management features documented in this guide are described below:
CHAPTER 2
DescriptionFeature
Active Buffer Monitoring
Warp Mode
User Accounts and RBAC
Session Manager
The Active Buffer Monitoring feature provides detailed buffer occupancy data to help you detect network congestion, review past events to understand when and how network congestion is affecting network operations, understand historical trending, and identify patterns of application traffic flow.
In warp mode, the access path is shortened by consolidating the forwarding table into single table, resulting in faster processing of frames and packets. In warp mode, latency is reduced by up to 20 percent.
User accounts and role-based access control (RBAC) allow you to define the rules for an assigned role. Roles restrict the authorization that the user has to access management operations. Each user role can contain multiple rules and each user can have multiple roles.
Session Manager allows you to create a configuration and apply it in batch mode after the configuration is reviewed and verified for accuracy and completeness.
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
3
System Management Features
Overview
DescriptionFeature
Online Diagnostics
System Message Logging
Smart Call Home
Cisco Generic Online Diagnostics (GOLD) define a common framework for diagnostic operations across Cisco platforms. The online diagnostic framework specifies the platform-independent fault-detection architecture for centralized and distributed systems, including the common diagnostics CLI and the platform-independent fault-detection procedures for boot-up and run-time diagnostics.
The platform-specific diagnostics provide hardware-specific fault-detection tests and allow you to take appropriate corrective action in response to diagnostic test results.
You can use system message logging to control the destination and to filter the severity level of messages that system processes generate. You can configure logging to a terminal session, a log file, and syslog servers on remote systems.
System message logging is based on RFC 3164. For more information about the system message format and the messages that the device generates, see the Cisco NX-OS System Messages Reference.
Call Home provides an e-mail-based notification of critical system policies. Cisco NX-OS provides a range of message formats for optimal compatibility with pager services, standard e-mail, or XML-based automated parsing applications. You can use this feature to page a network support engineer, e-mail a Network Operations Center, or use Cisco Smart Call Home services to automatically generate a case with the Technical Assistance Center.
Configuration Rollback
The configuration rollback feature allows users to take a snapshot, or user checkpoint, of the Cisco NX-OS configuration and then reapply that configuration to a switch at any point without having to reload the switch. A rollback allows any authorized administrator to apply this checkpoint configuration without requiring expert knowledge of the features configured in the checkpoint.
SNMP
The Simple Network Management Protocol (SNMP) is an application-layer protocol that provides a message format for communication between SNMP managers and agents. SNMP provides a standardized framework and a common language used for the monitoring and management of devices in a network.
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
4
Overview
System Management Features
DescriptionFeature
RMON
SPAN
RMON is an Internet Engineering Task Force (IETF) standard monitoring specification that allows various network agents and console systems to exchange network monitoring data. Cisco NX-OS supports RMON alarms, events, and logs to monitor Cisco NX-OS devices.
The Switched Port Analyzer (SPAN) feature (sometimes called port mirroring or port monitoring) selects network traffic for analysis by a network analyzer. The network analyzer can be a Cisco SwitchProbe, a Fibre Channel Analyzer, or other Remote Monitoring (RMON) probes.
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
5
System Management Features
Overview
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
6

Configuring PTP

This chapter contains the following sections:
Information About PTP, on page 7
PTP Device Types, on page 8
PTP Process, on page 9
High Availability for PTP, on page 9
Licensing Requirements for PTP, on page 10
Guidelines and Limitations for PTP, on page 10
Default Settings for PTP, on page 10
Configuring PTP, on page 11

Information About PTP

PTP is a time synchronization protocol for nodes distributed across a network. Its hardware timestamp feature provides greater accuracy than other time synchronization protocols such as the Network Time Protocol (NTP).
A PTP system can consist of a combination of PTP and non-PTP devices. PTP devices include ordinary clocks, boundary clocks, and transparent clocks. Non-PTP devices include ordinary network switches, routers, and other infrastructure devices.
CHAPTER 3
PTP is a distributed protocol that specifies how real-time PTP clocks in the system synchronize with each other. These clocks are organized into a master-slave synchronization hierarchy with the grandmaster clock, which is the clock at the top of the hierarchy, determining the reference time for the entire system. Synchronization is achieved by exchanging PTP timing messages, with the members using the timing information to adjust their clocks to the time of their master in the hierarchy. PTP operates within a logical scope called a PTP domain.
Starting from Cisco NXOS Release 6.0(2)A8(3), PTP supports configuring multiple PTP clocking domains, PTP grandmaster capability, PTP cost on interfaces for slave and passive election, and clock identity.
All the switches in a multi-domain environment, belong to one domain. The switches that are the part of boundary clock, must have multi-domain feature enabled on them. Each domain has user configurable parameters such as domain priority, clock class threshold and clock accuracy threshold. The clocks in each domain remain synchronized with the master clock in that domain. If the GPS in a domain fails, the master clock in the domain synchronizes time and data sets associated with the announce messages from the master clock in the domain where the GPS is active. If the master clock from the highest priority domain does not meet the clock quality attributes, a clock in the subsequent domain that match the criteria is selected. The Best Master Clock Algorithm (BMCA) is used to select the master clock if none of the domains has the desired
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
7

PTP Device Types

Configuring PTP
clock quality attributes. If all the domains have equal priority and the threshold values less than master clock attributes or if the threshold values are greater than the master clock attributes, BMCA is used to select the master clock.
Grandmaster capability feature controls the switch’s ability of propagating its clock to other devices that it is connected to. When the switch receives announce messages on an interface, it checks the clock class threshold and clock accuracy threshold values. If the values of these parameters are within the predefined limits, then the switch acts as per PTP standards specified in IEEE 1588v2. If the switch does not receive announce messages from external sources or if the parameters of the announce messages received are not within the predefined limits, the port state will be changed to listening mode. On a switch with no slave ports, the state of all the PTP enabled ports is rendered as listening and on a switch with one slave port, the BMCA is used to determine states on all PTP enabled ports. Convergence time prevents timing loops at the PTP level when grandmaster capability is disabled on a switch. If the slave port is not selected on the switch, all the ports on the switch will be in listening state for a minimum interval specified in the convergence time. The convergence time range is from 3 to 2600 seconds and the default value is 3 seconds.
The interface cost applies to each PTP enabled port if the switch has more than one path to grandmaster clock. The port with the least cost value is elected as slave and the rest of the ports will remain as passive ports.
The clock identity is a unique 8-octet array presented in the form of a character array based on the switch MAC address. The clock identity is determined from MAC according to the IEEE1588v2-2008 specifications. The clock ID is a combination of bytes in a VLAN MAC address as defined in IEEE1588v2.
PTP Device Types
The following clocks are common PTP devices:
Ordinary clock
Communicates with the network based on a single physical port, similar to an end host. An ordinary clock can function as a grandmaster clock.
Boundary clock
Typically has several physical ports, with each port behaving like a port of an ordinary clock. However, each port shares the local clock, and the clock data sets are common to all ports. Each port decides its individual state, either master (synchronizing other ports connected to it) or slave (synchronizing to a downstream port), based on the best clock available to it through all of the other ports on the boundary clock. Messages that are related to synchronization and establishing the master-slave hierarchy terminate in the protocol engine of a boundary clock and are not forwarded.
Transparent clock
Forwards all PTP messages like an ordinary switch or router but measures the residence time of a packet in the switch (the time that the packet takes to traverse the transparent clock) and in some cases the link delay of the ingress port for the packet. The ports have no state because the transparent clock does not need to synchronize to the grandmaster clock.
There are two kinds of transparent clocks:
End-to-end transparent clock
Measures the residence time of a PTP message and accumulates the times in the correction field of the PTP message or an associated follow-up message.
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
8
Configuring PTP
Note
PTP operates only in boundary clock mode. We recommend that you deploy a Grand Master Clock (10 MHz) upstream. The servers contain clocks that require synchronization and are connected to the switch.
End-to-end transparent clock and peer-to-peer transparent clock modes are not supported.

PTP Process

The PTP process consists of two phases: establishing the master-slave hierarchy and synchronizing the clocks.
Within a PTP domain, each port of an ordinary or boundary clock follows this process to determine its state:
PTP Process
Peer-to-peer transparent clock
Measures the residence time of a PTP message and computes the link delay between each port and a similarly equipped port on another node that shares the link. For a packet, this incoming link delay is added to the residence time in the correction field of the PTP message or an associated follow-up message.
• Examines the contents of all received announce messages (issued by ports in the master state)
• Compares the data sets of the foreign master (in the announce message) and the local clock for priority, clock class, accuracy, and so on
• Determines its own state as either master or slave
After the master-slave hierarchy has been established, the clocks are synchronized as follows:
• The master sends a synchronization message to the slave and notes the time it was sent.
• The slave receives the synchronization message and notes the time that it was received. For every synchronization message, there is a follow-up message. The number of sync messages should be equal to the number of follow-up messages.
• The slave sends a delay-request message to the master and notes the time it was sent.
• The master receives the delay-request message and notes the time it was received.
• The master sends a delay-response message to the slave. The number of delay request messages should be equal to the number of delay response messages.
• The slave uses these timestamps to adjust its clock to the time of its master.

High Availability for PTP

Stateful restarts are not supported for PTP
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
9

Licensing Requirements for PTP

Licensing Requirements for PTP
PTP requires no license. Any feature not included in a license package is bundled with the Cisco NX-OS system images and is provided at no extra charge to you. For a complete explanation of the Cisco NX-OS licensing scheme, see the Cisco NX-OS Licensing Guide.

Guidelines and Limitations for PTP

• In a Cisco Nexus 3500 only environment, PTP clock correction is expected to be in the 1- to 2-digit range, from 1 to 99 nanoseconds. However, in a mixed environment, PTP clock correction is expected to be up to 3 digits, from 100 to 999 nanoseconds.
• PTP operates only in boundary clock mode. End-to-end transparent clock and peer-to-peer transparent clock modes are not supported.
• PTP operates when the clock protocol is set to PTP. Configuring PTP and NTP together is not supported.
Configuring PTP
• PTP supports transport over User Datagram Protocol (UDP). Transport over Ethernet is not supported.
• PTP supports only multicast communication. Negotiated unicast communication is not supported.
• PTP is limited to a single domain per network.
• PTP-capable ports do not identify PTP packets and do not time-stamp or redirect those packets to CPU for processing unless you enable PTP on those ports. This means that if the PTP is disabled on a port, then the device will be capable of routing any multicast PTP packets, regardless of their type, assuming that there is a multicast state present for this. None of these multicast PTP packets from this port will be redirected to CPU for processing, because the exception used to redirect them to the CPU is programmed on a per-port basis, based on whether the PTP is enabled or not on the respective port.
• 1 packet per second (1 pps) input is not supported.
• PTP over IPv6 is not supported.
• Cisco Nexus 3500 Series switches support a maximum of 48 PTP sessions.
• Cisco Nexus switches should be synchronized from the neighboring master using a synchronization log interval that ranges from –3 to 1.
• Beginning with Cisco NX-OS Release 6.0(2)A8(7), all unicast and multicast PTP management messages will be forwarded as per the forwarding rules. All PTP management messages will be treated as regular multicast packets and process these in the same way as the other non-PTP multicast packets are processed by Cisco Nexus 3500 switches.
• Cisco Nexus 3500 Series switches do not support PTP on 40G interfaces.
• You must configure the incoming port as L3/SVI to enable forwarding of the PTP unicast packets.

Default Settings for PTP

The following table lists the default settings for PTP parameters.
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
10

Configuring PTP

Configuring PTP
Table 2: Default PTP Parameters
DefaultParameters
DisabledPTP
2PTP version
0. PTP multi domain is disabled by default.PTP domain
255PTP priority 1 value when advertising the clock
255PTP priority 2 value when advertising the clock
1 log secondPTP announce interval
1 log secondPTP sync interval
3 announce intervalsPTP announce timeout
1 log secondPTP minimum delay request interval
Configuring PTP

Configuring PTP Globally

You can enable or disable PTP globally on a device. You can also configure various PTP clock parameters to help determine which clock in the network has the highest priority to be selected as the grandmaster.
Procedure
Step 1
Step 2
Step 3
switch(config) # [no] ptp source ip-address [vrf vrf]
1PTP VLAN
PurposeCommand or Action
Enters global configuration mode.switch# configure terminal
Enables or disables PTP on the device.switch(config) # [no] feature ptp
Note
Configures the source IP address for all PTP packets.
Enabling PTP on the switch does not enable PTP on each interface.
Step 4
(Optional) switch(config) # [no] ptp domain
number
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
The ip-address can be in IPv4 format.
Configures the domain number to use for this clock. PTP domains allow you to use multiple independent PTP clocking subdomains on a single network.
The range for the number is from 0 to 128.
11
Configuring PTP Globally
Configuring PTP
PurposeCommand or Action
Step 5
Step 6
Step 7
Step 8
Step 9
(Optional) switch(config) # [no] ptp priority1
value
(Optional) switch(config) # [no] ptp priority2
value
(Optional) switch(config)# copy running-config startup-config
Configures the priority1 value to use when advertising this clock. This value overrides the default criteria (clock quality, clock class, and so on) for the best master clock selection. Lower values take precedence.
The range for the value is from 0 to 255.
Configures the priority2 value to use when advertising this clock. This value is used to decide between two devices that are otherwise equally matched in the default criteria. For example, you can use the priority2 value to give a specific switch priority over other identical switches.
The range for the value is from 0 to 255.
Displays the PTP status.(Optional) switch(config) # show ptp brief
Displays the properties of the local clock.(Optional) switch(config) # show ptp clock
Saves the change persistently through reboots and restarts by copying the running configuration to the startup configuration.
Example
The following example shows how to configure PTP globally on the device, specify the source IP address for PTP communications, and configure a preference level for the clock:
switch# configure terminal switch(config)# feature ptp switch(config)# ptp source 10.10.10.1 switch(config)# ptp priority1 1 switch(config)# ptp priority2 1 switch(config)# show ptp brief PTP port status
----------------------­Port State
------- -------------­switch(config)# show ptp clock PTP Device Type: Boundary clock Clock Identity : 0:22:55:ff:ff:79:a4:c1 Clock Domain: 0 Number of PTP ports: 0 Priority1 : 1 Priority2 : 1 Clock Quality: Class : 248 Accuracy : 254 Offset (log variance) : 65535 Offset From Master : 0 Mean Path Delay : 0 Steps removed : 0
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
12
Configuring PTP
Local clock time:Sun Jul 3 14:13:24 2011 switch(config)#

Configuring PTP on an Interface

After you globally enable PTP, it is not enabled on all supported interfaces by default. You must enable PTP interfaces individually.
Before you begin
Make sure that you have globally enabled PTP on the switch and configured the source IP address for PTP communication.
Procedure
Configuring PTP on an Interface
PurposeCommand or Action
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
switch(config) # interface ethernet slot/port
(Optional) switch(config-if) # [no] ptp
announce {interval log seconds | timeout count}
(Optional) switch(config-if) # [no] ptp delay request minimum interval log seconds
(Optional) switch(config-if) # [no] ptp sync interval log seconds
Enters global configuration mode.switch# configure terminal
Specifies the interface on which you are enabling PTP and enters interface configuration mode.
Enables or disables PTP on an interface.switch(config-if) # [no] feature ptp
Configures the interval between PTP announce messages on an interface or the number of PTP intervals before a timeout occurs on an interface.
The range for the PTP announcement interval is from 0 to 4 seconds, and the range for the interval timeout is from 2 to 10.
Configures the minimum interval allowed between PTP delay-request messages when the port is in the master state.
The range is from log(-6) to log(1) seconds. Where, log(-2) = 2 frames per second.
Configures the interval between PTP synchronization messages on an interface.
Step 7
Step 8
The range for the PTP synchronization interval is from -3 log second to 1 log second
(Optional) switch(config-if) # [no] ptp vlan
vlan-id
Specifies the VLAN for the interface where PTP is being enabled. You can only enable PTP on one VLAN on an interface.
The range is from 1 to 4094.
Displays the PTP status.(Optional) switch(config-if) # show ptp brief
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
13

Configuring Multiple PTP Domains

Configuring PTP
PurposeCommand or Action
Step 9
Displays the status of the PTP port.(Optional) switch(config-if) # show ptp port
interface interface slot/port
Step 10
(Optional) switch(config-if)# copy running-config startup-config
Saves the change persistently through reboots and restarts by copying the running configuration to the startup configuration.
Example
This example shows how to configure PTP on an interface and configure the intervals for the announce, delay-request, and synchronization messages:
switch# configure terminal switch(config)# interface ethernet 2/1 switch(config-if)# ptp switch(config-if)# ptp announce interval 3 switch(config-if)# ptp announce timeout 2 switch(config-if)# ptp delay-request minimum interval 4 switch(config-if)# ptp sync interval -1 switch(config-if)# show ptp brief PTP port status
----------------------­Port State
------- -------------­Eth2/1 Master switch(config-if)# show ptp port interface ethernet 1/1 PTP Port Dataset: Eth1/1 Port identity: clock identity: f4:4e:05:ff:fe:84:7e:7c Port identity: port number: 0 PTP version: 2 Port state: Slave VLAN info: 1 Delay request interval(log mean): 0 Announce receipt time out: 3 Peer mean path delay: 0 Announce interval(log mean): 1 Sync interval(log mean): 1 Delay Mechanism: End to End Cost: 255 Domain: 5 switch(config-if)#
Configuring Multiple PTP Domains
You can configure multiple PTP clocking domains on a single network. Each domain has a priority value associated with it. The default value is 255.
Procedure
Step 1
Step 2
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
14
PurposeCommand or Action
Enters global configuration mode.switch# configure terminal
Enables or disables PTP on the device.switch(config) # [no] feature ptp
Configuring PTP
PurposeCommand or Action
Note
Configuring Multiple PTP Domains
Enabling PTP on the switch does not enable PTP on each interface.
Step 3
Step 4
Step 5
Step 6
switch(config) # [no] ptp source ip-address [vrf vrf]
switch(config) # [no] ptp multi-domain
switch(config) # [no] ptp domain value
priority value
switch(config) # [no] ptp domain value clock-class-threshold value
Configures the source IP address for all PTP packets.
The ip-address can be in IPv4 format.
Enables configuring multi domain feature on the switch. It also allow you to set the attributes such as priority, clock-class threshold , clock-accuracy threshold, transition priorities etc. on the switch.
Specify the values for the domain and priority.
The range for the domain value is from 0 to
127. The default value of the domain is 0
The range for the priority value is from 0 to
255. The default value of the priority is 255
Specify the values for domain and clock class threshold. The default value is 248.
The range for the domain value is from 0 to
127.
The range for the clock-class-threshold value is from 0 to 255.
Step 7
switch(config) # [no] ptp domain value clock-accuracy-threshold value
Note
It is not necessary that a clock class threshold value ensure election of the slave clock on any ports. The switch uses this value to determine whether the source clock is traceable. If the clock class value from the peer is higher or equal than the clock class threshold value in a domain, the switch runs BMCA to elect the slave port from a domain. If none of the domains has the clock class below the threshold value, the switch runs BMCA on all the PTP enabled ports to elect the best clock.
Specify the values for domain and clock accuracy threshold. The default value is 254.
The range for the domain value is from 0 to
127.
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
15
Configuring Multiple PTP Domains
Configuring PTP
PurposeCommand or Action
The range for the clock-accuracy-threshold value is from 0 to 255.
Step 8
Step 9
switch(config) # [no] ptp multi-domain transition-attributes priority1 value
switch(config) # [no] ptp multi-domain transition-attributes priority2 value
Sets the domain transition-attributes priority1 value that is used when sending a packet out from this domain to a peer domain. The value of the priority1 in the announce message from the remote port is replaced by the value of domain transition-attributes priority1 when the announce message has to be transmitted to a peer in a domain, that is different from that of the slave interface. The default value is 255.
The range for the transition-attributes priority1 value is from 0 to 255.
Sets the domain transition-attributes priority2 value that is used when sending a packet out from this domain to a peer domain. The value of the priority2 in the announce message from the remote port is replaced by the value of domain transition-attributes priority2 when the announce message has to be transmitted to a peer in a domain, that is different from that of the slave interface. The default value is 255.
The range for the transition-attributes priority2 value is from 0 to 255.
Step 10
switch(config-if) # [no] ptp domain value
Associates a domain on a PTP enabled interface. If you do not configure the domain specifically on an interface, it takes the default value (0).
The range for the domain value is from 0 to
127.
Example
The following example shows the PTP domains configured on a switch:
switch(config)# show ptp domain data MULTI DOMAIN : ENABLED GM CAPABILITY : ENABLED PTP DEFAULT DOMAIN : 0 PTP TRANSITION PRIORITY1 : 20 PTP TRANSITION PRIORITY2 : 255 PTP DOMAIN PROPERTY Domain-Number Domain-Priority Clock-Class Clock-Accuracy Ports 0 255 248 254 Eth1/1 1 1 1 254
switch(config)#
Cisco Nexus 3548 Switch NX-OS System Management Configuration Guide, Release 7.x
16
Loading...
+ 200 hidden pages