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
- Source file
PTPBASE-MIB- Last revised
- Identity
ptpbaseMIB- Base OID
1.3.6.1.2.1.241
Imported Objects
| IF-MIB | InterfaceIndexOrZero |
| SNMPv2-CONF | MODULE-COMPLIANCE (no object page) OBJECT-GROUP (no object page) |
| SNMPv2-SMI | Counter32 Counter64 Gauge32 Integer32 mib-2 MODULE-IDENTITY (no object page) OBJECT-IDENTITY (no object page) OBJECT-TYPE (no object page) Unsigned32 |
| SNMPv2-TC | AutonomousType DisplayString TEXTUAL-CONVENTION (no object page) TruthValue |
Net-SNMP examples using the rfc MIB directory Show commands
These commands use the standard Observium installation path and load the selected MIB variant before the RFC and Net-SNMP directories.
Translate the module identity
/usr/bin/snmptranslate -Pud -Ir -On -m 'PTPBASE-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'PTPBASE-MIB::ptpbaseMIB'
Walk the MIB subtree
/usr/bin/snmpbulkwalk -v2c -c '<community>' -Pud -Ir -OQUs -m 'PTPBASE-MIB' -M '/opt/observium/mibs/rfc:/opt/observium/mibs/net-snmp' 'udp:<hostname>:161' 'PTPBASE-MIB::ptpbaseMIB'
Objects (163)
Showing 163 of 163 objects
Object legend
Object type
Icons distinguish tables, entry rows, columns, scalars, and structural nodes.
SNMPv2-TCTruthValue
Syntax
Blue badges identify the value syntax. Connected badges read as defining module and convention.
IF-MIBifIndex
Table index
Green identifies an index object; yellow names its module when the index is defined elsewhere.
r/w
deprecated
obsolete
Access and status
r/w means read-write. Grey labels mark definitions retained for compatibility.
OBS ✓
Observium use
The indicator appears only when Observium directly references that object.
ifOperStatus
.1.3.6.1.2.1…
Names and OIDs
Object names link to their detail pages. Hover or focus a linked name or badge for available definition details.
.1.3.6.1.2.1.241 |
||
.1.3.6.1.2.1.241.0 |
||
.1.3.6.1.2.1.241.1 |
||
.1.3.6.1.2.1.241.1.1 |
||
.1.3.6.1.2.1.241.1.1.1 |
||
.1.3.6.1.2.1.241.1.1.1.1 |
||
.1.3.6.1.2.1.241.1.1.1.1.1 |
||
.1.3.6.1.2.1.241.1.1.1.1.2 |
||
|
ptp portsSNMPv2-SMIGauge32
|
.1.3.6.1.2.1.241.1.1.1.1.3 |
|
.1.3.6.1.2.1.241.1.1.2 |
||
.1.3.6.1.2.1.241.1.1.2.1 |
||
.1.3.6.1.2.1.241.1.1.2.1.1 |
||
|
domainsSNMPv2-SMIUnsigned32
|
.1.3.6.1.2.1.241.1.1.2.1.2 |
|
.1.3.6.1.2.1.241.1.1.3 |
||
.1.3.6.1.2.1.241.1.2 |
||
.1.3.6.1.2.1.241.1.2.1 |
||
.1.3.6.1.2.1.241.1.2.1.1 |
||
.1.3.6.1.2.1.241.1.2.1.1.1 |
||
.1.3.6.1.2.1.241.1.2.1.1.2 |
||
.1.3.6.1.2.1.241.1.2.1.1.3 |
||
|
StepsSNMPv2-SMIUnsigned32
|
.1.3.6.1.2.1.241.1.2.1.1.4 |
|
|
Time IntervalPtpClockTimeInterval
|
.1.3.6.1.2.1.241.1.2.1.1.5 |
|
|
Time IntervalPtpClockTimeInterval
|
.1.3.6.1.2.1.241.1.2.1.1.6 |
|
.1.3.6.1.2.1.241.1.2.10 |
||
.1.3.6.1.2.1.241.1.2.10.1 |
||
.1.3.6.1.2.1.241.1.2.10.1.1 |
||
.1.3.6.1.2.1.241.1.2.10.1.2 |
||
.1.3.6.1.2.1.241.1.2.10.1.3 |
||
.1.3.6.1.2.1.241.1.2.10.1.4 |
||
.1.3.6.1.2.1.241.1.2.10.1.5 |
||
.1.3.6.1.2.1.241.1.2.10.1.6 |
||
|
Time IntervalPtpClockTimeInterval
|
.1.3.6.1.2.1.241.1.2.10.1.7 |
|
.1.3.6.1.2.1.241.1.2.11 |
||
.1.3.6.1.2.1.241.1.2.11.1 |
||
.1.3.6.1.2.1.241.1.2.11.1.1 |
||
|
packetsSNMPv2-SMICounter64
|
.1.3.6.1.2.1.241.1.2.11.1.10 |
|
|
packetsSNMPv2-SMICounter64
|
.1.3.6.1.2.1.241.1.2.11.1.11 |
|
.1.3.6.1.2.1.241.1.2.11.1.2 |
||
.1.3.6.1.2.1.241.1.2.11.1.3 |
||
.1.3.6.1.2.1.241.1.2.11.1.4 |
||
|
Unsigned32
|
.1.3.6.1.2.1.241.1.2.11.1.5 |
|
.1.3.6.1.2.1.241.1.2.11.1.6 |
||
.1.3.6.1.2.1.241.1.2.11.1.7 |
||
|
packetsSNMPv2-SMICounter64
|
.1.3.6.1.2.1.241.1.2.11.1.8 |
|
|
packetsSNMPv2-SMICounter64
|
.1.3.6.1.2.1.241.1.2.11.1.9 |
|
.1.3.6.1.2.1.241.1.2.12 |
||
.1.3.6.1.2.1.241.1.2.12.1 |
||
.1.3.6.1.2.1.241.1.2.12.2 |
||
.1.3.6.1.2.1.241.1.2.12.3 |
||
.1.3.6.1.2.1.241.1.2.12.4 |
||
.1.3.6.1.2.1.241.1.2.12.5 |
||
.1.3.6.1.2.1.241.1.2.12.6 |
||
.1.3.6.1.2.1.241.1.2.13 |
||
.1.3.6.1.2.1.241.1.2.13.1 |
||
.1.3.6.1.2.1.241.1.2.13.2 |
||
.1.3.6.1.2.1.241.1.2.13.3 |
||
.1.3.6.1.2.1.241.1.2.13.4 |
||
.1.3.6.1.2.1.241.1.2.13.5 |
||
.1.3.6.1.2.1.241.1.2.2 |
||
.1.3.6.1.2.1.241.1.2.2.1 |
||
.1.3.6.1.2.1.241.1.2.2.1.1 |
||
.1.3.6.1.2.1.241.1.2.2.1.10 |
||
.1.3.6.1.2.1.241.1.2.2.1.11 |
||
.1.3.6.1.2.1.241.1.2.2.1.12 |
||
.1.3.6.1.2.1.241.1.2.2.1.13 |
||
.1.3.6.1.2.1.241.1.2.2.1.2 |
||
.1.3.6.1.2.1.241.1.2.2.1.3 |
||
|
OctetString
|
.1.3.6.1.2.1.241.1.2.2.1.4 |
|
.1.3.6.1.2.1.241.1.2.2.1.5 |
||
|
Integer32
|
.1.3.6.1.2.1.241.1.2.2.1.6 |
|
.1.3.6.1.2.1.241.1.2.2.1.7 |
||
.1.3.6.1.2.1.241.1.2.2.1.8 |
||
.1.3.6.1.2.1.241.1.2.2.1.9 |
||
.1.3.6.1.2.1.241.1.2.3 |
||
.1.3.6.1.2.1.241.1.2.3.1 |
||
.1.3.6.1.2.1.241.1.2.3.1.1 |
||
.1.3.6.1.2.1.241.1.2.3.1.10 |
||
.1.3.6.1.2.1.241.1.2.3.1.11 |
||
.1.3.6.1.2.1.241.1.2.3.1.2 |
||
.1.3.6.1.2.1.241.1.2.3.1.3 |
||
.1.3.6.1.2.1.241.1.2.3.1.4 |
||
.1.3.6.1.2.1.241.1.2.3.1.5 |
||
.1.3.6.1.2.1.241.1.2.3.1.6 |
||
.1.3.6.1.2.1.241.1.2.3.1.7 |
||
.1.3.6.1.2.1.241.1.2.3.1.8 |
||
.1.3.6.1.2.1.241.1.2.3.1.9 |
||
.1.3.6.1.2.1.241.1.2.4 |
||
.1.3.6.1.2.1.241.1.2.4.1 |
||
.1.3.6.1.2.1.241.1.2.4.1.1 |
||
.1.3.6.1.2.1.241.1.2.4.1.2 |
||
.1.3.6.1.2.1.241.1.2.4.1.3 |
||
.1.3.6.1.2.1.241.1.2.4.1.4 |
||
.1.3.6.1.2.1.241.1.2.4.1.5 |
||
.1.3.6.1.2.1.241.1.2.4.1.6 |
||
.1.3.6.1.2.1.241.1.2.5 |
||
.1.3.6.1.2.1.241.1.2.5.1 |
||
.1.3.6.1.2.1.241.1.2.5.1.1 |
||
.1.3.6.1.2.1.241.1.2.5.1.10 |
||
.1.3.6.1.2.1.241.1.2.5.1.11 |
||
.1.3.6.1.2.1.241.1.2.5.1.2 |
||
.1.3.6.1.2.1.241.1.2.5.1.3 |
||
.1.3.6.1.2.1.241.1.2.5.1.4 |
||
.1.3.6.1.2.1.241.1.2.5.1.5 |
||
.1.3.6.1.2.1.241.1.2.5.1.6 |
||
.1.3.6.1.2.1.241.1.2.5.1.7 |
||
.1.3.6.1.2.1.241.1.2.5.1.8 |
||
.1.3.6.1.2.1.241.1.2.5.1.9 |
||
.1.3.6.1.2.1.241.1.2.6 |
||
.1.3.6.1.2.1.241.1.2.6.1 |
||
.1.3.6.1.2.1.241.1.2.6.1.1 |
||
.1.3.6.1.2.1.241.1.2.6.1.2 |
||
.1.3.6.1.2.1.241.1.2.6.1.3 |
||
.1.3.6.1.2.1.241.1.2.6.1.4 |
||
.1.3.6.1.2.1.241.1.2.6.1.5 |
||
.1.3.6.1.2.1.241.1.2.6.1.6 |
||
.1.3.6.1.2.1.241.1.2.7 |
||
.1.3.6.1.2.1.241.1.2.7.1 |
||
.1.3.6.1.2.1.241.1.2.7.1.1 |
||
.1.3.6.1.2.1.241.1.2.7.1.10 |
||
.1.3.6.1.2.1.241.1.2.7.1.2 |
||
.1.3.6.1.2.1.241.1.2.7.1.3 |
||
.1.3.6.1.2.1.241.1.2.7.1.4 |
||
|
OctetString
|
.1.3.6.1.2.1.241.1.2.7.1.5 |
|
.1.3.6.1.2.1.241.1.2.7.1.6 |
||
.1.3.6.1.2.1.241.1.2.7.1.7 |
||
.1.3.6.1.2.1.241.1.2.7.1.8 |
||
.1.3.6.1.2.1.241.1.2.7.1.9 |
||
.1.3.6.1.2.1.241.1.2.8 |
||
.1.3.6.1.2.1.241.1.2.8.1 |
||
.1.3.6.1.2.1.241.1.2.8.1.1 |
||
.1.3.6.1.2.1.241.1.2.8.1.10 |
||
.1.3.6.1.2.1.241.1.2.8.1.11 |
||
.1.3.6.1.2.1.241.1.2.8.1.12 |
||
|
Time IntervalPtpClockTimeInterval
|
.1.3.6.1.2.1.241.1.2.8.1.13 |
|
|
secondsSNMPv2-SMIUnsigned32
|
.1.3.6.1.2.1.241.1.2.8.1.14 |
|
.1.3.6.1.2.1.241.1.2.8.1.15 |
||
.1.3.6.1.2.1.241.1.2.8.1.2 |
||
.1.3.6.1.2.1.241.1.2.8.1.3 |
||
.1.3.6.1.2.1.241.1.2.8.1.4 |
||
|
OctetString
|
.1.3.6.1.2.1.241.1.2.8.1.5 |
|
|
OctetString
|
.1.3.6.1.2.1.241.1.2.8.1.6 |
|
|
Time IntervalPtpClockIntervalBase2
|
.1.3.6.1.2.1.241.1.2.8.1.7 |
|
.1.3.6.1.2.1.241.1.2.8.1.8 |
||
|
Time IntervalPtpClockIntervalBase2
|
.1.3.6.1.2.1.241.1.2.8.1.9 |
|
.1.3.6.1.2.1.241.1.2.9 |
||
.1.3.6.1.2.1.241.1.2.9.1 |
||
.1.3.6.1.2.1.241.1.2.9.1.1 |
||
.1.3.6.1.2.1.241.1.2.9.1.10 |
||
.1.3.6.1.2.1.241.1.2.9.1.11 |
||
.1.3.6.1.2.1.241.1.2.9.1.12 |
||
|
packetsSNMPv2-SMICounter64
|
.1.3.6.1.2.1.241.1.2.9.1.13 |
|
|
packetsSNMPv2-SMICounter64
|
.1.3.6.1.2.1.241.1.2.9.1.14 |
|
.1.3.6.1.2.1.241.1.2.9.1.2 |
||
.1.3.6.1.2.1.241.1.2.9.1.3 |
||
.1.3.6.1.2.1.241.1.2.9.1.4 |
||
|
OctetString
|
.1.3.6.1.2.1.241.1.2.9.1.5 |
|
.1.3.6.1.2.1.241.1.2.9.1.6 |
||
.1.3.6.1.2.1.241.1.2.9.1.7 |
||
.1.3.6.1.2.1.241.1.2.9.1.8 |
||
.1.3.6.1.2.1.241.1.2.9.1.9 |
||
.1.3.6.1.2.1.241.2 |
||
.1.3.6.1.2.1.241.2.1 |
||
.1.3.6.1.2.1.241.2.2 |
Dependencies (6) 4 direct · 2 transitive Show tree and compile order Hide dependency details
Each imported module is resolved in the importing module's source directory first, then through the normal default-variant rules.
Dependency tree
Dependency-first compile order
- SNMPv2-SMIrfc
- SNMPv2-TCrfc
- IANAifType-MIBrfc
- SNMPv2-CONFrfc
- SNMPv2-MIBrfc
- IF-MIBrfc
- PTPBASE-MIBrfcselected
Type Definitions (17)
| Unsigned32 |
range: 0..255 |
|
| OctetString |
range: 8 |
|
| Unsigned32 |
range: 0..255 |
|
| Integer32 |
range: -128..127 |
|
| Enumeration |
e2e(1)p2p(2)disabled(254) |
|
| Unsigned32 |
range: 0..65535 |
|
| Enumeration |
initializing(1)faulty(2)disabled(3)listening(4)preMaster(5)master(6)passive(7)uncalibrated(8)slave(9) |
|
| OctetString |
range: 1..255 |
|
| Enumeration |
default(1)telecom(2)vendorspecific(3) |
|
| Enumeration |
nanoSecond25(32)nanoSecond100(33)nanoSecond250(34)microSec1(35)microSec2dot5(36)microSec10(37)microSec25(38)microSec100(39)microSec250(40)milliSec1(41)milliSec2dot5(42)milliSec10(43)milliSec25(44)milliSec100(45)milliSec250(46)second1(47)second10(48)secondGreater10(49)unknown(254) |
|
| Enumeration |
clockclass6(6)clockclass7(7)clockclass13(13)clockclass14(14)clockclass52(52)clockclass58(58) |
|
| Enumeration |
master(1)slave(2) |
|
| Enumeration |
freerun(1)holdover(2)acquiring(3)frequencyLocked(4)phaseAligned(5) |
|
| OctetString |
range: 1..255 |
|
| Enumeration |
atomicClock(16)gps(32)terrestrialRadio(48)ptp(64)ntp(80)handSet(96)other(144)internalOscillator(160) |
|
| Enumeration |
unicast(1)multicast(2)multicastmix(3) |
|
| Enumeration |
ordinaryClock(1)boundaryClock(2)transparentClock(3)boundaryNode(4) |
Conformance Groups (12)
Compliance Statements (4)
OID
.1.3.6.1.2.1.241.2.1.1Compliance statement for agents that provide read-only support
for PTPBASE-MIB to provide system-level information of clock
devices. 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.
for PTPBASE-MIB to provide system-level information of clock
devices. 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.
Required groups
| mandatory | ptpbaseMIBSystemInfoGroup |
OID
.1.3.6.1.2.1.241.2.1.2Compliance statement for agents that provide read-only support
for PTPBASE-MIB to provide clock-related information.
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.
for PTPBASE-MIB to provide clock-related information.
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.
Required groups
| mandatory | ptpbaseMIBClockCurrentDSGroup | |
| mandatory | ptpbaseMIBClockParentDSGroup | |
| mandatory | ptpbaseMIBClockDefaultDSGroup | |
| mandatory | ptpbaseMIBClockRunningGroup | |
| mandatory | ptpbaseMIBClockTimepropertiesGroup |
OID
.1.3.6.1.2.1.241.2.1.3Compliance statement for agents that provide read-only support
for PTPBASE-MIB to provide clock-port-related information.
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.
for PTPBASE-MIB to provide clock-port-related information.
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.
Required groups
| mandatory | ptpbaseMIBClockPortGroup | |
| mandatory | ptpbaseMIBClockPortDSGroup | |
| mandatory | ptpbaseMIBClockPortRunningGroup | |
| mandatory | ptpbaseMIBClockPortAssociateGroup |
OID
.1.3.6.1.2.1.241.2.1.4Compliance statement for agents that provide read-only support
for PTPBASE-MIB to provide transparent-clock-related
information. 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.
for PTPBASE-MIB to provide transparent-clock-related
information. 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.
Required groups
| mandatory | ptpbaseMIBClockTranparentDSGroup | |
| mandatory | ptpbaseMIBClockPortTransDSGroup |