PTPBASE-MIB

The MIB module for PTP version 2

Copyright (c) 2017 IETF Trust and the persons identified as
authors of the code.  All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Simplified BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).

Overview of PTP version 2 (IEEE Std. 1588-2008)

[IEEE-1588-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 module does not address
PTPv1, the earlier version defined in IEEE Std. 1588-2002.
The protocol is applicable to network elements communicating
using IP.  The protocol enables heterogeneous systems that
include clocks of various inherent precision, resolution, and
stability to 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.  [IEEE-1588-2008] uses UDP/IP or
Ethernet and can be adapted to other mappings.  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.  [IEEE-1588-2008] also defines
conformance and management capability.

MIB description

This MIB module supports the Precision Time Protocol version 2
(PTPv2, hereafter designated as PTP) features of network element
system devices, when using the default PTP profile described in
[IEEE-1588-2008] when running over the IP network layer.

It is envisioned that this MIB module will complement other
managed objects to be defined to monitor and measure the
performance of the PTP devices and telecom clocks supporting
specific PTP profiles.

Some other PTP profiles have their own MIB modules defined as
part of the profile, and this MIB module is not intended to
replace those MIB modules.

Technical terms used in this module are defined in
[IEEE-1588-2008].

The MIB module refers to sections of [IEEE-1588-2008].

Abbreviations:
    E2E     End-to-End
    EUI     Extended Unique Identifier
    GPS     Global Positioning System
    IANA    Internet Assigned Numbers Authority
    IP      Internet Protocol
    NTP     Network Time Protocol (see [RFC5905])
    P2P     Peer-to-Peer
    PTP     Precision Time Protocol
    TAI     International Atomic Time
    UDP     User Datagram Protocol
    UTC     Coordinated Universal Time

References:

[IEEE-1588-2008] IEEE Standard for A Precision Clock
    Synchronization Protocol for Networked Measurement and
    Control Systems, IEEE Std. 1588-2008, July 2008.

The below table specifies the object formats of the various
textual conventions used.

Data type mapping   Textual Convention    SYNTAX
------------------- --------------------- ------------------
5.3.2 TimeInterval  PtpClockTimeInterval  OCTET
                                          STRING(SIZE(1..255))
5.3.3 Timestamp     PtpClockTimestamp     OCTET STRING(SIZE(6))
5.3.4 ClockIdentity PtpClockIdentity      OCTET STRING(SIZE(8))
5.3.5 PortIdentity  PtpClockPortNumber    INTEGER(1..65535)
5.3.7 ClockQuality  PtpClockQualityClassType

Imported Objects

InterfaceIndexOrZeroIF-MIB
OBJECT-GROUP, MODULE-COMPLIANCESNMPv2-CONF
MODULE-IDENTITY, OBJECT-TYPE, OBJECT-IDENTITY, Gauge32, Unsigned32, Counter32, Counter64, mib-2, Integer32SNMPv2-SMI
TEXTUAL-CONVENTION, TruthValue, DisplayString, AutonomousTypeSNMPv2-TC
ptpbaseMIB.1.3.6.1.2.1.241
ptpbaseMIBNotifs .1.3.6.1.2.1.241.0
ptpbaseMIBObjects .1.3.6.1.2.1.241.1
ptpbaseMIBSystemInfo .1.3.6.1.2.1.241.1.1
ptpbaseSystemTable .1.3.6.1.2.1.241.1.1.1
ptpbaseSystemEntry .1.3.6.1.2.1.241.1.1.1.1
ptpDomainIndex .1.3.6.1.2.1.241.1.1.1.1.1
ptpInstanceIndex .1.3.6.1.2.1.241.1.1.1.1.2
ptpDomainClockPortsTotal .1.3.6.1.2.1.241.1.1.1.1.3
ptpbaseSystemDomainTable .1.3.6.1.2.1.241.1.1.2
ptpbaseSystemDomainEntry .1.3.6.1.2.1.241.1.1.2.1
ptpbaseSystemDomainClockTypeIndex .1.3.6.1.2.1.241.1.1.2.1.1
ptpbaseSystemDomainTotals .1.3.6.1.2.1.241.1.1.2.1.2
ptpbaseSystemProfile .1.3.6.1.2.1.241.1.1.3
ptpbaseMIBClockInfo .1.3.6.1.2.1.241.1.2
ptpbaseClockCurrentDSTable .1.3.6.1.2.1.241.1.2.1
ptpbaseClockCurrentDSEntry .1.3.6.1.2.1.241.1.2.1.1
ptpbaseClockCurrentDSDomainIndex .1.3.6.1.2.1.241.1.2.1.1.1
ptpbaseClockCurrentDSClockTypeIndex .1.3.6.1.2.1.241.1.2.1.1.2
ptpbaseClockCurrentDSInstanceIndex .1.3.6.1.2.1.241.1.2.1.1.3
ptpbaseClockCurrentDSStepsRemoved .1.3.6.1.2.1.241.1.2.1.1.4
ptpbaseClockCurrentDSOffsetFromMaster .1.3.6.1.2.1.241.1.2.1.1.5
ptpbaseClockCurrentDSMeanPathDelay .1.3.6.1.2.1.241.1.2.1.1.6
ptpbaseClockPortTransDSTable .1.3.6.1.2.1.241.1.2.10
ptpbaseClockPortTransDSEntry .1.3.6.1.2.1.241.1.2.10.1
ptpbaseClockPortTransDSDomainIndex .1.3.6.1.2.1.241.1.2.10.1.1
ptpbaseClockPortTransDSInstanceIndex .1.3.6.1.2.1.241.1.2.10.1.2
ptpbaseClockPortTransDSPortNumberIndex .1.3.6.1.2.1.241.1.2.10.1.3
ptpbaseClockPortTransDSPortIdentity .1.3.6.1.2.1.241.1.2.10.1.4
ptpbaseClockPortTransDSlogMinPdelayReqInt .1.3.6.1.2.1.241.1.2.10.1.5
ptpbaseClockPortTransDSFaultyFlag .1.3.6.1.2.1.241.1.2.10.1.6
ptpbaseClockPortTransDSPeerMeanPathDelay .1.3.6.1.2.1.241.1.2.10.1.7
ptpbaseClockPortAssociateTable .1.3.6.1.2.1.241.1.2.11
ptpbaseClockPortAssociateEntry .1.3.6.1.2.1.241.1.2.11.1
ptpClockPortCurrentDomainIndex .1.3.6.1.2.1.241.1.2.11.1.1
ptpbaseClockPortAssociateInErrors .1.3.6.1.2.1.241.1.2.11.1.10
ptpbaseClockPortAssociateOutErrors .1.3.6.1.2.1.241.1.2.11.1.11
ptpClockPortCurrentClockTypeIndex .1.3.6.1.2.1.241.1.2.11.1.2
ptpClockPortCurrentClockInstanceIndex .1.3.6.1.2.1.241.1.2.11.1.3
ptpClockPortCurrentPortNumberIndex .1.3.6.1.2.1.241.1.2.11.1.4
ptpbaseClockPortAssociatePortIndex .1.3.6.1.2.1.241.1.2.11.1.5
ptpbaseClockPortAssociateAddressType .1.3.6.1.2.1.241.1.2.11.1.6
ptpbaseClockPortAssociateAddress .1.3.6.1.2.1.241.1.2.11.1.7
ptpbaseClockPortAssociatePacketsSent .1.3.6.1.2.1.241.1.2.11.1.8
ptpbaseClockPortAssociatePacketsReceived .1.3.6.1.2.1.241.1.2.11.1.9
ptpbaseWellKnownTransportTypes .1.3.6.1.2.1.241.1.2.12
ptpbaseTransportTypeIPversion4 .1.3.6.1.2.1.241.1.2.12.1
ptpbaseTransportTypeIPversion6 .1.3.6.1.2.1.241.1.2.12.2
ptpbaseTransportTypeEthernet .1.3.6.1.2.1.241.1.2.12.3
ptpbaseTransportTypeDeviceNET .1.3.6.1.2.1.241.1.2.12.4
ptpbaseTransportTypeControlNET .1.3.6.1.2.1.241.1.2.12.5
ptpbaseTransportTypeIEC61158 .1.3.6.1.2.1.241.1.2.12.6
ptpbaseWellKnownEncapsulationTypes .1.3.6.1.2.1.241.1.2.13
ptpbaseEncapsulationTypeEthernet .1.3.6.1.2.1.241.1.2.13.1
ptpbaseEncapsulationTypeVLAN .1.3.6.1.2.1.241.1.2.13.2
ptpbaseEncapsulationTypeUDPIPLSP .1.3.6.1.2.1.241.1.2.13.3
ptpbaseEncapsulationTypePWUDPIPLSP .1.3.6.1.2.1.241.1.2.13.4
ptpbaseEncapsulationTypePWEthernetLSP .1.3.6.1.2.1.241.1.2.13.5
ptpbaseClockParentDSTable .1.3.6.1.2.1.241.1.2.2
ptpbaseClockParentDSEntry .1.3.6.1.2.1.241.1.2.2.1
ptpbaseClockParentDSDomainIndex .1.3.6.1.2.1.241.1.2.2.1.1
ptpbaseClockParentDSGMClockPriority2 .1.3.6.1.2.1.241.1.2.2.1.10
ptpbaseClockParentDSGMClockQualityClass .1.3.6.1.2.1.241.1.2.2.1.11
ptpbaseClockParentDSGMClockQualityAccuracy .1.3.6.1.2.1.241.1.2.2.1.12
ptpbaseClockParentDSGMClockQualityOffset .1.3.6.1.2.1.241.1.2.2.1.13
ptpbaseClockParentDSClockTypeIndex .1.3.6.1.2.1.241.1.2.2.1.2
ptpbaseClockParentDSInstanceIndex .1.3.6.1.2.1.241.1.2.2.1.3
ptpbaseClockParentDSParentPortIdentity .1.3.6.1.2.1.241.1.2.2.1.4
ptpbaseClockParentDSParentStats .1.3.6.1.2.1.241.1.2.2.1.5
ptpbaseClockParentDSOffset .1.3.6.1.2.1.241.1.2.2.1.6
ptpbaseClockParentDSClockPhChRate .1.3.6.1.2.1.241.1.2.2.1.7
ptpbaseClockParentDSGMClockIdentity .1.3.6.1.2.1.241.1.2.2.1.8
ptpbaseClockParentDSGMClockPriority1 .1.3.6.1.2.1.241.1.2.2.1.9
ptpbaseClockDefaultDSTable .1.3.6.1.2.1.241.1.2.3
ptpbaseClockDefaultDSEntry .1.3.6.1.2.1.241.1.2.3.1
ptpbaseClockDefaultDSDomainIndex .1.3.6.1.2.1.241.1.2.3.1.1
ptpbaseClockDefaultDSQualityAccuracy .1.3.6.1.2.1.241.1.2.3.1.10
ptpbaseClockDefaultDSQualityOffset .1.3.6.1.2.1.241.1.2.3.1.11
ptpbaseClockDefaultDSClockTypeIndex .1.3.6.1.2.1.241.1.2.3.1.2
ptpbaseClockDefaultDSInstanceIndex .1.3.6.1.2.1.241.1.2.3.1.3
ptpbaseClockDefaultDSTwoStepFlag .1.3.6.1.2.1.241.1.2.3.1.4
ptpbaseClockDefaultDSClockIdentity .1.3.6.1.2.1.241.1.2.3.1.5
ptpbaseClockDefaultDSPriority1 .1.3.6.1.2.1.241.1.2.3.1.6
ptpbaseClockDefaultDSPriority2 .1.3.6.1.2.1.241.1.2.3.1.7
ptpbaseClockDefaultDSSlaveOnly .1.3.6.1.2.1.241.1.2.3.1.8
ptpbaseClockDefaultDSQualityClass .1.3.6.1.2.1.241.1.2.3.1.9
ptpbaseClockRunningTable .1.3.6.1.2.1.241.1.2.4
ptpbaseClockRunningEntry .1.3.6.1.2.1.241.1.2.4.1
ptpbaseClockRunningDomainIndex .1.3.6.1.2.1.241.1.2.4.1.1
ptpbaseClockRunningClockTypeIndex .1.3.6.1.2.1.241.1.2.4.1.2
ptpbaseClockRunningInstanceIndex .1.3.6.1.2.1.241.1.2.4.1.3
ptpbaseClockRunningState .1.3.6.1.2.1.241.1.2.4.1.4
ptpbaseClockRunningPacketsSent .1.3.6.1.2.1.241.1.2.4.1.5
ptpbaseClockRunningPacketsReceived .1.3.6.1.2.1.241.1.2.4.1.6
ptpbaseClockTimePropertiesDSTable .1.3.6.1.2.1.241.1.2.5
ptpbaseClockTimePropertiesDSEntry .1.3.6.1.2.1.241.1.2.5.1
ptpbaseClockTimePropertiesDSDomainIndex .1.3.6.1.2.1.241.1.2.5.1.1
ptpbaseClockTimePropertiesDSPTPTimescale .1.3.6.1.2.1.241.1.2.5.1.10
ptpbaseClockTimePropertiesDSSource .1.3.6.1.2.1.241.1.2.5.1.11
ptpbaseClockTimePropertiesDSClockTypeIndex .1.3.6.1.2.1.241.1.2.5.1.2
ptpbaseClockTimePropertiesDSInstanceIndex .1.3.6.1.2.1.241.1.2.5.1.3
ptpbaseClockTimePropertiesDSCurrentUTCOffsetValid .1.3.6.1.2.1.241.1.2.5.1.4
ptpbaseClockTimePropertiesDSCurrentUTCOffset .1.3.6.1.2.1.241.1.2.5.1.5
ptpbaseClockTimePropertiesDSLeap59 .1.3.6.1.2.1.241.1.2.5.1.6
ptpbaseClockTimePropertiesDSLeap61 .1.3.6.1.2.1.241.1.2.5.1.7
ptpbaseClockTimePropertiesDSTimeTraceable .1.3.6.1.2.1.241.1.2.5.1.8
ptpbaseClockTimePropertiesDSFreqTraceable .1.3.6.1.2.1.241.1.2.5.1.9
ptpbaseClockTransDefaultDSTable .1.3.6.1.2.1.241.1.2.6
ptpbaseClockTransDefaultDSEntry .1.3.6.1.2.1.241.1.2.6.1
ptpbaseClockTransDefaultDSDomainIndex .1.3.6.1.2.1.241.1.2.6.1.1
ptpbaseClockTransDefaultDSInstanceIndex .1.3.6.1.2.1.241.1.2.6.1.2
ptpbaseClockTransDefaultDSClockIdentity .1.3.6.1.2.1.241.1.2.6.1.3
ptpbaseClockTransDefaultDSNumOfPorts .1.3.6.1.2.1.241.1.2.6.1.4
ptpbaseClockTransDefaultDSDelay .1.3.6.1.2.1.241.1.2.6.1.5
ptpbaseClockTransDefaultDSPrimaryDomain .1.3.6.1.2.1.241.1.2.6.1.6
ptpbaseClockPortTable .1.3.6.1.2.1.241.1.2.7
ptpbaseClockPortEntry .1.3.6.1.2.1.241.1.2.7.1
ptpbaseClockPortDomainIndex .1.3.6.1.2.1.241.1.2.7.1.1
ptpbaseClockPortNumOfAssociatedPorts .1.3.6.1.2.1.241.1.2.7.1.10
ptpbaseClockPortClockTypeIndex .1.3.6.1.2.1.241.1.2.7.1.2
ptpbaseClockPortClockInstanceIndex .1.3.6.1.2.1.241.1.2.7.1.3
ptpbaseClockPortTablePortNumberIndex .1.3.6.1.2.1.241.1.2.7.1.4
ptpbaseClockPortName .1.3.6.1.2.1.241.1.2.7.1.5
ptpbaseClockPortRole .1.3.6.1.2.1.241.1.2.7.1.6
ptpbaseClockPortSyncTwoStep .1.3.6.1.2.1.241.1.2.7.1.7
ptpbaseClockPortCurrentPeerAddressType .1.3.6.1.2.1.241.1.2.7.1.8
ptpbaseClockPortCurrentPeerAddress .1.3.6.1.2.1.241.1.2.7.1.9
ptpbaseClockPortDSTable .1.3.6.1.2.1.241.1.2.8
ptpbaseClockPortDSEntry .1.3.6.1.2.1.241.1.2.8.1
ptpbaseClockPortDSDomainIndex .1.3.6.1.2.1.241.1.2.8.1.1
ptpbaseClockPortDSMinDelayReqInterval .1.3.6.1.2.1.241.1.2.8.1.10
ptpbaseClockPortDSPeerDelayReqInterval .1.3.6.1.2.1.241.1.2.8.1.11
ptpbaseClockPortDSDelayMech .1.3.6.1.2.1.241.1.2.8.1.12
ptpbaseClockPortDSPeerMeanPathDelay .1.3.6.1.2.1.241.1.2.8.1.13
ptpbaseClockPortDSGrantDuration .1.3.6.1.2.1.241.1.2.8.1.14
ptpbaseClockPortDSPTPVersion .1.3.6.1.2.1.241.1.2.8.1.15
ptpbaseClockPortDSClockTypeIndex .1.3.6.1.2.1.241.1.2.8.1.2
ptpbaseClockPortDSClockInstanceIndex .1.3.6.1.2.1.241.1.2.8.1.3
ptpbaseClockPortDSPortNumberIndex .1.3.6.1.2.1.241.1.2.8.1.4
ptpbaseClockPortDSName .1.3.6.1.2.1.241.1.2.8.1.5
ptpbaseClockPortDSPortIdentity .1.3.6.1.2.1.241.1.2.8.1.6
ptpbaseClockPortDSlogAnnouncementInterval .1.3.6.1.2.1.241.1.2.8.1.7
ptpbaseClockPortDSAnnounceRctTimeout .1.3.6.1.2.1.241.1.2.8.1.8
ptpbaseClockPortDSlogSyncInterval .1.3.6.1.2.1.241.1.2.8.1.9
ptpbaseClockPortRunningTable .1.3.6.1.2.1.241.1.2.9
ptpbaseClockPortRunningEntry .1.3.6.1.2.1.241.1.2.9.1
ptpbaseClockPortRunningDomainIndex .1.3.6.1.2.1.241.1.2.9.1.1
ptpbaseClockPortRunningEncapsulationType .1.3.6.1.2.1.241.1.2.9.1.10
ptpbaseClockPortRunningTxMode .1.3.6.1.2.1.241.1.2.9.1.11
ptpbaseClockPortRunningRxMode .1.3.6.1.2.1.241.1.2.9.1.12
ptpbaseClockPortRunningPacketsReceived .1.3.6.1.2.1.241.1.2.9.1.13
ptpbaseClockPortRunningPacketsSent .1.3.6.1.2.1.241.1.2.9.1.14
ptpbaseClockPortRunningClockTypeIndex .1.3.6.1.2.1.241.1.2.9.1.2
ptpbaseClockPortRunningClockInstanceIndex .1.3.6.1.2.1.241.1.2.9.1.3
ptpbaseClockPortRunningPortNumberIndex .1.3.6.1.2.1.241.1.2.9.1.4
ptpbaseClockPortRunningName .1.3.6.1.2.1.241.1.2.9.1.5
ptpbaseClockPortRunningState .1.3.6.1.2.1.241.1.2.9.1.6
ptpbaseClockPortRunningRole .1.3.6.1.2.1.241.1.2.9.1.7
ptpbaseClockPortRunningInterfaceIndex .1.3.6.1.2.1.241.1.2.9.1.8
ptpbaseClockPortRunningTransport .1.3.6.1.2.1.241.1.2.9.1.9
ptpbaseMIBConformance .1.3.6.1.2.1.241.2
ptpbaseMIBCompliances .1.3.6.1.2.1.241.2.1
ptpbaseMIBGroups .1.3.6.1.2.1.241.2.2