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
Page 2
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.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWAREOF 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: 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)
This publication is for network administrators who configure and maintain Cisco Nexus devices.
Document Conventions
Note
As part of our constant endeavor to remodel our documents to meet our customers' requirements, we have
modified the manner in which we document configuration tasks. As a result of this, you may find a
deviation in the style used to describe these tasks, with the newly included sections of the document
following the new format.
Command descriptions use the following conventions:
Bold text indicates the commands and keywords that you enter literally
as shown.
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.
xiii
Page 14
Document Conventions
Preface
DescriptionConvention
{x | y}
Braces enclosing keywords or arguments separated by a vertical bar
indicate a required choice.
[x {y | z}]
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.
variable
Indicates a variable for which you supply values, in context where italics
cannot be used.
string
A nonquoted set of characters. Do not use quotation marks around the
string or the string will include the quotation marks.
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
italic screen font
Arguments for which you supply values are in italic screen font.
Note
Caution
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.
This document uses the following conventions:
Means reader take note. Notes contain helpful suggestions or references to material not covered in the
manual.
Means reader be careful. In this situation, you might do something that could result in equipment damage
or loss of data.
New and Changed Information in this Release, page 1
•
New and Changed Information in this Release
The following table provides an overview of the significant changes made to this configuration guide. The
table does not provide an exhaustive list of all changes made to this guide or all new features in a particular
release.
Table 1: New and Changed Features
PTP Enhancements
Software Maintenance
Upgrades (SMUs)
DescriptionFeature
domains, grandmaster capability, PTP cost on
interfaces and clock identity.
Maintenance Upgrades (SMUs).
Changed
in
Release
6.0(2)A8(3)Added support for configuring PTP on multiple
6.0(2)A8(1)Added support for DOM logging.DOM logging
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 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.
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.
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.
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
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.
Only Cisco Nexus 3000 Series switches support PTP. Cisco Nexus 3100 Series switches do not support this
feature.
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.
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.
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.
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:
After the master-slave hierarchy has been established, the clocks are synchronized as follows:
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
•
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.
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
Configuring 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 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.
•
All management messages are forwarded on ports on which PTP is enabled. Handling management
•
messages is not supported.
PTP-capable ports do not identify PTP packets and do not time-stamp or redirect those packets unless
•
you enable PTP on those ports.
1 packet per second (1 pps) input is not supported.
•
PTP over IPv6 is not supported.
•
Cisco Nexus 3500 Switches support a maximum of 32 PTP sessions
•
Cisco Nexus switches should be synchronized from the neighboring master using a synchronization log
•
interval that ranges from –3 to 1.
Default Settings for PTP
The following table lists the default settings for PTP parameters.
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
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
ptp
PurposeCommand or Action
Enters global configuration mode.switch# configure terminal
Enables or disables PTP on the device.switch(config) # [no] feature
Note
1 log secondPTP minimum delay request interval
1PTP VLAN
Enabling PTP on the switch does not enable PTP on
each interface.
Configures the source IP address for all PTP packets.switch(config) # [no] ptp source
The ip-address can be in IPv4 format.
(Optional)
Configures the domain number to use for this clock. PTP
domains allow you to use multiple independent PTP clocking
subdomains on a single network.
11
Page 28
Configuring PTP Globally
Configuring PTP
PurposeCommand or Action
The range for the number is from 0 to 128.
Step 5
Step 6
Step 7
Step 8
Step 9
switch(config) # [no] ptp
priority1 value
switch(config) # [no] ptp
priority2 value
switch(config) # show ptp brief
switch(config) # show ptp clock
switch(config)# copy
running-config startup-config
(Optional)
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.
(Optional)
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.
(Optional)
Displays the PTP status.
(Optional)
Displays the properties of the local clock.
(Optional)
Saves the change persistently through reboots and restarts by
copying the running configuration to the startup configuration.
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
Local clock time:Sun Jul 3 14:13:24 2011
switch(config)#
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
(Optional)
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.
(Optional)
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.
(Optional)
Configures the interval between PTP synchronization
messages on an interface.
The range for the PTP synchronization interval is from
Enters global configuration mode.switch# configure terminal
Enables or disables PTP on the device.switch(config) # [no] feature
Note
Enabling PTP on the switch does not enable PTP on each
interface.
Page 31
Configuring PTP
Configuring Multiple PTP Domains
PurposeCommand or Action
Step 3
Step 4
Step 5
Step 6
source ip-address [vrf vrf]
switch(config) # [no] ptp
multi-domain
domain value priority value
switch(config) # [no] ptp
domain value
clock-class-threshold value
Configures the source IP address for all PTP packets.switch(config) # [no] ptp
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.switch(config) # [no] ptp
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.
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.
Step 7
Step 8
Step 9
switch(config) # [no] ptp
domain value
clock-accuracy-threshold
value
switch(config) # [no] ptp
multi-domain
transition-attributes
priority1 value
switch(config) # [no] ptp
multi-domain
transition-attributes
priority2 value
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.
The range for the clock-accuracy-threshold value is from 0 to 255.
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
The following example shows the domains associated with each PTP enabled interfaces:
switch(config)# show ptp interface domain
PTP port interface domain
-------------------------PortDomain
------- ----------------Eth1/10
11254
switch(config)#
Configuring PTP Grandmaster Clock
You can configure convergence time to prevent timing loops at the PTP level when grandmaster capability
is disabled on a switch. Grandmaster capability is enabled on the device by default.
Enters global configuration mode.switch# configure terminal
Enables or disables PTP on the device.switch(config) # [no] feature ptp
Note
Enabling PTP on the switch does not enable PTP on
each interface.
Page 33
Configuring PTP
Configuring PTP Grandmaster Clock
PurposeCommand or Action
Step 3
Step 4
Step 5
Step 6
ip-address [vrf vrf]
switch(config) # no ptpgrandmaster-capable [
convergence-time]
switch(config) # [no] ptp domain
value clock-class-threshold
value
value clock-accuracy-threshold
value
Configures the source IP address for all PTP packets.switch(config) # [no] ptp source
The ip-address can be in IPv4 format.
Disables grandmaster capability on the switch. Prevents the
device from acting as a grandmaster when there is no external
grandmaster available in any domains. The default convergence
time is 30 seconds.
Specify the values for domain and clock class threshold. Clockclass threshold defines the threshold value of clock class that
the device uses to determine whether the source clock can be
considered as a grandmaster clock.
The range for the domain value is from 0 to 127.
The range for the clock-class-threshold value is from 0 to 255.
Note
The switch uses this value to determine whether the
source clock is traceable. If the clock class value from
all the peers is higher than the clock class threshold
value, the BMCA may change all the port state to
listening.
Specify the values for domain and clock accuracy thresholdswitch(config) # [no] ptp domain
The range for the domain value is from 0 to 127.
The range for the clock-accuracy-threshold value is from 0 to
255.
Step 7
Enables grandmaster capability on a switch.switch(config) # ptp
grandmaster-capable
The following example displays the PTP clock information:
switch(config-if)# show ptp clock
PTP Device Type: Boundary clock
Clock Identity : f4:4e:05:ff:fe:84:7e:7c
Clock Domain: 5
Number of PTP ports: 2
Priority1 : 129
Priority2 : 255
Clock Quality:
Class : 248
Accuracy : 254
Offset (log variance) : 65535
Offset From Master : 0
Mean Path Delay : 391
Steps removed : 1
Local clock time:Wed Nov 9 10:31:21 2016
switch(config-if)#
You can configure interface cost on each PTP enabled port on a Cisco Nexus 3500 switch. The cost applies
to each PTP enabled port if the switch has more than one path to grandmaster clock.
.
Procedure
Configuring PTP
PurposeCommand or Action
Step 1
Step 2
Enters global configuration mode.switch# configure terminal
Enables or disables PTP on the device.switch(config) # [no] feature ptp
Note
Enabling PTP on the switch does not enable
PTP on each interface.
Step 3
Step 4
Step 5
ip-address [vrf vrf]
switch(config-if) # [no] ptp cost
value
Configures the source IP address for all PTP packets.switch(config) # [no] ptp source
The ip-address can be in IPv4 format.
Enables or disables PTP on the interface.switch(config-if) # [no] feature ptp
Associate cost on a PTP enabled interface. The interface
having the least cost becomes the slave interface.
The range for the cost is from 0 to 255. The default value
is 255.
The following example shows cost that is associated with each PTP enabled interfaces:
switch(config)# show ptp cost
PTP port costs
----------------------PortCost
------- -------------Eth1/1255
switch(config)#
Configuring clock Identity
You can configure clock identity on a Cisco Nexus 3500 switch. The default clock identity is a unique 8-octet
array presented in the form of a character array based on the switch MAC address.
Enters global configuration mode.switch# configure terminal
Enables or disables PTP on the device.switch(config) # [no] feature ptp
Page 35
Configuring PTP
PurposeCommand or Action
Note
Verifying the PTP Configuration
Enabling PTP on the switch does not enable PTP
on each interface.
Step 3
switch(config-if) # ptp
clock-identity MAC Address
Verifying the PTP Configuration
Use one of the following commands to verify the configuration:
Table 3: PTP Show Commands
show ptp clock
show ptp clock foreign-masters-record
Assigns 6 byte MAC address for PTP clock-identity. Default
clock identity is based on the MAC address of the switch.
The clock-identity is defined as per IEEE standard (MAC-48
Byte0 | MAC-48 Byte1 | MAC-48 Byte2 | FF | FE | MAC-48
Bytes3-5).
PurposeCommand
Displays the PTP status.show ptp brief
Displays the properties of the local clock, including
the clock identity.
Displays the state of foreign masters known to the
PTP process. For each foreign master, the output
displays the clock identity, basic clock properties,
and whether the clock is being used as a grandmaster.
Guidelines and Limitations for User Accounts, page 24
•
Configuring User Accounts, page 25
•
Configuring RBAC, page 26
•
Verifying the User Accounts and RBAC Configuration, page 29
•
Configuring User Accounts Default Settings for the User Accounts and RBAC, page 30
•
Information About User Accounts and RBAC
Cisco Nexus Series switches use role-based access control (RBAC) to define the amount of access that each
user has when the user logs into the switch.
With RBAC, you define one or more user roles and then specify which management operations each user role
is allowed to perform. When you create a user account for the switch, you associate that account with a user
role, which then determines what the individual user is allowed to do on the switch.
User Roles
User roles contain rules that define the operations allowed for the user who is assigned the role. Each user
role can contain multiple rules and each user can have multiple roles. For example, if role1 allows access only
to configuration operations, and role2 allows access only to debug operations, users who belong to both role1
and role2 can access configuration and debug operations. You can also limit access to specific VLANs, and
interfaces.
The switch provides the following default user roles:
network-admin (superuser)
Complete read and write access to the entire switch.
If you belong to multiple roles, you can execute a combination of all the commands permitted by these
roles. Access to a command takes priority over being denied access to a command. For example, suppose
a user has RoleA, which denied access to the configuration commands. However, the user also has RoleB,
which has access to the configuration commands. In this case, the user has access to the configuration
commands.
Only network-admin user can perform a Checkpoint or Rollback in the RBAC roles. Though other users
have these commands as a permit rule in their role, the user access is denied when you try to execute these
commands.
The rule is the basic element of a role. A rule defines what operations the role allows the user to perform. You
can apply rules for the following parameters:
Command
A command or group of commands defined in a regular expression.
Feature
Commands that apply to a function provided by the Cisco Nexus device. Enter the show role feature
command to display the feature names available for this parameter.
Feature group
Default or user-defined group of features. Enter the show role feature-group command to display the
default feature groups available for this parameter.
These parameters create a hierarchical relationship. The most basic control parameter is the command. The
next control parameter is the feature, which represents all commands associated with the feature. The last
control parameter is the feature group. The feature group combines related features and allows you to easily
manage the rules.
You can configure up to 256 rules for each role. The user-specified rule number determines the order in which
the rules are applied. Rules are applied in descending order. For example, if a role has three rules, rule 3 is
applied before rule 2, which is applied before rule 1.
User Role Policies
You can define user role policies to limit the switch resources that the user can access, or to limit access to
interfaces and VLANs.
User role policies are constrained by the rules defined for the role. For example, if you define an interface
policy to permit access to specific interfaces, the user does not have access to the interfaces unless you configure
a command rule for the role to permit the interface command.
If a command rule permits access to specific resources (interfaces, VLANs), the user is permitted to access
these resources, even if the user is not listed in the user role policies associated with that user.
User Account Configuration Restrictions
The following words are reserved and cannot be used to configure users:
Cisco Nexus device passwords are case sensitive and can contain alphanumeric characters only. Special
characters, such as the dollar sign ($) or the percent sign (%), are not allowed.
Configuring User Accounts and RBAC
Note
Starting from Cisco NX-OS Release 7.2(0)N1(1), special characters, such as the dollar sign ($) or the
percent sign (%), can be used in Cisco Nexus device passwords.
If a password is trivial (such as a short, easy-to-decipher password), the Cisco Nexus device rejects the
password. Be sure to configure a strong password for each user account. A strong password has the following
characteristics:
At least eight characters long
•
Does not contain many consecutive characters (such as "abcd")
•
Does not contain many repeating characters (such as "aaabbb")
•
Does not contain dictionary words
•
Does not contain proper names
•
Contains both uppercase and lowercase characters
•
Contains numbers
•
The following are examples of strong passwords:
If2CoM18
•
2009AsdfLkj30
•
Cb1955S21
•
For security reasons, user passwords do not display in the configuration files.Note
Guidelines and Limitations for User Accounts
User accounts have the following guidelines and limitations when configuring user accounts and RBAC:
Up to 256 rules can be added to a user role.
•
A maximum of 64 user roles can be assigned to a user account.
•
You can assign a user role to more that one user account.
•
Predefined roles such as network-admin, network-operator, and san-admin are not editable.
•
Add, delete, and editing of rules is not supported for the SAN admin user role.
•
The interface, VLAN, and/or VSAN scope cannot be changed for the SAN admin user role.
The rule number that you specify determines the order in which the rules are applied. Rules are applied in
descending order. For example, if a role has three rules, rule 3 is applied before rule 2, which is applied before
rule 1.
Procedure
Configuring User Accounts and RBAC
PurposeCommand or Action
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
switch(config) # role name role-name
switch(config-role) # rule number
{deny | permit} command
command-string
switch(config-role)# rule number
{deny | permit} {read | read-write}
switch(config-role)# rule number
{deny | permit} {read | read-write}
feature feature-name
switch(config-role)# rule number
{deny | permit} {read | read-write}
feature-group group-name
Enters global configuration mode.switch# configure terminal
Specifies a user role and enters role configuration mode.
The role-name argument is a case-sensitive,
alphanumeric character string with a maximum of 16
characters.
Configures a command rule.
The command-string can contain spaces and regular
expressions. For example, interface ethernet * includes
all Ethernet interfaces.
Repeat this command for as many rules as needed.
Configures a read-only or read-and-write rule for all
operations.
Configures a read-only or read-and-write rule for a
feature.
Use the show role feature command to display a list of
features.
Repeat this command for as many rules as needed.
Configures a read-only or read-and-write rule for a
feature group.
Use the show role feature-group command to display
a list of feature groups.
(Optional)
Configures the role description. You can include spaces
in the description.
Exits role configuration mode.switch(config-role)# end
Page 43
Configuring User Accounts and RBAC
Creating Feature Groups
PurposeCommand or Action
Step 9
Step 10
switch# show role
switch# copy running-config
startup-config
This example shows how to create user roles and specify rules:
switch# configure terminal
switch(config)# role name UserA
switch(config-role)# rule deny command clear users
switch(config-role)# rule deny read-write
switch(config-role)# description This role does not allow users to use clear commands
switch(config-role)# end
switch(config)# show role
Creating Feature Groups
Procedure
(Optional)
Displays the user role configuration.
(Optional)
Saves the change persistently through reboots and
restarts by copying the running configuration to the
startup configuration.
PurposeCommand or Action
Step 1
Step 2
switch(config) # role feature-group
group-name
Step 3
Step 4
Step 5
switch# show role feature-group
switch# copy running-config
startup-config
This example shows how to create a feature group:
switch# configure terminal
switch(config) # role feature-group group1
switch(config) # exit
switch# show role feature-group
switch# copy running-config startup-config
switch#
Enters global configuration mode.switch# configure terminal
Specifies a user role feature group and enters role feature
group configuration mode.
The group-name is a case-sensitive, alphanumeric
character string with a maximum of 32 characters.
Exits global configuration mode.switch(config) # exit
(Optional)
Displays the role feature group configuration.
(Optional)
Saves the change persistently through reboots and restarts
by copying the running configuration to the startup
configuration.
You can change a user role interface policy to limit the interfaces that the user can access. Specify a list of
interfaces that the role can access. You can specify it for as many interfaces as needed.
Procedure
Configuring User Accounts and RBAC
PurposeCommand or Action
Step 1
Step 2
switch(config) # role name role-name
Enters global configuration mode.switch# configure terminal
Specifies a user role and enters role configuration
mode.
Step 3
Enters role interface policy configuration mode.switch(config-role) # interface policy
deny
Step 4
interface interface-list
Specifies a list of interfaces that the role can access.switch(config-role-interface) # permit
Repeat this command for as many interfaces as
needed.
For this command, you can specify Ethernet
interfaces.
Step 5
Step 6
switch(config-role) # show role
Exits role interface policy configuration mode.switch(config-role-interface) # exit
Discards the configuration session without applying
the commands.
Configuration Example for Session Manager
The following example shows how to create a configuration session for ACLs:
switch# configure session name test2
switch(config-s)# ip access-list acl2
switch(config-s-acl)# permit tcp any any
switch(config-s-acl)# exit
switch(config-s)# interface Ethernet 1/4
switch(config-s-ip)# ip port access-group acl2 in
switch(config-s-ip)# exit
switch(config-s)# verify
switch(config-s)# exit
switch# show configuration session test2
Verifying the Session Manager Configuration
To verify Session Manager configuration information, perform one of the following tasks:
PurposeCommand
show configuration session [name]
show configuration session status [name]
Displays the contents of the configuration session.
Displays the status of the configuration session.
Displays a summary of all the configuration sessions.show configuration session summary
The timetable for completing a job. You can assign multiple jobs to a schedule.
A schedule is defined as either periodic or one-time only:
• Periodic mode— A recurring interval that continues until you delete the job. You can configure
the following types of intervals:
◦ Daily— Job is completed once a day.
◦ Weekly— Job is completed once a week.
◦ Monthly—Job is completed once a month.
◦ Delta—Job begins at the specified start time and then at specified intervals
(days:hours:minutes).
• One-time mode—Job is completed only once at a specified time.
Remote User Authentication
Before starting a job, the scheduler authenticates the user who created the job. Because user credentials from
a remote authentication are not retained long enough to support a scheduled job, you must locally configure
the authentication passwords for users who create jobs. These passwords are part of the scheduler configuration
and are not considered a locally configured user.
Before starting the job, the scheduler validates the local password against the password from the remote
authentication server.
Scheduler Log Files
The scheduler maintains a log file that contains the job output. If the size of the job output is greater than the
size of the log file, the output is truncated.
Licensing Requirements for the Scheduler
This feature does not require a 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 the Scheduler
The scheduler can fail if it encounters one of the following while performing a job:
•
If a feature license is expired when a job for that feature is scheduled.
◦
If a feature is disabled at the time when a job for that feature is scheduled.
Remote users must authenticate with their clear text password before creating and configuring jobs.
Remote user passwords are always shown in encrypted form in the output of the show running-config
command. The encrypted option (7) in the command supports the ASCII device configuration.
Enters global configuration mode.switch# configure terminal
Defines the scheduler log file size in kilobytes.switch(config) # scheduler logfile
The range is from 16 to 1024. The default log file size is
16.
Note
(Optional)
Saves the change persistently through reboots and restarts
by copying the running configuration to the startup
configuration.
If the size of the job output is greater than the size
of the log file, the output is truncated.
This example shows how to create a scheduler job named backup-cfg, save the running configuration to a file
in bootflash, copy the file from bootflash to a TFTP server, and save the change to the startup configuration:
switch# configure terminal
switch(config) # scheduler job name backup-cfg
switch(config-job) # cli var name timestamp
This example shows how to delete a job called configsave:
switch# configure terminal
switch(config)# no scheduler job name configsave
switch(config-job)# copy running-config startup-config
switch(config-job)#
Defining a Timetable
You must configure a timetable. Otherwise, jobs will not be scheduled.
If you do not specify the time for the time commands, the scheduler assumes the current time. For example,
if the current time is March 24, 2008, 22:00 hours,jobs are started as follows:
switch(config) # no scheduler job name
name
switch(config-job) # show scheduler job
[name]
switch(config-job) # copy
running-config startup-config
Enters global configuration mode.switch# configure terminal
Deletes the specified job and all commands defined
within it.
The name is restricted to 31 characters.
(Optional)
Displays the job information.
(Optional)
Saves the change persistently through reboots and
restarts by copying the running configuration to the
startup configuration.
For the time start 23:00 repeat 4:00:00 command, the scheduler assumes a start time of March 24,
•
2008, 23:00 hours.
For the time daily 55 command, the scheduler assumes a start time every day at 22:55 hours.
•
For the time weekly 23:00 command, the scheduler assumes a start time every Friday at 23:00 hours.
For the time monthly 23:00 command, the scheduler assumes a start time on the 24th of every month
•
at 23:00 hours.
Note
The scheduler will not begin the next occurrence of a job before the last one completes. For example, you
have scheduled a job to be completed at one-minute intervals beginning at 22:00; but the job requires two
minutes to complete. The scheduler starts the first job at 22:00, completes it at 22:02, and then observes
a one-minute interval before starting the next job at 22:03.
Procedure
PurposeCommand or Action
Step 1
Step 2
switch(config) # scheduler schedule
name name
Enters global configuration mode.switch# configure terminal
Creates a new scheduler and enters schedule configuration
mode for that schedule.
The name is restricted to 31 characters.
Step 3
switch(config-schedule) # job name
name
Associates a job with this schedule. You can add multiple
jobs to a schedule.
The name is restricted to 31 characters.
Step 4
Step 5
switch(config-schedule) # time daily
time
weekly [[day-of-week:] HH:] MM
Indicates the job starts every day at a designated time,
specified as HH:MM.
Indicates that the job starts on a specified day of the week.switch(config-schedule) # time
The day of the week is represented by an integer (for
example, 1 for Sunday, 2 for Monday) or as an abbreviation
(for example, sun, mon).
Use one of the following commands to verify the configuration:
Table 6: Scheduler Show Commands
show scheduler job [name name]
(Optional)
Saves the change persistently through reboots and
restarts by copying the running configuration to
the startup configuration.
PurposeCommand
Displays the scheduler configuration.show scheduler config
Displays the jobs configured.
Displays the contents of the scheduler log file.show scheduler logfile
show scheduler schedule [name name]
Displays the schedules configured.
Configuration Examples for the Scheduler
Creating a Scheduler Job
This example shows how to create a scheduler job that saves the running configuration to a file in bootflash
and then copies the file from bootflash to a TFTP server (the filename is created using the current time stamp
and switch name):
switch# configure terminal
switch(config)# scheduler job name backup-cfg
switch(config-job)# cli var name timestamp $(TIMESTAMP) ;copy running-config
bootflash:/$(SWITCHNAME)-cfg.$(timestamp) ;copy bootflash:/$(SWITCHNAME)-cfg.$(timestamp)
tftp://1.2.3.4/ vrf management
switch(config-job)# end
switch(config)#
This example shows how to schedule a scheduler job called backup-cfg to run daily at 1 a.m.:
switch# configure terminal
switch(config)# scheduler schedule name daily
switch(config-schedule)# job name backup-cfg
switch(config-schedule)# time daily 1:00
switch(config-schedule)# end
switch(config)#
Displaying the Job Schedule
This example shows how to display the job schedule:
switch# show scheduler schedule
Schedule Name: daily
--------------------------User Name: admin
Schedule Type: Run every day at 1 Hrs 00 Mins
Last Execution Time : Fri Jan 2 1:00:00 2009
Last Completion Time: Fri Jan 2 1:00:01 2009
Execution count: 2
----------------------------------------------Job NameLast Execution Status
-----------------------------------------------
back-cfgSuccess (0)
switch(config)#
Configuring the Scheduler
Displaying the Results of Running Scheduler Jobs
This example shows how to display the results of scheduler jobs that have been executed by the scheduler:
switch# show scheduler logfile
Job Name: back-cfgJob Status: Failed (1)
Schedule Name : dailyUser Name : admin
Completion time: Fri Jan 1 1:00:01 2009
`cli var name timestamp 2009-01-02-01.00.00`
`copy running-config bootflash:/switch-cfg.2009-01-02-01.00.00`
`copy bootflash:/switch-cfg.2009--01-02-01.00.00 tftp://1.2.3.4/ vrf management `
Connection to Server Established.
[]0.50KBTrying to connect to tftp server......
[######]24.50KB
TFTP put operation was successful
==============================================================================
switch#
Verifying the Online Diagnostics Configuration, page 50
•
Default Settings for Online Diagnostics, page 51
•
Information About Online Diagnostics
Online diagnostics provide verification of hardware components during switch bootup or reset, and they
monitor the health of the hardware during normal switch operation.
Cisco Nexus Series switches support bootup diagnostics and runtime diagnostics. Bootup diagnostics include
disruptive tests and nondisruptive tests that run during system bootup and system reset.
Runtime diagnostics (also known as health monitoring diagnostics) include nondisruptive tests that run in the
background during normal operation of the switch.
Bootup Diagnostics
Bootup diagnostics detect faulty hardware before bringing the switch online. Bootup diagnostics also check
the data path and control path connectivity between the supervisor and the ASICs. The following table describes
the diagnostics that are run only during switch bootup or reset.
Table 7: Bootup Diagnostics
DescriptionDiagnostic
Tests PCI express (PCIe) access.PCIe
Verifies the integrity of the NVRAM.NVRAM
Tests connectivity of the inband port to the supervisor.In band port
Bootup diagnostics also include a set of tests that are common with health monitoring diagnostics.
Bootup diagnostics log any failures to the onboard failure logging (OBFL) system. Failures also trigger an
LED display to indicate diagnostic test states (on, off, pass, or fail).
You can configure Cisco Nexus device to either bypass the bootup diagnostics or run the complete set of
bootup diagnostics.
Health Monitoring Diagnostics
Health monitoring diagnostics provide information about the health of the switch. They detect runtime hardware
errors, memory errors, software faults, and resource exhaustion.
Health monitoring diagnostics are nondisruptive and run in the background to ensure the health of a switch
that is processing live network traffic.
The following table describes the health monitoring diagnostics for the switch.
Configuring Online Diagnostics
DescriptionDiagnostic
Tests the management port.Management port
Verifies the integrity of the DRAM.Memory
Note
Table 8: Health Monitoring Diagnostics Tests
DescriptionDiagnostic
Monitors port and system status LEDs.LED
Monitors the power supply health state.Power Supply
Monitors temperature sensor readings.Temperature Sensor
Monitors the fan speed and fan control.Test Fan
When the switch reaches the intake temperature threshold and does not go within the limits in 120 seconds,
the switch will power off and the power supplies will have to be re-seated to recover the switch
The following table describes the health monitoring diagnostics that also run during system boot or system
reset.
Table 9: Health Monitoring and Bootup Diagnostics Tests
DescriptionDiagnostic
SPROM
Verifies the integrity of backplane and supervisor
SPROMs.
Tests the ports on the switch fabric ASIC.Fabric port
Tests the forwarding engine ASICs.Forwarding engine
Tests the ports on the forwarding engine ASICs.Forwarding engine port
Front port
Note
When the switch exceeds the intake temperature threshold of 40 degrees Celsius and does not decrease
to within the threshold limits in 120 seconds, the switch powers off and the power supplies must be
re-seated to recover the switch.
Expansion Module Diagnostics
During the switch bootup or reset, the bootup diagnostics include tests for the in-service expansion modules
in the switch.
When you insert an expansion module into a running switch, a set of diagnostics tests are run. The following
table describes the bootup diagnostics for an expansion module. These tests are common with the bootup
diagnostics. If the bootup diagnostics fail, the expansion module is not placed into service.
Table 10: Expansion Module Bootup and Health Monitoring Diagnostics
Tests the components (such as PHY and MAC) on
the front ports.
DescriptionDiagnostic
SPROM
Front port
Verifies the integrity of backplane and supervisor
SPROMs.
Tests the switch fabric ASICs.Fabric engine
Tests the ports on the switch fabric ASIC.Fabric port
Tests the forwarding engine ASICs.Forwarding engine
Tests the ports on the forwarding engine ASICs.Forwarding engine port
Tests the components (such as PHY and MAC) on
the front ports.
Health monitoring diagnostics are run on in-service expansion modules. The following table describes the
additional tests that are specific to health monitoring diagnostics for expansion modules.
Table 11: Expansion Module Health Monitoring Diagnostics
Configuring Online Diagnostics
You can configure the bootup diagnostics to run the complete set of tests, or you can bypass all bootup
diagnostic tests for a faster module boot up time.
Configuring Online Diagnostics
DescriptionDiagnostic
Monitors port and system status LEDs.LED
Monitors temperature sensor readings.Temperature Sensor
Note
We recommend that you set the bootup online diagnostics level to complete. We do not recommend
bypassing the bootup online diagnostics.
Procedure
PurposeCommand or Action
Step 1
Step 2
Step 3
The following example shows how to configure the bootup diagnostics level to trigger the complete diagnostics:
The Network Time Protocol (NTP) synchronizes the time of day among a set of distributed time servers and
clients so that you can correlate events when you receive system logs and other time-specific events from
multiple network devices. NTP uses the User Datagram Protocol (UDP) as its transport protocol. All NTP
communications use Coordinated Universal Time (UTC).
An NTP server usually receives its time from an authoritative time source, such as a radio clock or an atomic
clock attached to a time server, and then distributes this time across the network. NTP is extremely efficient;
no more than one packet per minute is necessary to synchronize two machines to within a millisecond of each
other.
NTP uses a stratum to describe the distance between a network device and an authoritative time source:
A stratum 1 time server is directly attached to an authoritative time source (such as a radio or atomic
A stratum 2 NTP server receives its time through NTP from a stratum 1 time server.
•
Before synchronizing, NTP compares the time reported by several network devices and does not synchronize
with one that is significantly different, even if it is a stratum 1. Because Cisco NX-OS cannot connect to a
radio or atomic clock and act as a stratum 1 server, we recommend that you use the public NTP servers
available on the Internet. If the network is isolated from the Internet, Cisco NX-OS allows you to configure
the time as though it were synchronized through NTP, even though it was not.
Note
You can create NTP peer relationships to designate the time-serving hosts that you want your network
device to consider synchronizing with and to keep accurate time if a server failure occurs.
The time kept on a device is a critical resource, so we strongly recommend that you use the security features
of NTP to avoid the accidental or malicious setting of incorrect time. Two mechanisms are available: an access
list-based restriction scheme and an encrypted authentication mechanism.
NTP as a Time Server
the Cisco NX-OS device can use NTP to distribute time. Other devices can configure it as a time server. You
can also configure the device to act as an authoritative NTP server, enabling it to distribute time even when
it is not synchronized to an outside time source.
Distributing NTP Using CFS
Cisco Fabric Services (CFS) distributes the local NTP configuration to all Cisco devices in the network. After
enabling CFS on your device, a network-wide lock is applied to NTP whenever an NTP configuration is
started. After making the NTP configuration changes, you can discard or commit them. In either case, the
CFS lock is then released from the NTP application.
Clock Manager
Clocks are resources that need to be shared across different processes. Multiple time synchronization protocols,
such as NTP and Precision Time Protocol (PTP), might be running in the system.
The clock manager allows you to specify the protocol to control the various clocks in the system. Once you
specify the protocol, the system clock starts updating.
Virtualization Support
NTP recognizes virtual routing and forwarding (VRF) instances. NTP uses the default VRF if you do not
configure a specific VRF for the NTP server and NTP peer.
Licensing Requirements for NTP
The following table shows the licensing requirements for this feature:
NTP has the following configuration guidelines and limitations:
To configure NTP, you must have connectivity to at least one server that is running NTP.
•
You should have a peer association with another device only when you are sure that your clock is reliable
•
(which means that you are a client of a reliable NTP server).
A peer configured alone takes on the role of a server and should be used as a backup. If you have two
•
servers, you can configure several devices to point to one server and the remaining devices to point to
the other server. You can then configure a peer association between these two servers to create a more
reliable NTP configuration.
If you have only one server, you should configure all the devices as clients to that server.
•
You can configure up to 64 NTP entities (servers and peers).
•
If CFS is disabled for NTP, then NTP does not distribute any configuration and does not accept a
•
distribution from other devices in the network.
NTP 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.
After CFS distribution is enabled for NTP, the entry of an NTP configuration command locks the network
•
for NTP configuration until a commit command is entered. During the lock, no changes can be made to
the NTP configuration by any other device in the network except the device that initiated the lock.
If you use CFS to distribute NTP, all devices in the network should have the same VRFs configured as
•
you use for NTP.
If you configure NTP in a VRF, ensure that the NTP server and peers can reach each other through the
•
configured VRFs.
You must manually distribute NTP authentication keys on the NTP server and Cisco NX-OS devices
Enters global configuration mode.switch# configure terminal
Forms an association with a server.switch(config)# [no] ntp server
Use the key keyword to configure a key to be used while
communicating with the NTP server. The range for the key-id
argument is from 1 to 65535.
Use the maxpoll and minpoll keywords to configure the maximum
and minimum intervals in which to poll a peer. The range for the
max-poll and min-poll arguments is from 4 to 16 seconds, and the
default values are 6 and 4, respectively.
Use the prefer keyword to make this the preferred NTP server for
the device.
Use the use-vrf keyword to configure the NTP server to
communicate over the specified VRF. The vrf-name argument can
be default, management, or any case-sensitive alphanumeric string
up to 32 characters.
Note
If you configure a key to be used while communicating
with the NTP server, make sure that the key exists as a
trusted key on the device.
Use the key keyword to configure a key to be used while
communicating with the NTP peer. The range for the key-id
argument is from 1 to 65535.
Use the maxpoll and minpoll keywords to configure the maximum
and minimum intervals in which to poll a peer. The range for the
max-poll and min-poll arguments is from 4 to 16 seconds, and the
default values are 6 and 4, respectively.
Use the prefer keyword to make this the preferred NTP server for
the device.
Use the use-vrf keyword to configure the NTP server to
communicate over the specified VRF. The vrf-name argument can
be default, management, or any case-sensitive alphanumeric string
up to 32 characters.
This example shows how to configure an NTP server and peer:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# ntp server 192.0.2.10 key 10 use-vrf Red
switch(config)# ntp peer 2001:0db8::4101 prefer use-vrf Red
switch(config)# show ntp peers
-------------------------------------------------Peer IP Address Serv/Peer
192.0.2.10 Server (configured)
switch(config)# copy running-config startup-config
[########################################] 100%
switch(config)#
Configuring NTP Authentication
(Optional)
Displays the configured server and peers.
Note
A domain name is resolved only when you have a DNS
server configured.
(Optional)
Saves the change persistently through reboots and restarts by copying
the running configuration to the startup configuration.
You can configure the device to authenticate the time sources to which the local clock is synchronized. When
you enable NTP authentication, the device synchronizes to a time source only if the source carries one of the
authentication keys specified by the ntp trusted-key command. The device drops any packets that fail the
authentication check and prevents them from updating the local clock. NTP authentication is disabled by
default.
Make sure that you configured the NTP server with the authentication keys that you plan to specify in this
procedure.
Procedure
Configuring NTP
PurposeCommand or Action
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
switch(config)# [no] ntp
authentication-key number md5
md5-string
switch(config)# show ntp
authentication-keys
switch(config)# [no]ntp trusted-key
number
switch(config)# show ntp
trusted-keys
switch(config)# [no] ntp
authenticate
switch(config)# show ntp
authentication-status
Enters global configuration mode.switch# configure terminal
Defines the authentication keys. The device does not
synchronize to a time source unless the source has one of
these authentication keys and the key number is specified
by the ntp trusted-key number command.
(Optional)
Displays the configured NTP authentication keys.
Specifies one or more keys that a time source must provide
in its NTP packets in order for the device to synchronize
to it. The range for trusted keys is from 1 to 65535.
This command provides protection against accidentally
synchronizing the device to a time source that is not
trusted.
(Optional)
Displays the configured NTP trusted keys.
Enables or disables the NTP authentication feature. NTP
authentication is disabled by default.
(Optional)
Displays the status of NTP authentication.
You can control access to NTP services by using access groups. Specifically, you can specify the types of
requests that the device allows and the servers from which it accepts responses.
If you do not configure any access groups, NTP access is granted to all devices. If you configure any access
groups, NTP access is granted only to the remote device whose source IP address passes the access list criteria.
Enters global configuration mode.switch# configure terminal
Creates or removes an access group to control NTP access and
applies a basic IP access list.
The access group options are scanned in the following order, from
least restrictive to most restrictive. However, if NTP matches a deny
ACL rule in a configured peer, ACL processing stops and does not
continue to the next access group option.
The peer keyword enables the device to receive time requests
•
and NTP control queries and to synchronize itself to the servers
specified in the access list.
The serve keyword enables the device to receive time requests
•
and NTP control queries from the servers specified in the
access list but not to synchronize itself to the specified servers.
The serve-only keyword enables the device to receive only
•
time requests from servers specified in the access list.
The query-only keyword enables the device to receive only
•
NTP control queries from the servers specified in the access
list.
(Optional)
Displays the NTP access group configuration.
NTP sets the source IP address for all NTP packets based on the address of the interface through which the
NTP packets are sent. You can configure NTP to use a specific source IP address.
To configure the NTP source IP address, use the following command in global configuration mode:
Procedure
Configuring NTP
PurposeCommand or Action
Step 1
This example shows how to configure NTP to a source IP address:
switch(config)# ntp source 192.0.2.1
switch(config)# [no] ntp source
ip-address
Configuring the NTP Source Interface
You can configure NTP to use a specific interface.
To configure the NTP source interface, use the following command in global configuration mode:
Procedure
Step 1
This example shows how to configure NTP to a specific interface:
This example shows how to enable CFS distribution for NTP:
switch# config t
Enter configuration commands, one per
line. End with CNTL/Z.
switch(config)# ntp distribute
switch(config)# copy running-config
startup-config
Commiting NTP Configuration Changes
When you commit the NTP configuration changes, the effective database is overwritten by the configuration
changes in the pending database and all the devices in the network receive the same configuration.
Procedure
Configuring NTP
PurposeCommand or Action
Step 1
Step 2
switch(config)# ntp commit
This example shows how to commit the NTP configuration changes:
switch(config)# ntp commit
Discarding NTP Configuration Changes
After making the configuration changes, you can choose to discard the changes instead of committing them.
If you discard the changes, Cisco NX-OS removes the pending database changes and releases the CFS lock.
To discard NTP configuration changes, use the following command in global configuration mode:
Procedure
Step 1
switch(config)# ntp abort
Enters global configuration mode.switch# configure terminal
Distributes the NTP configuration changes to all Cisco
NX-OS devices in the network and releases the CFS lock.
This command overwrites the effective database with the
changes made to the pending database.
PurposeCommand or Action
Discards the NTP configuration changes in the pending database
and releases the CFS lock. Use this command on the device
where you started the NTP configuration.
This example shows how to discard the NTP configuration changes:
If you have performed an NTP configuration and have forgotten to release the lock by either committing or
discarding the changes, you or another administrator can release the lock from any device in the network.
This action also discards pending database changes.
To release the session lock from any device and discard any pending database changes, use the following
command in global configuration mode:
Procedure
Releasing the CFS Session Lock
PurposeCommand or Action
Step 1
This example shows how to release the CFS session lock:
switch(config)# clear ntp session
switch(config)# clear ntp session
Verifying the NTP Configuration
To display the NTP configuration, perform one of the following tasks:
Use the clear ntp session command to clear the NTP sessions.
Use the clear ntp statistics command to clear the NTP statistics.
Procedure
Step 1
Step 2
Step 3
Discards the NTP configuration changes in the pending
database and releases the CFS lock.
PurposeCommand or Action
Displays the NTP access group configuration.show ntp access-groups
Displays the configured NTP authentication keys.show ntp authentication-keys
Displays the status of NTP authentication.show ntp authentication-status
Step 4
Step 5
Step 6
Step 7
Step 8
Step 9
Displays the NTP logging status.show ntp logging-status
Displays the status for all NTP servers and peers.show ntp peer-status
Displays all the NTP peers.show ntp peers
Displays the temporary CFS database for NTP.show ntp pending
Displays the difference between the pending CFS
database and the current NTP configuration.
Displays the RTS update status.show ntp rts-update
63
Page 80
Configuration Examples for NTP
Configuring NTP
PurposeCommand or Action
Step 10
show ntp session status
Step 11
Step 12
Step 13
memory | peer {ipaddr {ipv4-addr |
ipv6-addr} | name peer-name}}
Step 14
Step 15
Step 16
Configuration Examples for NTP
This example shows how to configure an NTP server and peer, enable NTP authentication, enable NTP
logging, and then save the configuration in startup so that it is saved across reboots and restarts:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# ntp server 192.0.2.105 key 42
switch(config)# ntp peer 2001:0db8::4101
switch(config)# show ntp peers
-------------------------------------------------Peer IP AddressServ/Peer
Licensing Requirements for System Message Logging, page 68
•
Guidelines and Limitations for System Message Logging, page 69
•
Default Settings for System Message Logging, page 69
•
Configuring System Message Logging, page 69
•
Configuring DOM Logging, page 79
•
Verifying the System Message Logging Configuration, page 80
•
Information About System Message Logging
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 terminal sessions, 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.
By default, the Cisco Nexus device outputs messages to terminal sessions.
By default, the switch logs system messages to a log file.
The following table describes the severity levels used in system messages. When you configure the severity
level, the system outputs messages at that level and lower.
The switch logs the most recent 100 messages of severity 0, 1, or 2 to the NVRAM log. You cannot configure
logging to the NVRAM.
You can configure which system messages should be logged based on the facility that generated the message
and its severity level.
Syslog Servers
Syslog servers run on remote systems that are configured to log system messages based on the syslog protocol.
You can configure the Cisco Nexus Series switch to sends logs to up to eight syslog servers.
To support the same configuration of syslog servers on all switches in a fabric, you can use Cisco Fabric
Services (CFS) to distribute the syslog server configuration.
2 – critical
3 – error
4 – warning
5 – notification
6 – informational
7 – debugging
Critical condition
Error condition
Warning condition
Normal but significant condition
Informational message only
Appears during debugging only
When the switch first initializes, messages are sent to syslog servers only after the network is initialized.Note
Licensing Requirements for System Message Logging
License RequirementProduct
Cisco NX-OS
System message logging 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 CiscoNX-OS Licensing Guide.
Copies syslog messages from the console to the current
terminal session.
69
Page 86
Configuring System Message Logging to Terminal Sessions
Configuring System Message Logging
PurposeCommand or Action
Step 2
Step 3
Step 4
Step 5
switch(config)# logging console
[severity-level]
switch(config)# no loggingconsole [severity-level]
switch(config)# logging monitor
[severity-level]
Enters global configuration mode.switch# configure terminal
Enables the switch to log messages to the console session
based on a specified severity level or higher (a lower number
value indicates a higher severity level). Severity levels range
from 0 to 7:
• 0 – emergency
• 1 – alert
• 2 – critical
• 3 – error
• 4 – warning
• 5 – notification
• 6 – informational
• 7 – debugging
If the severity level is not specified, the default of 2 is used.
(Optional)
Disables logging messages to the console.
Enables the switch to log messages to the monitor based on
a specified severity level or higher (a lower number value
indicates a higher severity level). Severity levels range from
0 to 7:
Step 6
switch(config)# no logging
monitor [severity-level]
• 0 – emergency
• 1 – alert
• 2 – critical
• 3 – error
• 4 – warning
• 5 – notification
• 6 – informational
• 7 – debugging
If the severity level is not specified, the default of 2 is used.
The configuration applies to Telnet and SSH sessions.
(Optional)
Disables logging messages to Telnet and SSH sessions.
optionally specify a maximum file size. The default severity
level is 5 and the file size is 4194304.
Severity levels range from 0 to 7:
• 0 – emergency
• 1 – alert
• 2 – critical
• 3 – error
• 4 – warning
• 5 – notification
• 6 – informational
• 7 – debugging
The file size is from 4096 to 10485760 bytes.
Step 3
switch(config)# no logging logfile
[logfile-name severity-level [sizebytes]]
(Optional)
Disables logging to the log file. You can optionally specify a
maximum file size. The default severity level is 5 and the file
size is 4194304.
Step 4
switch# show logging info
(Optional)
Displays the logging configuration. You can optionally specify
a maximum file size. The default severity level is 5 and the
file size is 4194304.
Step 5
switch# copy running-config
startup-config
(Optional)
Copies the running configuration to the startup configuration.
The following example shows how to configure a switch to log system messages to a file:
To apply the same severity level to all facilities, use the all
facility. For defaults, see the show logging level command.
Note
If the default severity and current session severity of a
component is the same, then the logging level for the
component will not be displayed in the running
configuration.
Step 4
Step 5
switch(config)# no logging
module [severity-level]
switch(config)# no logging
level [facility severity-level]
(Optional)
Disables module log messages.
(Optional)
Resets the logging severity level for the specified facility to its
default level. If you do not specify a facility and severity level,
the switch resets all facilities to their default levels.
Step 6
switch# show logging module
(Optional)
Displays the module logging configuration.
Step 7
switch# show logging level
[facility]
(Optional)
Displays the logging level configuration and the system default
level by facility. If you do not specify a facility, the switch
displays levels for all facilities.
Step 8
switch# copy running-config
startup-config
(Optional)
Copies the running configuration to the startup configuration.
The following example shows how to configure the severity level of module and specific facility messages:
You can configure up to eight syslog servers that reference remote systems where you want to log system
messages.
(Optional)
Resets the logging time-stamp units to the
default of seconds.
(Optional)
Displays the logging time-stamp units
configured.
(Optional)
Copies the running configuration to the startup
configuration.
Procedure
Step 1
Step 2
Example:
switch# configure terminal
switch(config)#
logging server host [severity-level
[use-vrf vrf-name [facilityfacility]]]
Example:
switch(config)# logging
server 172.28.254.254 5
use-vrf default facility
local3
PurposeCommand or Action
Enters global configuration mode.configure terminal
Configures a host to receive syslog messages.
The host argument identifies the hostname or the IPv4 or
•
IPv6 address of the syslog server host.
The severity-level argument limits the logging of messages
•
to the syslog server to a specified level. Severity levels
range from 0 to 7. See Table 14: System Message Severity
Levels , on page 67.
The use vrf vrf-name keyword and argument identify the
•
default or management values for the virtual routing and
forwarding (VRF) name. If a specific VRF is not identified,
management is the default. However, if management is
configured, it will not be listed in the output of the
show-running command because it is the default. If a
specific VRF is configured, the show-running command
output will list the VRF for each server.
Note
The current Cisco Fabric Services (CFS)
distribution does not support VRF. If CFS
distribution is enabled, the logging server
configured with the default VRF is distributed as
the management VRF.
The facility argument names the syslog facility type. The
•
default outgoing facility is local7.
The facilities are listed in the command reference for the
Cisco Nexus Series software that you are using.
Note
Debugging is a CLI facility but the debug syslogs are
not sent to the server.
Step 3
no logging server host
(Optional)
Removes the logging server for the specified host.
Example:
switch(config)# no logging
server 172.28.254.254 5
Step 4
show logging server
(Optional)
Displays the syslog server configuration.
Example:
switch# show logging server
Step 5
copy running-config
startup-config
(Optional)
Saves the change persistently through reboots and restarts by
copying the running configuration to the startup configuration.
Configuring syslog Server Configuration Distribution
DescriptionField
Step 1
Facility
Creator of the message, which can be auth, authpriv,
cron, daemon, kern, lpr, mail, mark, news, syslog,
user, local0 through local7, or an asterisk (*) for all.
These facility designators allow you to control the
destination of messages based on their origin.
Note
Check your configuration before using a
local facility.
Level
Minimum severity level at which messages are
logged, which can be debug, info, notice, warning,
err, crit, alert, emerg, or an asterisk (*) for all. You
can use none to disable a facility.
Action
Destination for messages, which can be a filename,
a hostname preceded by the at sign (@), or a
comma-separated list of users or an asterisk (*) for
all logged-in users.
Procedure
Log debug messages with the local7 facility in the file /var/log/myfile.log by adding the following line to the
/etc/syslog.conf file:
debug.local7/var/log/myfile.log
Step 2
Step 3
Create the log file by entering these commands at the shell prompt:
$ touch /var/log/myfile.log
$ chmod 666 /var/log/myfile.log
Make sure that the system message logging daemon reads the new changes by checking myfile.log after
entering this command:
$ kill -HUP ~cat /etc/syslog.pid~
Configuring syslog Server Configuration Distribution
You can distribute the syslog server configuration to other switches in the network by using the Cisco Fabric
Services (CFS) infrastructure.
After you enable syslog server configuration distribution, you can modify the syslog server configuration and
view the pending changes before committing the configuration for distribution. As long as distribution is
enabled, the switch maintains pending changes to the syslog server configuration.
If the switch is restarted, the syslog server configuration changes that are kept in volatile memory might
get lost.
Before You Begin
You must have configured one or more syslog servers.
Procedure
PurposeCommand or Action
Step 1
Step 2
switch(config)# logging
distribute
Enters global configuration mode.switch# configure terminal
Enables distribution of the syslog server configuration to
network switches using the CFS infrastructure. By default,
distribution is disabled.
Step 3
switch(config)# logging commit
Commits the pending changes to the syslog server
configuration for distribution to the switches in the fabric.
Step 4
switch(config)# logging abort
Cancels the pending changes to the syslog server
configuration.
Step 5
switch(config)# no logging
distribute
(Optional)
Disables the distribution of the syslog server configuration
to network switches using the CFS infrastructure. You cannot
disable distribution when configuration changes are pending.
See the logging commit and logging abort commands. By
default, distribution is disabled.
Step 6
Step 7
switch# show logging pending
switch# show logging
pending-diff
Step 8
switch# copy running-config
startup-config
Displaying and Clearing Log Files
You can display or clear messages in the log file and the NVRAM.
(Optional)
Displays the pending changes to the syslog server
configuration.
(Optional)
Displays the differences from the current syslog server
configuration to the pending changes of the syslog server
configuration.
(Optional)
Copies the running configuration to the startup configuration.
Displays the last number of lines in the logging file. You
can specify from 1 to 9999 for the last number of lines.
Displays the messages in the log file that have a time
stamp within the span entered. If you do not enter an end
time, the current time is used. You enter three characters
for the month time field and digits for the year and day
time fields.
Displays the messages in the NVRAM. To limit the
number of lines displayed, you can enter the last number
of lines to display. You can specify from 1 to 100 for the
last number of lines.
Clears the contents of the log file.switch# clear logging logfile
Clears the logged messages in NVRAM.switch# clear logging nvram
Guidelines and Limitations for Smart Call Home, page 92
•
Prerequisites for Smart Call Home, page 92
•
Default Call Home Settings, page 93
•
Configuring Smart Call Home, page 93
•
Verifying the Smart Call Home Configuration, page 103
•
Sample Syslog Alert Notification in Full-Text Format, page 104
•
Sample Syslog Alert Notification in XML Format, page 104
•
Information About Smart Call Home
Smart Call Home provides e-mail-based notification of critical system events. Cisco Nexus Series switches
provide 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 (TAC).
If you have a service contract directly with Cisco, you can register your devices for the Smart Call Home
service. Smart Call Home provides fast resolution of system problems by analyzing Smart 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
by the Cisco TAC.
Smart Call Home offers the following features:
Continuous device health monitoring and real-time diagnostic alerts.
•
Analysis of Smart 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 that require 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 Smart Call Home messages and recommendations, inventory and configuration
•
information for all Smart Call Home devices, and field notices, security advisories, and end-of-life
information.
Smart Call Home Overview
You can use Smart Call Home to notify an external entity when an important event occurs on your device.
Smart Call Home delivers alerts to multiple recipients that you configure in destination profiles.
Smart Call Home includes a fixed set of predefined alerts on your switch. These alerts are grouped into alert
groups and CLI commands that are assigned to execute when an alert in an alert group occurs. The switch
includes the command output in the transmitted Smart Call Home message.
The Smart Call Home feature offers the following:
Configuring Smart Call Home
Automatic execution and attachment of relevant CLI command output.
•
Multiple message format options such as the following:
•
◦ Short Text—Text that is suitable for pagers or printed reports.
◦ Full Text—Fully formatted message information that is suitable for human reading.
◦ XML—Matching readable format that uses the Extensible Markup Language (XML) and the
Adaptive Messaging Language (AML) XML schema definition (XSD). The XML format enables
communication with the Cisco TAC.
Multiple concurrent message destinations. You can configure up to 50 e-mail destination addresses for
•
each destination profile.
Smart Call Home Destination Profiles
A Smart Call Home destination profile includes the following information:
• One or more alert groups—The group of alerts that trigger a specific Smart Call Home message if the
alert occurs.
• One or more e-mail destinations—The list of recipients for the Smart Call Home messages that are
generated by alert groups assigned to this destination profile.
• Message format—The format for the Smart Call Home message (short text, full text, or XML).
• Message severity level—The Smart Call Home severity level that the alert must meet before the switch
generates a Smart Call Home message to all e-mail addresses in the destination profile. The switch does
not generate an alert if the Smart Call Home severity level of the alert is lower than the message severity
level set for the destination profile.
You can also configure a destination profile to allow periodic inventory update messages by using the inventory
alert group that will send out periodic messages daily, weekly, or monthly.