TICTOC Working Group Vinay Shankarkumar
INTERNET DRAFT Laurent Montini
Intended status: Standards Track Cisco Systems
Tim Frost
Greg Dowd
Symmetricom
Expires: September 7, 2011 March 7, 2011
Precision Time Protocol Version 2 (PTPv2)
Management Information Base
draft-vinay-tictoc-ptp-mib-00.txt
Status of this Memo
This Internet-Draft is submitted to IETF in full conformance with
the provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet-
Drafts.
Internet-Drafts are draft documents valid for a maximum of six
months and may be updated, replaced, or obsoleted by other documents
at any time. It is inappropriate to use Internet-Drafts as
reference material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html
This Internet-Draft will expire on September 7, 2011.
Copyright Notice
Copyright (c) 2011 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
Shankarkumar et al. Expires September 7, 2011 [Page 1]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
carefully, as they describe your rights and restrictions with
respect to this document. Code Components extracted from this
document must include Simplified BSD License text as described in
Section 4.e of the Trust Legal Provisions and are provided without
warranty as described in the Simplified BSD License.
Abstract
This memo defines a portion of the Management Information Base (MIB)
for use with network management protocols in TCP/IP-based internets.
In particular, it defines objects for managing networks using
Precision Time Protocol.
This memo specifies a MIB module in a manner that is both compliant
to the SNMPv2 SMI, and semantically identical to the peer SNMPv1
definitions.
Table of Contents
1. Introduction...................................................2
1.1. Change Log................................................3
2. The SNMP Management Framework..................................3
3. Overview.......................................................4
4. Structure of MIB Module........................................4
4.1. Textual Conventions......................................12
4.2. The Notifications Subtree................................21
4.3. The Table Structures.....................................27
5. Relationship to the Interface MIB.............................63
6. MIB modules required for IMPORTS..............................64
7. Security Considerations.......................................64
8. IANA Considerations...........................................65
9. References....................................................65
9.1. Normative References.....................................65
9.2. Informative References...................................65
10. Acknowledgements.............................................66
11. Author's Addresses...........................................67
1. Introduction
This memo defines a portion of the Management Information Base (MIB)
for use with network management protocols in the Internet Community.
In particular, it describes managed objects used for managing PTP
devices including the ordinary clock, transparent clock, boundary
clocks. It is envisioned this MIB will complement other managed
objects defined to monitor, measure the performance of the PTP
devices and telecom clocks. Those objects are considered out of
scope for the current draft.
Shankarkumar et al. Expires September 7, 2011 [Page 2]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
1.1. Change Log
This section tracks changes made to the revisions of the Internet
Drafts of this document. It will be *deleted* when the document is
published as an RFC. This section tracks changes made to the
visions of the Internet Drafts of this document. It will be
*deleted* when the document is published as an RFC.
2. The SNMP Management Framework
The SNMP Management Framework presently consists of five major
components:
o An overall architecture, described in [RFC 2271].
o Mechanisms for describing and naming objects and events for the
purpose of management. The first version of this Structure of
Management Information (SMI) is called SMIv1 and described in
[RFC 1155], [RFC 1212] and [RFC 1215].
The second version, called SMIv2, is described in [RFC 2578],
[RFC 2579] and [RFC 2580]
o Message protocols for transferring management information. The
first version of the SNMP message protocol is called SNMPv1 and
described in [RFC 1157]. A second version of the SNMP message
protocol, which is not an Internet standards track protocol, is
called SNMPv2c and described in [RFC 1901] and [RFC 1905]. The
third version of the message protocol is called SNMPv3 and
described in [RFC 1906], [RFC 2572] and [RFC 2574].
o Protocol operations for accessing management information. The
first set of protocol operations and associated PDU formats is
described in [RFC 1157]. A second set of protocol operations and
associated PDU formats is described in [RFC 1905].
o A set of fundamental applications described in [RFC 2573] and the
view-based access control mechanism described in [RFC 2575].
Managed objects are accessed via a virtual information store, termed
the Management Information Base or MIB. Objects in the MIB are
defined using the mechanisms defined in the SMI.
This memo specifies a MIB module that is compliant to the SMIv2. A
MIB conforming to the SMIv1 can be produced through the appropriate
translations. The resulting translated MIB must be semantically
equivalent, except where objects or events are omitted because no
translation is possible (e.g., use of Counter64). Some machine
readable information in SMIv2 will be converted into textual
descriptions in SMIv1 during the translation process. However, this
Shankarkumar et al. Expires September 7, 2011 [Page 3]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
loss of machine readable information is not considered to change the
semantics of the MIB.
3. Overview
The objects defined in this MIB are to be used when describing
Precision Time Protocol (PTPv2).
4. Structure of MIB Module
IETF-PTP-MIB DEFINITIONS ::= BEGIN
ietfPtpMIB MODULE-IDENTITY
LAST-UPDATED "201101280000Z"
ORGANIZATION "TICTOC Working Group"
CONTACT-INFO
"WG Email: tictoc@ietf.org
Vinay Shankarkumar
Cisco Systems,
Email: vinays@cisco.com
Laurent Montini,
Cisco Systems,
Email: lmontini@cisco.com
Tim Frost,
Symmetricom Inc.,
Email: tfrost@symmetricom.com
Greg Dowd,
Symmetricom Inc.,
Email: gdowd@symmetricom.com"
DESCRIPTION
"The MIB module for PTPv2 (IEEE (TM) 1588 - 2008)
Overview of PTPv2 (IEEE (TM) 1588-2008)
[IEEE1588-2008] defines a protocol enabling precise
synchronization of clocks in measurement and control systems
implemented with packet-based networks, the Precision Time
protocol version 2 (PTPv2). This MIB does not address the
standard IEEE(TM) 1588 (2002) and PTPv1. The protocol is
applicable to network element communicating using IP. The
protocol enables heterogeneous systems that include clocks
of various inherent precision, resolution, and stability to
Shankarkumar et al. Expires September 7, 2011 [Page 4]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
synchronize to a grandmaster clock.
The protocol supports system-wide synchronization accuracy
in the sub-microsecond range with minimal network and local
clock computing resources. [IEEE1588-2008] uses UDP/IP or
Ethernet and can be adapted to other mapping. It includes
formal mechanisms for message extensions, higher sampling
rates, correction for asymmetry, a clock type to reduce
error accumulation in large topologies, and specifications
on how to incorporate the resulting additional data into the
synchronization protocol. The [IEEE1588-2008] defines
conformance and management capability also.
MIB description
This MIB is to support the Precision Time Protocol version 2
(PTPv2, hereafter designated as PTP) features of network
Element System devices.
Acronyms:
ARB arbitrary
BMC best master clock
CAN Controller Area Network
CP Communication Profile
(according to IEC 61784-1:200710)
CPF Communication Profile Family
(according to IEC 61784-1:2007)
DS Differentiated Service
E2E End-to-End
E2ETC End-to-End Transparent Clock
EUI Extended Unique Identifier.
FFO Fractional Frequency Offset
GPS Global Positioning System
IANA Internet Assigned Numbers Authority
ICV Integrity Check Value
ID Identification
IPv4 Internet Protocol version 4
IPv6 Internet Protocol version 6
JD Julian Date
JDN Julian Day Number
MAC Media Access Control
(according to IEEE Std 802.3-2005)
MJD Modified Julian Day
NIST National Institute of Standards and
Technology (see http://www.nist.gov)
NTP Network Time Protocol (see [RFC 1305])
OUI Organizational Unique Identifier
(allocated by the IEEE)
P2P Peer-to-Peer
Shankarkumar et al. Expires September 7, 2011 [Page 5]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
P2PTC Peer-To-Peer Transparent Clock
PHY physical layer
(according to IEEE Std 802.3 2005)
POSIX Portable Operating System Interface
(see ISO/IEC 9945:2003)
PPS Pulse per Second
PTP Precision Time Protocol
SA Security Associations
SNTP Simple Network Time Protocol
SOF Start of Frame
TAI International Atomic Time
TC Traffic Class
TC Transparent Clock
TLV Type, Length, Value
(according to IEEE Std 02.1AB)
ToD Time of Day Synchronization
ToS Type of Service
UCMM UnConnect Message Manager
UDP/IP User Datagram Protocol
UTC Coordinated Universal Time
References:
[1] Precision clock synchronization protocol for networked
measurement and control systems - IEC 61588 IEEE 1588(tm)
Edition 2.0 2009-02
As defined in [IEEE1588-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.
The precision is a measure of the deviation of the error
From the mean.
Atomic process:
A process is atomic if the values of all inputs to the
Process are not permitted to change until all of the results
of the process are instantiated, and the outputs of the
process are not visible to other processes until the
processing of each output is complete.
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,
Shankarkumar et al. Expires September 7, 2011 [Page 6]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
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 Correction Field.
Epoch:
The origin of a timescale.
Event:
An abstraction of the mechanism by which signals or
conditions are generated and represented.
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.
Shankarkumar et al. Expires September 7, 2011 [Page 7]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
Management node:
A device that configures and monitors clocks.
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.
Message timestamp point:
A point within a Precision Time Protocol event message
serving as a reference point in the message. A timestamp is
defined by the instant a message timestamp point passes the
reference plane of a clock.
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.
One-step clock:
A clock that provides time information using a single event
message.
On-pass support:
Indicates that each node in the synchronization chain from
master to slave can support IEEE-1588.
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
Shankarkumar et al. Expires September 7, 2011 [Page 8]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
performed using the peer-to-peer delay measurement
mechanism.
Phase change rate:
The observed rate of change in the measured time with
respect to the reference time. The phase change rate is
equal to the fractional frequency offset between the
measured frequency and the reference frequency.
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.
Precision Time Protocol communication:
Information used in the operation of the protocol,
transmitted in a PTP message over a PTP communication path.
Precision Time Protocol communication path:
The signaling path portion of a particular network enabling
direct communication among ordinary and boundary clocks.
Precision Time Protocol node:
PTP ordinary, boundary, or transparent clock or a device
that generates or parses PTP messages.
Precision Time Protocol port:
A logical access point of a clock for PTP communications to
the communications network.
Recognized standard time source:
A recognized standard time source is a source external to
Precision Time Protocol that provides time and/or frequency
as appropriate that is traceable to the international
standards laboratories maintaining clocks that form the
basis for the International Atomic Time and Universal
Coordinated Time timescales. Examples of these are Global
Positioning System, NTP, and National Institute of Standards
and Technology (NIST) timeservers.
Requestor:
The port implementing the peer-to-peer delay mechanism that
Shankarkumar et al. Expires September 7, 2011 [Page 9]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
initiates the mechanism by sending a Pdelay_Req message.
Responder:
The port responding to the receipt of a Pdelay_Req message
as part of the operation of the peer-to-peer delay
mechanism.
Synchronized clocks:
Two clocks are synchronized to a specified uncertainty if
they have the same epoch and their measurements of the time
of a single event at an arbitrary time differ by no more
than that uncertainty.
Syntonized clocks:
Two clocks are syntonized if the duration of the second is
the same on both, which means the time as measured by each
advances at the same rate. They may or may not share the
same epoch.
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.
Traceability:
A property of the result of a measurement or the value of a
standard whereby it can be related to stated references,
usually national or international standards, through an
unbroken chain of comparisons all having stated
uncertainties.
Translation device:
A boundary clock or, in some cases, a transparent clock that
translates the protocol messages between regions
implementing different transport and messaging protocols,
between different versions of IEEE Std 1588-2008/IEC
61588:2009, or different Precision Time Protocol profiles.
Transparent clock:
A device that measures the time taken for a Precision Time
Protocol event message to transit the device and provides
this information to clocks receiving this PTP event message.
Two-step clock:
A clock that provides time information using the combination
of an event message and a subsequent general message.
Shankarkumar et al. Expires September 7, 2011 [Page 10]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
The below table specifies the object formats of the various
textual conventions used.
Data type mapping Textual Convention SYNTAX
------------------- ------------------ --------------------
5.3.2 TimeInterval ClockTimeInterval OCTET STRING
(SIZE(1..255))
5.3.3 Timestamp ClockTimestamp OCTET STRING(SIZE(6))
5.3.4 ClockIdentity ClockIdentity OCTET STRING
(SIZE(1..255))
5.3.5 PortIdentity ClockPortNumber INTEGER(1..65535)
5.3.7 ClockQuality ClockQualityClassType
Simple master-slave hierarchy [1] section 6.6.2.4
---------------
- 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 Clocks(0-N) Ordinary Clocks(0-N)
Ordinary Clocks(0-N)
Relationship cardinality
Shankarkumar et al. Expires September 7, 2011 [Page 11]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
PTP system 1 : N PTP Clock
PTP Clock 1 : 1 Domain
PTP Clock 1 : N PTP Ports
PTP Port N : N Physical Port (interface in IF-MIB)
Transparent clock diagram from section 6.7.1.3 of [1]
+----------------------------+
| Boundary clock - 1 |
+----------------------------+
| |
| |
+-- A --+ B
| |
+---------------------+ |
| Ordinary clock - 1| |
+---------------------+ |
+----------------------+
+--------------+ | End-to-end |
| Ordinary |-----------------| transparent clock- |
| clock 1-1 | | 1 - 1 |
+--------------+ +----------------------+
|
|
C
|
|
+----------------------+
+--------------+ | End-to-end |
| Ordinary |-----------------| transparent clock- |
| clock 1-2 | | 1 - 2 |
+--------------+ +----------------------+
The MIB refers to the sections of [IEEE1588-2008]."
4.1. Textual Conventions
ClockDomainType ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"The Domain is identified by an integer, the domainNumber,
in the range of 0 to 255. An integer value that is used to
assign each PTP device to a particular domain. The following
values define the valid domains. [1] Section 7.1 Domains
Table 2
Value definition.
Shankarkumar et al. Expires September 7, 2011 [Page 12]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
--------- -------------------
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 and Table 2 of [1]"
SYNTAX Unsigned32 (0..255)
ClockIdentity ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The clock Identity is an 8-octet array and will be
presented in the form of a character array. The value of the
ClockIdentity should be taken from the IEEE EUI-64
individual assigned numbers as indicated in Section
7.5.2.2.2 of [1]. The EUI-64 address is divided into the
following fields.
OUI byte[0-2]
Extension identifier bytes:[3-7]
The clock identifier can be constructed from existing EUI-48
assignments and here is an abbreviated example extracted
from section 7.5.2.2.2 [1].
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 from [1]"
SYNTAX OCTET STRING (SIZE (1..255))
ClockIntervalBase2 ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"The interval included in message types Announce, Sync,
Delay_Req, and Pdelay_Req as indicated in section 7.7.2.1 of
[1].
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
Shankarkumar et al. Expires September 7, 2011 [Page 13]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
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 [1]"
SYNTAX Integer32 (-128..127)
ClockMechanismType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The clock type based on whether End to End or peer to peer
mechanisms are used. The mechanism used to calculate the
Mean Path Delay as indicated in Table 9 of [IEEE1588-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 "Sections 8.2.5.4.4, 6.6.4 and 7.4.2 of [1]."
SYNTAX INTEGER {
e2e(1),
p2p(2),
disabled(254)
}
ClockInstanceType ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"The instance of the Clock of a given clock type in a given
domain."
SYNTAX Unsigned32 (0..255)
ClockPortNumber ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"An index identifying a specific Precision Time Protocol
(PTP) port on a PTP node."
REFERENCE "Section 7.5.2.3 Port Number and 5.3.5 of [1]"
SYNTAX Unsigned32 (0..65535)
Shankarkumar et al. Expires September 7, 2011 [Page 14]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ClockPortState ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This is the value of the current state of the protocol
engine 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 "Section 8.2.5.3.1 portState and 9.2.5 of [1]"
SYNTAX INTEGER {
initializing(1),
faulty(2),
disabled(3),
listening(4),
preMaster(5),
master(6),
passive(7),
uncalibrated(8),
Shankarkumar et al. Expires September 7, 2011 [Page 15]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
slave(9)
}
ClockProfileType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Clock Profile used. From [1] section 3.1.30, Profile is the
set of allowed Precision Time Protocol (PTP) features
applicable to a device."
REFERENCE "Section 3.1.30 and 19.3 PTP profiles of [1]"
SYNTAX INTEGER {
default(1),
telecom(2),
vendorspecific(3)
}
ClockQualityAccuracyType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The ClockQuality as specified in section 5.3.7, 7.6.2.5 and
Table 6 of [1].
The following values are not represented in the enumerated
values.
0x01-0x1F Reserved
0x32-0x7F Reserved
It is important to note that section 7.1.1 [RFC 2578]
allows for gaps and enumerate values to start with zero when
indicated by the protocol."
REFERENCE "Section 5.3.7, 7.6.2.5 and Table 6 of [1]"
SYNTAX INTEGER {
reserved00(1), -- 0
nanoSecond25(32), -- 0x20
nanoSecond100(33), -- 0x21
nanoSecond250(34), -- 0x22
microSec1(35), -- 0x23
microSec2dot5(36), -- 0x24
microSec10(37), -- 0x25
microSec25(38), -- 0x26
microSec100(39), -- 0x27
microSec250(40), -- 0x28
milliSec1(41), -- 0x29
milliSec2dot5(42), -- 0x2A
milliSec10(43), -- 0x2B
milliSec25(44), -- 0x2C
Shankarkumar et al. Expires September 7, 2011 [Page 16]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
milliSec100(45), -- 0x2D
milliSec250(46), -- 0x2E
second1(47), -- 0x2F
second10(48), -- 0x30
secondGreater10(49), -- 0x31
unknown(254), -- 0xFE
reserved255(255) -- 0xFF
}
ClockQualityClassType ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d"
STATUS current
DESCRIPTION
"The ClockQuality as specified in section 5.3.7, 7.6.2.4 and
Table 5 of [1].
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
Shankarkumar et al. Expires September 7, 2011 [Page 17]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
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 ver. 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 [1]."
SYNTAX Unsigned32 (0..255)
ClockRoleType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The Clock Role. The protocol generates a Master Slave
relationship among the clocks in the system.
Clock Role Value Description
Shankarkumar et al. Expires September 7, 2011 [Page 18]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
------------------------------------------------------------
Master clock 1 A clock that is the source of
time to which all other clocks on
that path synchronize.
Slave clock 2 A clock which synchronizes to
another clock (master)."
SYNTAX INTEGER {
master(1),
slave(2)
}
ClockStateType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The clock state returned by PTP engine.
Clock State Value Description
------------------------------------------------------------
Freerun state 1 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 2 In this state the slave device is
locked to a master but communication
with the master is lost or the
timestamps in the ptp packets are
incorrect. But since the slave was
locked to the master, it can run
with the same accuracy for some
time. The slave can continue to
operate in this state for some time.
If communication with the master is
not restored for a while, the device
is moved to the FREERUN state.
Acquiring state 3 The slave device is receiving
packets from a master and is trying
to acquire a clock.
Freq_locked state 4 The slave device is locked to the
master with respect to frequency,
but not phase aligned
Phase_aligned state 5 The slave device is locked to the
Shankarkumar et al. Expires September 7, 2011 [Page 19]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
master with respect to frequency and
phase."
SYNTAX INTEGER {
freerun(1),
holdover(2),
acquiring(3),
frequencyLocked(4),
phaseAligned(5)
}
ClockTimeSourceType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The ClockQuality as specified in section 5.3.7, 7.6.2.6 and
Table 7 of [1].
The following values are not represented in the enumerated
values.
0xF0-0xFE For use by alternate PTP profiles
0xFF Reserved
It is important to note that section 7.1.1 [RFC 2578]
allows for gaps and enumerate values to start with zero when
indicated by the protocol."
REFERENCE "section 5.3.7, 7.6.2.6 and Table 7 of [1]."
SYNTAX INTEGER {
atomicClock(16), -- 0x10
gps(32), -- 0x20
terrestrialRadio(48), -- 0x22
ptp(64), -- 0x40
ntp(80), -- 0x50
handSet(96), -- 0x60
other(144), -- 0x90
internalOsillator(160) -- 0xA0
}
ClockTimeInterval ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual convention corresponds to the TimeInterval
structure indicated in section 5.3.2 of [1]. It will be
presented in the form of a character array.
The TimeInterval type represents time intervals.
struct TimeInterval
Shankarkumar et al. Expires September 7, 2011 [Page 20]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
{
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 0000 0000 0002 8000 in
Base16."
REFERENCE
"Section 5.3.2 and section 7.7.2.1 Timer interval
specification of [1]"
SYNTAX OCTET STRING (SIZE (1..255))
ClockTxModeType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Transmission mode.
unicast. Using unicast communication channel.
multicast. Using Multicast communication channel.
multicast-mix. Using multicast-unicast comm. channel"
SYNTAX INTEGER {
unicast(1),
multicast(2),
multicastmix(3)
}
ClockType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The clock types as defined in the MIB module description."
REFERENCE "section 6.5.1 of [1]."
SYNTAX INTEGER {
ordinaryClock(1),
boundaryClock(2),
transparentClock(3),
boundaryNode(4)
}
4.2. The Notifications Subtree
Shankarkumar et al. Expires September 7, 2011 [Page 21]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfPtpMIB Notifs OBJECT IDENTIFIER
::= { ietfPtpMIB 0 }
ietfPtpMIB Objects OBJECT IDENTIFIER
::= { ietfPtpMIB 1 }
ietfPtpMIB Conformance OBJECT IDENTIFIER
::= { ietfPtpMIB 2 }
ietfPtpMIB SystemInfo OBJECT IDENTIFIER
::= { ietfPtpMIB Objects 1 }
-- Conformance Information Definition
ietfPtpMIB Compliances OBJECT IDENTIFIER
::= { ietfPtpMIB Conformance 1 }
ietfPtpMIB Groups OBJECT IDENTIFIER
::= { ietfPtpMIB Conformance 2 }
ietfPtpMIB Compliances1 MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"Compliance statement for agents that provide read-only
support for IETF-PTP-MIB. Such devices can only be monitored
using this MIB module.
The Module is implemented with support for read-only. In
other words, only monitoring is available by implementing
this MODULE-COMPLIANCE."
MODULE -- this module
MANDATORY-GROUPS { ietfPtpMIB SystemInfoGroup }
::= { ietfPtpMIB Compliances 1 }
ietfPtpMIB Compliances2 MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"Compliance statement for agents that provide read-only
support for IETF-PTP-MIB. Such devices can only be monitored
using this MIB module.
The Module is implemented with support for read-only. In
other words, only monitoring is available by implementing
this MODULE-COMPLIANCE."
MODULE -- this module
MANDATORY-GROUPS {
ietfPtpMIB ClockCurrentDSGroup,
ietfPtpMIB ClockParentDSGroup,
ietfPtpMIB ClockDefaultDSGroup,
Shankarkumar et al. Expires September 7, 2011 [Page 22]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfPtpMIB ClockRunningGroup,
ietfPtpMIB ClockTimepropertiesGroup
}
::= { ietfPtpMIB Compliances 2 }
ietfPtpMIB Compliances3 MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"Compliance statement for agents that provide read-only
support for IETF-PTP-MIB. Such devices can only be monitored
using this MIB module.
The Module is implemented with support for read-only. In
other words, only monitoring is available by implementing
this MODULE-COMPLIANCE."
MODULE -- this module
MANDATORY-GROUPS {
ietfPtpMIB ClockPortGroup,
ietfPtpMIB ClockPortDSGroup,
ietfPtpMIB ClockPortRunningGroup,
ietfPtpMIB ClockPortAssociateGroup
}
::= { ietfPtpMIB Compliances 3 }
ietfPtpMIB Compliances4 MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"Compliance statement for agents that provide read-only
support for IETF-PTP-MIB. Such devices can only be monitored
using this MIB module.
The Module is implemented with support for read-only. In
other words, only monitoring is available by implementing
this MODULE-COMPLIANCE."
MODULE -- this module
MANDATORY-GROUPS {
ietfPtpMIB ClockTranparentDSGroup,
ietfPtpMIB ClockPortTransDSGroup
}
::= { ietfPtpMIB Compliances 4 }
ietfPtpMIB SystemInfoGroup OBJECT-GROUP
OBJECTS {
ietfptpSystemDomainTotals,
ietfptpDomainClockPortsTotal,
ietfptpSystemProfile
}
STATUS current
Shankarkumar et al. Expires September 7, 2011 [Page 23]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
DESCRIPTION
"Group which aggregates objects describing system-wide
information"
::= { ietfPtpMIB Groups 1 }
ietfPtpMIB ClockCurrentDSGroup OBJECT-GROUP
OBJECTS {
ietfptpClockCurrentDSStepsRemoved,
ietfptpClockCurrentDSOffsetFromMaster,
ietfptpClockCurrentDSMeanPathDelay
}
STATUS current
DESCRIPTION
"Group which aggregates objects describing PTP Current
Dataset information"
::= { ietfPtpMIB Groups 2 }
ietfPtpMIB ClockParentDSGroup OBJECT-GROUP
OBJECTS {
ietfptpClockParentDSParentPortIdentity,
ietfptpClockParentDSParentStats,
ietfptpClockParentDSOffset,
ietfptpClockParentDSClockPhChRate,
ietfptpClockParentDSGMClockIdentity,
ietfptpClockParentDSGMClockPriority1,
ietfptpClockParentDSGMClockPriority2,
ietfptpClockParentDSGMClockQualityClass,
ietfptpClockParentDSGMClockQualityAccuracy,
ietfptpClockParentDSGMClockQualityOffset
}
STATUS current
DESCRIPTION
"Group which aggregates objects describing PTP Parent
Dataset information"
::= { ietfPtpMIB Groups 3 }
ietfPtpMIB ClockDefaultDSGroup OBJECT-GROUP
OBJECTS {
ietfptpClockDefaultDSTwoStepFlag,
ietfptpClockDefaultDSClockIdentity,
ietfptpClockDefaultDSPriority1,
ietfptpClockDefaultDSPriority2,
ietfptpClockDefaultDSSlaveOnly,
ietfptpClockDefaultDSQualityClass,
ietfptpClockDefaultDSQualityAccuracy,
ietfptpClockDefaultDSQualityOffset
}
STATUS current
DESCRIPTION
Shankarkumar et al. Expires September 7, 2011 [Page 24]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
"Group which aggregates objects describing PTP Default
Dataset information"
::= { ietfPtpMIB Groups 4 }
ietfPtpMIB ClockRunningGroup OBJECT-GROUP
OBJECTS {
ietfptpClockRunningState,
ietfptpClockRunningPacketsSent,
ietfptpClockRunningPacketsReceived
}
STATUS current
DESCRIPTION
"Group which aggregates objects describing PTP running state
information"
::= { ietfPtpMIB Groups 5 }
ietfPtpMIB ClockTimepropertiesGroup OBJECT-GROUP
OBJECTS {
ietfptpClockTimePropertiesDSCurrentUTCOffsetValid,
ietfptpClockTimePropertiesDSCurrentUTCOffset,
ietfptpClockTimePropertiesDSLeap59,
ietfptpClockTimePropertiesDSLeap61,
ietfptpClockTimePropertiesDSTimeTraceable,
ietfptpClockTimePropertiesDSFreqTraceable,
ietfptpClockTimePropertiesDSPTPTimescale,
ietfptpClockTimePropertiesDSSource
}
STATUS current
DESCRIPTION
"Group which aggregates objects describing PTP Time
Properties information"
::= { ietfPtpMIB Groups 6 }
ietfPtpMIB ClockTranparentDSGroup OBJECT-GROUP
OBJECTS {
ietfptpClockTransDefaultDSClockIdentity,
ietfptpClockTransDefaultDSNumOfPorts,
ietfptpClockTransDefaultDSDelay,
ietfptpClockTransDefaultDSPrimaryDomain
}
STATUS current
DESCRIPTION
"Group which aggregates objects describing PTP Transparent
Dataset information"
::= { ietfPtpMIB Groups 7 }
ietfPtpMIB ClockPortGroup OBJECT-GROUP
Shankarkumar et al. Expires September 7, 2011 [Page 25]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
OBJECTS {
ietfptpClockPortName,
ietfptpClockPortSyncOneStep,
ietfptpClockPortCurrentPeerAddress,
ietfptpClockPortNumOfAssociatedPorts,
ietfptpClockPortCurrentPeerAddressType,
ietfptpClockPortRole
}
STATUS current
DESCRIPTION
"Group which aggregates objects describing information for a
given PTP Port."
::= { ietfPtpMIB Groups 8 }
ietfPtpMIB ClockPortDSGroup OBJECT-GROUP
OBJECTS {
ietfptpClockPortDSName,
ietfptpClockPortDSPortIdentity,
ietfptpClockPortDSAnnouncementInterval,
ietfptpClockPortDSAnnounceRctTimeout,
ietfptpClockPortDSSyncInterval,
ietfptpClockPortDSMinDelayReqInterval,
ietfptpClockPortDSPeerDelayReqInterval,
ietfptpClockPortDSDelayMech,
ietfptpClockPortDSPeerMeanPathDelay,
ietfptpClockPortDSGrantDuration,
ietfptpClockPortDSPTPVersion
}
STATUS current
DESCRIPTION
"Group which aggregates objects describing PTP Port Dataset
information"
::= { ietfPtpMIB Groups 9 }
ietfPtpMIB ClockPortRunningGroup OBJECT-GROUP
OBJECTS {
ietfptpClockPortRunningName,
ietfptpClockPortRunningState,
ietfptpClockPortRunningRole,
ietfptpClockPortRunningInterfaceIndex,
ietfptpClockPortRunningIPversion,
ietfptpClockPortRunningEncapsulationType,
ietfptpClockPortRunningTxMode,
ietfptpClockPortRunningRxMode,
ietfptpClockPortRunningPacketsReceived,
ietfptpClockPortRunningPacketsSent
}
STATUS current
DESCRIPTION
Shankarkumar et al. Expires September 7, 2011 [Page 26]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
"Group which aggregates objects describing PTP running
interface information"
::= { ietfPtpMIB Groups 10 }
ietfPtpMIB ClockPortTransDSGroup OBJECT-GROUP
OBJECTS {
ietfptpClockPortTransDSPortIdentity,
ietfptpClockPortTransDSlogMinPdelayReqInt,
ietfptpClockPortTransDSFaultyFlag,
ietfptpClockPortTransDSPeerMeanPathDelay
}
STATUS current
DESCRIPTION
"Group which aggregates objects describing PTP TransparentDS
Dataset information"
::= { ietfPtpMIB Groups 11 }
ietfPtpMIB ClockPortAssociateGroup OBJECT-GROUP
OBJECTS {
ietfptpClockPortAssociatePacketsSent,
ietfptpClockPortAssociatePacketsReceived,
ietfptpClockPortAssociateAddress,
ietfptpClockPortAssociateAddressType,
ietfptpClockPortAssociateInErrors,
ietfptpClockPortAssociateOutErrors
}
STATUS current
DESCRIPTION
"Group which aggregates objects describing information on
peer PTP ports for a given PTP clock-port."
::= { ietfPtpMIB Groups 12 }
ietfPtpMIB ClockInfo OBJECT IDENTIFIER
::= { ietfPtpMIB Objects 2 }
4.3. The Table Structures
ietfptpSystemTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpSystemEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of count information about the PTP system for all
domains."
::= { ietfPtpMIB SystemInfo 1 }
ietfptpSystemEntry OBJECT-TYPE
SYNTAX ietfptpSystemEntry
MAX-ACCESS not-accessible
Shankarkumar et al. Expires September 7, 2011 [Page 27]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
STATUS current
DESCRIPTION
"An entry in the table, containing count information about a
single domain. New row entries are added when the PTP clock
for this domain is configured, while the unconfiguration of
the PTP clock removes it."
INDEX {
ietfptpDomainIndex,
ietfptpInstanceIndex
}
::= { ietfptpSystemTable 1 }
ietfptpSystemEntry ::= SEQUENCE {
ietfptpDomainIndex
ClockDomainType,
ietfptpInstanceIndex
ClockInstanceType,
ietfptpDomainClockPortsTotal Gauge32
}
ietfptpDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices. The Clock Domain is a logical
group of clocks and devices that synchronize with each other
using the PTP protocol.
0 Default domain
1 Alternate domain 1
2 Alternate domain 2
3 Alternate domain 3
4 - 127 User-defined domains
128 - 255 Reserved"
::= { ietfptpSystemEntry 1 }
ietfptpInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the Clock for this
domain."
::= { ietfptpSystemEntry 2 }
ietfptpDomainClockPortsTotal OBJECT-TYPE
SYNTAX Gauge32
Shankarkumar et al. Expires September 7, 2011 [Page 28]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
UNITS "ptp ports"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the total number of clock ports
configured within a domain."
::= { ietfptpSystemEntry 3 }
ietfptpSystemDomainTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpSystemDomainEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the PTP system for all clock
modes -- ordinary, boundary or transparent."
::= { ietfPtpMIB SystemInfo 2 }
ietfptpSystemDomainEntry OBJECT-TYPE
SYNTAX ietfptpSystemDomainEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
single clock mode for the PTP system. A row entry gets added
when PTP clocks are configured on the router."
INDEX { ietfptpSystemDomainClockTypeIndex }
::= { ietfptpSystemDomainTable 1 }
ietfptpSystemDomainEntry ::= SEQUENCE {
ietfptpSystemDomainClockTypeIndex ClockType,
ietfptpSystemDomainTotals Gauge32
}
ietfptpSystemDomainClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the clock type as defined in the
Textual convention description."
::= { ietfptpSystemDomainEntry 1 }
ietfptpSystemDomainTotals OBJECT-TYPE
SYNTAX Gauge32
UNITS "domains"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the total number of PTP domains for
Shankarkumar et al. Expires September 7, 2011 [Page 29]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
this particular clock type configured in this node."
::= { ietfptpSystemDomainEntry 2 }
ietfptpClockNodeTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockNodeEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the PTP system for a given
domain."
::= { ietfPtpMIB SystemInfo 3 }
ietfptpClockNodeEntry OBJECT-TYPE
SYNTAX ietfptpClockNodeEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
single domain. A entry is added when a new PTP clock domain
is configured on the router."
INDEX {
ietfptpClockDomainIndex,
ietfptpClockTypeIndex,
ietfptpClockInstanceIndex
}
::= { ietfptpClockNodeTable 1 }
ietfptpClockNodeEntry ::= SEQUENCE {
ietfptpClockDomainIndex ClockDomainType,
ietfptpClockTypeIndex ClockType,
ietfptpClockInstanceIndex ClockInstanceType,
ietfptpSystemProfile ClockProfileType
}
ietfptpClockDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
::= { ietfptpClockNodeEntry 1 }
ietfptpClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the clock type as defined in the
Shankarkumar et al. Expires September 7, 2011 [Page 30]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
Textual convention description."
::= { ietfptpClockNodeEntry 2 }
ietfptpClockInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the Clock for this
clock type for the given domain."
::= { ietfptpClockNodeEntry 3 }
ietfptpSystemProfile OBJECT-TYPE
SYNTAX ClockProfileType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the PTP Profile implemented on the
system."
REFERENCE "Section 19.3 PTP profiles of [1]"
::= { ietfPtpMIB SystemInfo 1 }
ietfptpClockCurrentDSTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockCurrentDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the PTP clock Current Datasets
for all domains."
::= { ietfPtpMIB ClockInfo 1 }
ietfptpClockCurrentDSEntry OBJECT-TYPE
SYNTAX ietfptpClockCurrentDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
single PTP clock Current Datasets for a domain."
REFERENCE
"[IEEE1588-2008] Section 8.2.2 currentDS data set member
specifications of [1]"
INDEX {
ietfptpClockCurrentDSDomainIndex,
ietfptpClockCurrentDSClockTypeIndex,
ietfptpClockCurrentDSInstanceIndex
}
::= { ietfptpClockCurrentDSTable 1 }
Shankarkumar et al. Expires September 7, 2011 [Page 31]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockCurrentDSEntry ::= SEQUENCE {
ietfptpClockCurrentDSDomainIndex ClockDomainType,
ietfptpClockCurrentDSClockTypeIndex ClockType,
ietfptpClockCurrentDSInstanceIndex ClockInstanceType,
ietfptpClockCurrentDSStepsRemoved Counter32,
ietfptpClockCurrentDSOffsetFromMaster ClockTimeInterval,
ietfptpClockCurrentDSMeanPathDelay ClockTimeInterval
}
ietfptpClockCurrentDSDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
::= { ietfptpClockCurrentDSEntry 1 }
ietfptpClockCurrentDSClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the clock type as defined in the
Textual convention description."
::= { ietfptpClockCurrentDSEntry 2 }
ietfptpClockCurrentDSInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
::= { ietfptpClockCurrentDSEntry 3 }
ietfptpClockCurrentDSStepsRemoved OBJECT-TYPE
SYNTAX Counter32
UNITS "steps"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current clock dataset StepsRemoved value.
This object specifies the distance measured by the number of
boundary clocks between the local clock and the Foreign
master as indicated in the stepsRemoved field of Announce
messages."
REFERENCE "[IEEE1588-2008] Section 8.2.2.2 stepsRemoved"
Shankarkumar et al. Expires September 7, 2011 [Page 32]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
::= { ietfptpClockCurrentDSEntry 4 }
ietfptpClockCurrentDSOffsetFromMaster OBJECT-TYPE
SYNTAX ClockTimeInterval
UNITS "Time Interval"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the current clock dataset ClockOffset
value. The value of the computation of the offset in time
between
a slave and a master clock."
REFERENCE "[IEEE1588-2008] Section 8.2.2.3 of [1]"
::= { ietfptpClockCurrentDSEntry 5 }
ietfptpClockCurrentDSMeanPathDelay OBJECT-TYPE
SYNTAX ClockTimeInterval
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the current clock dataset
MeanPathDelay value.
The mean path delay between a pair of ports as measure by
the delay request-response mechanism."
REFERENCE "[IEEE1588-2008] Section 8.2.2.4 mean path
delay"
::= { ietfptpClockCurrentDSEntry 6 }
ietfptpClockParentDSTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockParentDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the PTP clock Parent Datasets
for all domains."
::= { ietfPtpMIB ClockInfo 2 }
ietfptpClockParentDSEntry OBJECT-TYPE
SYNTAX ietfptpClockParentDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
single PTP clock Parent Datasets for a domain."
REFERENCE
"Section 8.2.3 parentDS data set member specifications of
[1]"
INDEX {
Shankarkumar et al. Expires September 7, 2011 [Page 33]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockParentDSDomainIndex,
ietfptpClockParentDSClockTypeIndex,
ietfptpClockParentDSInstanceIndex
}
::= { ietfptpClockParentDSTable 1 }
ietfptpClockParentDSEntry ::= SEQUENCE {
ietfptpClockParentDSDomainIndex ClockDomainType,
ietfptpClockParentDSClockTypeIndex ClockType,
ietfptpClockParentDSInstanceIndex ClockInstanceType,
ietfptpClockParentDSParentPortIdentity OCTET STRING,
ietfptpClockParentDSParentStats TruthValue,
ietfptpClockParentDSOffset ClockIntervalBase2,
ietfptpClockParentDSClockPhChRate Integer32,
ietfptpClockParentDSGMClockIdentity ClockIdentity,
ietfptpClockParentDSGMClockPriority1 Integer32,
ietfptpClockParentDSGMClockPriority2 Integer32,
ietfptpClockParentDSGMClockQualityClass
ClockQualityClassType,
ietfptpClockParentDSGMClockQualityAccuracy
ClockQualityAccuracyType,
ietfptpClockParentDSGMClockQualityOffset Unsigned32
}
ietfptpClockParentDSDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
::= { ietfptpClockParentDSEntry 1 }
ietfptpClockParentDSClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the clock type as defined in the
Textual convention description."
::= { ietfptpClockParentDSEntry 2 }
ietfptpClockParentDSInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
Shankarkumar et al. Expires September 7, 2011 [Page 34]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
::= { ietfptpClockParentDSEntry 3 }
ietfptpClockParentDSParentPortIdentity OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the value of portIdentity of the port
on the master that issues the Sync messages used in
synchronizing this clock."
REFERENCE
"section 8.2.3.2 parentDS.parentPortIdentity of [1]"
::= { ietfptpClockParentDSEntry 4 }
ietfptpClockParentDSParentStats OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Parent Dataset ParentStats value.
This value indicates whether the values of ParentDSOffset
and ParentDSClockPhChRate have been measured and are valid.
A TRUE value shall indicate valid data."
REFERENCE "section 8.2.3.3 parentDS.parentStats of [1]"
::= { ietfptpClockParentDSEntry 5 }
ietfptpClockParentDSOffset OBJECT-TYPE
SYNTAX ClockIntervalBase2 (-128..127)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Parent Dataset
ParentOffsetScaledLogVariance value.
This value is the variance of the parent clocks phase as
measured by the local clock."
REFERENCE
"section 8.2.3.4
parentDS.observedParentOffsetScaledLogVariance [1]"
::= { ietfptpClockParentDSEntry 6 }
ietfptpClockParentDSClockPhChRate OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the clock's parent dataset
ParentClockPhaseChangeRate value.
Shankarkumar et al. Expires September 7, 2011 [Page 35]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
This value is an estimate of the parent clocks phase change
rate as measured by the slave clock."
REFERENCE
"section 8.2.3.5
parentDS.observedParentClockPhaseChangeRate of [1]"
::= { ietfptpClockParentDSEntry 7 }
ietfptpClockParentDSGMClockIdentity OBJECT-TYPE
SYNTAX ClockIdentity
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the parent dataset Grandmaster clock
identity."
REFERENCE
"section 8.2.3.6 parentDS.grandmasterIdentity of [1]"
::= { ietfptpClockParentDSEntry 8 }
ietfptpClockParentDSGMClockPriority1 OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the parent dataset Grandmaster clock
priority1."
REFERENCE
"section 8.2.3.8 parentDS.grandmasterPriority1 of [1]"
::= { ietfptpClockParentDSEntry 9 }
ietfptpClockParentDSGMClockPriority2 OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the parent dataset grandmaster clock
priority2."
REFERENCE
"section 8.2.3.9 parentDS.grandmasterPriority2 of [1]"
::= { ietfptpClockParentDSEntry 10 }
ietfptpClockParentDSGMClockQualityClass OBJECT-TYPE
SYNTAX ClockQualityClassType (0..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the parent dataset grandmaster clock
quality class."
REFERENCE
Shankarkumar et al. Expires September 7, 2011 [Page 36]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
"section 8.2.3.7 parentDS.grandmasterClockQuality of [1]"
::= { ietfptpClockParentDSEntry 11 }
ietfptpClockParentDSGMClockQualityAccuracy OBJECT-TYPE
SYNTAX ClockQualityAccuracyType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the parent dataset grandmaster clock
quality accuracy."
REFERENCE
"section 8.2.3.7 parentDS.grandmasterClockQuality of [1]"
::= { ietfptpClockParentDSEntry 12 }
ietfptpClockParentDSGMClockQualityOffset OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the parent dataset grandmaster clock
quality offset."
REFERENCE
"section 8.2.3.7 parentDS.grandmasterClockQuality of [1]"
::= { ietfptpClockParentDSEntry 13 }
ietfptpClockDefaultDSTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockDefaultDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the PTP clock Default Datasets
for all domains."
::= { ietfPtpMIB ClockInfo 3 }
ietfptpClockDefaultDSEntry OBJECT-TYPE
SYNTAX ietfptpClockDefaultDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
single PTP clock Default Datasets for a domain."
INDEX {
ietfptpClockDefaultDSDomainIndex,
ietfptpClockDefaultDSClockTypeIndex,
ietfptpClockDefaultDSInstanceIndex
}
::= { ietfptpClockDefaultDSTable 1 }
ietfptpClockDefaultDSEntry ::= SEQUENCE {
Shankarkumar et al. Expires September 7, 2011 [Page 37]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockDefaultDSDomainIndex ClockDomainType,
ietfptpClockDefaultDSClockTypeIndex ClockType,
ietfptpClockDefaultDSInstanceIndex ClockInstanceType,
ietfptpClockDefaultDSTwoStepFlag TruthValue,
ietfptpClockDefaultDSClockIdentity ClockIdentity,
ietfptpClockDefaultDSPriority1 Integer32,
ietfptpClockDefaultDSPriority2 Integer32,
ietfptpClockDefaultDSSlaveOnly TruthValue,
ietfptpClockDefaultDSQualityClass ClockQualityClassType,
ietfptpClockDefaultDSQualityAccuracy ClockQualityAccuracyType,
ietfptpClockDefaultDSQualityOffset Integer32
}
ietfptpClockDefaultDSDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
::= { ietfptpClockDefaultDSEntry 1 }
ietfptpClockDefaultDSClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the clock type as defined in the
Textual convention description."
::= { ietfptpClockDefaultDSEntry 2 }
ietfptpClockDefaultDSInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
::= { ietfptpClockDefaultDSEntry 3 }
ietfptpClockDefaultDSTwoStepFlag OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies whether the Two Step process is
used."
::= { ietfptpClockDefaultDSEntry 4 }
Shankarkumar et al. Expires September 7, 2011 [Page 38]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockDefaultDSClockIdentity OBJECT-TYPE
SYNTAX ClockIdentity
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the default Datasets clock identity."
::= { ietfptpClockDefaultDSEntry 5 }
ietfptpClockDefaultDSPriority1 OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the default Datasets clock
Priority1."
::= { ietfptpClockDefaultDSEntry 6 }
ietfptpClockDefaultDSPriority2 OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the default Datasets clock
Priority2."
::= { ietfptpClockDefaultDSEntry 7 }
ietfptpClockDefaultDSSlaveOnly OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Whether the SlaveOnly flag is set."
::= { ietfptpClockDefaultDSEntry 8 }
ietfptpClockDefaultDSQualityClass OBJECT-TYPE
SYNTAX ClockQualityClassType (0..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the default dataset Quality Class."
::= { ietfptpClockDefaultDSEntry 9 }
ietfptpClockDefaultDSQualityAccuracy OBJECT-TYPE
SYNTAX ClockQualityAccuracyType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the default dataset Quality
Accuracy."
Shankarkumar et al. Expires September 7, 2011 [Page 39]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
::= { ietfptpClockDefaultDSEntry 10 }
ietfptpClockDefaultDSQualityOffset OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the default dataset Quality offset."
::= { ietfptpClockDefaultDSEntry 11 }
ietfptpClockRunningTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockRunningEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the PTP clock Running Datasets
for all domains."
::= { ietfPtpMIB ClockInfo 4 }
ietfptpClockRunningEntry OBJECT-TYPE
SYNTAX ietfptpClockRunningEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
single PTP clock running Datasets for a domain."
INDEX {
ietfptpClockRunningDomainIndex,
ietfptpClockRunningClockTypeIndex,
ietfptpClockRunningInstanceIndex
}
::= { ietfptpClockRunningTable 1 }
ietfptpClockRunningEntry ::= SEQUENCE {
ietfptpClockRunningDomainIndex ClockDomainType,
ietfptpClockRunningClockTypeIndex ClockType,
ietfptpClockRunningInstanceIndex ClockInstanceType,
ietfptpClockRunningState ClockStateType,
ietfptpClockRunningPacketsSent Counter64,
ietfptpClockRunningPacketsReceived Counter64
}
ietfptpClockRunningDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
Shankarkumar et al. Expires September 7, 2011 [Page 40]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
::= { ietfptpClockRunningEntry 1 }
ietfptpClockRunningClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the clock type as defined in the
Textual convention description."
::= { ietfptpClockRunningEntry 2 }
ietfptpClockRunningInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
::= { ietfptpClockRunningEntry 3 }
ietfptpClockRunningState OBJECT-TYPE
SYNTAX ClockStateType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Clock state returned by PTP
engine which was described earlier.
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 is lost or the
timestamps in the ptp packets are incorrect. But since the
slave was locked to the master, it can run with the same
accuracy for sometime. The slave can continue to operate in
this state for some time. If communication with the master
is not restored for a while, the device is moved 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. The slave device is locked to the master
with respect to frequency, but is not phase aligned.
Shankarkumar et al. Expires September 7, 2011 [Page 41]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
Phase_aligned state. The slave device is locked to the
master with respect to frequency and phase."
::= { ietfptpClockRunningEntry 4 }
ietfptpClockRunningPacketsSent OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the total number of all packet
Unicast and multicast that have been sent out for this clock
in this domain for this type."
::= { ietfptpClockRunningEntry 5 }
ietfptpClockRunningPacketsReceived OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the total number of all packet
Unicast and multicast that have been received for this clock
in this domain for this type."
::= { ietfptpClockRunningEntry 6 }
ietfptpClockTimePropertiesDSTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockTimePropertiesDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the PTP clock Timeproperties
Datasets for all domains."
::= { ietfPtpMIB ClockInfo 5 }
ietfptpClockTimePropertiesDSEntry OBJECT-TYPE
SYNTAX ietfptpClockTimePropertiesDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
single PTP clock timeproperties Datasets for a domain."
REFERENCE "Section 8.2.4 of [1]"
INDEX {
ietfptpClockTimePropertiesDSDomainIndex,
ietfptpClockTimePropertiesDSClockTypeIndex,
ietfptpClockTimePropertiesDSInstanceIndex
}
::= { ietfptpClockTimePropertiesDSTable 1 }
ietfptpClockTimePropertiesDSEntry ::= SEQUENCE {
Shankarkumar et al. Expires September 7, 2011 [Page 42]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockTimePropertiesDSDomainIndex
ClockDomainType,
ietfptpClockTimePropertiesDSClockTypeIndex ClockType,
ietfptpClockTimePropertiesDSInstanceIndex
ClockInstanceType,
ietfptpClockTimePropertiesDSCurrentUTCOffsetValid TruthValue,
ietfptpClockTimePropertiesDSCurrentUTCOffset Integer32,
ietfptpClockTimePropertiesDSLeap59 TruthValue,
ietfptpClockTimePropertiesDSLeap61 TruthValue,
ietfptpClockTimePropertiesDSTimeTraceable TruthValue,
ietfptpClockTimePropertiesDSFreqTraceable TruthValue,
ietfptpClockTimePropertiesDSPTPTimescale TruthValue,
ietfptpClockTimePropertiesDSSource
ClockTimeSourceType
}
ietfptpClockTimePropertiesDSDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
::= { ietfptpClockTimePropertiesDSEntry 1 }
ietfptpClockTimePropertiesDSClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the clock type as defined in the
Textual convention description."
::= { ietfptpClockTimePropertiesDSEntry 2 }
ietfptpClockTimePropertiesDSInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
::= { ietfptpClockTimePropertiesDSEntry 3 }
ietfptpClockTimePropertiesDSCurrentUTCOffsetValid OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the timeproperties dataset value of
Shankarkumar et al. Expires September 7, 2011 [Page 43]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
whether current UTC offset is valid."
REFERENCE "Section 8.2.4.2 of [1]"
::= { ietfptpClockTimePropertiesDSEntry 4 }
ietfptpClockTimePropertiesDSCurrentUTCOffset OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the timeproperties dataset value of
current UTC offset.
In PTP systems whose epoch is the PTP epoch, the value of
timePropertiesDS.currentUtcOffset is the offset
between TAI and UTC; otherwise the value has no meaning. The
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 "Section 8.2.4.3 of [1]"
::= { ietfptpClockTimePropertiesDSEntry 5 }
ietfptpClockTimePropertiesDSLeap59 OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Leap59 value in the clock Current
Dataset."
REFERENCE "Section 8.2.4.4 of [1]"
::= { ietfptpClockTimePropertiesDSEntry 6 }
ietfptpClockTimePropertiesDSLeap61 OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Leap61 value in the clock Current
Dataset."
REFERENCE "Section 8.2.4.5 of [1]"
::= { ietfptpClockTimePropertiesDSEntry 7 }
ietfptpClockTimePropertiesDSTimeTraceable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
Shankarkumar et al. Expires September 7, 2011 [Page 44]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
STATUS current
DESCRIPTION
"This object specifies the Timetraceable value in the clock
Current Dataset."
REFERENCE "Section 8.2.4.6 of [1]"
::= { ietfptpClockTimePropertiesDSEntry 8 }
ietfptpClockTimePropertiesDSFreqTraceable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Frequency Traceable value in the
clock Current Dataset."
REFERENCE "Section 8.2.4.7 of [1]"
::= { ietfptpClockTimePropertiesDSEntry 9 }
ietfptpClockTimePropertiesDSPTPTimescale OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the PTP Timescale value in the clock
Current Dataset."
REFERENCE "Section 8.2.4.8 of [1]"
::= { ietfptpClockTimePropertiesDSEntry 10 }
ietfptpClockTimePropertiesDSSource OBJECT-TYPE
SYNTAX ClockTimeSourceType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Timesource value in the clock
Current Dataset."
REFERENCE "Section 8.2.4.9 of [1]"
::= { ietfptpClockTimePropertiesDSEntry 11 }
ietfptpClockTransDefaultDSTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockTransDefaultDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the PTP transparent clock
Default Datasets for all domains."
::= { ietfPtpMIB ClockInfo 6 }
ietfptpClockTransDefaultDSEntry OBJECT-TYPE
SYNTAX ietfptpClockTransDefaultDSEntry
MAX-ACCESS not-accessible
Shankarkumar et al. Expires September 7, 2011 [Page 45]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
single PTP transparent clock Default Datasets for a domain."
REFERENCE "Section 8.3.2 of [1]"
INDEX {
ietfptpClockTransDefaultDSDomainIndex,
ietfptpClockTransDefaultDSInstanceIndex
}
::= { ietfptpClockTransDefaultDSTable 1 }
ietfptpClockTransDefaultDSEntry ::= SEQUENCE {
ietfptpClockTransDefaultDSDomainIndex ClockDomainType,
ietfptpClockTransDefaultDSInstanceIndex ClockInstanceType,
ietfptpClockTransDefaultDSClockIdentity ClockIdentity,
ietfptpClockTransDefaultDSNumOfPorts Counter32,
ietfptpClockTransDefaultDSDelay ClockMechanismType,
ietfptpClockTransDefaultDSPrimaryDomain Integer32
}
ietfptpClockTransDefaultDSDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
::= { ietfptpClockTransDefaultDSEntry 1 }
ietfptpClockTransDefaultDSInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
::= { ietfptpClockTransDefaultDSEntry 2 }
ietfptpClockTransDefaultDSClockIdentity OBJECT-TYPE
SYNTAX ClockIdentity
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the value of the clockIdentity
attribute of the local clock."
REFERENCE "Section 8.3.2.2.1 of [1]"
::= { ietfptpClockTransDefaultDSEntry 3 }
ietfptpClockTransDefaultDSNumOfPorts OBJECT-TYPE
Shankarkumar et al. Expires September 7, 2011 [Page 46]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the number of PTP ports of the
device."
REFERENCE "Section 8.3.2.2.2 of [1]"
::= { ietfptpClockTransDefaultDSEntry 4 }
ietfptpClockTransDefaultDSDelay OBJECT-TYPE
SYNTAX ClockMechanismType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object, if the transparent clock is an end-to-end
transparent clock, has the value shall be E2E; If the
transparent clock is a peer-to-peer transparent clock, the
value shall be P2P."
REFERENCE "Section 8.3.2.3.1 of [1]"
::= { ietfptpClockTransDefaultDSEntry 5 }
ietfptpClockTransDefaultDSPrimaryDomain OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the value of the primary
syntonization domain. The initialization value shall be 0."
REFERENCE "Section 8.3.2.3.2 of [1]"
::= { ietfptpClockTransDefaultDSEntry 6 }
ietfptpClockPortTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockPortEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the clock ports for a particular
domain."
::= { ietfPtpMIB ClockInfo 7 }
ietfptpClockPortEntry OBJECT-TYPE
SYNTAX ietfptpClockPortEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
single clock port."
INDEX {
ietfptpClockPortDomainIndex,
Shankarkumar et al. Expires September 7, 2011 [Page 47]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockPortClockTypeIndex,
ietfptpClockPortClockInstanceIndex,
ietfptpClockPortTablePortNumberIndex
}
::= { ietfptpClockPortTable 1 }
ietfptpClockPortEntry ::= SEQUENCE {
ietfptpClockPortDomainIndex ClockDomainType,
ietfptpClockPortClockTypeIndex ClockType,
ietfptpClockPortClockInstanceIndex ClockInstanceType,
ietfptpClockPortTablePortNumberIndex ClockPortNumber,
ietfptpClockPortName DisplayString,
ietfptpClockPortRole ClockRoleType,
ietfptpClockPortSyncOneStep TruthValue,
ietfptpClockPortCurrentPeerAddressType InetAddressType,
ietfptpClockPortCurrentPeerAddress InetAddress,
ietfptpClockPortNumOfAssociatedPorts Gauge32
}
ietfptpClockPortDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
::= { ietfptpClockPortEntry 1 }
ietfptpClockPortClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the clock type as defined in the
Textual convention description."
::= { ietfptpClockPortEntry 2 }
ietfptpClockPortClockInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
::= { ietfptpClockPortEntry 3 }
ietfptpClockPortTablePortNumberIndex OBJECT-TYPE
SYNTAX ClockPortNumber (1..65535)
MAX-ACCESS not-accessible
Shankarkumar et al. Expires September 7, 2011 [Page 48]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
STATUS current
DESCRIPTION
"This object specifies the PTP Portnumber for this port."
::= { ietfptpClockPortEntry 4 }
ietfptpClockPortName OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..64))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the PTP clock port name configured on
the router."
::= { ietfptpClockPortEntry 5 }
ietfptpClockPortRole OBJECT-TYPE
SYNTAX ClockRoleType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object describes the current role (slave/master) of
the port."
::= { ietfptpClockPortEntry 6 }
ietfptpClockPortSyncOneStep OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies that one-step clock operation between
the PTP master and slave device is enabled."
::= { ietfptpClockPortEntry 7 }
ietfptpClockPortCurrentPeerAddressType OBJECT-TYPE
SYNTAX InetAddressType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the current peer's network address
used for PTP communication. Based on the scenario and the
setup involved, the values might look like these -
Scenario Value
------------------- ----------------
Single Master master port
Multiple Masters selected master port
Single Slave slave port
Multiple Slaves <empty>
(In relevant setups, information on available
slaves and available masters will be available through
Shankarkumar et al. Expires September 7, 2011 [Page 49]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockPortAssociateTable)"
::= { ietfptpClockPortEntry 8 }
ietfptpClockPortCurrentPeerAddress OBJECT-TYPE
SYNTAX InetAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the current peer's network address
used for PTP communication. Based on the scenario and the
setup involved, the values might look like these -
Scenario Value
------------------- ----------------
Single Master master port
Multiple Masters selected master port
Single Slave slave port
Multiple Slaves <empty>
(In relevant setups, information on available
slaves and available masters will be available through
ietfptpClockPortAssociateTable)"
::= { ietfptpClockPortEntry 9 }
ietfptpClockPortNumOfAssociatedPorts OBJECT-TYPE
SYNTAX Gauge32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies -
For a master port - the number of PTP slave sessions (peers)
associated with this PTP port.
For a slave port - the number of masters available to this
slave port (might or might not be peered)."
::= { ietfptpClockPortEntry 10 }
ietfptpClockPortDSTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockPortDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the clock ports dataset for a
particular domain."
::= { ietfPtpMIB ClockInfo 8 }
ietfptpClockPortDSEntry OBJECT-TYPE
SYNTAX ietfptpClockPortDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
Shankarkumar et al. Expires September 7, 2011 [Page 50]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
"An entry in the table, containing port dataset information
for a single clock port."
INDEX {
ietfptpClockPortDSDomainIndex,
ietfptpClockPortDSClockTypeIndex,
ietfptpClockPortDSClockInstanceIndex,
ietfptpClockPortDSPortNumberIndex
}
::= { ietfptpClockPortDSTable 1 }
ietfptpClockPortDSEntry ::= SEQUENCE {
ietfptpClockPortDSDomainIndex ClockDomainType,
ietfptpClockPortDSClockTypeIndex ClockType,
ietfptpClockPortDSClockInstanceIndex ClockInstanceType,
ietfptpClockPortDSPortNumberIndex ClockPortNumber,
ietfptpClockPortDSName DisplayString,
ietfptpClockPortDSPortIdentity OCTET STRING,
ietfptpClockPortDSAnnouncementInterval Integer32,
ietfptpClockPortDSAnnounceRctTimeout Integer32,
ietfptpClockPortDSSyncInterval Integer32,
ietfptpClockPortDSMinDelayReqInterval Integer32,
ietfptpClockPortDSPeerDelayReqInterval Integer32,
ietfptpClockPortDSDelayMech ClockMechanismType,
ietfptpClockPortDSPeerMeanPathDelay ClockTimeInterval,
ietfptpClockPortDSGrantDuration Unsigned32,
ietfptpClockPortDSPTPVersion Integer32
}
ietfptpClockPortDSDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
::= { ietfptpClockPortDSEntry 1 }
ietfptpClockPortDSClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the clock type as defined in the
Textual convention description."
::= { ietfptpClockPortDSEntry 2 }
ietfptpClockPortDSClockInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
Shankarkumar et al. Expires September 7, 2011 [Page 51]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
::= { ietfptpClockPortDSEntry 3 }
ietfptpClockPortDSPortNumberIndex OBJECT-TYPE
SYNTAX ClockPortNumber (1..65535)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the PTP portnumber associated with
this PTP port."
::= { ietfptpClockPortDSEntry 4 }
ietfptpClockPortDSName OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..64))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the PTP clock port name."
::= { ietfptpClockPortDSEntry 5 }
ietfptpClockPortDSPortIdentity OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the PTP clock port Identity."
::= { ietfptpClockPortDSEntry 6 }
ietfptpClockPortDSAnnouncementInterval OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Announce message transmission
interval associated with this clock port."
::= { ietfptpClockPortDSEntry 7 }
ietfptpClockPortDSAnnounceRctTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Announce receipt timeout
associated with this clock port."
::= { ietfptpClockPortDSEntry 8 }
Shankarkumar et al. Expires September 7, 2011 [Page 52]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockPortDSSyncInterval OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Sync message transmission
interval."
::= { ietfptpClockPortDSEntry 9 }
ietfptpClockPortDSMinDelayReqInterval OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Delay_Req message transmission
interval."
::= { ietfptpClockPortDSEntry 10 }
ietfptpClockPortDSPeerDelayReqInterval OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the Pdelay_Req message transmission
interval."
::= { ietfptpClockPortDSEntry 11 }
ietfptpClockPortDSDelayMech OBJECT-TYPE
SYNTAX ClockMechanismType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the delay mechanism used. If the
clock is an end-to-end clock, the value of the is e2e, else
if the clock is a peer to-peer clock, the value shall be
p2p."
::= { ietfptpClockPortDSEntry 12 }
ietfptpClockPortDSPeerMeanPathDelay OBJECT-TYPE
SYNTAX ClockTimeInterval
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the peer meanPathDelay."
::= { ietfptpClockPortDSEntry 13 }
ietfptpClockPortDSGrantDuration OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
Shankarkumar et al. Expires September 7, 2011 [Page 53]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
STATUS current
DESCRIPTION
"This object specifies the grant duration allocated by the
master."
::= { ietfptpClockPortDSEntry 14 }
ietfptpClockPortDSPTPVersion OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the PTP version being used."
::= { ietfptpClockPortDSEntry 15 }
ietfptpClockPortRunningTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockPortRunningEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the clock ports running dataset
for a particular domain."
::= { ietfPtpMIB ClockInfo 9 }
ietfptpClockPortRunningEntry OBJECT-TYPE
SYNTAX ietfptpClockPortRunningEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing runing dataset
information about a single clock port."
INDEX {
ietfptpClockPortRunningDomainIndex,
ietfptpClockPortRunningClockTypeIndex,
ietfptpClockPortRunningClockInstanceIndex,
ietfptpClockPortRunningPortNumberIndex
}
::= { ietfptpClockPortRunningTable 1 }
ietfptpClockPortRunningEntry ::= SEQUENCE {
ietfptpClockPortRunningDomainIndex ClockDomainType,
ietfptpClockPortRunningClockTypeIndex ClockType,
ietfptpClockPortRunningClockInstanceIndex ClockInstanceType,
ietfptpClockPortRunningPortNumberIndex ClockPortNumber,
ietfptpClockPortRunningName DisplayString,
ietfptpClockPortRunningState ClockPortState,
ietfptpClockPortRunningRole ClockRoleType,
Shankarkumar et al. Expires September 7, 2011 [Page 54]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockPortRunningInterfaceIndex
InterfaceIndexOrZero,
ietfptpClockPortRunningIPversion Integer32,
ietfptpClockPortRunningEncapsulationType Integer32,
ietfptpClockPortRunningTxMode ClockTxModeType,
ietfptpClockPortRunningRxMode ClockTxModeType,
ietfptpClockPortRunningPacketsReceived Counter64,
ietfptpClockPortRunningPacketsSent Counter64
}
ietfptpClockPortRunningDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
::= { ietfptpClockPortRunningEntry 1 }
ietfptpClockPortRunningClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the clock type as defined in the
Textual convention description."
::= { ietfptpClockPortRunningEntry 2 }
ietfptpClockPortRunningClockInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
::= { ietfptpClockPortRunningEntry 3 }
ietfptpClockPortRunningPortNumberIndex OBJECT-TYPE
SYNTAX ClockPortNumber (1..65535)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the PTP portnumber associated with
this clock port."
::= { ietfptpClockPortRunningEntry 4 }
ietfptpClockPortRunningName OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..64))
MAX-ACCESS read-only
Shankarkumar et al. Expires September 7, 2011 [Page 55]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
STATUS current
DESCRIPTION
"This object specifies the PTP clock port name."
::= { ietfptpClockPortRunningEntry 5 }
ietfptpClockPortRunningState OBJECT-TYPE
SYNTAX ClockPortState
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the port state returned by PTP
engine.
initializing - In this state a port initializes
its data sets, hardware, and
communication facilities.
faulty - The fault state of the protocol.
disabled - The port shall not place any
messages on its communication path.
listening - The port is waiting for the
announceReceiptTimeout to expire or
to receive an Announce message from
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."
::= { ietfptpClockPortRunningEntry 6 }
ietfptpClockPortRunningRole OBJECT-TYPE
SYNTAX ClockRoleType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Shankarkumar et al. Expires September 7, 2011 [Page 56]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
"This object specifies the Clock Role."
::= { ietfptpClockPortRunningEntry 7 }
ietfptpClockPortRunningInterfaceIndex OBJECT-TYPE
SYNTAX InterfaceIndexOrZero
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the interface on the router being
used by the PTP Clock for PTP communication."
::= { ietfptpClockPortRunningEntry 8 }
ietfptpClockPortRunningIPversion OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the IP version being used for PTP
communication (the mapping used)."
::= { ietfptpClockPortRunningEntry 9 }
ietfptpClockPortRunningEncapsulationType OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the type of encapsulation if the
interface is adding extra layers (eg. VLAN, Pseudowire
encapsulation...) for the PTP messages."
::= { ietfptpClockPortRunningEntry 10 }
ietfptpClockPortRunningTxMode OBJECT-TYPE
SYNTAX ClockTxModeType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the clock transmission mode as
unicast: Using unicast communication channel.
multicast: Using Multicast communication channel.
multicast-mix: Using multicast-unicast comm. channel"
::= { ietfptpClockPortRunningEntry 11 }
ietfptpClockPortRunningRxMode OBJECT-TYPE
SYNTAX ClockTxModeType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the clock receive mode as
Shankarkumar et al. Expires September 7, 2011 [Page 57]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
unicast: Using unicast communication channel.
multicast: Using Multicast communication channel.
multicast-mix: Using multicast-unicast comm. channel"
::= { ietfptpClockPortRunningEntry 12 }
ietfptpClockPortRunningPacketsReceived OBJECT-TYPE
SYNTAX Counter64
UNITS "packets"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the packets received on the clock
port (cumulative)."
::= { ietfptpClockPortRunningEntry 13 }
ietfptpClockPortRunningPacketsSent OBJECT-TYPE
SYNTAX Counter64
UNITS "packets"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the packets sent on the clock port
(cumulative)."
::= { ietfptpClockPortRunningEntry 14 }
ietfptpClockPortTransDSTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockPortTransDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about the transparent clock ports
running dataset for a particular domain."
::= { ietfPtpMIB ClockInfo 10 }
ietfptpClockPortTransDSEntry OBJECT-TYPE
SYNTAX ietfptpClockPortTransDSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing clock port transparent
dataset information about a single clock port"
INDEX {
ietfptpClockPortTransDSDomainIndex,
ietfptpClockPortTransDSInstanceIndex,
ietfptpClockPortTransDSPortNumberIndex
}
::= { ietfptpClockPortTransDSTable 1 }
Shankarkumar et al. Expires September 7, 2011 [Page 58]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockPortTransDSEntry ::= SEQUENCE {
ietfptpClockPortTransDSDomainIndex ClockDomainType,
ietfptpClockPortTransDSInstanceIndex ClockInstanceType,
ietfptpClockPortTransDSPortNumberIndex ClockPortNumber,
ietfptpClockPortTransDSPortIdentity ClockIdentity,
ietfptpClockPortTransDSlogMinPdelayReqInt Integer32,
ietfptpClockPortTransDSFaultyFlag TruthValue,
ietfptpClockPortTransDSPeerMeanPathDelay ClockTimeInterval
}
ietfptpClockPortTransDSDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the domain number used to create
logical group of PTP devices."
::= { ietfptpClockPortTransDSEntry 1 }
ietfptpClockPortTransDSInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType (0..255)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
::= { ietfptpClockPortTransDSEntry 2 }
ietfptpClockPortTransDSPortNumberIndex OBJECT-TYPE
SYNTAX ClockPortNumber (1..65535)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the PTP port number associated with
this port."
REFERENCE "Section 7.5.2 Port Identity of [1]"
::= { ietfptpClockPortTransDSEntry 3 }
ietfptpClockPortTransDSPortIdentity OBJECT-TYPE
SYNTAX ClockIdentity
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the value of the PortIdentity
attribute of the local port."
REFERENCE "Section 8.3.3.2.1 of [1]"
::= { ietfptpClockPortTransDSEntry 4 }
ietfptpClockPortTransDSlogMinPdelayReqInt OBJECT-TYPE
Shankarkumar et al. Expires September 7, 2011 [Page 59]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the value of the logarithm to the
base 2 of the minPdelayReqInterval."
REFERENCE "Section 8.3.3.3.1 of [1]"
::= { ietfptpClockPortTransDSEntry 5 }
ietfptpClockPortTransDSFaultyFlag OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the value TRUE if the port is faulty
and FALSE if the port is operating normally."
REFERENCE "Section 8.3.3.3.2 of [1]"
::= { ietfptpClockPortTransDSEntry 6 }
ietfptpClockPortTransDSPeerMeanPathDelay OBJECT-TYPE
SYNTAX ClockTimeInterval
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies, (if the delayMechanism used is P2P)
the value is the estimate of the current one-way propagation
delay, i.e. <meanPathDelay> on the link attached to this
port computed using the peer delay mechanism. If the value
of the delayMechanism used is E2E, then the value will be
zero."
REFERENCE "Section 8.3.3.3.3 of [1]"
::= { ietfptpClockPortTransDSEntry 7 }
ietfptpClockPortAssociateTable OBJECT-TYPE
SYNTAX SEQUENCE OF ietfptpClockPortAssociateEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Table of information about a given port's associated ports.
For a master port - multiple slave ports which have
established sessions with the current master port.
For a slave port - the list of master clocks available for a
given slave port.
Session information (pkts, errors) to be displayed based on
availability and scenario."
::= { ietfPtpMIB ClockInfo 11 }
Shankarkumar et al. Expires September 7, 2011 [Page 60]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
ietfptpClockPortAssociateEntry OBJECT-TYPE
SYNTAX ietfptpClockPortAssociateEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
single associated port for the given clockport."
INDEX {
ietfptpClockPortCurrentDomainIndex,
ietfptpClockPortCurrentClockTypeIndex,
ietfptpClockPortCurrentClockInstanceIndex,
ietfptpClockPortCurrentPortNumberIndex,
ietfptpClockPortAssociatePortIndex
}
::= { ietfptpClockPortAssociateTable 1 }
ietfptpClockPortAssociateEntry ::= SEQUENCE {
ietfptpClockPortCurrentDomainIndex ClockDomainType,
ietfptpClockPortCurrentClockTypeIndex ClockType,
ietfptpClockPortCurrentClockInstanceIndex ClockInstanceType,
ietfptpClockPortCurrentPortNumberIndex ClockPortNumber,
ietfptpClockPortAssociatePortIndex Unsigned32,
ietfptpClockPortAssociateAddressType InetAddressType,
ietfptpClockPortAssociateAddress InetAddress,
ietfptpClockPortAssociatePacketsSent Counter64,
ietfptpClockPortAssociatePacketsReceived Counter64,
ietfptpClockPortAssociateInErrors Counter64,
ietfptpClockPortAssociateOutErrors Counter64
}
ietfptpClockPortCurrentDomainIndex OBJECT-TYPE
SYNTAX ClockDomainType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the given port's domain number."
::= { ietfptpClockPortAssociateEntry 1 }
ietfptpClockPortCurrentClockTypeIndex OBJECT-TYPE
SYNTAX ClockType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the given port's clock type."
::= { ietfptpClockPortAssociateEntry 2 }
ietfptpClockPortCurrentClockInstanceIndex OBJECT-TYPE
SYNTAX ClockInstanceType
MAX-ACCESS not-accessible
Shankarkumar et al. Expires September 7, 2011 [Page 61]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
STATUS current
DESCRIPTION
"This object specifies the instance of the clock for this
clock type in the given domain."
::= { ietfptpClockPortAssociateEntry 3 }
ietfptpClockPortCurrentPortNumberIndex OBJECT-TYPE
SYNTAX ClockPortNumber
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the PTP Port Number for the given
port."
::= { ietfptpClockPortAssociateEntry 4 }
ietfptpClockPortAssociatePortIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..65535)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object specifies the associated port's serial number
in the current port's context."
::= { ietfptpClockPortAssociateEntry 5 }
ietfptpClockPortAssociateAddressType OBJECT-TYPE
SYNTAX InetAddressType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the peer port's network address type
used for PTP communication."
::= { ietfptpClockPortAssociateEntry 6 }
ietfptpClockPortAssociateAddress OBJECT-TYPE
SYNTAX InetAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the peer port's network address used
for PTP communication."
::= { ietfptpClockPortAssociateEntry 7 }
ietfptpClockPortAssociatePacketsSent OBJECT-TYPE
SYNTAX Counter64
UNITS "packets"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of packets sent to this peer port from the
Shankarkumar et al. Expires September 7, 2011 [Page 62]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
current port."
::= { ietfptpClockPortAssociateEntry 8 }
ietfptpClockPortAssociatePacketsReceived OBJECT-TYPE
SYNTAX Counter64
UNITS "packets"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of packets received from this peer port by the
current port."
::= { ietfptpClockPortAssociateEntry 9 }
ietfptpClockPortAssociateInErrors OBJECT-TYPE
SYNTAX Counter64
UNITS "packets"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the input errors associated with the
peer port."
::= { ietfptpClockPortAssociateEntry 10 }
ietfptpClockPortAssociateOutErrors OBJECT-TYPE
SYNTAX Counter64
UNITS "packets"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object specifies the output errors associated with the
peer port."
::= { ietfptpClockPortAssociateEntry 11 }
END
5. Relationship to the Interface MIB
This section clarifies the relationship of this MIB to the
Interfaces MIB [RFC 2233]. Several areas of correlation are
addressed in the following subsections. The implementor is referred
to the Interfaces MIB document in order to understand the general
intent of these areas.
Shankarkumar et al. Expires September 7, 2011 [Page 63]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
6. MIB modules required for IMPORTS
MODULE-IDENTITY,
OBJECT-TYPE,
Integer32,
Gauge32,
Unsigned32,
Counter32,
Counter64
FROM SNMPv2-SMI
OBJECT-GROUP,
MODULE-COMPLIANCE
FROM SNMPv2-CONF
TEXTUAL-CONVENTION,
TruthValue,
DisplayString
FROM SNMPv2-TC
InetAddressType,
InetAddress
FROM INET-ADDRESS-MIB
InterfaceIndexOrZero
FROM IETF-TC
7. Security Considerations
This MIB contains readable objects whose values provide information
related to PTP objects. While unauthorized access to the readable
objects is relatively innocuous, unauthorized access to the write-
able objects could cause a denial of service, or could cause
unauthorized creation and/or manipulation of tunnels. Hence, the
support for SET operations in a non-secure environment without
proper protection can have a negative effect on network operations.
SNMPv1 by itself is such an insecure environment. Even if the
network itself is secure (for example by using IPSec), even then,
there is no control as to who on the secure network is allowed to
access and SET (change/create/delete) the objects in this MIB.
It is recommended that the implementers consider the security
features as provided by the SNMPv3 framework. Specifically, the use
of the User-based Security Model [RFC 2574] and the View-based
Access Control Model [RFC 2575] is recommended.
It is then a customer/user responsibility to ensure that the SNMP
entity giving access to this MIB, is properly configured to give
access to those objects only to those principals (users) that have
legitimate rights to access them.
Shankarkumar et al. Expires September 7, 2011 [Page 64]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
8. IANA Considerations
To be added.
9. References
9.1. Normative References
[IEEE1588-2008] "Standard for A Precision Clock Synchronization
Protocol for Networked Measurement and Control Systems", IEEE1588-
2008.
9.2. Informative References
[RFC 1155] Rose, M., and K. McCloghrie, "Structure and
Identification of Management Information for TCP/IP-based
Internets", RFC 1155, Performance Systems International, Hughes LAN
Systems, May 1990
[RFC 1157] Case, J., Fedor, M., Schoffstall, M., and J. Davin,
"Simple Network Management Protocol", RFC 1157, SNMP Research,
Performance Systems International, Performance Systems
International, MIT Laboratory for Computer Science, May 1990.
[RFC 1212] Rose, M., and K. McCloghrie, "Concise MIB Definitions",
RFC 1212, Performance Systems International, Hughes LAN Systems,
March 1991
[RFC 1215] M. Rose, "A Convention for Defining Traps for use with
the SNMP", RFC 1215, Performance Systems International, March 1991
[RFC 1305] David L. Mills, "Network Time Protocol (Version 3) -
Specification, Implementation and Analysis", RFC 1305, University of
Delaware, March 1992.
[RFC 1901] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose,
M., and S. Waldbusser, "Introduction to Community-based SNMPv2", RFC
1901, SNMP Research, Inc., Cisco Systems, Inc., Dover Beach
Consulting, Inc., International Network Services, January 1996.
[RFC 1905] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M.,
and S. Waldbusser, "Protocol Operations for Version 2 of the Simple
Network Management Protocol (SNMPv2)", RFC 1905, SNMP Research,
Inc., Cisco Systems, Inc., Dover Beach Consulting, Inc.,
International Network Services, January 1996.
[RFC 1906] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M.,
and S. Waldbusser, "Transport Mappings for Version 2 of the Simple
Network Management Protocol (SNMPv2)", RFC 1906, SNMP Research,
Shankarkumar et al. Expires September 7, 2011 [Page 65]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
Inc., Cisco Systems, Inc., Dover Beach Consulting, Inc.,
International Network Services, January 1996.
[RFC 2233] "The Interfaces Group MIB using SMIv2", K. McCloghrie, F.
Kastenholz, November 1997, RFC 2233
[RFC 2271] Harrington, D., Presuhn, R., and B. Wijnen, "An
Architecture for Describing SNMP Management Frameworks", RFC 2271,
Cabletron Systems, Inc., BMC Software, Inc., IBM T. J. Watson
Research, January 1998
[RFC 2572] Case, J., Harrington D., Presuhn R., and B. Wijnen,
"Message Processing and Dispatching for the Simple Network
Management Protocol (SNMP)", RFC 2572, SNMP Research, Inc.,
Cabletron Systems, Inc., BMC Software, Inc., IBM T. J. Watson
Research, April 1999.
[RFC 2573] Levi, D., Meyer, P., and B. Stewart, "SNMPv3
Applications", RFC 2573, SNMP Research, Inc., Secure Computing
Corporation, Cisco Systems, April 1999.
[RFC 2574] Blumenthal, U., and B. Wijnen, "User-based Security Model
(USM) for version 3 of the Simple Network Management Protocol
(SNMPv3)", RFC 2574, IBM T. J. Watson Research, April 1999.
[RFC 2575] Wijnen, B., Presuhn, R., and K. McCloghrie, "View-based
Access Control Model (VACM) for the Simple Network Management
Protocol (SNMP)", RFC 2575, IBM T. J. Watson Research, BMC Software,
Inc., Cisco Systems, Inc., April 1999.
[RFC 2578] McCloghrie, K., Perkins, D., and J. Schoenwaelder,
"Structure of Management Information Version 2 (SMIv2)", STD 58, RFC
2578, April 1999.
[RFC 2579] McCloghrie, K., Perkins, D., and J. Schoenwaelder,
"Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999.
[RFC 2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder,
"Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999.
10. Acknowledgements
Thanks to John Linton and Danny Lee for valuable comments.
Shankarkumar et al. Expires September 7, 2011 [Page 66]
Internet-Draft draft-vinay-tictoc-ptp-mib-00.txt March 7, 2011
11. Author's Addresses
Vinay Shankarkumar
Cisco Systems,
7025-4 Kit Creek Road,
Research Triangle Park,
NC 27560,
USA.
Email: vinays@cisco.com
Laurent Montini,
Cisco Systems,
11, rue Camille Desmoulins,
92782 Issy-les-Moulineaux,
France.
Email: lmontini@cisco.com
Tim Frost,
Symmetricom Inc.,
2300 Orchard Parkway,
San Jose,
CA 95131,
USA.
Email: tfrost@symmetricom.com
Greg Dowd,
Symmetricom Inc.,
2300 Orchard Parkway,
San Jose,
CA 95131,
USA.
Email: gdowd@symmetricom.com
Shankarkumar et al. Expires September 7, 2011 [Page 67]