RAPTOR™ - iS5 Communications

CFGUM-PTP-Raptor-1.2-EN.docx i © 2019 iS5 COMMUNICATIONS INC. ALL RIGHTS RESERVED.

CONFIG User Manual PTP

RAPTOR™ Intelligent Cyber Secure Platform

Version 1.2, Nov. 2019

© 2019 iS5 Communications Inc. All rights reserved.

CONFIG USER MANUAL PTP

CFGUM-PTP-Raptor-1.2-EN.docx ii © 2019 iS5 COMMUNICATIONS INC. ALL RIGHTS RESERVED.

COPYRIGHT NOTICE © 2019 iS5 Communications Inc. All rights reserved.

No part of this publication may be reproduced in any form without the prior written consent of iS5 Communications Inc. (iS5).

TRADEMARKS iS5Com is a registered trademark of iS5. All other trademarks belong to their respective owners.

REGULATORY COMPLIANCE STATEMENT Product(s) associated with this publication complies/comply with all applicable regulations. For more details, refer to the Technical Specifications.

WARRANTY iS5 warrants that all products are free from defects in material and workmanship for a specified warranty period from the invoice date (5 years for most products). iS5 will repair or replace products found to be defective within this warranty period including shipping costs. This warranty does not cover product modifications or repairs done by persons other than iS5-approved personnel, and this warranty does not apply to products that are misused, abused, improperly installed, or damaged by accident. Refer to the Technical Specifications for the actual warranty period(s) of the product(s) associated with this publication.

DISCLAIMER Information in this publication is intended to be accurate. iS5 shall not be responsible for its use or infringements on third parties because of the use of this publication. There may occasionally be unintentional errors on this publication. iS5 reserves the right to revise the contents of this publication without notice.

CONTACT INFORMATION iS5 Communications Inc. Tel: +1 905-670-0004 Toll Free: +1 844-520-0588 Technical Support : +1 844-475-8324 Email : [email protected] 5895 Ambler Dr., Mississauga, Ontario, L4W 5B7 Website : www.iS5Com.com Technical Support E-mail : [email protected] Sales Contact E-mail: [email protected]

http://www.is5com.com/

mailto:[email protected]

mailto:[email protected]


CFGUM-PTP-Raptor-1.2-EN.docx v © 2019 iS5 COMMUNICATIONS INC. ALL RIGHTS RESERVED.

Contents

Terms and Typographical Conventions in Use .............................................. 1 CHAPTER 1: INTRODUCTION ________________________________________________ 2

Purpose and Scope ............................................................................... 2 Acronyms ............................................................................................... 2 References ............................................................................................. 3 General Configurations ........................................................................ 4

1.4.1 CLI Command Modes ............................................................................. 4 1.4.2 PTP MIB .................................................................................................. 5 1.4.2.1 MIBs Summary ................................................................................. 5 1.4.2.2 Supported Operations ...................................................................... 7 1.4.2.3 set Operation .................................................................................... 8 1.4.2.4 get Operation .................................................................................... 8

CHAPTER 2: PROTOCOL DESCRIPTIONS ______________________________________ 9

PTP Devices ........................................................................................... 9 2.1.1 Ordinary Clock (not supported at the current version) ............................ 9 2.1.2 Boundary Clock (not supported at the current version) ........................ 10 2.1.3 End-to-End Transparent Clocks ........................................................... 11 2.1.4 Peer-to-Peer Transparent Clock ........................................................... 12 2.1.5 PTP Transparent Clock with Profiles Configuration ............................. 13

PTP Master-Slave Hierarchy .............................................................. 13 PTP Synchronization and Syntonization .......................................... 14

CHAPTER 3: PTP CONFIGURATIONS _________________________________________ 17

Configuring PTP by CLI and SNMP ................................................... 18 3.1.1 Enabling/Disabling PTP in the Switch................................................... 18 3.1.1.1 CLI Configuration ........................................................................... 18 3.1.1.2 SNMP Configuration ....................................................................... 18 3.1.2 Configuring / Unconfiguring PTP domain ............................................. 19 3.1.2.1 CLI Configuration ........................................................................... 19 3.1.2.2 SNMP Configuration ....................................................................... 20 3.1.3 Configuring Mode for a Domain in PTP ................................................ 20 3.1.3.1 CLI Configuration ........................................................................... 20 3.1.3.2 SNMP Configuration ....................................................................... 23 3.1.4 Enabling/Disabling PTP on Interface .................................................... 23 3.1.4.1 CLI Configuration ........................................................................... 23 3.1.4.2 SNMP Configuration ....................................................................... 25 3.1.5 Configuring / Unconfiguring PTP profile ............................................... 25 3.1.5.1 CLI Configuration ........................................................................... 25 3.1.5.2 SNMP Configuration ....................................................................... 26 3.1.6 Other Configuration Commands ........................................................... 27 3.1.6.1 CLI Configuration ........................................................................... 27 3.1.6.2 SNMP Configuration ....................................................................... 27 3.1.7 show Commands .................................................................................. 28 3.1.7.1 CLI Configuration ........................................................................... 28 3.1.7.2 SNMP Configuration ....................................................................... 32 3.1.8 Examples of PTP Configurations .......................................................... 34

PTP Configuration by WebUI ............................................................. 46 3.2.1 PTP Global Configurations ................................................................... 46 3.2.2 Clock Configurations Screen ................................................................ 47 3.2.3 Port Settings- PTP Interfaces ............................................................... 50


CFGUM-PTP-Raptor-1.2-EN.docx vi © 2019 iS5 COMMUNICATIONS INC. ALL RIGHTS RESERVED.

Table of Figures Figure 1-1: ptpPowerProfileMIB.................................................................................................................... 5 Figure 2-1: Model of an ordinary clock .......................................................................................................10 Figure 2-2: Model of a boundary clock .......................................................................................................10 Figure 2-3: End-to-end transparent clock ...................................................................................................11 Figure 2-4: Model of a peer-to-peer transparent clock ...............................................................................12 Figure 2-5: Basic Synchronization Message Exchange .............................................................................14 Figure 2-6: Link Delay Measurement .........................................................................................................15 Figure 3-1: Multiple Contexts–Single Domain Topology ............................................................................17 Figure 3-2: PTP Global Configurations .......................................................................................................46 Figure 3-3: Clock Configurations Page .......................................................................................................47 Figure 3-4: PTP Interfaces ..........................................................................................................................50


CFGUM-PTP-Raptor-1.2-EN.docx 1 © 2019 iS5 COMMUNICATIONS INC. ALL RIGHTS RESERVED.

Terms and Typographical Conventions in Use The terms and typographical conventions to be used in this document are as listed in Table 1.

Conventions Usage Example

Courier New 10 bold orange

Syntax of the CLI command configure terminal

< > The parameter inside < > indicates the input fields of the syntax

<integer (100-1000)>

[ ] The parameter inside [ ] indicates the optional fields of syntax

[<output file>]

{ } For grouping parameters in the syntax

{console}

| For separating grouped parameters in the syntax

{console | vty | <line-number(2)>}

Arial Bold 10 CLI (Command Line Interface) Commands

iS5comm# configure terminal

Arial 10 Italics User inputs to a command iS5comm(config)# ptp domain 0

Courier New 10 Regular, blue color

CLI Command output iS5comm# show ptp global info

PTP System Status

-----------------

Global Status : Enabled

Domain : None

Prerequisites Alias name can be set only for the

commands having equal to or less than 10 tokens.

. Notes. These topics convey additional information on an associated topic.

BFD support is enabled on an interface by default

Output of the configured value iS5comm# show ip vrf vrf3

VcId VRF-Name Interfaces

---- -------- ----------

1 vrf3 Gi0/7 Gi0/8



Chapter

Introduction

PTP (Precision Time Protocol) was originally defined in the IEEE 1588-2002 standard, officially entitled "Standard for a Precision Clock Synchronization Protocol for Networked Measurement and Control Systems” and published in 2002. In 2008, IEEE 1588-2008 was released as a revised standard; also known as PTP Version 2. It improves accuracy, precision, and robustness, but is not backward compatible with the original 2002 version [1].

PTP (Precision Time Protocol) is defined in IEEE 1588 as Precision Clock Synchronization for Networked Measurements and Control Systems, and it was developed to synchronize the clocks in packet-based networks that include distributed device clocks of varying precision and stability standalone software which implements IEEE 1588. PTP is message-based protocol that specifies how the real-time clocks in a distributed system synchronize with each other. PTP creates master-slave hierarchy to synchronize the clocks in the system.

This chapter describes the purpose and scope of this document, lists the definitions / acronyms, conventions used in this document and the general CLI and SNMP configurations.

Purpose and Scope This document describes the PTP module configuration. This document describes the configuration detail through CLI (Command Line Interface), SNMP (Simple Network Management Protocol), and Web UI (user interface) interfaces.

The reader is expected to have a basic knowledge of the PTP protocol as a pre-requisite.

Acronyms The following table shows all acronyms used in this document.

Acronym Expansion BMC BMC (Best Master Clock) CLI Command Line Interface CSR Certificate Signing Request (File) E2E End-to-end (clock)



Acronym Expansion GPS Global Positioning System MIB Management Interface Base MSR Model-Specific Register (File) PDelay Peer Delay Mechanism PTP Precision Time Protocol P2P Peer-to-Peer (clock) SNMP Simple Network Management Protocol VLAN Virtual Local Area Network TAI International Atomic Time UTC Universal Coordinated Time

References [1] IEEE Std 1588-2008 (Revision of IEEE Std 1588-2002) - IEEE Standard for a Precision Clock

Synchronization Protocol for Networked Measurement and Control Systems.

[2] Juniper Networks, TechLibrary >Junos OS > Network Management and Monitoring Guide > Understanding the Implementation of SNMP https://www.juniper.net/documentation/en_US/junos/topics/concept/snmp-qfx-series-understanding.html Online, Accessed on Aug 31, 2018

[3] Cisco.com, Precision Time Protocol Software Configuration Guide for IE 2000U and Connected Grid Switches https://www.cisco.com/c/en/us/td/docs/switches/connectedgrid/cg-switch-sw-master/software/configuration/guide/ptp/b_ptp_ie2ku.html#con_1057665 Online,

[4] IEEE C37.238-2017 - IEEE Standard Profile for Use of IEEE 1588 Precision Time Protocol in Power System Applications

[5] IEEE 61850-9-3-2016 - IEC/IEEE International Standard - Communication networks and systems for power utility automation – Part 9-3: Precision time protocol profile for power utility automation

https://www.juniper.net/documentation/en_US/junos/topics/concept/snmp-qfx-series-understanding.html

https://www.juniper.net/documentation/en_US/junos/topics/concept/snmp-qfx-series-understanding.html

https://www.cisco.com/c/en/us/td/docs/switches/connectedgrid/cg-switch-sw-master/software/configuration/guide/ptp/b_ptp_ie2ku.html#con_1057665

https://www.cisco.com/c/en/us/td/docs/switches/connectedgrid/cg-switch-sw-master/software/configuration/guide/ptp/b_ptp_ie2ku.html#con_1057665



General Configurations

1.4.1 CLI Command Modes Raptor has three major command modes which are listed in order of increasing privileges as follows: • User EXEC mode—it is the initial mode of access. • Privileged EXEC mode—it is accessed from User EXEC mode. • Global Configuration mode—it allows you to make changes to the running configuration. If you save

the configuration, the change in the setting survive a reload of Raptor. More sub-modes can be accessed from Global Configuration mode as seen in the table below. The following table provides the access and exit methods to all above mentioned configuration modes.

Table 1-1: CLI Command Modes Command Mode Access Method Prompt Exit method

User EXEC This is the initial mode of access. iS5comm> Exit: logout

Privileged EXEC

Enter Privileged EXEC mode, from User EXEC mode: enable

iS5comm# Exit to User EXEC Mode: disable

Global Configuration

Enter Global Configuration mode, from Privileged EXEC mode:

iS5comm(config)# Exit to Privileged EXEC: end or exit

configure terminal

Interface Configuration

Enter the Interface configuration mode, from Global Configuration mode interface <interface- type><interface-id> e.g. (config)# interface gigabitethernet 0/1

iS5comm(config-if)#

Exit to Global Configuration mode: exit Exit to Privileged EXEC mode: end

PTP Configuration

The Global Configuration mode command ptp [ domain <short (0-127)>] is used to enter the PTP Configuration mode.

e.g. (config)# ptp domain 0 Note: Only one domain is supported.

iS5comm (config-ptp)#

Exit to Global Configuration mode: exit Exit to Privileged EXEC mode: end



1.4.2 PTP MIB

1.4.2.1 MIBs Summary The path to the ptpPowerProfileMIB is iso(1).org(3).dod(6).internet(1). private(4).enterprises(1).is5communications(41094).products(0). raptor(250).iss(2).ptpPowerProfileMIB(45) OID: 1.3.6.1.4.1.41094.0.250.2.45

If your are using MG-SOFT MIB Browser, go to the Query view.

A screen capture of the fsPtpMIB tree is given below:

Figure 1-1: ptpPowerProfileMIB

For all OBJECT-TYPE MIBs, the icons are or

In Query view, the different colors signify different Max Access types: 1. Purple stands for Not-accessible 2. Blue – read-only 3. Black – read-write 4. Orange – read-create (e.g. fsPtpContextRowStatus) All OBJECT-TYPE MIBs are shown in the table below. Note that the objects with not-accessible max. access are not included in the table.



Description of ptpPoweProfileMIB OID 1.3.6.1.4.1.41094.0.250.2.45

Value list/ Default value/ Status Max

access fsPtpGlobalSysCtrl (1.1.1) 1: start(1)

2: shutdown(2) Default values:shutdown (name)

current read-write

fsPtpGblTraceOption (1.1.2) critical (char-str) current read-write fsPtpPrimaryContext (1.1.3) 0 (int) current read-only fsPtpAdminStatus (1.1.4.1.2) 1: enabled(1)

2: disabled(2) Default:disabled (name)

current read-write

fsPtpTraceOption (1.1.4.1.3) critical (char-str) current read-write fsPtpContextType(1.1.4.1.4) 1: l2Context(1)

2: l3Context(2) 3: l2Andl3Context(3)

current read-only

fsPtpPrimaryDomain (1.1.4.1.5) 0 (int) current read-only fsPtpContextRowStatus (1.1.4.1.6) current read-create fsPtpDomainClockMode (1.2.1.1.2) 1: transparent(3)

2: forward(4) Default:forward (name)

current read-write

fsPtpDomainClockIdentity (1.2.1.1.3) e8:e8:75:ff:fe:90:0b:02 current read-only fsPtpDomainRowStatus (1.2.1.1.4) current read-write fsPtpTransparentClockIdentity (1.3.1.1.1) e8:e8:75:ff:fe:90:0b:02 current read-only fsPtpTransparentClockTwoStepFlag (1.3.1.1.2) false (name) current read-only fsPtpTransparentClockNumberPorts (1.3.1.1.3) 0 (int) current read-write fsPtpTransparentClockDelaymechanism (1.3.1.1.4) 1: endtoend (1)

2: peertopeer (2) Default values: 1 (int)

current read-write

fsPtpTransparentClockPrimaryDomain (1.3.1.1.5) current read-only fsPtpTransparentPortInterfaceType (1.4.1.1.2) ieee8023(3) current read-write fsPtpTransparentPortIfaceNumber (1.4.1.1.3) Interface index current read-only fsPtpTransparentPortClockIdentity (1.4.1.1.4) current read-only fsPtpTransparentPortMinPdelayReqInterval (1.4.1.1.5) 1 (int) current read-write fsPtpTransparentPortFaultyFlag (1.4.1.1.6) false (name) current read-only fsPtpTransparentPortPeerMeanPathDelay (1.4.1.1.7) current read-only fsPtpTransparentPortPtpStatus (1.4.1.1.8) false (name) current read-write fsPtpTransparentPortRowStatus (1.4.1.1.9) current read-create fsPtpPortClockIdentity (1.5.1.1.2) current read-only fsPtpPortInterfaceType (1.5.1.1.3) ieee8023(3) current read-write fsPtpPortIfaceNumber (1.5.1.1.4) Interface index current read-only fsPtpPortMinPdelayReqInterval (1.5.1.1.5) 0 (int) current read-write fsPtpPortPeerMeanPathDelay (1.5.1.1.6) current read-only fsPtpPortDelayMechanism (1.5.1.1.7) 1: endtoend (1)

2: peertopeer (2) 3: disabled (255) Default values:1 (int)

current read-only

fsPtpPortVersionNumber (1.5.1.1.8) 2 (int) current read-only fsPtpPortPtpStatus (1.5.1.1.9) false (name) current read-write fsPtpPortRcvdSyncMsgCnt (1.5.1.1.10) current read-only fsPtpPortDiscardedMsgCnt (1.5.1.1.11) current read-only fsPtpPortTransSyncMsgCnt (1.5.1.1.12) current read-only fsPtpPortRcvdPeerDelayReqMsgCnt (1.5.1.1.13) current read-only fsPtpPortTransPeerDelayReqMsgCnt (1.5.1.1.14) current read-only fsPtpPortRcvdPeerDelayRespMsgCnt (1.5.1.1.15) current read-only fsPtpPortTransPeerDelayRespMsgCnt (1.5.1.1.16) current read-only fsPtpPortTransPeerDelayRespFollowUpMsgCnt 1.17) current read-only fsPtpPortRcvdPeerDelayRespFollowUpMsgCnt 1.18) current read-only fsPtpPortRcvdPeerDelayRespFollowUpMsgCnt 1.19) current read-create ptpTcDefaultDs ptpTcDefaultDsClkIdentity (2.1.2.1.1) current read-only ptpTcDefaultDsNumberPorts (2.1.2.1.2) current read-only



Description of ptpPoweProfileMIB OID 1.3.6.1.4.1.41094.0.250.2.45

Value list/ Default value/ Status Max

access ptpTcDefaultDsDelayMech (2.1.2.1.3) Default values: 2 (int) current read-write ptpTcDefaultDsProfileSet (2.1.2.1.5) current read-only ptpTcDefaultDsTimeInaccuracy (2.1.2.1.6) Default values: 7FFFFFFF

(hex-str) current read-only

ptpTcDefaultDsProfileId (2.1.2.1.7) 1: noProfile(128) 2: defaultE2EProfile(64)

3: defaultP2PProfile(32) 4: utlityProfile(16)

5: powerProfilev2(8)

current read-write

ptpTcPortDsClockIdentity (2.1.2.2.1.2) current read-only ptpTcPortDsPortNumber (2.1.2.2.1.3) current read-only ptpTcPortDsLogMinPdelayReqInterv (2.1.2.2.1.4) current read-write ptpTcPortDsFaultyFlag (2.1.2.2.1.5) current read-only ptpTcPortDsPeerMeanLinkDelay (2.1.2.2.1.6) current read-only ptpTcPortDsPortEnabled (2.1.2.2.1.7) Default values: 1 (int) current read-write ptpTcPortDsDlyAsymmetry (2.1.2.2.1.8) Default values:7FFFFFFF

(hex-str) current read-only

ptpTcPortDsTwoStepFlag (2.1.2.2.1.9) Default values: 1 (int) current read-only ptpTcPortDsErrorCounter (2.1.2.2.1.10) current read-only

1.4.2.2 Supported Operations Settings Supported Operations

fsPtpSysCtrlGlobal Get Set fsPtpGblTraceOption Get Set fsPtpPrimaryContext Get fsPtpAdminStatus Get Set fsPtpTraceOption Get Set fsPtpContextType Get fsPtpPrimaryDomain Get fsPtpContextRowStatus Get fsPtpDomainClockMode Get Set fsPtpDomainClockIdentity Get fsPtpDomainRowStatus Get Set fsPtpTransparentClockIdentity Get fsPtpTransparentClockTwoStepFlag Get fsPtpTransparentClockNumberPorts Get Set fsPtpTransparentClockDelaymechanism Get Set fsPtpTransparentClockPrimaryDomain Get fsPtpTransparentPortInterfaceType Get Set fsPtpTransparentPortIfaceNumber Get fsPtpTransparentPortClockIdentity Get fsPtpTransparentPortMinPdelayReqInterval Get Set fsPtpTransparentPortFaultyFlag Get fsPtpTransparentPortPeerMeanPathDelay Get fsPtpTransparentPortPtpStatus Get Set fsPtpTransparentPortRowStatus Get fsPtpPortClockIdentity Get fsPtpPortInterfaceType Get Set fsPtpPortIfaceNumber Get fsPtpPortMinPdelayReqInterval Get Set fsPtpPortPeerMeanPathDelay Get fsPtpPortDelayMechanism Get



Settings Supported Operations fsPtpPortVersionNumber Get fsPtpPortPtpStatus Get Set fsPtpPortRcvdSyncMsgCnt Get fsPtpPortDiscardedMsgCnt Get fsPtpPortTransSyncMsgCnt Get fsPtpPortRcvdPeerDelayReqMsgCnt Get fsPtpPortTransPeerDelayReqMsgCnt Get fsPtpPortRcvdPeerDelayRespMsgCnt Get fsPtpPortTransPeerDelayRespFollowUpMsgCnt Get fsPtpPortRcvdPeerDelayRespFollowUpMsgCnt Get fsPtpPortRcvdPeerDelayRespFollowUpMsgCnt Get ptpTcDefaultDsClkIdentity Get ptpTcDefaultDsNumberPorts Get ptpTcDefaultDsDelayMech Get Set ptpTcDefaultDsProfileSet Get ptpTcDefaultDsTimeInaccuracy Get ptpTcDefaultDsProfileId Get Set ptpTcPortDsClockIdentity Get ptpTcPortDsPortNumber Get ptpTcPortDsLogMinPdelayReqInterv Get Set ptpTcPortDsFaultyFlag Get ptpTcPortDsPeerMeanLinkDelay Get ptpTcPortDsPortEnabled Get Set ptpTcPortDsDlyAsymmetry Get ptpTcPortDsTwoStepFlag Get ptpTcPortDsErrorCounter Get

The following sub sections brief on the purpose of each of these operations and provide syntax and an example for the same.

1.4.2.3 set Operation

The Set operation is used to configure a particular value of an object identified by the indices used in the operation.

Syntax: % snmpSession set {{ObjectName.Index1.Index2…IndexN DataType ValueToBeSet}}

DataType is an optional argument Example: % snmp0 set {{fsPtpAdminStatus.0 enabled}}

Where, ContextID = 0

1.4.2.4 get Operation

The Get operation is used to obtain the configured value of an object identified by the indices used in the operation.

Syntax: % snmpSession get {{ObjectName.Index1.Index2…IndexN}}

Output: {ObjectIdentifier DataType Value}

Example: % snmp0 get {{fsPtpAdminStatus.0 enabled}}

Where, ContextId = 0



Chapter

Protocol Descriptions

PTP Devices At this version of Raptor, iS5Com PTP supports end-to-end and peer-to-peer transparent clocks. The other 2 types of clocks are ordinary and boundary transparent clocks. They are explained in this chapter but are NOT supported by this version of Raptor.

2.1.1 Ordinary Clock (not supported at the current version) An ordinary clock can be a grandmaster or slave clock in a master-slave hierarchy. Master clocks provide the time reference to other nodes, and slave clocks synchronize to a master clock. The ordinary clock has a single PTP port and single PTP port state. It consists of the local clock, the PTP control engine, the data and port data sets, timestamp functions for event messages, and application functions.



Figure 2-1: Model of an ordinary clock

The ordinary clock executes the port state machine and BMC (Best Master Clock) algorithm to select the PTP port state. If the port is in the master state, the local clock is synchronized to an external source of time traceable to TAI (International Atomic Time) and UTC (Universal Coordinated Time) such as GPS (Global Positioning System) system. If the port is in slave state, the local clock is synchronized with its master clock.

A PTP ordinary clock sends and receives PTP messages to synchronize the clocks. The ordinary clock contains one physical port and two logical interfaces to handle PTP event messages and PTP general messages separately. The PTP event messages are timestamp messages. Ordinary clock can use Delay request-response mechanism or Peer Delay request-response mechanism to calculate the propagation delay. In addition to event messages, general messages are used to transport non-timing critical data between the devices, such as Announce or Follow_Upmessages. PTP ordinary clocks are connected application devices such as sensors or actuators.

2.1.2 Boundary Clock (not supported at the current version) The boundary clock can be grandmaster or master or slave clock in a master-slave hierarchy. It can have more than one port. It has functionally similar to the ordinary clock, except that a boundary clock executes port state machine on each port and BMC algorithm to select the port state of each port. The local clock and clock data set are common for all ports in the boundary clock.

A boundary clock is used only as a network element and is not associated with application devices such as sensors or actuators.

Figure 2-2: Model of a boundary clock



2.1.3 End-to-End Transparent Clocks End-to-end (E2E) transparent clocks forward PTP messages, measure the residence time of PTP event message at the transparent clock, and add this residence time in the correction field of the PTP messages. Transparent clock timestamps the event messages on ingress and egress port. The difference between these timestamps is the residence time within the transparent clock. End-to-end transparent clocks will not execute port state machine and BMC algorithm to select the state of the port.

End-to-end transparent clocks may be used as a network element, or they may be associated with application devices such as sensors or actuators if an ordinary clock is combined with the end-to-end transparent clock. In an end-to-end transparent clock, users can:

1. Configure PTP on global switch level.

2. Enable/disable PTP protocol at port level.

3. Show the current PTP configuration and statistics.

4. Go to PTP mode and set mode to End-to-End Transparent mode or Peer to Peer (P2P) Transparent mode.

5. Set the number of ports that can support Transparent mode.

6. Set minimum amount of time between sending PDelay request message in P2P mode.

7. Save PTP configuration.

8. Debug the PTP module.

Figure 2-3: End-to-end transparent clock

Where, RC stands for rate estimation and control and RE1—rate estimation relative to master.



2.1.4 Peer-to-Peer Transparent Clock Peer-to-peer transparent clock differs from the end-to-end transparent clock in the way it corrects and handles the timing messages. End-to-end transparent clock time stamps all PTP timing messages; peer-to-peer transparent clock forwards only Sync and Follow up messages.

Peer-to-peer transparent clock calculates the residence time of PTP messages in peer-to-peer transparent clock, measures the link delay of the ingress port of PTP messages, and adds this correction field in the PTP messages. Peer-to-peer transparent clock uses Pdelay request-response mechanism to measure the link delay. It uses rate estimation and control mechanism to avoid the residence time error.

Peer-to-peer transparent clock may be used as a network element or it may be associated with application devices such as sensors or actuators if an ordinary clock is combined with the peer-to-peer transparent clock.

Figure 2-4: Model of a peer-to-peer transparent clock

Where, RC stands for rate estimation and control, RE1—rate estimation relative to master, and RE2—rate estimation relative to neighbor.



2.1.5 PTP Transparent Clock with Profiles Configuration

1. User can configure PTP on global switch level.

2. With the current Raptor configuration, a user can configure 4 profiles. User can create PTP domain explicitly (implicitly done by configuring profile).

3. User can enable/disable PTP protocol at port level.

4. User is able show the current PTP configuration and statistics.

5. User can go to PTP mode and can set mode to “E2E Transparent mode” or “P2P Transparent mode”.

6. User can set the number of ports that can support Transparent mode.

7. User can set minimum amount of time between sending peer delay request message in transparent Peer to Peer mode.

8. User can save PTP configuration.

9. User can debug the PTP module

PTP Master-Slave Hierarchy PTP forms the master-slave hierarchy with ordinary and boundary clocks in a such way so that all slave clocks are synchronized with their master clock. The clock at the top of the hierarchy is the grandmaster clock which will sync its time with external time source.

PTP uses different kinds of messages for its protocol operations. The following messages are used:

• Announce message • Sync message • Follow_Up message • Delay_Req message • Delay_Resp message • Pdelay_Req message • Pdelay_Resp message • Management message • Signaling message

In the above messages, Sync, Delay_Req, and Pdelay_Req messages are called event messages, and all other messages are called general messages. The announce message is used to form master-slave hierarchy; all event messages are used for slave clock synchronization. Management messages are used to manage PTP devices. All event messages will be time stamped.

To provide more orderly behavior when a clock comes online, an ordinary clock or boundary clock listens for an Announce message from a master for a configurable time interval. If no announce



message is received within this time, the clock assumes itself as the master until a better clock appears.

The Best Master Algorithm (BMC) is triggered periodically for each announce interval. The port state is selected by comparing the clock characteristic of other clocks received from the announce message and the clock characteristics of local clock.

If the port state is selected as master, it periodically sends Announce message and Sync messages on this port. If the type of the clock is two step clock, then it sends the Follow_Up message also. The master port sends the Delay_Resp message if it receives the Delay_Req message. It also sends the Delay_Resp_Follow_Up message if the clock is two step clock.

If a port is selected as a slave port, then it calculates the offset from master using the time stamped messages and adjusts its local clock time. The slave clocks calculate the propagation delay either using the Delay request-response mechanism or Peer delay request response mechanism.

If the slave clock uses Delay request-response mechanism, it sends the Delay_Req as soon as it receives the sync message. The master clock will send the Delay_Resp message in reply to the Delay_Req message. Using the time stamp in the Sync, Delay_Req and Delay_Resp messages, the slave clock calculates the mean path delay and calculates the offset from master.

If the slave clock uses Peer delay request-response mechanism, the slave clock should also have peer-to-peer transparent clock which will have link delay for all the ingress ports. The slave clock calculates the offset from the master using the time stamp in the sync message and the link delay from the peer-to-peer transparent clock.

PTP Synchronization and Syntonization The time error of the slave clock with the master clock is corrected using synchronization. The calculation of OffsetFromMaster will correct the time error at the slave clock. The OffsetFromMaster is calculated using the following formula at the slave clock.

Figure 2-5: Basic Synchronization Message Exchange

If the type of clock is not a two step clock,

<offsetFromMaster> = <syncEventIngressTimestamp> ─ <originTimestamp> ─ <meanPathDelay> ─ correctionField of Sync message



If the type of clock is a two step clock,

<offsetFromMaster> = <syncEventIngressTimestamp> ─ <preciseOriginTimestamp> ─ <meanPathDelay> ─ correctionField of Sync message ─ correctionField of Follow_UpMessage

Where, syncEventIngressTimestamp = t2 originTimestamp = t1 meanPathDelay = [(t2 – t1) + (t4 – t3)]/2 = [(t2 –t3) + (t4 – t1)]/2

The correction field depends on inbound latency, outbound latency, delay asymmetry in the communication path, and residence time at switches or routers in the communication path.

If the slave clock uses peer delay request-response mechanism, the mean path delay will be calculated using the following formulae:

Figure 2-6: Link Delay Measurement

If the type of clock is not a two step clock, <meanPathDelay> = [(t4 − t1) − correctionField of Pdelay_Resp]/2

If the type of clock is two step clock, <meanPathDelay> = [(t4 − t1) − (responseOriginTimestamp − requestReceiptTimestamp) − correctionField of Pdelay_Resp − correctionField of Pdelay_Resp_Follow_Up]/2

The rate error correction is called syntonization. This rate error is calculated using the following formulae and then the clock is adjusted for the rate error. <syncEventIngressTimestamp>N − <syncEventIngressTimestamp> 0

<correctedMasterEventTimestamp> N − <correctedMasterEventTimestamp>

Where N is the number of syncInterval separating the timestamps (N>0).

The frequency of clock A can then be adjusted by this factor, where <correctedMasterEventTime0stamp> is calculated as follows:



If the type of clock is not a two step clock,

<correctedMasterEventTimestamp> = <originTimestamp> + <meanPathDelay> + correctionField of Sync message

If the type of clock is a two step clock,

<correctedMasterEventTimestamp> = <preciseOriginTimestamp> + <meanPathDelay> + correctionField of Sync message + correctionField of Follow_Up message



Chapter

PTP Configurations

This chapter describes the various PTP configurations such as:

• Enabling / Disabling PTP in the switch • Configuring / Unconfiguring PTP domain • Configuring Mode for a Domain in PTP • Enabling/Disabling PTP on an Interface • Configuring / Unconfiguring PTP Profile • Other configuration and show CLI commands • Examples of PTP configurations

This chapter provides a sample of a configuration setup of iS5Com PTP through CLI and SNMP.

Figure 3-1: Multiple Contexts–Single Domain Topology

Raptor 1

PTP Client 1 PTP client 2

P1

P5

P4

P3

P2

Master clock



Configuring PTP by CLI and SNMP This section lists the CLI and SNMP configuration steps for configuring the PTP.

3.1.1 Enabling/Disabling PTP in the Switch

This section lists the CLI and SNMP configuration steps for enabling/disabling PTP.

3.1.1.1 CLI Configuration

To enable/disable PTP through CLI, execute the following steps:

1. Enable PTP in the switch.


S5comm (config)# no shutdown ptp This command enables PTP globally and power profile v2 (C37-238-2017) gets configured by default with domain 254, minimum Pdelay Req Interval as 0 i.e. 1 sec ,and delay mechanism as peer to peer. The configuration can be verified when command show ptp global info is used (see below).

2. View the PTP enabled status in the switch.

iS5comm# show ptp global info

PTP System Status

-----------------


Network Protocol : IEEE 802.3

Domain : 254

3. Disable PTP in the switch.


iS5comm(config)# shutdown ptp This command disabled PTP globally and removes all PTP related configuration both in software and hardware. The configuration can be verified when command show ptp global info is used (see below).

4. View the PTP disabled status in the switch.


% PTP is shutdown

3.1.1.2 SNMP Configuration

To enable/disable PTP through SNMP, execute the following steps:

1. Enable PTP in the switch.



set {{ fsPtpGlobalSysCtrl.0 start}}

2. View the status of PTP enabled in the switch.

get {{ fsPtpGlobalSysCtrl.0 }}

{1.3.6.1.4.1.41094.0.250.2.45.1.1.4.1.20 INTEGER start}

3. Disable PTP in the switch.

set {{ fsPtpGlobalSysCtrl.0 shutdown}}

4. View the status of PTP disabled in the switch.

get {{ fsPtpGlobalSysCtrl.0 }}

{1.3.6.1.4.1.41094.0.250.2.45.1.1.4.1.20 INTEGER shutdown}

3.1.2 Configuring / Unconfiguring PTP domain This section lists the CLI and SNMP configuration steps for configuring / unconfiguring PTP domain.


To configure / unconfigure PTP domain through CLI, execute the following steps:

1. Configure a default PTP domain.

iS5comm(config)# ptp domain [{ <id (0- 127)> | power-profile }]

iS5comm(config)# ptp domain 0

iS5comm(config-ptp)#

2. View the status of the default PTP domain.


PTP System Status

-----------------



Domain : 0

3. Unconfigure the default PTP domain.

iS5comm(config)# no ptp domain

iS5comm(config)#

This command deletes the current configured domain, if any, and removes the enabled port configuration. The command can be verified using show ptp global info and show ptp clock commands.

4. View the status of the default PTP domain.




PTP System Status

-----------------



Domain : None

3.1.2.2 SNMP Configuration FUNCTIONALITY SNMP LOCATION

Create / Delete PTP domain

fsPptDomainDataSet -> fsPptDomainDataSetTable -> fsPptDomainDataSetEntry -> fsPtpDomainRowStatus

3.1.3 Configuring Mode for a Domain in PTP

This section lists the CLI and SNMP configuration steps for setting the clock mode of a PTP domain.


To configure the clock mode for a domain in PTP through CLI, execute the following steps:

1. Create PTP domain

DOMAIN_NUMBER—128 available domains: from 0 to 127. Can be seen in show ptp global info




2. Delete PTP domain (DOMAIN_NUMBER—128 available domains: from 0 to 127)


iS5comm(config)# no ptp domain 10

iS5comm(config-ptp)# Only one domain can be configured; any old domain needs to be removed before configuring a

new one.

3. Configures the PTP



iS5comm(config-ptp)# ptp ?

mode related configuration of the PTP Clock



ports-statistcs-cnt-reset Reset statistic counters for all port

transparent clock related configuration

4. Configure the mode for a domain in PTP as end-to-end transparent clock (can be seen in show ptp clock)



iS5comm(config-ptp)# ptp mode ?

e2etransparent PTP Clock is configured as end to end transparent Clock

p2ptransparent PTP Clock is configured as peer to peer transparent Clock

iS5comm(config-ptp)#ptp mode e2etransparent


This command configures the mode as transparent and delay mechanism as end-to-end or peer-to- peer or forward for the domain. The configuration can be verified using show ptp clock command.

5. Configure the mode for a domain in PTP as transparent.



iS5comm(config-ptp)#ptp mode p2ptransparent


6. Verify if the mode for a domain in PTP is end-to-end transparent clock.

iS5comm# show ptp clock domain 10 PTP Clock Information

-------------------------

Clock Identity : e8:e8:75:ff:fe:90:25:82

Clock Context : 0

Clock Domain : 10

Primary Domain : 10

Clock Mode : Transparent

Type Of Clock : One Step

Delay Mechanism : End to End

Number of PTP ports : 17

Number of max PTP TS ports : 24

7. Set the mode for a domain in PTP back to default (forward)





iS5comm(config-ptp)# no ptp mode ? e2etransparent PTP Clock is configured as end to end

transparent Clock

p2ptransparent PTP Clock is configured as peer to peer

transparent ClockiS5comm(config-ptp)#

8. Set PTP mode as peer-to-peer transparent (can be seen in show ptp clock)


iS5comm(config)# ptp domain DOMAIN_NUMBER

iS5comm(config-ptp)# ptp mode p2ptransparent

9. Set PTP mode back to default (forward)


iS5comm(config)# ptp domain DOMAIN_NUMBER

iS5comm(config-ptp)# no ptp mode p2ptransparent

10. Set PTP number of maximum ports that support transparent clock mode

PORTS_NUMBER—the default is 24; there are 24 available ports, an additional port cannot be opened if this number equal or less than already enabled transparent ports. This can be seen when show ptp clock command is used.



iS5comm(config-ptp)# ptp transparent max-ports 24


11. Reset Statistic Counters for all ports.

iS5comm# configure terminal iS5comm(config)# ptp domain 10

iS5comm(config-ptp)# ptp ? mode related configuration of the PTP

Clock

ports-statistcs-cnt-reset Reset statistic counters for all port

transparent clock related configuration

iS5comm(config-ptp)# ptp ports-statistcs-cnt-reset ? iS5comm(config-ptp)#



12. Show PTP clock information per domain

iS5comm# show ptp clock

PTP Clock Information

-------------------------

Clock Identity : e8:e8:75:ff:fe:90:25:82

Clock Context : 0

Clock Domain : 10

Primary Domain : 10



Delay Mechanism : Peer to Peer




Set PTP mode to E2E / P2P

fsPptDomainDataSet -> fsPptDomainDataSetTable -> fsPptDomainDataSetEntry -> fsPtpDomainClockMode

Set PTP number of maximum ports

fsPptTransparentDataSet -> fsPptTransparentDataSetTable -> fsPptTransparentDataSetEntry -> fsPtpTransparentClockNumberPorts

3.1.4 Enabling/Disabling PTP on Interface

This section lists the CLI and SNMP configuration steps for enabling / disabling PTP on an interface.


To enable/disable PTP on an interface through CLI, execute the following steps:

1. Enable PTP on interface.

iS5comm(config)# interface gigabitethernet 0/1

iS5comm(config-if)# ptp enable

This command enables PTP on port if a domain is configured. Use the command show ptp port to verify that the status is enabled..

2. View PTP port status.

iS5comm# show ptp port PTP Transparent Port Properties

-------------------------------



Record # 1

Interface : Gi0/1

Faulty Flag : 0

LogMinPdelayReqInterval: 0 (1 sec)

Status : ENABLED

Clock Identity : e8:e8:75:ff:fe:90:0b:02

Peer Mean Path Delay : 0 nsec

Clock type : E2E TRANSPARENT

PhysicalAddress : not specified

SW revision : V2

Disable PTP on an interface.



iS5comm(config-if)# no ptp enable domain 0

iS5comm(config-if)# exit

iS5comm(config)#

3. Set minimum peer delay request interval on interface

INTERVAL—the default is 0; range is from 0 to 5; time interval calculated as 2 power INTERVAL; if INTERVAL is 0, time interval is 1 sec = 2 power 0; this can be seen in show ptp port.



iS5comm(config-if)# ptp min-pdelay-req-interval ?

exponent-Of-2-seconds Exponent of 2, Delay interval calculated from equation: 2 exponent(exponent-Of-2)seconds

iS5comm(config-if)# ptp min-pdelay-req-interval 2

iS5comm(config-if)

4. Set minimum peer delay request interval on interface to default value of 1 sec.

iS5comm# configure terminal iS5comm(config)# interface gigabitethernet 0/1 iS5comm(config-if)# no min-pdelay-req-interval




To enable/disable PTP in a port through SNMP, execute the following steps:

1. Enable PTP on a port in the PTP domain in PTP.

set {{fsPtpTransparentPortPtpStatus.1.0.1 TRUE }}

2. View the status of a port in a PTP domain in PTP.

get {{fsPtpTransparentPortPtpStatus.1.0.1 }}

{1.3.6.1.4.1.41094.0.250.2.45.1.1.4.1.2 INTEGER true}

3. PTP on a port in a PTP domain in PTP.

set {{fsPtpTransparentPortPtpStatus.1.0.1 FALSE }}

4. View the status of a port in a PTP domain in PTP.

get {{fsPtpTransparentPortPtpStatus.1.0.1 }}

{1.3.6.1.4.1.41094.0.250.2.45.1.1.4.1.2 INTEGER false}

FUNCTIONALITY SNMP LOCATION

Enable / Disable PTP on interface

fsPptTransparentPortDataSet -> fsPptTransparentPortDataSetTable -> fsPptTransparentPortDataSetEntry -> fsPtpTransparentPortPtpStatus

Set minimum peer delay request interval on interface

fsPptTransparentPortDataSet -> fsPptTransparentPortDataSetTable -> fsPptTransparentPortDataSetEntry -> fsPtpTransparentPortMinPdelayReqInterval

3.1.5 Configuring / Unconfiguring PTP profile


1. Configure PTP Profile

iS5comm# configure terminal iS5comm(config)# ptp profile ? DefaultE2E Default End-to-End profile as per IEEE

1588-Annex J

DefaultP2P Default Peer-to-Peer profile as per IEEE 1588-Annex J

PowerProfileV2 C37-238-2017 profile

Reset Resets the current configured profile to default values

UtiltyProfile 61850-9-3:2016 profile

iS5comm(config)# ptp profile UtiltyProfile



This command creates the domain, sets a domain number, minimum pDelay req interval, and delay mechanism corresponding to the selected PTP profile. More information about the 4 supported profiles is as follows:

Profile Name Profile ID Min pdelay Request Interval Domain Number Default E2E 00:1b:19:00:01:00 n/a 0 Default P2P 00:1b:19:00:02:00 0 0 Utility Profile i.e. 61850-9-3:2016 00:0c:cd:00:01:00 0 0 Power Profile v2 i.e. C37-238-2017 1c:12:9d:00:00:00 0 254

2. Unconfigure PTP Profile

iS5comm# configure terminal iS5comm(config)# no ptp profile This command deletes the domain, only if profile is configured.

3.1.5.2 SNMP Configuration The iS5 Communications proprietary MIB (IEC62439-8-MIB.mib) is implemented for PTP Power profile. This is reference from IEC-62439-3-MIB.

1. Configure PTP Profile


Set Profile fsPtpPowerProfileObjects -> ptpTc -> fsptpTcDefaultDs -> ptpTcDefaultDsProfileId

2. Configure profile attributes at port level


Set Minimum peer delay request interval

fsPtpPowerProfileObjects -> ptpTc -> ptpTcPortDsTable -> ptpTcPortDsEntry -> ptpTcPortDsLogMinPdelayReqInterv

Enable PTP on port

fsPtpPowerProfileObjects -> ptpTc -> ptpTcPortDsTable -> ptpTcPortDsEntry -> ptpTcPortDsPortEnabled

3. Show ptp profile:


Show set of supported profiles

fsPtpPowerProfileObjects -> ptpTc -> fsptpTcDefaultDs -> ptpTcDefaultDsProfileSet




Show current configured profile

fsPtpPowerProfileObjects -> ptpTc -> fsptpTcDefaultDs -> ptpTcDefaultDsProfileId

3.1.6 Other Configuration Commands


This section lists some additional CLI commands.

1. Set MSR as a type of file that includes saved PTP configuration. The msr configuration restore will be in the format of MIB OID. A model-specific register (MSR) is any of various control registers in the x86 instruction set used for debugging, program execution tracing, computer performance monitoring, and toggling certain CPU features.

iS5comm(config)# default restore-type msr

2. Set CSR as the type of file that includes saved PTP configuration. The csr configuration restore will be in the format of CLI commands. A Certificate Signing Request (CSR) file is a file created as a signing request for a digital certificate. It contains an encrypted block of text that identifies the applicant of the certificate and includes encrypted data for country, state, organization, domain, email address, and public key.

iS5comm(config)# default restore-type csr

3. Save PTP configuration. Startup Configuration. If this option is chosen, then the switch will start with the saved configuration on reboot.

iS5comm# write startup-config

4. Debug PTP

iS5comm# debug ptp ?

<CR> Enables debugging for PTP module

all trace messages

critical trace messages This command enables the debug traces for the PTP module.


Set Debug mode fsPptGeneralGroup -> fsPtpGblTraceOption



3.1.7 show Commands


This section lists some additional show CLI commands.

iS5comm# show ptp ? clock PTP clock related Information

counters PTP Port counter related Information

global PTP related global Information

null-management Management type

port PTP port properties Information

profile PTP profile related Information

transparent For transparent clock

1. Show PTP counters per port or all of them. Other options are as shown below.

iS5comm# show ptp counters ?

PTP Interface Counters

----------------------

Interface gigabitethernet 0/1:

Number of modified Egress packet with updated correction field: 0

Number of dropped Egress packets: 0

Number of saved time stamp Ingress packet: 0

Number of dropped Ingress packets: 0

Number of received Sync packets: 0

Number of received Peer delay request packets: 0

Number of transmitted Peer delay request packets: 0

Number of received Peer delay response packets: 0

Number of transmitted Peer delay response packets: 0

Number of received Peer delay response Follow Up packets: 0

Number of transmitted Peer delay response Follow Up packets: 0

iS5comm# show ptp counters

PTP Interface Counters

----------------------




Number of modified Egress packet with updated correction field: 10844 827





Number of transmitted Sync packets: 0



















Number of transmitted Peer delay response Follow Up packets: 0, etc.

iS5comm# show ptp counters Gigabitethernet ?

<0>/<1-28> Slot Number/Port Number

iS5comm# show ptp counters Gigabitethernet 0/1


Number of modified Egress packet with updated correction field: 10844 827



























2. Show PTP Stack readiness

iS5comm# show ptp null-management

Getting PTP Null Management DONE

Setting PTP Null Management DONE

Applying PTP Null Management DONE

3. Show PTP maximum transparent ports per domain:

iS5comm# show ptp transparent max-ports PTP TS max port number: 24

4. Show PTP clock related information

iS5comm# show ptp clock PTP Clock Information

-------------------------


Clock Context : 0

Clock Domain : 10

Primary Domain : 10








5. Show PTP related global Information


PTP System Status

-----------------



Domain : 10

6. PTP port properties Information

iS5comm# show ptp port ?

<CR> Displays PTP port properties of the

enabled ports.

Extreme-Ethernet Extreme ethernet interface

Gigabitethernet Gigabit ethernet interface

iS5comm# show ptp port gigabitethernet ?

<0>/<1-28> Slot Number/Port Number

iS5comm# show ptp port gi 0/1

PTP Transparent Port Properties

-------------------------------

Record # 1

Interface : Gi0/1

Faulty Flag : 0


Status : ENABLED




Physical Address : not specified

SW revision : V2

7. Display the configured profile default values

iS5comm# show ptp profile

PTP Profile

-----------

Profile Name : Utility Profile (IEC61850-9-3-2016)

Profile ID : 00:0c:cd:00:01:00



Default Domain Number : 0

Default Min pDelay Request Interval : 0

Default Delay Mechanism : Peer-to-Peer


1. Show PTP global status


Read Global Status fsPptGeneralGroup -> fsPtpGlobalSysCtrl

Read Domain fsPptGeneralGroup -> fsPtpTable -> fsPtpEntry -> fsPtpPrimaryDomain

2. Show PTP port status

FUNCTIONALITY SNMP LOCATION Device type fsPptPortConfigurationDataSet ->

fsPptPortConfigurationDataSetTable -> fsPptPortConfigurationDataSetEntry -> fsPtpPortInterfaceType

Interface Number fsPptPortConfigurationDataSet -> fsPptPortConfigurationDataSetTable -> fsPptPortConfigurationDataSetEntry -> fsPtpPortIfaceNumber

Faulty Flag fsPptTransparentPortDataSet -> fsPptTransparentPortDataSetTable -> fsPptTransparentPortDataSetEntry -> fsPtpTransparentPortFaultyFlag

LogMinPdelayReqInterval fsPptPortConfigurationDataSet -> fsPptPortConfigurationDataSetTable -> fsPptPortConfigurationDataSetEntry -> fsPtpPortMinPdelayReqInterval

Enabled / Disabled Status

fsPptPortConfigurationDataSet -> fsPptPortConfigurationDataSetTable -> fsPptPortConfigurationDataSetEntry -> fsPtpPortPtpStatus

Clock Identity fsPptPortConfigurationDataSet -> fsPptPortConfigurationDataSetTable -> fsPptPortConfigurationDataSetEntry -> fsPtpPortClockIdentity

Peer Mean Path Delay fsPptPortConfigurationDataSet -> fsPptPortConfigurationDataSetTable -> fsPptPortConfigurationDataSetEntry -> fsPtpPortPeerMeanPathDelay

Clock type fsPptPortConfigurationDataSet -> fsPptPortConfigurationDataSetTable -> fsPptPortConfigurationDataSetEntry -> fsPtpPortDelayMechanism

SW revision fsPptPortConfigurationDataSet -> fsPptPortConfigurationDataSetTable -> fsPptPortConfigurationDataSetEntry -> fsPtpPortVersionNumber



3. Show PTP clock information per domain:


Clock Identity fsPptTransparentDataSet -> fsPptTransparentDataSetTable -> fsPptTransparentDataSetEntry -> fsPtpTransparentClockIdentity

Clock Context fsPptGeneralGroup -> fsPtpPrimaryContext

Clock Domain fsPptDomainDataSet -> fsPptDomainDataSetTable -> fsPptDomainDataSetEntry -> fsPtpDomainRowStatus

Primary Domain fsPptTransparentDataSet -> fsPptTransparentDataSetTable -> fsPptTransparentDataSetEntry -> fsPtpTransparentClockPrimaryDomain

Clock Mode fsPptDomainDataSet -> fsPptDomainDataSetTable -> fsPptDomainDataSetEntry -> fsPtpDomainClockMode

Type Of Clock fsPptTransparentDataSet -> fsPptTransparentDataSetTable -> fsPptTransparentDataSetEntry -> fsPtpTransparentClockTwoStepFlag

Delay Mechanism fsPptTransparentDataSet -> fsPptTransparentDataSetTable -> fsPptTransparentDataSetEntry -> fsPtpTransparentClockDelaymechanism

Number of PTP ports fsPptPortConfigurationDataSet -> fsPptPortConfigurationDataSetTable -> fsPptPortConfigurationDataSetEntry -> fsPtpPortPtpStatus

Number of max PTP TS ports

fsPptTransparentDataSet -> fsPptTransparentDataSetTable -> fsPptTransparentDataSetEntry -> fsPtpTransparentClockNumberPorts

4. Show PTP counters per port or all.


PTP counters per port or all

fsPptPortConfigurationDataSet ->

fs PptPortConfigurationDataSetTable ->

fsPptPortConfigurationDataSetEntry -> CHOOSE_BY_NAME



3.1.8 Examples of PTP Configurations This section lists some examples of PTP configurations by CLI commands as follows:

1. Example 1: Use Raptor as transparent clock within PTP network with power profile v2 as a profile. Enable PTP globally and on the ports.

S5comm# configure terminal

iS5comm(config)# no shutdown ptp







iS5comm(config)# ptp profile powerProfileV2

iS5comm(config)# exit

iS5comm#show ptp clock PTP Clock Information

-------------------------


Clock Context : 0

Clock Domain : 10

Primary Domain : 10






iS5comm#show ptp port PTP Transparent Port Properties

-------------------------------

Record # 1

Interface : Gi0/1

Faulty Flag : 0




Status : ENABLED





SW revision : V2

Record # 2

Interface : Gi0/2

Faulty Flag : 0


Status : ENABLED





SW revision : V2

iS5comm#show ptp profile PTP Profile

-----------

Profile Name : PowerProfileV2 (C37.238-2017)

Profile ID : 1c:12:9d:00:00:00




2. Example 2: Switch PTP profile. Enable PTP globally and on ports. Switch to another type profile.

iS5comm# configure terminal iS5comm(config)# no shutdown ptp iS5comm(config)# interface gigabitethernet 0/1 iS5comm(config-if)# ptp enable iS5comm(config-if)# exit iS5comm(config)# interface gigabitethernet 0/2 iS5comm(config-if)# ptp enable iS5comm(config-if)# exit iS5comm(config)# ptp profile UtilityProfile iS5comm(config)# exit iS5comm#show ptp clock




-------------------------


Clock Context : 0

Clock Domain : 0

Primary Domain : 0






iS5comm#show ptp port PTP Transparent Port Properties

-------------------------------

Record # 1

Interface : Gi0/1

Faulty Flag : 1


Status : ENABLED



Clock type : P2P TRANSPARENT


SW revision : V2

Record # 2

Interface : Gi0/2

Faulty Flag : 1


Status : ENABLED





SW revision : V2

iS5comm#show ptp profile

PTP Profile

-----------

Profile Name : Utility Profile (IEC61850-9-3-2016)



Profile ID : 00:0c:cd:00:01:00




iS5comm#configure terminal iS5comm(config)# ptp profile DefaultE2E iS5comm(config)# exit iS5comm#show ptp clock


-------------------------


Clock Context : 0

Clock Domain : 0

Primary Domain : 0






iS5comm#show ptp port


-------------------------------

Record # 1

Interface : Gi0/1

Faulty Flag : 1


Status : ENABLED





SW revision : V2

Record # 2

Interface : Gi0/2

Faulty Flag : 1


Status : ENABLED







SW revision : V2


PTP Profile

-----------

Profile Name : Default E2E Profile

Profile ID : 00:1b:19:00:01:00



Default Delay Mechanism : End-to-End

iS5comm#configure terminal iS5comm(config)# ptp profile DefaultP2P iS5comm(config)# exit iS5comm#show ptp clock


-------------------------


Clock Context : 0

Clock Domain : 0

Primary Domain : 0






iS5comm#show ptp port


-------------------------------

Record # 1

Interface : Gi0/1

Faulty Flag : 1


Status : ENABLED







SW revision : V2

Record # 2

Interface : Gi0/2

Faulty Flag : 1


Status : ENABLED





SW revision : V2


PTP Profile

-----------

Profile Name : Default P2P Profile

Profile ID : 00:1b:19:00:02:00




3. Example 3: Configure PTP without any profile. enable PTP, unconfigure profile, create a new domain, configure transparent mode and E2E delay mechanism.


iS5comm(config)# no shutdown ptp

iS5comm(config)# no ptp profile


iS5comm(config-ptp)# ptp mode e2etransparent % PTP domain clock delay mechanism incompatible with profile

Note that the profile should be compatible with the PTP domain clock delay. In this case, we will change to defaulte2E as shown below.

iS5comm(config-ptp)# exit

iS5comm(config)# ptp profile defaulte2E


iS5comm(config-ptp)# ptp mode e2etransparent

iS5comm(config-ptp)# exit






iS5comm(config)# exit

iS5comm#show ptp clock


-------------------------


Clock Context : 0

Clock Domain : 100

Primary Domain : 100






4. Example 4: Configure PTP without any profile: enable PTP, unconfigure profile, create a new domain configure transparent mode, P2P delay mechanism

iS5comm# configure terminal iS5comm(config)# no shutdown ptp iS5comm(config)# no ptp profile iS5comm(config)# ptp domain 100 iS5comm(config-ptp)# ptp mode p2ptransparent iS5comm(config-ptp)# exit iS5comm(config)# int gi 0/1 iS5comm(config-if)# ptp enable iS5comm(config-if)# exit iS5comm(config)# exit iS5comm# show ptp clock


-------------------------


Clock Context : 0

Clock Domain : 100









5. Example 5: Customize the profile default values by changing domain and minimum pDelay interval. Enable PTP, create a new domain (the default will be overwritten), enable ptp on port, and change the min pdelay interval to non-default value.

iS5comm# configure terminal iS5comm(config)# no shutdown ptp iS5comm(config)# ptp domain 100 iS5comm(config-ptp)# exit iS5comm(config)# int gi 0/1 iS5comm(config-if)# ptp enable iS5comm(config-if)# ptp min-pdelay-req-interval 5 iS5comm(config-if)# exit iS5comm(config)# exit iS5comm# show ptp clock


-------------------------


Clock Context : 0

Clock Domain : 100







iS5comm# show ptp port


-------------------------------

Record # 1

Interface : Gi0/1

Faulty Flag : 1


Status : ENABLED





SW revision : V2



6. Example 6: Debug PTP module, enable PTP, configure domain, transparent mode, E2E delay mechanism, set transparent max ports, open ports 1 and 2, configure minimum peer delay request interval for both ports.

iS5comm# debug ptp all iS5comm# configure terminal iS5comm(config)# no shutdown ptp iS5comm(config)# ptp domain 0 % PTP Domain already configured, remove first

There was a previously configured domain 100 that has to be removed.

iS5comm(config)# no ptp domain iS5comm(config)# ptp domain 0 iS5comm(config-ptp)# ptp mode e2etransparent iS5comm(config-ptp)# ptp transparent max-ports 3 iS5comm(config-ptp)# exit iS5comm(config)# in gi 0/1 iS5comm(config-if)# ptp enable iS5comm(config-if)# ptp min-pdelay-req-interval 1 iS5comm(config-if)# exit iS5comm(config)# int gi 0/2 iS5comm(config-if)# ptp min-pdelay-req-interval 2 iS5comm(config-if)# ptp enable iS5comm(config-if)# exit iS5comm(config)# exit iS5comm# show ptp clock


-------------------------


Clock Context : 0

Clock Domain : 0

Primary Domain : 0






iS5comm# show ptp port


-------------------------------



Record # 1

Interface : Gi0/1

Faulty Flag : 1


Status : ENABLED





SW revision : V2

Record # 2

Interface : Gi0/2

Faulty Flag : 1


Status : ENABLED





SW revision : V2

7. Switch to P2P delay mechanism and back to E2E. Assuming that debugging is switched ON and ports are already enabled.

iS5comm# configure terminal iS5comm(config)# no shutdown ptp iS5comm(config)# no ptp profile iS5comm(config)# ptp domain 0 iiS5comm(config-ptp)# ptp mode p2ptransparent iS5comm(config-ptp)# ptp mode e2etransparent iS5comm(config-ptp)# exit iS5comm(config)# exit iS5comm# show ptp clock


-------------------------


Clock Context : 0

Clock Domain : 0

Primary Domain : 0








8. Shut down PTP: Enable PTP globally, then enable PTP on ports and shutdown PTP

iS5comm# configure terminal iS5comm(config)# no shutdown ptp iS5comm(config)# ptp domain 100 % PTP Domain already configured, remove first

iS5comm(config)# no ptp domain iS5comm(config)# ptp domain 100 iS5comm(config-ptp)# exit iS5comm(config)# in gi 0/1 iS5comm(config-if)# ptp enable

% PTP mode is NOT set iS5comm(config-if)# exit iS5comm(config)# ptp domain 100 iS5comm(config-ptp)# ptp mode e2etransparent iS5comm(config-ptp)# exit iS5comm(config)# in gi 0/1 iS5comm(config-if)# ptp enable iS5comm(config-if)# ptp min-pdelay-req-interval 5 iS5comm(config-if)# exit iS5comm(config)# exit iS5comm# show ptp global info

PTP System Status

-----------------



Domain : 100

iS5comm# show ptp clock


-------------------------


Clock Context : 0

Clock Domain : 100









iS5comm# show ptp port PTP Transparent Port Properties

-------------------------------

Record # 1

Interface : Gi0/1

Faulty Flag : 1


Status : ENABLED





SW revision : V2

iS5comm# configure terminal iS5comm(config)# shutdown ptp iS5comm(config)# exit iS5comm# show ptp global info

% PTP is shutdown iS5comm# show ptp clock

% PTP is shutdown iS5comm# show ptp port

% PTP is shutdown To see status of each parameter, find the applicable show command in the explanations above.



PTP Configuration by WebUI To access Raptor WebUI (User Interface), launch a web browser and enter the Raptor’s IP address in the address bar of the web screen.

The IP address of the Raptor’s interface is 192.168.10.1. Enter http://192.168.10.1 in the address bar of the web browser. iS5com's Raptor product is compatible with Internet Explorer 8.0 or Mozilla Firefox 3.5 and above.

To access PTP screens, click Clock > PTP. The PTP link on the left pane allows configuring the PTP parameters through the following links: • Basic Settings • Clock Settings • Port Settings

By default, the tab Basic Settings displays the PTP Global Configurations screen.

3.2.1 PTP Global Configurations

Figure 3-2: PTP Global Configurations

Screen Objective This screen allows configuring the basic settings of PTP such as starting the PTP module and creating the primary context

Navigation Clock > PTP

Fields • Global Status—specifies the system control status of the PTP module. The default option is Disabled. The list contains: o Disabled—shuts PTP in a device. This will remove all PTP related

configurations from the system. o Enabled—starts PTP in a device. This will allow the user to configure

the PTP parameters. PTP module should be started for configuring the PTP parameters.

• Network Protocol – specifies protocols that support PTP

Buttons • Apply—modifies attributes and saves the changes.

http://192.168.10.1/



3.2.2 Clock Configurations Screen

Figure 3-3: Clock Configurations Page

Screen Objective

This screen allows the user to configure the clock data set table information.

The clock data set table contains information of the clock on a particular domain. The entries in this table are created with the default values.

Navigation Clock > PTP > Clock Settings

Fields • PTP Profile—from the drop-down list select a PTP Profile. The IEEE 1588 definition of a PTP profile is the set of allowed PTP features applicable to a device. A PTP profile is usually specific to a particular type of application or environment and defines the values such as a set of predefined PTP configuration parameters, like clock mode, delay mechanism and domain number.

The options are: o Power profile V2—this profile defines specific or allowed values for PTP networks

used in power substations. The defined values include the optimum physical layer, the higher level protocol for PTP messages, and the preferred best master clock algorithm. The Power Profile values ensure consistent and reliable network time distribution within substations, between substations, and across wide geographic areas [3]. It is compliant with IEEE C37.238-2017 - IEEE Standard Profile for Use of IEEE 1588 Precision Time Protocol in Power System Applications [4]

o No Profile o Default Profile E2E & Default Profile P2P - The default PTP profile mode on the

switch is Default Profile mode. In this mode: The PTP mode of transport is Layer 3. The supported transparent clock mode is E2E or P2P respectively.

o Utility Profile— this profile defines specific or allowed values for PTP networks used in power utility automation. It is compliant with IEEE 61850-9-3-2016 - IEC/IEEE International Standard - Communication networks and systems for power utility automation – Part 9-3: Precision time protocol profile for power utility automation [5]



Profiles Default Configuration

Profile No Profile

Power Utility E2E P2P

Clock Mode

Forward Transparent Transparent Transparent Transparent

Delay Mech

N/A P2P P2P E2E P2P

Domain 0 254 0 0 0

Profiles Available Configuration

Profile No Profile Power Utility E2E P2P

Clock Mode

Forward / Transparent

Transparent Transparent Transparent Transparent

Delay Mech

N/A / E2E / P2P

P2P P2P E2E P2P

Domain 0 - 127 0 – 127, 254

0 - 127 0 - 127 0 - 127

• Profile ID—this is the MAC address of the profile. Its written in MM:MM:MM:SS:SS:SS format and is a read-only field.

A summary of the profiles and their parameters is shown below.

Profile Name Profile ID Min pdelay Request Interval

Domain Number

Default E2E 00:1b:19:00:01:00 n/a 0 Default P2P 00:1b:19:00:02:00 0 0 Utility Profile i.e. 61850-9-3:2016 [5] 00:0c:cd:00:01:00 0 0 Power Profile v2 i.e. C37-238-2017 [4] 1c:12:9d:00:00:00 0 254

• Clock Mode—specifies the operating mode of the clock in the domain. The default option is Transparent. The list contains: o Transparent—the clock is in transparent mode. A switch in this mode allows

support of PTP communication messages with neighbors. o Forward—a switch configured for forward mode passes incoming PTP packets

as normal multicast traffic. All incoming PTP messages are forwarded.

• Delay Mech.— specifies the operating mode of Transparent clock mode. - E2E —the clock is in end-to-end transparent mode. Measures the time taken for

a PTP event message to transit the device. This information will be updated in the correction field of the PTP messages.

- P2P —the clock is in peer-to-peer transparent mode. Measures the time taken for a PTP event message to transit the device. This information will be updated in the correction field of the PTP messages.



PTP port delay mechanism is linked to the PTP Profile. For the Default P2P, the Delay Mech. is P2P, and for Default E2E, the Delay Mech. is E2E, respectively. For Utility and PowerV2Profile, the Delay Mech. is P2P.

• Domain Number—specifies the unique identifier of the domain. This domain ID defines the scope of the PTP message communication, state, operations, data sets and timescale. This value ranges from 0 to 255 (configurable range is between 0 and 127 and 254). Domain identifiers 128 to 255 are reserved.

• Max Clock Ports—indicates the number of PTP ports on the device. This value ranges from 0 to 24. The default value is 1. For an ordinary clock, this value should be 1. This value can be configured, if the PTP domain row status is not in service.

• Clock Identity—specifies the unique identity of the local clock or management node associated with the domain. This is an octet string with size of 8 Bytes.

Buttons • Add / Apply—adds and saves new configuration

• Delete—deletes the selected entry.



3.2.3 Port Settings- PTP Interfaces

Figure 3-4: PTP Interfaces

Screen Objective This screen allows the user to view the PTP configuration information for a particular port of a transparent clock.

PTP transparent port data set table contains PTP configuration information for a particular port of transparent clock.



Navigation Clock > PTP > Port Settings

Fields • Select—select the port to be configured.

• Port—- specifies the port and the type of the interface that the PTP runs over.

PTP interfaces running in a node or system, interfaces with the network through entities called PTP ports. PTP ports are different from the set of interfaces defined in the interface MIB.

• Status specifies the PTP status in the port. The list contains: o Enabled—PTP is enabled in the port. o Disabled—PTP is disabled in the port.

• PDelay Interval—specifies the delay interval between sending peer delay request messages.

• Propagation Delay—an estimate of the current one-way propagation delay in scaled nanoseconds on the link attached to the port, calculated using the peer delay mechanism. If the PTP port delay mechanism is end-to-end, this value will be 0.

Buttons • Apply—applies the configuration to the switch

Documents

RAPTOR™ - iS5 Communications