draft-ietf-tictoc-ptp-mib-11.txt   draft-ietf-tictoc-ptp-mib-12.txt 
TICTOC Working Group Vinay Shankarkumar TICTOC Working Group Vinay Shankarkumar
INTERNET DRAFT Laurent Montini INTERNET DRAFT Laurent Montini
Intended status: Standards Track Cisco Systems Intended status: Standards Track Cisco Systems
Tim Frost Tim Frost
Calnex Solutions Ltd. Calnex Solutions Ltd.
Greg Dowd Greg Dowd
Microsemi Microsemi
Expires: February 24, 2017 August 24, 2016 Expires: September 17, 2017 March 17, 2017
Precision Time Protocol Version 2 (PTPv2) Precision Time Protocol Version 2 (PTPv2)
Management Information Base Management Information Base
draft-ietf-tictoc-ptp-mib-11.txt draft-ietf-tictoc-ptp-mib-12.txt
Status of this Memo Status of this Memo
This Internet-Draft is submitted to IETF in full conformance with the This Internet-Draft is submitted to IETF in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet- other groups may also distribute working documents as Internet-
Drafts. Drafts.
skipping to change at page 1, line 39 skipping to change at page 1, line 39
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed at The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html http://www.ietf.org/shadow.html
This Internet-Draft will expire on February 24, 2017. This Internet-Draft will expire on March 17, 2017.
Copyright Notice Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
skipping to change at page 2, line 30 skipping to change at page 2, line 30
to the SMIv2, and semantically identical to the peer SMIv1 to the SMIv2, and semantically identical to the peer SMIv1
definitions. definitions.
Table of Contents Table of Contents
1. Introduction ................................................. 2 1. Introduction ................................................. 2
1.1. Relationship to other Profiles and MIBs ................. 3 1.1. Relationship to other Profiles and MIBs ................. 3
1.2. Change Log .............................................. 3 1.2. Change Log .............................................. 3
2. The SNMP Management Framework ................................ 5 2. The SNMP Management Framework ................................ 5
3. Overview ..................................................... 6 3. Overview ..................................................... 6
4. IETF PTP MIB Definition ...................................... 10 4. IETF PTP MIB Definition ...................................... 6
5. Security Considerations ..................................... 66 5. Security Considerations ..................................... 58
6. IANA Considerations ......................................... 69 6. IANA Considerations ......................................... 61
7. References .................................................. 70 7. References .................................................. 61
7.1. Normative References ................................... 70 7.1. Normative References ................................... 61
7.2. Informative References ................................. 70 7.2. Informative References ................................. 61
8. Acknowledgements ............................................ 72 8. Acknowledgements ............................................ 63
9. Author's Addresses .......................................... 72 9. Author's Addresses .......................................... 63
1. Introduction 1. Introduction
This memo defines a portion of the Management Information Base (MIB) This memo defines a portion of the Management Information Base (MIB)
module for use with network management protocols in the Internet module for use with network management protocols in the Internet
Community. In particular, it describes managed objects used for Community. In particular, it describes managed objects used for
managing PTP devices including the ordinary clock, transparent clock, managing PTP devices including the ordinary clock, transparent clock,
boundary clocks. boundary clocks.
This MIB module is restricted to reading standard PTP data elements, This MIB module is restricted to reading standard PTP data elements,
skipping to change at page 5, line 21 skipping to change at page 5, line 21
-11 Aug 16 Used corrected version of MIB text -11 Aug 16 Used corrected version of MIB text
- Reduced the DESCIPTION section and moved to section 3 - Reduced the DESCIPTION section and moved to section 3
- Added clarification that PtpClockIdentity can also be - Added clarification that PtpClockIdentity can also be
non-EUI-64 address non-EUI-64 address
- Clarifications on PtpClockPortTransportTypeAddress, - Clarifications on PtpClockPortTransportTypeAddress,
and mentioned counters being discontinuous and mentioned counters being discontinuous
- Made PtpClockQualityClassType as enumeration - Made PtpClockQualityClassType as enumeration
Updated overview section with a longer description. Updated overview section with a longer description.
-12 Mar 17 Replaced direct quotations of [IEEE 1588-2008] with
references to avoid copyright issues.
2. The SNMP Management Framework 2. The SNMP Management Framework
The SNMP Management Framework presently consists of five major The SNMP Management Framework presently consists of five major
components: components:
o An overall architecture, described in STD62, [RFC 3411]. o An overall architecture, described in STD62, [RFC 3411].
o Mechanisms for describing and naming objects and events for the o Mechanisms for describing and naming objects and events for the
purpose of management. The first version of this Structure of purpose of management. The first version of this Structure of
Management Information (SMI) is called SMIv1 and described in Management Information (SMI) is called SMIv1 and described in
skipping to change at page 6, line 22 skipping to change at page 6, line 24
semantically equivalent, except where objects or events are omitted semantically equivalent, except where objects or events are omitted
because no translation is possible (e.g., use of Counter64). Some because no translation is possible (e.g., use of Counter64). Some
machine readable information in SMIv2 will be converted into textual machine readable information in SMIv2 will be converted into textual
descriptions in SMIv1 during the translation process. However, this descriptions in SMIv1 during the translation process. However, this
loss of machine readable information is not considered to change the loss of machine readable information is not considered to change the
semantics of the MIB module. semantics of the MIB module.
3. Overview 3. Overview
The objects defined in this MIB module are to be used when describing The objects defined in this MIB module are to be used when describing
the Precision Time Protocol (PTP), as defined in[IEEE 1588-2008]. the Precision Time Protocol (PTP), as defined in [IEEE 1588-2008].
The following diagrams show the typical synchronization hierarchy
found in PTP networks.
Simple master-slave hierarchy, section 6.6.2.4 [IEEE 1588-2008]:
+---------------+
| Ordinary |
| Clock -1 |
| (GrandMaster) |
+-------M-------+
|
1
|
+---------------S-----------------+
| Boundary |
| Clock -1 |
+-----M---------------------M-----+
| |
2 3
| |
+-----S-----+ +------------S-------------+
| Ordinary | | Boundary |
| Clock -2 | | Clock -2 |
+-----------+ +-----M--------------M-----+
| |
4 5
| |
+-----S-----+ +-----S-----+
| Ordinary | | Ordinary |
| Clock -3 | | Clock -4 |
+-----------+ +-----------+
Grandmaster
Boundary Clock(0-N)
Ordinary Clocks(0-N)
Relationship cardinality:
PTP system 1 : N PTP Clocks
PTP Clock 1 : 1 Domain
PTP Clock 1 : N PTP Ports
PTP Ports N : M Physical Ports (interface in IF-MIB)
Transparent clock diagram, section 6.7.1.3 of [IEEE 1588-2008]:
+-----------------------------+
| Boundary clock - 1 |
+-----------------------------+
| |
| |
+-- A --+ B
| |
+----------------------+ |
| Ordinary clock | |
+----------------------+ |
+----------------------+
+----------------------+ | End-to-end |
| Ordinary clock 1-1 |----------| transparent clock- |
+----------------------+ | 1 - 1 |
+----------------------+
|
C
|
+----------------------+
+----------------------+ | End-to-end |
| Ordinary clock 1-2 |----------| transparent clock- |
+----------------------+ | 1 - 2 |
+----------------------+
The following terms are defined in section 3.1 of [IEEE 1588-2008]:
Accuracy:
The mean of the time or frequency error between the clock under
test and a perfect reference clock, over an ensemble of
measurements. Stability is a measure of how the mean varies
with respect to variables such as time, temperature, and so on,
while the precision is a measure of the deviation of the error
from the mean.
Boundary clock:
A clock that has multiple Precision Time Protocol (PTP) ports in
a domain and maintains the timescale used in the domain. It
may serve as the source of time, i.e., be a master clock, and
may synchronize to another clock, i.e., be a slave clock.
Clock:
A node participating in the Precision Time Protocol (PTP) that
is capable of providing a measurement of the passage of time
since a defined epoch.
Domain:
A logical grouping of clocks that synchronize to each other
using the protocol, but that are not necessarily synchronized
to clocks in another domain.
End-to-end transparent clock:
A transparent clock that supports the use of the end-to-end
delay measurement mechanism between slave clocks and the master
clock. Each node must measure the residence time of PTP event
messages and accumulate it in the Correction Field.
Epoch:
The origin of a timescale.
Foreign master:
An ordinary or boundary clock sending Announce messages to
another clock that is not the current master recognized by the
other clock.
Grandmaster clock:
Within a domain, a clock that is the ultimate source of time
for clock synchronization using the protocol.
Holdover:
A clock previously synchronized/syntonized to another clock
(normally a primary reference or a master clock) but now
free-running based on its own internal oscillator, whose
frequency is being adjusted using data acquired while it had
been synchronized/syntonized to the other clock. It is said to
be in holdover or in the holdover mode, as long as it is within
its accuracy requirements.
Link:
A network segment between two Precision Time Protocol ports
supporting the peer delay mechanism of this standard. The peer
delay mechanism is designed to measure the propagation time
over such a link.
Master clock:
In the context of a single Precision Time Protocol
communication path, a clock that is the source of time to which
all other clocks on that path synchronize.
Multicast communication:
A communication model in which each Precision Time Protocol
message sent from any PTP port is capable of being received and
processed by all PTP ports on the same PTP communication path.
Node:
A device that can issue or receive Precision Time Protocol
communications on a network.
Ordinary clock:
A clock that has a single Precision Time Protocol port in a
domain and maintains the timescale used in the domain. It may
serve as a source of time, i.e., be a master clock, or may
synchronize to another clock, i.e., be a slave clock.
Parent clock:
The master clock to which a clock is synchronized.
Peer-to-peer transparent clock:
A transparent clock that, in addition to providing Precision
Time Protocol event transit time information, also provides
corrections for the propagation delay of the link connected to
the port receiving the PTP event message. In the presence of
peer-to-peer transparent clocks, delay measurements between
slave clocks and the master clock are performed using the
peer-to-peer delay measurement mechanism.
PortNumber:
An index identifying a specific Precision Time Protocol port on
a PTP node.
Primary reference:
A source of time and or frequency that is traceable to
international standards.
Profile:
The set of allowed Precision Time Protocol features applicable
to a device.
Timeout:
A mechanism for terminating requested activity that, at least
from the requester's perspective, does not complete within the
specified time.
Timescale:
A linear measure of time from an epoch.
Transparent clock: Section 6 of [IEEE 1588-2008] provides an overview of synchronization
A device that measures the time taken for a Precision Time networks using PTP.
Protocol event message to transit the device and provides this
information to clocks receiving this PTP event message.
Two-step clock: Terms used in this document have meanings as defined in section 3.1
A clock that provides time information using the combination of of [IEEE 1588-2008].
an event message and a subsequent general message.
4. IETF PTP MIB Definition 4. IETF PTP MIB Definition
PTPBASE-MIB DEFINITIONS ::= BEGIN PTPBASE-MIB DEFINITIONS ::= BEGIN
IMPORTS IMPORTS
MODULE-IDENTITY, MODULE-IDENTITY,
OBJECT-TYPE, OBJECT-TYPE,
OBJECT-IDENTITY, OBJECT-IDENTITY,
Gauge32, Gauge32,
skipping to change at page 10, line 41 skipping to change at page 7, line 10
FROM SNMPv2-CONF FROM SNMPv2-CONF
TEXTUAL-CONVENTION, TEXTUAL-CONVENTION,
TruthValue, TruthValue,
DisplayString, DisplayString,
AutonomousType AutonomousType
FROM SNMPv2-TC FROM SNMPv2-TC
InterfaceIndexOrZero InterfaceIndexOrZero
FROM IF-MIB; FROM IF-MIB;
ptpbaseMIB MODULE-IDENTITY ptpbaseMIB MODULE-IDENTITY
LAST-UPDATED "201608240000Z" LAST-UPDATED "201703120000Z"
ORGANIZATION "TICTOC Working Group" ORGANIZATION "TICTOC Working Group"
CONTACT-INFO CONTACT-INFO
"WG Email: tictoc@ietf.org "WG Email: tictoc@ietf.org
Vinay Shankarkumar Vinay Shankarkumar
Cisco Systems, Cisco Systems,
Email: vinays@cisco.com Email: vinays@cisco.com
Laurent Montini, Laurent Montini,
Cisco Systems, Cisco Systems,
skipping to change at page 12, line 11 skipping to change at page 8, line 25
It is envisioned this MIB module will complement other managed It is envisioned this MIB module will complement other managed
objects to be defined to monitor and measure the performance of objects to be defined to monitor and measure the performance of
the PTP devices and telecom clocks supporting specific PTP the PTP devices and telecom clocks supporting specific PTP
profiles. profiles.
Some other PTP profiles have their own MIB modules defined as Some other PTP profiles have their own MIB modules defined as
part of the profile, and this MIB module is not intended to part of the profile, and this MIB module is not intended to
replace those MIB modules. replace those MIB modules.
Technical terms used in this module are defined in section 3.1 Technical terms used in this module are defined in [IEEE 1588-
of [IEEE 1588-2008]. 2008].
The MIB module refers to the sections of [IEEE 1588-2008]. The MIB module refers to the sections of [IEEE 1588-2008].
Acronyms: Acronyms:
ARB Arbitrary Timescale ARB Arbitrary Timescale
E2E End-to-End E2E End-to-End
EUI Extended Unique Identifier EUI Extended Unique Identifier
GPS Global Positioning System GPS Global Positioning System
IANA Internet Assigned Numbers Authority IANA Internet Assigned Numbers Authority
IP Internet Protocol IP Internet Protocol
skipping to change at page 12, line 34 skipping to change at page 8, line 48
according to [IEEE 802.3-2008] according to [IEEE 802.3-2008]
MAC-48 Used to identify hardware instances within 802-based MAC-48 Used to identify hardware instances within 802-based
networking applications. This is obsolete now. networking applications. This is obsolete now.
NIST National Institute of Standards and Technology NIST National Institute of Standards and Technology
NTP Network Time Protocol (see IETF [RFC 5905]) NTP Network Time Protocol (see IETF [RFC 5905])
OUI Organizational Unique Identifier OUI Organizational Unique Identifier
(allocated by the IEEE) (allocated by the IEEE)
P2P Peer-to-Peer P2P Peer-to-Peer
PTP Precision Time Protocol PTP Precision Time Protocol
TAI International Atomic Time TAI International Atomic Time
TC Transparent Clock
UDP User Datagram Protocol UDP User Datagram Protocol
UTC Coordinated Universal Time UTC Coordinated Universal Time
References: References:
[IEEE 1588-2008] IEEE Standard for a Precision Clock
[IEEE 1588-2008] IEEE Standard for A Precision Clock
Synchronization Protocol for Networked Measurement and Synchronization Protocol for Networked Measurement and
Control Systems, IEEE Std. 1588(TM)-2008, 24 July 2008. Control Systems, IEEE Std. 1588(TM)-2008, 24 July 2008.
The below table specifies the object formats of the various The below table specifies the object formats of the various
textual conventions used. textual conventions used.
Data type mapping Textual Convention SYNTAX Data type mapping Textual Convention SYNTAX
------------------- --------------------- ------------------ ------------------- --------------------- ------------------
5.3.2 TimeInterval PtpClockTimeInterval OCTET 5.3.2 TimeInterval PtpClockTimeInterval OCTET
STRING(SIZE(1..255)) STRING(SIZE(1..255))
5.3.3 Timestamp PtpClockTimestamp OCTET STRING(SIZE(6)) 5.3.3 Timestamp PtpClockTimestamp OCTET STRING(SIZE(6))
5.3.4 ClockIdentity PtpClockIdentity OCTET STRING(SIZE(8)) 5.3.4 ClockIdentity PtpClockIdentity OCTET STRING(SIZE(8))
5.3.5 PortIdentity PtpClockPortNumber INTEGER(1..65535) 5.3.5 PortIdentity PtpClockPortNumber INTEGER(1..65535)
5.3.7 ClockQuality PtpClockQualityClassType 5.3.7 ClockQuality PtpClockQualityClassType
" "
-- revision log -- revision log
REVISION "201703120000Z"
DESCRIPTION "Draft 12, for IESG approval remvoed the IEEE
standard texts."
REVISION "201608240000Z" REVISION "201608240000Z"
DESCRIPTION "Draft 11, for IESG approval after all comments, DESCRIPTION "Draft 11, for IESG approval after all comments,
including the correct MIB." including the correct MIB."
REVISION "201608220000Z" REVISION "201608220000Z"
DESCRIPTION "Draft 10, for IESG approval after all comments DESCRIPTION "Draft 10, for IESG approval after all comments
addressed." addressed."
REVISION "201604200000Z" REVISION "201604200000Z"
DESCRIPTION "Draft 9, for IESG approval." DESCRIPTION "Draft 9, for IESG approval."
REVISION "201602220000Z" REVISION "201602220000Z"
DESCRIPTION "Draft 8, for IETF last call." DESCRIPTION "Draft 8, for IETF last call."
::= { mib-2 XXX } -- XXX to be assigned by IANA ::= { mib-2 XXX } -- XXX to be assigned by IANA
-- Textual Conventions -- Textual Conventions
PtpClockDomainType ::= TEXTUAL-CONVENTION PtpClockDomainType ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d" DISPLAY-HINT "d"
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The Domain is identified by an integer, the domainNumber, in "The Domain is identified by an integer, the domainNumber, in
the range of 0 to 255. An integer value that is used to assign the range of 0 to 255. An integer value that is used to assign
each PTP device to a particular domain. The following values each PTP device to a particular domain."
define the valid domains.
Value Definition
--------- -------------------
0 Default domain
1 Alternate domain 1
2 Alternate domain 2
3 Alternate domain 3
4 - 127 User-defined domains
128 - 255 Reserved"
REFERENCE "Section 7.1 Domains, Table 2 of [IEEE 1588-2008]" REFERENCE "Section 7.1 Domains, Table 2 of [IEEE 1588-2008]"
SYNTAX Unsigned32 (0..255) SYNTAX Unsigned32 (0..255)
PtpClockIdentity ::= TEXTUAL-CONVENTION PtpClockIdentity ::= TEXTUAL-CONVENTION
DISPLAY-HINT "255a" DISPLAY-HINT "255a"
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The clock Identity is an 8-octet array and will be presented in "The clock Identity is an 8-octet array and will be presented in
the form of a character array. Network byte order is assumed. the form of a character array. Network byte order is assumed.
The value of the PtpClockIdentity should be taken from the The value of the PtpClockIdentity should be taken from the
IEEE EUI-64 individual assigned numbers as indicated in IEEE EUI-64 individual assigned numbers as indicated in
Section 7.5.2.2.2 of [IEEE 1588-2008]. It can also be non-EUI-64 Section 7.5.2.2.2 of [IEEE 1588-2008]. It can also be non-EUI-64
address as defined in section 7.5.2.2.3 of [IEEE 1588-2008]. address as defined in section 7.5.2.2.3 of [IEEE 1588-2008].
The EUI-64 address is divided into the following fields:
OUI bytes (0-2)
Extension identifier bytes (3-7)
The clock identifier can be constructed from existing EUI-48 The clock identifier can be constructed from existing EUI-48
assignments and here is an abbreviated example extracted from assignments and here is an abbreviated example extracted from
section 7.5.2.2.2 [IEEE 1588-2008]. section 7.5.2.2.2 [IEEE 1588-2008]."
Company EUI-48 = 0xACDE4823456716
EUI-64 = ACDE48FFFE23456716
It is important to note the IEEE Registration Authority has
deprecated the use of MAC-48 in any new design."
REFERENCE "Section 7.5.2.2.1 of [IEEE 1588-2008]" REFERENCE "Section 7.5.2.2.1 of [IEEE 1588-2008]"
SYNTAX OCTET STRING (SIZE (8)) SYNTAX OCTET STRING (SIZE (8))
PtpClockInstanceType ::= TEXTUAL-CONVENTION PtpClockInstanceType ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d" DISPLAY-HINT "d"
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The instance of the Clock of a given clock type in a given "The instance of the Clock of a given clock type in a given
domain." domain."
SYNTAX Unsigned32 (0..255) SYNTAX Unsigned32 (0..255)
PtpClockIntervalBase2 ::= TEXTUAL-CONVENTION PtpClockIntervalBase2 ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d" DISPLAY-HINT "d"
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The interval included in message types Announce, Sync, "The interval included in message types Announce, Sync,
Delay_Req, and Pdelay_Req as indicated in section 7.7.2.1 of Delay_Req, and Pdelay_Req as indicated in section 7.7.2.1 of
[IEEE 1588-2008]. [IEEE 1588-2008]."
The mean time interval between successive messages shall be
represented as the logarithm to the base 2 of this time
interval measured in seconds on the local clock of the device
sending the message. The values of these logarithmic attributes
shall be selected from integers in the range -128 to 127 subject
to further limits established in an applicable PTP profile."
REFERENCE "Section 7.7.2.1 General interval specification of REFERENCE "Section 7.7.2.1 General interval specification of
[IEEE 1588-2008]" [IEEE 1588-2008]"
SYNTAX Integer32 (-128..127) SYNTAX Integer32 (-128..127)
PtpClockMechanismType ::= TEXTUAL-CONVENTION PtpClockMechanismType ::= TEXTUAL-CONVENTION
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The clock type based on whether end-to-end or peer-to-peer "The clock type based on whether end-to-end or peer-to-peer
mechanisms are used. The mechanism used to calculate the Mean mechanisms are used. The mechanism used to calculate the Mean
Path Delay as indicated in Table 9 of [IEEE 1588-2008]. Path Delay as indicated in Table 9 of [IEEE 1588-2008]."
Delay mechanism Value(hex) Specification
--------------- ---------- -------------
E2E 01 The port is configured to use the
delay request-response mechanism.
P2P 02 The port is configured to use the
peer delay mechanism.
DISABLED FE The port does not implement the
delay mechanism."
REFERENCE REFERENCE
"Sections 8.2.5.4.4 portDS.delayMechanism, "Sections 8.2.5.4.4 portDS.delayMechanism,
6.6.4 Measuring link propagation delay in clocks supporting 6.6.4 Measuring link propagation delay in clocks supporting
peer-to-peer path correction, peer-to-peer path correction,
7.4.2 communication Path asymmetry of [IEEE 1588-2008]." 7.4.2 communication Path asymmetry of [IEEE 1588-2008]."
SYNTAX INTEGER { SYNTAX INTEGER {
e2e(1), e2e(1),
p2p(2), p2p(2),
disabled(254) disabled(254)
skipping to change at page 16, line 6 skipping to change at page 11, line 32
REFERENCE REFERENCE
"Sections 7.5.2.3 portNumber and 5.3.5 PortIdentity of "Sections 7.5.2.3 portNumber and 5.3.5 PortIdentity of
[IEEE 1588-2008]" [IEEE 1588-2008]"
SYNTAX Unsigned32 (0..65535) SYNTAX Unsigned32 (0..65535)
PtpClockPortState ::= TEXTUAL-CONVENTION PtpClockPortState ::= TEXTUAL-CONVENTION
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This is the value of the current state of the protocol engine "This is the value of the current state of the protocol engine
associated with this port. associated with this port."
Port state Value Description
-----------------------------------------------------------
initializing 1 In this state a port initializes
its data sets, hardware, and
communication facilities.
faulty 2 The fault state of the protocol.
disabled 3 The port shall not place any
messages on its communication path.
listening 4 The port is waiting for the
announceReceiptTimeout to expire or
to receive an Announce message from
a master.
preMaster 5 The port shall behave in all respects
as though it were in the MASTER state
except that it shall not place any
messages on its communication path
except for Pdelay_Req, Pdelay_Resp,
Pdelay_Resp_Follow_Up, signaling, or
management messages.
master 6 The port is behaving as a master port.
passive 7 The port shall not place any messages
on its communication path except for
Pdelay_Req, Pdelay_Resp,
Pdelay_Resp_Follow_Up, or signaling
messages, or management messages that
are a required response to another
management message
uncalibrated 8 The local port is preparing to
synchronize to the master port.
slave 9 The port is synchronizing to the
selected master port."
REFERENCE REFERENCE
"Section 8.2.5.3.1 portState and 9.2.5 State machines of "Section 8.2.5.3.1 portState and 9.2.5 State machines of
[IEEE 1588-2008]" [IEEE 1588-2008]"
SYNTAX INTEGER { SYNTAX INTEGER {
initializing(1), initializing(1),
faulty(2), faulty(2),
disabled(3), disabled(3),
listening(4), listening(4),
preMaster(5), preMaster(5),
skipping to change at page 18, line 35 skipping to change at page 13, line 30
second1(47), -- 0x2F second1(47), -- 0x2F
second10(48), -- 0x30 second10(48), -- 0x30
secondGreater10(49), -- 0x31 secondGreater10(49), -- 0x31
unknown(254) -- 0xFE unknown(254) -- 0xFE
-- reserved255(255), 0xFF -- reserved255(255), 0xFF
} }
PtpClockQualityClassType ::= TEXTUAL-CONVENTION PtpClockQualityClassType ::= TEXTUAL-CONVENTION
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The ClockQuality as specified in section 5.3.7 ClockQuality, 7.6.2.4 "The ClockQuality as specified in section 5.3.7 ClockQuality,
clockClass and Table 5 clockClass specifications of [IEEE 1588-2008]. 7.6.2.4 clockClass and Table 5 clockClass specifications of
[IEEE 1588-2008]."
Value Description
-------- ------------------------------------------------
0 Reserved to enable compatibility with future
versions.
1-5 Reserved
6 Shall designate a clock that is synchronized
to a primary reference time source. The
timescale distributed shall be PTP. A
clockClass 6 clock shall not be a slave to
another clock in the domain.
7 Shall designate a clock that has previously
been designated as clockClass 6 but that has
lost the ability to synchronize to a primary
reference time source and is in holdover mode
and within holdover specifications. The
timescale distributed shall be PTP. A
clockClass 7 clock shall not be a slave to
another clock in the domain.
8 Reserved.
9-10 Reserved to enable compatibility with future
versions.
11-12 Reserved.
13 Shall designate a clock that is synchronized
to an application-specific source of time.
The timescale distributed shall be ARB. A
clockClass 13 clock shall not be a slave to
another clock in the domain.
14 Shall designate a clock that has previously
been designated as clockClass 13 but that
has lost the ability to synchronize to an
application-specific source of time and is
in holdover mode and within holdover
specifications. The timescale distributed
shall be ARB. A clockClass 14 clock shall
not be a slave to another clock in the domain.
15-51 Reserved.
52 Degradation alternative A for a clock of
clockClass 7 that is not within holdover
specification. A clock of clockClass 52
shall not be a slave to another clock in
the domain.
53-57 Reserved.
58 Degradation alternative A for a clock of
clockClass 14 that is not within holdover
specification. A clock of clockClass 58 shall
not be a slave to another clock in the domain.
59-67 Reserved.
68-122 For use by alternate PTP profiles.
123-127 Reserved.
128-132 Reserved.
133-170 For use by alternate PTP profiles.
171-186 Reserved.
187 Degradation alternative B for a clock of
clockClass 7 that is not within holdover
specification. A clock of clockClass 187 may
be a slave to another clock in the domain.
188-192 Reserved.
193 Degradation alternative B for a clock of
clockClass 14 that is not within holdover
specification. A clock of clockClass 193 may
be a slave to another clock in the domain.
194-215 Reserved.
216-232 For use by alternate PTP profiles.
233-247 Reserved.
248 Default. This clockClass shall be used if
none of the other clockClass definitions apply.
249-250 Reserved.
251 Reserved for version 1 compatibility; see Clause 18.
252-254 Reserved.
255 Shall be the clockClass of a slave-only clock; see
9.2.2."
REFERENCE "Section 5.3.7, 7.6.2.4 and Table 5 of REFERENCE "Section 5.3.7, 7.6.2.4 and Table 5 of
[IEEE 1588-2008]." [IEEE 1588-2008]."
SYNTAX INTEGER { SYNTAX INTEGER {
-- reserved(0), 0x00 -- reserved(0), 0x00
-- reserved(1:5), 0x01 to 0x05 -- reserved(1:5), 0x01 to 0x05
clockclass6(6), -- 0x06 clockclass6(6), -- 0x06
clockclass7(7), -- 0x07 clockclass7(7), -- 0x07
-- reserved(8), 0x08 -- reserved(8), 0x08
-- reserved(9:10), 0x09 to 0x0A -- reserved(9:10), 0x09 to 0x0A
skipping to change at page 20, line 41 skipping to change at page 14, line 13
-- reserved(123:127), 0x7B to 0x7F -- reserved(123:127), 0x7B to 0x7F
-- reserved(128:132), 0x80 to 0x84 -- reserved(128:132), 0x80 to 0x84
} }
PtpClockRoleType ::= TEXTUAL-CONVENTION PtpClockRoleType ::= TEXTUAL-CONVENTION
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The Clock Role. The protocol generates a Master Slave "The Clock Role. The protocol generates a Master Slave
relationship among the clocks in the system. relationship among the clocks in the system.
Clock Role Value Description Clock Role Value
-------------------------------------------------------------- -------------------------
Master clock 1 A clock that is the source of Master clock 1
time to which all other clocks on Slave clock 2 "
that path synchronize.
Slave clock 2 A clock which synchronizes to
another clock (master)."
SYNTAX INTEGER { SYNTAX INTEGER {
master(1), master(1),
slave(2) slave(2)
} }
PtpClockStateType ::= TEXTUAL-CONVENTION PtpClockStateType ::= TEXTUAL-CONVENTION
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The clock state returned by a PTP engine. "The clock state returned by a PTP engine.
Clock State Value Description Clock State Value
-------------------------------------------------------------- ------------------------
Freerun state 1 Applies to a slave device that is not Freerun state 1
locked to a master. This is the initial Holdover state 2
state a slave starts out with when it Acquiring state 3
is not getting any PTP packets from the Freq_locked state 4
master or because of some other input Phase_aligned state 5 "
error (erroneous packets, etc).
Holdover state 2 In this state the slave device is
locked to a master but communication
with the master has been lost or the
timestamps in the PTP packets are
incorrect. Since the slave was
locked to the master, it can run in this
state, with similar accuracy for some
time. If communication with the master
is not restored for an extended period
(dependent on the clock implementation),
the device should move to the Freerun
state.
Acquiring state 3 The slave device is receiving packets
from a master and is trying to acquire
a lock.
Freq_locked state 4 Slave device is locked to the Master
with respect to frequency, but not phase
aligned
Phase_aligned state 5 Locked to the master with respect to
frequency and phase."
SYNTAX INTEGER { SYNTAX INTEGER {
freerun(1), freerun(1),
holdover(2), holdover(2),
acquiring(3), acquiring(3),
frequencyLocked(4), frequencyLocked(4),
phaseAligned(5) phaseAligned(5)
} }
PtpClockTimeInterval ::= TEXTUAL-CONVENTION PtpClockTimeInterval ::= TEXTUAL-CONVENTION
DISPLAY-HINT "255a" DISPLAY-HINT "255a"
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This textual convention corresponds to the TimeInterval "This textual convention corresponds to the TimeInterval
structure indicated in section 5.3.2 of [IEEE 1588-2008]. structure indicated in section 5.3.2 of [IEEE 1588-2008].
It will be presented in the form of a character array. It will be presented in the form of a character array.
Network byte order is assumed. Network byte order is assumed."
The TimeInterval type represents time intervals.
struct TimeInterval
{
Integer64 scaledNanoseconds;
};
The scaledNanoseconds member is the time interval expressed in
units of nanoseconds and multiplied by 2**16.
Positive or negative time intervals outside the maximum range
of this data type shall be encoded as the largest positive and
negative values of the data type, respectively.
For example, 2.5 ns is expressed as string '0000 0000 0002 8000'
in Base16."
REFERENCE REFERENCE
"Section 5.3.2 TimeInterval and section 7.7.2.1 Timer interval "Section 5.3.2 TimeInterval and section 7.7.2.1 Timer interval
specification of [IEEE 1588-2008]" specification of [IEEE 1588-2008]"
SYNTAX OCTET STRING (SIZE (1..255)) SYNTAX OCTET STRING (SIZE (1..255))
PtpClockTimeSourceType ::= TEXTUAL-CONVENTION PtpClockTimeSourceType ::= TEXTUAL-CONVENTION
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The ClockQuality as specified in Sections 5.3.7, 7.6.2.6 and "The ClockQuality as specified in Sections 5.3.7, 7.6.2.6 and
skipping to change at page 36, line 51 skipping to change at page 29, line 28
DESCRIPTION DESCRIPTION
"This object specifies the instance of the clock for this clock "This object specifies the instance of the clock for this clock
type in the given domain." type in the given domain."
::= { ptpbaseClockRunningEntry 3 } ::= { ptpbaseClockRunningEntry 3 }
ptpbaseClockRunningState OBJECT-TYPE ptpbaseClockRunningState OBJECT-TYPE
SYNTAX PtpClockStateType SYNTAX PtpClockStateType
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This object specifies the Clock state returned by a PTP engine "This object specifies the Clock state returned by a PTP
which was described earlier. engine."
Freerun state. Applies to a slave device that is not locked to
a master. This is the initial state a slave starts out with
when it is not getting any PTP packets from the master, or
because of some other input error (erroneous packets, etc).
Holdover state. In this state the slave device is locked to a
master but communication with the master has been lost or the
timestamps in the PTP packets are incorrect. Since the
slave was previously locked to the master, it can run in this
state, with similar accuracy for some time. If communication
with the master is not restored for an extended period
(dependent on the clock implementation), the device should move
to the FREERUN state.
Acquiring state. The slave device is receiving packets from a
master and is trying to acquire a lock.
Freq_locked state. Slave device is locked to the Master with
respect to frequency, but not phase aligned
Phase_aligned state. Locked to the master with respect to
frequency and phase."
::= { ptpbaseClockRunningEntry 4 } ::= { ptpbaseClockRunningEntry 4 }
ptpbaseClockRunningPacketsSent OBJECT-TYPE ptpbaseClockRunningPacketsSent OBJECT-TYPE
SYNTAX Counter64 SYNTAX Counter64
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This object specifies the total number of all unicast and "This object specifies the total number of all unicast and
multicast packets that have been sent out for this clock in this multicast packets that have been sent out for this clock in this
domain for this type. These counters are discontinuous." domain for this type. These counters are discontinuous."
skipping to change at page 39, line 46 skipping to change at page 31, line 50
SYNTAX Integer32 SYNTAX Integer32
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This object specifies the timeproperties dataset value of "This object specifies the timeproperties dataset value of
the current UTC offset. the current UTC offset.
In PTP systems whose epoch is the PTP epoch, the value of In PTP systems whose epoch is the PTP epoch, the value of
timePropertiesDS.currentUtcOffset is the offset timePropertiesDS.currentUtcOffset is the offset
between TAI and UTC; otherwise the value has no meaning. The between TAI and UTC; otherwise the value has no meaning. The
value shall be in units of seconds. value shall be in units of seconds."
The initialization value shall be selected as follows:
a) If the timePropertiesDS.ptpTimescale (see 8.2.4.8) is TRUE,
the value is the value obtained from a
primary reference if the value is known at the time of
initialization, else,
b) The value shall be the current number of leap seconds (7.2.3)
when the node is designed."
REFERENCE REFERENCE
"Section 8.2.4.3 timePropertiesDS.currentUtcOffsetValid of "Section 8.2.4.3 timePropertiesDS.currentUtcOffsetValid of
[IEEE 1588-2008]" [IEEE 1588-2008]"
::= { ptpbaseClockTimePropertiesDSEntry 5 } ::= { ptpbaseClockTimePropertiesDSEntry 5 }
ptpbaseClockTimePropertiesDSLeap59 OBJECT-TYPE ptpbaseClockTimePropertiesDSLeap59 OBJECT-TYPE
SYNTAX TruthValue SYNTAX TruthValue
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This object specifies the Leap59 value in the clock Current "This object specifies the Leap59 value in the clock Current
Dataset." Dataset."
skipping to change at page 51, line 52 skipping to change at page 43, line 49
"This object specifies the PTP clock port name." "This object specifies the PTP clock port name."
::= { ptpbaseClockPortRunningEntry 5 } ::= { ptpbaseClockPortRunningEntry 5 }
ptpbaseClockPortRunningState OBJECT-TYPE ptpbaseClockPortRunningState OBJECT-TYPE
SYNTAX PtpClockPortState SYNTAX PtpClockPortState
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This object specifies the port state returned by PTP engine. "This object specifies the port state returned by PTP engine.
initializing - In this state a port initializes initializing
its data sets, hardware, and faulty
communication facilities. disabled
faulty - The fault state of the protocol. listening
disabled - The port shall not place any preMaster
messages on its communication path. master
listening - The port is waiting for the passive
announceReceiptTimeout to expire or uncalibrated
to receive an Announce message from slave "
a master.
preMaster - The port shall behave in all respects
as though it were in the MASTER state
except that it shall not place any
messages on its communication path
except for Pdelay_Req, Pdelay_Resp,
Pdelay_Resp_Follow_Up, signaling, or
management messages.
master - The port is behaving as a master port.
passive - The port shall not place any
messages on its communication path
except for Pdelay_Req, Pdelay_Resp,
Pdelay_Resp_Follow_Up, or signaling
messages, or management messages
that are a required response to
another management message
uncalibrated - The local port is preparing to
synchronize to the master port.
slave - The port is synchronizing to the
selected master port."
::= { ptpbaseClockPortRunningEntry 6 } ::= { ptpbaseClockPortRunningEntry 6 }
ptpbaseClockPortRunningRole OBJECT-TYPE ptpbaseClockPortRunningRole OBJECT-TYPE
SYNTAX PtpClockRoleType SYNTAX PtpClockRoleType
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"This object specifies the Clock Role." "This object specifies the Clock Role."
::= { ptpbaseClockPortRunningEntry 7 } ::= { ptpbaseClockPortRunningEntry 7 }
skipping to change at page 72, line 14 skipping to change at page 63, line 41
[RFC 5905] David L. Mills, "Network Time Protocol Version 4: Protocol [RFC 5905] David L. Mills, "Network Time Protocol Version 4: Protocol
and Algorithms Specification", RFC 5905, University of Delaware, June and Algorithms Specification", RFC 5905, University of Delaware, June
2010. 2010.
[RFC 6353] Hardraker, W., "Transport Layer Security (TLS) Transport [RFC 6353] Hardraker, W., "Transport Layer Security (TLS) Transport
Model for the Simple Network Management Protocol (SNMP)", RFC 6353, Model for the Simple Network Management Protocol (SNMP)", RFC 6353,
SPARTA, Inc., July 2011. SPARTA, Inc., July 2011.
[IEEE 802.3-2012] "IEEE Standard for Ethernet", IEEE Std. 802.3 - [IEEE 802.3-2012] "IEEE Standard for Ethernet", IEEE Std. 802.3 -
2012, 30 August 2012 2015, 3 September 2015
[G.8265.1] "Precision time protocol telecom profile for frequency [G.8265.1] "Precision time protocol telecom profile for frequency
synchronization", ITU-T Recommendation G.8265.1, July 2014. synchronization", ITU-T Recommendation G.8265.1, July 2014.
8. Acknowledgements 8. Acknowledgements
Thanks to John Linton and Danny Lee for valuable comments, and to Thanks to John Linton and Danny Lee for valuable comments, and to
Bert Wijnen, Kevin Gross, Alan Luchuk, Chris Elliot, Brian Haberman Bert Wijnen, Kevin Gross, Alan Luchuk, Chris Elliot, Brian Haberman
and Dan Romascanu for their reviews of this MIB module. and Dan Romascanu for their reviews of this MIB module.
 End of changes. 32 change blocks. 
472 lines changed or deleted 66 lines changed or added

This html diff was produced by rfcdiff 1.45. The latest version is available from http://tools.ietf.org/tools/rfcdiff/