idnits 2.17.1 draft-ietf-tictoc-ptp-mib-09.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- == There are 7 instances of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (April 21, 2016) is 2927 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Possible downref: Non-RFC (?) normative reference: ref. 'IEEE 1588-2008' -- Obsolete informational reference (is this intentional?): RFC 1906 (Obsoleted by RFC 3417) Summary: 0 errors (**), 0 flaws (~~), 2 warnings (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 TICTOC Working Group Vinay Shankarkumar 2 INTERNET DRAFT Laurent Montini 3 Intended status: Standards Track Cisco Systems 5 Tim Frost 6 Calnex Solutions Ltd. 8 Greg Dowd 9 Microsemi 11 Expires: October 21, 2016 April 21, 2016 13 Precision Time Protocol Version 2 (PTPv2) 14 Management Information Base 15 draft-ietf-tictoc-ptp-mib-09.txt 17 Status of this Memo 19 This Internet-Draft is submitted to IETF in full conformance with the 20 provisions of BCP 78 and BCP 79. 22 Internet-Drafts are working documents of the Internet Engineering 23 Task Force (IETF), its areas, and its working groups. Note that 24 other groups may also distribute working documents as Internet- 25 Drafts. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 The list of current Internet-Drafts can be accessed at 33 http://www.ietf.org/ietf/1id-abstracts.txt 35 The list of Internet-Draft Shadow Directories can be accessed at 36 http://www.ietf.org/shadow.html 38 This Internet-Draft will expire on October 21, 2016. 40 Copyright Notice 42 Copyright (c) 2016 IETF Trust and the persons identified as the 43 document authors. All rights reserved. 45 This document is subject to BCP 78 and the IETF Trust's Legal 46 Provisions Relating to IETF Documents 47 (http://trustee.ietf.org/license-info) in effect on the date of 48 publication of this document. Please review these documents 49 carefully, as they describe your rights and restrictions with respect 50 to this document. Code Components extracted from this document must 51 include Simplified BSD License text as described in Section 4.e of 52 the Trust Legal Provisions and are provided without warranty as 53 described in the Simplified BSD License. 55 Abstract 57 This memo defines a portion of the Management Information Base (MIB) 58 for use with network management protocols in TCP/IP-based internets. 59 In particular, it defines objects for managing networks using 60 Precision Time Protocol, specified in IEEE Std. 1588(TM)-2008. 62 This memo specifies a MIB module in a manner that is both compliant 63 to the SMIv2, and semantically identical to the peer SMIv1 64 definitions. 66 Table of Contents 68 1. Introduction ................................................. 2 69 1.1. Relationship to other Profiles and MIBs ................. 3 70 1.2. Change Log .............................................. 3 71 2. The SNMP Management Framework ................................ 5 72 3. Overview ..................................................... 6 73 4. IETF PTP MIB Definition ...................................... 6 74 5. Security Considerations ..................................... 6 75 6. IANA Considerations ......................................... 77 76 7. References .................................................. 77 77 7.1. Normative References ................................... 77 78 7.2. Informative References ................................. 77 79 8. Acknowledgements ............................................ 79 80 9. Author's Addresses .......................................... 79 82 1. Introduction 84 This memo defines a portion of the Management Information Base (MIB) 85 module for use with network management protocols in the Internet 86 Community. In particular, it describes managed objects used for 87 managing PTP devices including the ordinary clock, transparent clock, 88 boundary clocks. 90 This MIB module is restricted to reading standard PTP data elements, 91 as described in [IEEE 1588-2008]. This enables it to monitor the 92 operation of PTP clocks within the network. It is envisioned this 93 MIB module will complement other managed objects to be defined that 94 will provide more detailed information on the performance of PTP 95 clocks supporting the Telecom Profile defined in [G.8265.1], and any 96 future profiles that may be defined. Those objects are considered 97 out of scope for the current draft. 99 Similarly, this MIB module is read-only and not intended to provide 100 the ability to configure PTP clocks. Since PTP clocks are often 101 embedded in other network elements such as routers, switches and 102 gateways, this ability is generally provided via the configuration 103 interface for the network element. 105 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 106 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 107 document are to be interpreted as described in [RFC 2119]. 109 1.1. Relationship to other Profiles and MIBs 111 This MIB module is intended to be used with the default PTP profile 112 described in [IEEE 1588-2008] when running over the IP network layer. 113 As stated above, it is envisioned this MIB module will complement 114 other managed objects to be defined to monitor and measure the 115 performance of PTP clocks supporting specific PTP profiles, e.g. the 116 Telecom Profile defined in [G.8265.1]. 118 Some other PTP profiles have their own MIB modules defined as part of 119 the profile, and this MIB module is not intended to replace those MIB 120 modules. 122 1.2. Change Log 124 This section tracks changes made to the revisions of the Internet 125 Drafts of this document. It will be *deleted* when the document is 126 published as an RFC. 128 draft-vinay-tictoc-ptp-mib 130 -00 Mar 11 Initial version; showed structure of MIB 132 draft-ietf-tictoc-ptp-mib 134 -00 Jul 11 First full, syntactically correct and compileable MIB 136 -01 Jan 12 Revised following comments from Bert Wijnen: 137 - revised introduction to clarify the scope, and the 138 relationship to other MIBs and profiles 139 - changed name to "ptpbase" 140 - corrected some data types 141 - corrected references and typos 143 -02 Jul 12 Revised following comment at IETF83: 145 - changed "ptpbaseClockPortRunningIPversion" to the more 146 generic "ptpbaseClockPortRunningTransport", covering 147 all transport types defined in [IEEE 1588-2008] 148 (i.e. IPv4, IPv6, Ethernet, DeviceNet and ControlNet). 149 - changed addresses associated with transports from 150 "InetAddress" (for the IP transport) to a string, 151 to allow for the different transport types. 153 -03 Jul 12 Minor changes following comments from Andy Bierman: 154 - corrected some compilation errors 155 - moved OBJECT-GROUP and MODULE-COMPLIANCE macros to the 156 end 158 -04 Jan 13 Changes: 159 - Use of 'AutonomousType' import 160 - Display hint being specified for ClockIdentity, 161 ClockInterval, ClockPortTransportTypeAddress 162 Textual Conventions 163 - Removal of the Textual convention 164 ClockPortTransportType, replaced with the 165 wellKnownTransportTypes 166 - Modified ptpbaseClockPortCurrentPeerAddressType, 167 ptpbaseClockPortRunningTransport, 168 ptpbaseClockPortAssociateAddressType, to use 169 AutonomousType. 170 - various textual changes to descriptive text in 171 response to comments 173 -05 Feb 13 Several changes in response to comments from Alun Luchuk 174 and Kevin Gross: 175 - Modified the use of wellKnownTransportTypes and 176 wellKnownEncapsulationTypes 177 - changed ptpbaseClockPortSyncOneStep to 178 ptpbaseClockPortSyncTwoStep to match IEEE1588 179 semantics 180 - Re-ordered textual conventions to be alphabetic 181 - Changed some types from Integer32 to use defined 182 textual conventions 183 - various minor descriptive text changes 185 -06 Mar 14 Updated author information, and fixed typos 187 -07 Mar 15 Updated author information, and fixed typo/enum 189 -08 Feb 16 Updated MIB in response to Brian Haberman's comments: 190 - Fixed MIB date 191 - Fixed references to IEEE1588-2008 192 - Changed "router" for "node" 194 -09 Apr 16 Updated following Dan Romascanu's MIB Doctor comments 196 2. The SNMP Management Framework 198 The SNMP Management Framework presently consists of five major 199 components: 201 o An overall architecture, described in STD62, [RFC 3411]. 203 o Mechanisms for describing and naming objects and events for the 204 purpose of management. The first version of this Structure of 205 Management Information (SMI) is called SMIv1 and described in 206 STD 16: [RFC 1155], [RFC 1212] and [RFC 1215]. 207 The second version, called SMIv2, is described in STD 58: 208 [RFC 2578], [RFC 2579] and [RFC 2580]. 210 o Message protocols for transferring management information. The 211 first version of the SNMP message protocol is called SNMPv1 and 212 described in STD 15 [RFC 1157]. A second version of the SNMP 213 message protocol, which is not an Internet standards track 214 protocol, is called SNMPv2c and described in [RFC 1901] and 215 [RFC 1906]. The third version of the message protocol is called 216 SNMPv3 and described in STD62: [RFC 3417], [RFC 3412] and [RFC 217 3414]. 219 o Protocol operations for accessing management information. The 220 first set of protocol operations and associated PDU formats is 221 described in STD 15 [RFC 1157]. A second set of protocol 222 operations and associated PDU formats is described in STD 62 223 [RFC 3416]. 225 o A set of fundamental applications described in STD 62 [RFC 3413] 226 and the view-based access control mechanism described in STD 62 227 [RFC 3415]. 229 Managed objects are accessed via a virtual information store, termed 230 the Management Information Base or MIB. Objects in the MIB are 231 defined using the mechanisms defined in the SMI. 233 This memo specifies a MIB module that is compliant to the SMIv2. A 234 MIB module conforming to the SMIv1 can be produced through the 235 appropriate translations. The resulting translated MIB must be 236 semantically equivalent, except where objects or events are omitted 237 because no translation is possible (e.g., use of Counter64). Some 238 machine readable information in SMIv2 will be converted into textual 239 descriptions in SMIv1 during the translation process. However, this 240 loss of machine readable information is not considered to change the 241 semantics of the MIB module. 243 3. Overview 245 The objects defined in this MIB module are to be used when describing 246 the Precision Time Protocol (PTPv2). 248 4. IETF PTP MIB Definition 250 PTPBASE-MIB DEFINITIONS ::= BEGIN 252 IMPORTS 253 MODULE-IDENTITY, 254 OBJECT-TYPE, 255 OBJECT-IDENTITY, 256 Gauge32, 257 Unsigned32, 258 Counter32, 259 Counter64, 260 mib-2, 261 Integer32 262 FROM SNMPv2-SMI 263 OBJECT-GROUP, 264 MODULE-COMPLIANCE 265 FROM SNMPv2-CONF 266 TEXTUAL-CONVENTION, 267 TruthValue, 268 DisplayString, 269 AutonomousType 270 FROM SNMPv2-TC 271 InterfaceIndexOrZero 272 FROM IF-MIB; 274 ptpbaseMIB MODULE-IDENTITY 275 LAST-UPDATED "201604200000Z" 276 ORGANIZATION "TICTOC Working Group" 277 CONTACT-INFO 278 "WG Email: tictoc@ietf.org 280 Vinay Shankarkumar 281 Cisco Systems, 282 Email: vinays@cisco.com 284 Laurent Montini, 285 Cisco Systems, 286 Email: lmontini@cisco.com 288 Tim Frost, 289 Calnex Solutions Ltd., 290 Email: tim.frost@calnexsol.com 292 Greg Dowd, 293 Microsemi Inc., 294 Email: greg.dowd@microsemi.com" 296 DESCRIPTION 297 "The MIB module for PTP version 2 (IEEE Std. 1588(TM)-2008) 299 Overview of PTP version 2 (IEEE Std. 1588(TM)-2008) 301 [IEEE 1588-2008] defines a protocol enabling precise 302 synchronization of clocks in measurement and control systems 303 implemented with packet-based networks, the Precision Time 304 Protocol Version 2 (PTPv2). This MIB module does not address 305 the earlier version IEEE Std. 1588(TM)-2002 (PTPv1). The 306 protocol is applicable to network elements communicating using 307 IP. The protocol enables heterogeneous systems that include 308 clocks of various inherent precision, resolution, and stability 309 to synchronize to a grandmaster clock. 311 The protocol supports system-wide synchronization accuracy in 312 the sub-microsecond range with minimal network and local clock 313 computing resources. [IEEE 1588-2008] uses UDP/IP or 314 Ethernet and can be adapted to other mappings. It includes 315 formal mechanisms for message extensions, higher sampling rates, 316 correction for asymmetry, a clock type to reduce error 317 accumulation in large topologies, and specifications on how to 318 incorporate the resulting additional data into the 319 synchronization protocol. The [IEEE 1588-2008] defines 320 conformance and management capability also. 322 MIB description 324 This MIB module supports the Precision Time Protocol version 2 325 (PTPv2, hereafter designated as PTP) features of network element 326 system devices, when using the default PTP profile described in 327 [IEEE 1588-2008] when running over the IP network layer. 329 It is envisioned this MIB module will complement other managed 330 objects to be defined to monitor and measure the performance of 331 the PTP devices and telecom clocks supporting specific PTP 332 profiles. 334 Some other PTP profiles have their own MIB modules defined as 335 part of the profile, and this MIB module is not intended to 336 replace those MIB modules. 338 Acronyms: 339 ARB Arbitrary Timescale 340 E2E End-to-End 341 EUI Extended Unique Identifier 342 GPS Global Positioning System 343 IANA Internet Assigned Numbers Authority 344 IP Internet Protocol 345 MAC Media Access Control 346 according to [IEEE 802.3-2008] 347 MAC-48 Used to identify hardware instances within 802-based 348 networking applications. This is obsolete now. 349 NIST National Institute of Standards and Technology 350 NTP Network Time Protocol (see IETF [RFC 5905]) 351 OUI Organizational Unique Identifier 352 (allocated by the IEEE) 353 P2P Peer-to-Peer 354 PTP Precision Time Protocol 355 TAI International Atomic Time 356 TC Transparent Clock 357 UDP User Datagram Protocol 358 UTC Coordinated Universal Time 360 References: 361 [IEEE 1588-2008] IEEE Standard for A Precision Clock 362 Synchronization Protocol for Networked Measurement and 363 Control Systems, IEEE Std. 1588(TM)-2008, 24 July 2008. 365 As defined in [IEEE 1588-2008]: 367 Accuracy: 368 The mean of the time or frequency error between the clock under 369 test and a perfect reference clock, over an ensemble of 370 measurements. Stability is a measure of how the mean varies 371 with respect to variables such as time, temperature, and so on, 372 while the precision is a measure of the deviation of the error 373 from the mean. 375 Atomic process: 376 A process is atomic if the values of all inputs to the process 377 are not permitted to change until all of the results of the 378 process are instantiated, and the outputs of the process are 379 not visible to other processes until the processing of each 380 output is complete. 382 Boundary clock: 383 A clock that has multiple Precision Time Protocol (PTP) ports in 384 a domain and maintains the timescale used in the domain. It 385 may serve as the source of time, i.e., be a master clock, and 386 may synchronize to another clock, i.e., be a slave clock. 388 Boundary node clock: 389 A clock that has multiple Precision Time Protocol(PTP) ports in 390 a domain and maintains the timescale used in the domain. It 391 differs from a boundary clock in that the clock roles can 392 change. 394 Clock: 395 A node participating in the Precision Time Protocol (PTP) that 396 is capable of providing a measurement of the passage of time 397 since a defined epoch. 399 Domain: 400 A logical grouping of clocks that synchronize to each other 401 using the protocol, but that are not necessarily synchronized 402 to clocks in another domain. 404 End-to-end transparent clock: 405 A transparent clock that supports the use of the end-to-end 406 delay measurement mechanism between slave clocks and the master 407 clock. Each node must measure the residence time of PTP event 408 messages and accumulate it in Correction Field. 410 Epoch: 411 The origin of a timescale. 413 Event: 415 An abstraction of the mechanism by which signals or conditions 416 are generated and represented. 418 Foreign master: 419 An ordinary or boundary clock sending Announce messages to 420 another clock that is not the current master recognized by the 421 other clock. 423 Grandmaster clock: 424 Within a domain, a clock that is the ultimate source of time 425 for clock synchronization using the protocol. 427 Holdover: 428 A clock previously synchronized/syntonized to another clock 429 (normally a primary reference or a master clock) but now 430 free-running based on its own internal oscillator, whose 431 frequency is being adjusted using data acquired while it had 432 been synchronized/syntonized to the other clock. It is said to 433 be in holdover or in the holdover mode, as long as it is within 434 its accuracy requirements. 436 Link: 437 A network segment between two Precision Time Protocol ports 438 supporting the peer delay mechanism of this standard. The peer 439 delay mechanism is designed to measure the propagation time 440 over such a link. 442 Management node: 443 A device that configures and monitors clocks. 445 Master clock: 446 In the context of a single Precision Time Protocol 447 communication path, a clock that is the source of time to which 448 all other clocks on that path synchronize. 450 Message timestamp point: 451 A point within a Precision Time Protocol event message serving 452 as a reference point in the message. A timestamp is defined by 453 the instant a message timestamp point passes the reference 454 plane of a clock. 456 Multicast communication: 457 A communication model in which each Precision Time Protocol 458 message sent from any PTP port is capable of being received and 459 processed by all PTP ports on the same PTP communication path. 461 Node: 462 A device that can issue or receive Precision Time Protocol 463 communications on a network. 465 One-step clock: 466 A clock that provides time information using a single event 467 message. 469 On-pass support: 470 Indicates that each node in the synchronization chain from 471 master to slave can support IEEE-1588. 473 Ordinary clock: 474 A clock that has a single Precision Time Protocol port in a 475 domain and maintains the timescale used in the domain. It may 476 serve as a source of time, i.e., be a master clock, or may 477 synchronize to another clock, i.e., be a slave clock. 479 Parent clock: 480 The master clock to which a clock is synchronized. 482 Peer-to-peer transparent clock: 483 A transparent clock that, in addition to providing Precision 484 Time Protocol event transit time information, also provides 485 corrections for the propagation delay of the link connected to 486 the port receiving the PTP event message. In the presence of 487 peer-to-peer transparent clocks, delay measurements between 488 slave clocks and the master clock are performed using the 489 peer-to-peer delay measurement mechanism. 491 Phase change rate: 492 The observed rate of change in the measured time with respect 493 to the reference time. The phase change rate is equal to the 494 fractional frequency offset between the measured frequency and 495 the reference frequency. 497 PortNumber: 498 An index identifying a specific Precision Time Protocol port on 499 a PTP node. 501 Primary reference: 502 A source of time and or frequency that is traceable to 503 international standards. 505 Profile: 506 The set of allowed Precision Time Protocol features applicable 507 to a device. 509 Precision Time Protocol communication: 510 Information used in the operation of the protocol, transmitted 511 in a PTP message over a PTP communication path. 513 Precision Time Protocol communication path: 514 The signaling path portion of a particular network enabling 515 direct communication among ordinary and boundary clocks. 517 Precision Time Protocol node: 518 A PTP ordinary, boundary, or transparent clock or a device that 519 generates or parses PTP messages. 521 Precision Time Protocol port: 522 A logical access point of a clock for PTP communications to the 523 communications network. 525 Recognized standard time source: 526 A recognized standard time source is a source external to 527 Precision Time Protocol that provides time and/or frequency as 528 appropriate that is traceable to the international standards 529 laboratories maintaining clocks that form the basis for the 530 International Atomic Time and Universal Coordinated Time 531 timescales. Examples of these are GPS, NTP, and NIST 532 timeservers. 534 Requestor: 535 The port implementing the peer-to-peer delay mechanism that 536 initiates the mechanism by sending a Pdelay_Req message. 538 Responder: 539 The port responding to the receipt of a Pdelay_Req message as 540 part of the operation of the peer-to-peer delay mechanism. 542 Synchronized clocks: 543 Two clocks are synchronized to a specified uncertainty if they 544 have the same epoch and their measurements of the time of a 545 single event at an arbitrary time differ by no more than that 546 uncertainty. 548 Syntonized clocks: 549 Two clocks are syntonized if the duration of the second is the 550 same on both, which means the time as measured by each advances 551 at the same rate. They may or may not share the same epoch. 553 Timeout: 554 A mechanism for terminating requested activity that, at least 555 from the requester's perspective, does not complete within the 556 specified time. 558 Timescale: 559 A linear measure of time from an epoch. 561 Traceability: 562 A property of the result of a measurement or the value of a 563 standard whereby it can be related to stated references, 564 usually national or international standards, through an 565 unbroken chain of comparisons all having stated uncertainties. 567 Translation device: 568 A boundary clock or, in some cases, a transparent clock that 569 translates the protocol messages between regions implementing 570 different transport and messaging protocols, between different 571 versions of [IEEE 1588-2008], or different PTP profiles. 573 Transparent clock: 574 A device that measures the time taken for a Precision Time 575 Protocol event message to transit the device and provides this 576 information to clocks receiving this PTP event message. 578 Two-step clock: 579 A clock that provides time information using the combination of 580 an event message and a subsequent general message. 582 The below table specifies the object formats of the various 583 textual conventions used. 585 Data type mapping Textual Convention SYNTAX 586 ------------------- -------------------- ------------------ 587 5.3.2 TimeInterval PtpClockTimeInterval OCTET 588 STRING(SIZE(1..255)) 589 5.3.3 Timestamp PtpClockTimestamp OCTET STRING(SIZE(6)) 590 5.3.4 ClockIdentity PtpClockIdentity OCTET STRING(SIZE(8)) 591 5.3.5 PortIdentity PtpClockPortNumber INTEGER(1..65535) 592 5.3.7 ClockQuality PtpClockQualityClassType 594 Simple master-slave hierarchy, section 6.6.2.4 [IEEE 1588-2008]: 596 +---------------+ 597 | Ordinary | 598 | Clock -1 | 599 | (GrandMaster) | 600 +-------M-------+ 601 | 602 1 603 | 604 +---------------S-----------------+ 605 | Boundary | 606 | Clock -1 | 607 +-----M---------------------M-----+ 608 | | 609 2 3 610 | | 611 +-----S-----+ +------------S-------------+ 612 | Ordinary | | Boundary | 613 | Clock -2 | | Clock -2 | 614 +-----------+ +-----M--------------M-----+ 615 | | 616 4 5 617 | | 618 +-----S-----+ +-----S-----+ 619 | Ordinary | | Ordinary | 620 | Clock -3 | | Clock -4 | 621 +-----------+ +-----------+ 623 Grandmaster 624 Boundary Clock(0-N) 625 Ordinary Clocks(0-N) 627 Relationship cardinality: 628 PTP system 1 : N PTP Clocks 629 PTP Clock 1 : 1 Domain 630 PTP Clock 1 : N PTP Ports 631 PTP Ports N : M Physical Ports (interface in IF-MIB) 633 Transparent clock diagram, section 6.7.1.3 of [IEEE 1588-2008]: 635 +-----------------------------+ 636 | Boundary clock - 1 | 637 +-----------------------------+ 638 | | 639 | | 640 +-- A --+ B 641 | | 642 +----------------------+ | 643 | Ordinary clock | | 644 +----------------------+ | 645 +----------------------+ 646 +----------------------+ | End-to-end | 647 | Ordinary clock 1-1 |----------| transparent clock- | 648 +----------------------+ | 1 - 1 | 649 +----------------------+ 650 | 651 C 652 | 653 +----------------------+ 654 +----------------------+ | End-to-end | 655 | Ordinary clock 1-2 |----------| transparent clock- | 656 +----------------------+ | 1 - 2 | 657 +----------------------+ 659 The MIB module refers to the sections of [IEEE 1588-2008]." 661 -- revision log 662 REVISION "201604200000Z" 663 DESCRIPTION "Draft 9, for IESG approval." 665 REVISION "201602220000Z" 666 DESCRIPTION "Draft 8, for IETF last call." 668 ::= { mib-2 XXX } -- XXX to be assigned by IANA 670 -- Textual Conventions 672 PtpClockDomainType ::= TEXTUAL-CONVENTION 673 DISPLAY-HINT "d" 674 STATUS current 675 DESCRIPTION 676 "The Domain is identified by an integer, the domainNumber, in 677 the range of 0 to 255. An integer value that is used to assign 678 each PTP device to a particular domain. The following values 679 define the valid domains. 681 Value Definition 682 --------- ------------------- 683 0 Default domain 684 1 Alternate domain 1 685 2 Alternate domain 2 686 3 Alternate domain 3 687 4 - 127 User-defined domains 688 128 - 255 Reserved" 690 REFERENCE "Section 7.1 Domains, Table 2 of [IEEE 1588-2008]" 691 SYNTAX Unsigned32 (0..255) 693 PtpClockIdentity ::= TEXTUAL-CONVENTION 694 DISPLAY-HINT "255a" 695 STATUS current 696 DESCRIPTION 697 "The clock Identity is an 8-octet array and will be presented in 698 the form of a character array. Network byte order is assumed. 700 The value of the PtpClockIdentity should be taken from the 701 IEEE EUI-64 individual assigned numbers as indicated in 702 Section 7.5.2.2.2 of [IEEE 1588-2008]. 704 The EUI-64 address is divided into the following fields: 706 OUI bytes (0-2) 707 Extension identifier bytes (3-7) 709 The clock identifier can be constructed from existing EUI-48 710 assignments and here is an abbreviated example extracted from 711 section 7.5.2.2.2 [IEEE 1588-2008]. 713 Company EUI-48 = 0xACDE4823456716 714 EUI-64 = ACDE48FFFE23456716 716 It is important to note the IEEE Registration Authority has 717 deprecated the use of MAC-48 in any new design." 719 REFERENCE "Section 7.5.2.2.1 of [IEEE 1588-2008]" 720 SYNTAX OCTET STRING (SIZE (8)) 722 PtpClockInstanceType ::= TEXTUAL-CONVENTION 723 DISPLAY-HINT "d" 724 STATUS current 725 DESCRIPTION 726 "The instance of the Clock of a given clock type in a given 727 domain." 728 SYNTAX Unsigned32 (0..255) 730 PtpClockIntervalBase2 ::= TEXTUAL-CONVENTION 731 DISPLAY-HINT "d" 732 STATUS current 733 DESCRIPTION 734 "The interval included in message types Announce, Sync, 735 Delay_Req, and Pdelay_Req as indicated in section 7.7.2.1 of 736 [IEEE 1588-2008]. 738 The mean time interval between successive messages shall be 739 represented as the logarithm to the base 2 of this time 740 interval measured in seconds on the local clock of the device 741 sending the message. The values of these logarithmic attributes 742 shall be selected from integers in the range -128 to 127 subject 743 to further limits established in an applicable PTP profile." 745 REFERENCE "Section 7.7.2.1 General interval specification of 746 [IEEE 1588-2008]" 747 SYNTAX Integer32 (-128..127) 749 PtpClockMechanismType ::= TEXTUAL-CONVENTION 750 STATUS current 751 DESCRIPTION 752 "The clock type based on whether end-to-end or peer-to-peer 753 mechanisms are used. The mechanism used to calculate the Mean 754 Path Delay as indicated in Table 9 of [IEEE 1588-2008]. 756 Delay mechanism Value(hex) Specification 757 --------------- ---------- ------------- 758 E2E 01 The port is configured to use the 759 delay request-response mechanism. 760 P2P 02 The port is configured to use the 761 peer delay mechanism. 762 DISABLED FE The port does not implement the 763 delay mechanism." 765 REFERENCE 766 "Sections 8.2.5.4.4 portDS.delayMechanism, 767 6.6.4 Measuring link propagation delay in clocks supporting 768 peer-to-peer path correction, 769 7.4.2 communication path asymmetry of [IEEE 1588-2008]." 770 SYNTAX INTEGER { 771 e2e(1), 772 p2p(2), 773 disabled(254) 774 } 776 PtpClockPortNumber ::= TEXTUAL-CONVENTION 777 DISPLAY-HINT "d" 778 STATUS current 779 DESCRIPTION 780 "An index identifying a specific Precision Time Protocol (PTP) 781 port on a PTP node." 783 REFERENCE "Sections 7.5.2.3 portNumber and 5.3.5 PortIdentity of 784 [IEEE 1588-2008]" 785 SYNTAX Unsigned32 (0..65535) 787 PtpClockPortState ::= TEXTUAL-CONVENTION 788 STATUS current 789 DESCRIPTION 790 "This is the value of the current state of the protocol engine 791 associated with this port. 792 Port state Value Description 793 ----------------------------------------------------------- 794 initializing 1 In this state a port initializes 795 its data sets, hardware, and 796 communication facilities. 797 faulty 2 The fault state of the protocol. 799 disabled 3 The port shall not place any 800 messages on its communication path. 801 listening 4 The port is waiting for the 802 announceReceiptTimeout to expire or 803 to receive an Announce message from 804 a master. 805 preMaster 5 The port shall behave in all respects 806 as though it were in the MASTER state 807 except that it shall not place any 808 messages on its communication path 809 except for Pdelay_Req, Pdelay_Resp, 810 Pdelay_Resp_Follow_Up, signaling, or 811 management messages. 812 master 6 The port is behaving as a master port. 813 passive 7 The port shall not place any messages 814 on its communication path except for 815 Pdelay_Req, Pdelay_Resp, 816 Pdelay_Resp_Follow_Up, or signaling 817 messages, or management messages that 818 are a required response to another 819 management message 820 uncalibrated 8 The local port is preparing to 821 synchronize to the master port. 822 slave 9 The port is synchronizing to the 823 selected master port." 825 REFERENCE "Section 8.2.5.3.1 portState and 9.2.5 State 826 machines of [IEEE 1588-2008]" 827 SYNTAX INTEGER { 828 initializing(1), 829 faulty(2), 830 disabled(3), 831 listening(4), 832 preMaster(5), 833 master(6), 834 passive(7), 835 uncalibrated(8), 836 slave(9) 837 } 839 PtpClockPortTransportTypeAddress ::= TEXTUAL-CONVENTION 840 DISPLAY-HINT "255a" 841 STATUS current 842 DESCRIPTION 843 "The Clock port transport protocol address used for this 844 communication between the clock nodes. This is a string 845 corresponding to the address type as specified by the 846 transport type used. The transport types can be defined 847 elsewhere, in addition to the ones defined in this document. 848 This can be an address of type IP version 4, IP version 6, 849 Ethernet, DeviceNET, ControlNET or IEC61158." 851 REFERENCE "Annex D (IPv4), Annex E (IPv6), Annex F (Ethernet), 852 Annex G (DeviceNET), Annex H (ControlNET) and 853 Annex I (IEC61158) of [IEEE 1588-2008]" 854 SYNTAX OCTET STRING (SIZE (1..255)) 856 PtpClockProfileType ::= TEXTUAL-CONVENTION 857 STATUS current 858 DESCRIPTION 859 "Clock Profile used. A profile is the set of allowed Precision 860 Time Protocol (PTP) features applicable to a device." 862 REFERENCE "Section 3.1.30 profile and 19.3 PTP profiles of 863 [IEEE 1588-2008]" 864 SYNTAX INTEGER { 865 default(1), 866 telecom(2), 867 vendorspecific(3) 868 } 870 PtpClockQualityAccuracyType ::= TEXTUAL-CONVENTION 871 STATUS current 872 DESCRIPTION 873 "The ClockQuality as specified in sections 5.3.7, 7.6.2.5 and 874 Table 6 of [IEEE 1588-2008]. 876 The following values are not represented in the enumerated 877 values. 879 0x01-0x1F Reserved 880 0x32-0x7F Reserved 882 It is important to note that section 7.1.1 of [RFC 2578] allows 883 for gaps and enumerate values starting at zero when indicated by 884 the protocol." 886 REFERENCE 887 "Section 5.3.7 ClockQuality, 7.6.2.5 clockAccuracy and Table 6 888 clockAccuracy enumeration of [IEEE 1588-2008]" 889 SYNTAX INTEGER { 890 -- reserved00(0:31), 0x00 to 0x1F 891 nanoSecond25(32), -- 0x20 892 nanoSecond100(33), -- 0x21 893 nanoSecond250(34), -- 0x22 894 microSec1(35), -- 0x23 895 microSec2dot5(36), -- 0x24 896 microSec10(37), -- 0x25 897 microSec25(38), -- 0x26 898 microSec100(39), -- 0x27 899 microSec250(40), -- 0x28 900 milliSec1(41), -- 0x29 901 milliSec2dot5(42), -- 0x2A 902 milliSec10(43), -- 0x2B 903 milliSec25(44), -- 0x2C 904 milliSec100(45), -- 0x2D 905 milliSec250(46), -- 0x2E 906 second1(47), -- 0x2F 907 second10(48), -- 0x30 908 secondGreater10(49), -- 0x31 909 unknown(254) -- 0xFE 910 -- reserved255(255), 0xFF 911 } 913 PtpClockQualityClassType ::= TEXTUAL-CONVENTION 914 DISPLAY-HINT "d" 915 STATUS current 916 DESCRIPTION 917 "The ClockQuality as specified in section 5.3.7 ClockQuality, 918 7.6.2.4 clockClass and Table 5 clockClass specifications of 919 [IEEE 1588-2008]. 921 Value Description 922 -------- ------------------------------------------------ 923 0 Reserved to enable compatibility with future 924 versions. 925 1-5 Reserved 926 6 Shall designate a clock that is synchronized 927 to a primary reference time source. The 928 timescale distributed shall be PTP. A 929 clockClass 6 clock shall not be a slave to 930 another clock in the domain. 931 7 Shall designate a clock that has previously 932 been designated as clockClass 6 but that has 933 lost the ability to synchronize to a primary 934 reference time source and is in holdover mode 935 and within holdover specifications. The 936 timescale distributed shall be PTP. A 937 clockClass 7 clock shall not be a slave to 938 another clock in the domain. 939 8 Reserved. 940 9-10 Reserved to enable compatibility with future 941 versions. 942 11-12 Reserved. 943 13 Shall designate a clock that is synchronized 944 to an application-specific source of time. 945 The timescale distributed shall be ARB. A 946 clockClass 13 clock shall not be a slave to 947 another clock in the domain. 948 14 Shall designate a clock that has previously 949 been designated as clockClass 13 but that 950 has lost the ability to synchronize to an 951 application-specific source of time and is 952 in holdover mode and within holdover 953 specifications. The timescale distributed 954 shall be ARB. A clockClass 14 clock shall 955 not be a slave to another clock in the domain. 956 15-51 Reserved. 957 52 Degradation alternative A for a clock of 958 clockClass 7 that is not within holdover 959 specification. A clock of clockClass 52 960 shall not be a slave to another clock in 961 the domain. 962 53-57 Reserved. 963 58 Degradation alternative A for a clock of 964 clockClass 14 that is not within holdover 965 specification. A clock of clockClass 58 shall 966 not be a slave to another clock in the domain. 967 59-67 Reserved. 968 68-122 For use by alternate PTP profiles. 969 123-127 Reserved. 970 128-132 Reserved. 972 133-170 For use by alternate PTP profiles. 973 171-186 Reserved. 974 187 Degradation alternative B for a clock of 975 clockClass 7 that is not within holdover 976 specification. A clock of clockClass 187 may 977 be a slave to another clock in the domain. 978 188-192 Reserved. 979 193 Degradation alternative B for a clock of 980 clockClass 14 that is not within holdover 981 specification. A clock of clockClass 193 may 982 be a slave to another clock in the domain. 983 194-215 Reserved. 984 216-232 For use by alternate PTP profiles. 985 233-247 Reserved. 986 248 Default. This clockClass shall be used if 987 none of the other clockClass definitions apply. 988 249-250 Reserved. 989 251 Reserved for version 1 compatibility; see Clause 18. 990 252-254 Reserved. 991 255 Shall be the clockClass of a slave-only clock; see 992 9.2.2." 994 REFERENCE "Section 5.3.7, 7.6.2.4 and Table 5 of 995 [IEEE 1588-2008]." 996 SYNTAX Unsigned32 (0..255) 998 PtpClockRoleType ::= TEXTUAL-CONVENTION 999 STATUS current 1000 DESCRIPTION 1001 "The Clock Role. The protocol generates a Master Slave 1002 relationship among the clocks in the system. 1004 Clock Role Value Description 1005 -------------------------------------------------------------- 1006 Master clock 1 A clock that is the source of 1007 time to which all other clocks on 1008 that path synchronize. 1010 Slave clock 2 A clock which synchronizes to 1011 another clock (master)." 1012 SYNTAX INTEGER { 1013 master(1), 1014 slave(2) 1016 } 1018 PtpClockStateType ::= TEXTUAL-CONVENTION 1019 STATUS current 1020 DESCRIPTION 1021 "The clock state returned by a PTP engine. 1023 Clock State Value Description 1024 -------------------------------------------------------------- 1025 Freerun state 1 Applies to a slave device that is not 1026 locked to a master. This is the initial 1027 state a slave starts out with when it 1028 is not getting any PTP packets from the 1029 master or because of some other input 1030 error (erroneous packets, etc). 1032 Holdover state 2 In this state the slave device is 1033 locked to a master but communication 1034 with the master has been lost or the 1035 timestamps in the PTP packets are 1036 incorrect. Since the slave was 1037 locked to the master, it can run in this 1038 state, with similar accuracy for some 1039 time. If communication with the master 1040 is not restored for an extended period 1041 (dependent on the clock implementation), 1042 the device should move to the Freerun 1043 state. 1045 Acquiring state 3 The slave device is receiving packets 1046 from a master and is trying to acquire 1047 a lock. 1049 Freq_locked state 4 Slave device is locked to the Master 1050 with respect to frequency, but not phase 1051 aligned 1053 Phase_aligned state 5 Locked to the master with respect to 1054 frequency and phase." 1055 SYNTAX INTEGER { 1056 freerun(1), 1057 holdover(2), 1058 acquiring(3), 1059 frequencyLocked(4), 1060 phaseAligned(5) 1061 } 1063 PtpClockTimeInterval ::= TEXTUAL-CONVENTION 1064 DISPLAY-HINT "255a" 1065 STATUS current 1066 DESCRIPTION 1067 "This textual convention corresponds to the TimeInterval 1068 structure indicated in section 5.3.2 of [IEEE 1588-2008]. 1069 It will be presented in the form of a character array. 1070 Network byte order is assumed. 1072 The TimeInterval type represents time intervals. 1074 struct TimeInterval 1075 { 1076 Integer64 scaledNanoseconds; 1077 }; 1079 The scaledNanoseconds member is the time interval expressed in 1080 units of nanoseconds and multiplied by 2**16. 1082 Positive or negative time intervals outside the maximum range 1083 of this data type shall be encoded as the largest positive and 1084 negative values of the data type, respectively. 1086 For example, 2.5 ns is expressed as 0000 0000 0002 8000 in 1087 Base16." 1089 REFERENCE 1090 "Section 5.3.2 TimeInterval and section 7.7.2.1 Timer interval 1091 specification of [IEEE 1588-2008]" 1092 SYNTAX OCTET STRING (SIZE (1..255)) 1094 PtpClockTimeSourceType ::= TEXTUAL-CONVENTION 1095 STATUS current 1096 DESCRIPTION 1097 "The ClockQuality as specified in Sections 5.3.7, 7.6.2.6 and 1098 Table 7 of [IEEE 1588-2008]. 1100 The following values are not represented in the enumerated 1101 values. 1103 0xF0-0xFE For use by alternate PTP profiles 1104 0xFF Reserved 1106 It is important to note that section 7.1.1 RFC 2578 allows for 1107 gaps and enumerate values to start with zero when indicated by 1108 the protocol." 1110 REFERENCE "Section 5.3.7, 7.6.2.6 and Table 7 of 1111 [IEEE 1588-2008]." 1112 SYNTAX INTEGER { 1113 atomicClock(16), -- 0x10 1114 gps(32), -- 0x20 1115 terrestrialRadio(48), -- 0x22 1116 ptp(64), -- 0x40 1117 ntp(80), -- 0x50 1118 handSet(96), -- 0x60 1119 other(144), -- 0x90 1120 internalOscillator(160) -- 0xA0 1121 } 1123 PtpClockTxModeType ::= TEXTUAL-CONVENTION 1124 STATUS current 1125 DESCRIPTION 1126 "Transmission mode. 1128 Unicast: Using unicast communication channel. 1129 Multicast: Using Multicast communication channel. 1130 multicast-mix: Using multicast-unicast communication channel" 1131 SYNTAX INTEGER { 1132 unicast(1), 1133 multicast(2), 1134 multicastmix(3) 1135 } 1137 PtpClockType ::= TEXTUAL-CONVENTION 1138 STATUS current 1139 DESCRIPTION 1140 "The clock types as defined in the MIB module description." 1142 REFERENCE "Section 6.5.1 PTP device types of [IEEE 1588-2008]." 1143 SYNTAX INTEGER { 1144 ordinaryClock(1), 1145 boundaryClock(2), 1146 transparentClock(3), 1147 boundaryNode(4) 1148 } 1150 ptpbaseMIBNotifs OBJECT IDENTIFIER 1151 ::= { ptpbaseMIB 0 } 1153 ptpbaseMIBObjects OBJECT IDENTIFIER 1154 ::= { ptpbaseMIB 1 } 1156 ptpbaseMIBConformance OBJECT IDENTIFIER 1157 ::= { ptpbaseMIB 2 } 1159 ptpbaseMIBSystemInfo OBJECT IDENTIFIER 1160 ::= { ptpbaseMIBObjects 1 } 1162 ptpbaseMIBClockInfo OBJECT IDENTIFIER 1163 ::= { ptpbaseMIBObjects 2 } 1165 ptpbaseSystemTable OBJECT-TYPE 1166 SYNTAX SEQUENCE OF PtpbaseSystemEntry 1167 MAX-ACCESS not-accessible 1168 STATUS current 1169 DESCRIPTION 1170 "Table of count information about the PTP system for all 1171 domains." 1172 ::= { ptpbaseMIBSystemInfo 1 } 1174 ptpbaseSystemEntry OBJECT-TYPE 1175 SYNTAX PtpbaseSystemEntry 1176 MAX-ACCESS not-accessible 1177 STATUS current 1178 DESCRIPTION 1179 "An entry in the table, containing count information about a 1180 single domain. New row entries are added when the PTP clock for 1181 this domain is configured, while the unconfiguration of the PTP 1182 clock removes it." 1183 INDEX { 1184 ptpDomainIndex, 1185 ptpInstanceIndex 1186 } 1188 ::= { ptpbaseSystemTable 1 } 1190 PtpbaseSystemEntry ::= SEQUENCE { 1191 ptpDomainIndex PtpClockDomainType, 1192 ptpInstanceIndex PtpClockInstanceType, 1193 ptpDomainClockPortsTotal Gauge32 1194 } 1196 ptpDomainIndex OBJECT-TYPE 1197 SYNTAX PtpClockDomainType 1198 MAX-ACCESS not-accessible 1199 STATUS current 1200 DESCRIPTION 1201 "This object specifies the domain number used to create a 1202 logical 1203 group of PTP devices. The Clock Domain is a logical group of 1204 clocks and devices that synchronize with each other using the 1205 PTP protocol. 1207 0 Default domain 1208 1 Alternate domain 1 1209 2 Alternate domain 2 1210 3 Alternate domain 3 1211 4 - 127 User-defined domains 1212 128 - 255 Reserved" 1213 ::= { ptpbaseSystemEntry 1 } 1215 ptpInstanceIndex OBJECT-TYPE 1216 SYNTAX PtpClockInstanceType 1217 MAX-ACCESS not-accessible 1218 STATUS current 1219 DESCRIPTION 1220 "This object specifies the instance of the Clock for this 1221 domain." 1222 ::= { ptpbaseSystemEntry 2 } 1224 ptpDomainClockPortsTotal OBJECT-TYPE 1225 SYNTAX Gauge32 1226 UNITS "ptp ports" 1227 MAX-ACCESS read-only 1228 STATUS current 1229 DESCRIPTION 1230 "This object specifies the total number of clock ports 1231 configured within a domain in the system." 1232 ::= { ptpbaseSystemEntry 3 } 1234 ptpbaseSystemDomainTable OBJECT-TYPE 1235 SYNTAX SEQUENCE OF PtpbaseSystemDomainEntry 1236 MAX-ACCESS not-accessible 1237 STATUS current 1238 DESCRIPTION 1239 "Table of information about the PTP system for all clock modes 1240 -- ordinary, boundary or transparent." 1241 ::= { ptpbaseMIBSystemInfo 2 } 1243 ptpbaseSystemDomainEntry OBJECT-TYPE 1244 SYNTAX PtpbaseSystemDomainEntry 1245 MAX-ACCESS not-accessible 1246 STATUS current 1247 DESCRIPTION 1248 "An entry in the table, containing information about a single 1249 clock mode for the PTP system. A row entry gets added when PTP 1250 clocks are configured on the node." 1251 INDEX { ptpbaseSystemDomainClockTypeIndex } 1252 ::= { ptpbaseSystemDomainTable 1 } 1254 PtpbaseSystemDomainEntry ::= SEQUENCE { 1255 ptpbaseSystemDomainClockTypeIndex PtpClockType, 1256 ptpbaseSystemDomainTotals Unsigned32 1257 } 1259 ptpbaseSystemDomainClockTypeIndex OBJECT-TYPE 1260 SYNTAX PtpClockType 1261 MAX-ACCESS not-accessible 1262 STATUS current 1263 DESCRIPTION 1264 "This object specifies the clock type as defined in the 1265 Textual convention description." 1266 ::= { ptpbaseSystemDomainEntry 1 } 1268 ptpbaseSystemDomainTotals OBJECT-TYPE 1269 SYNTAX Unsigned32 1270 UNITS "domains" 1271 MAX-ACCESS read-only 1272 STATUS current 1273 DESCRIPTION 1274 "This object specifies the total number of PTP domains for this 1275 particular clock type configured in this node." 1276 ::= { ptpbaseSystemDomainEntry 2 } 1278 ptpbaseSystemProfile OBJECT-TYPE 1279 SYNTAX PtpClockProfileType 1280 MAX-ACCESS read-only 1281 STATUS current 1282 DESCRIPTION 1283 "This object specifies the PTP Profile implemented on the 1284 system." 1285 REFERENCE "Section 19.3 PTP profiles of [IEEE 1588-2008]" 1286 ::= { ptpbaseMIBSystemInfo 3 } 1288 ptpbaseClockCurrentDSTable OBJECT-TYPE 1289 SYNTAX SEQUENCE OF PtpbaseClockCurrentDSEntry 1290 MAX-ACCESS not-accessible 1291 STATUS current 1292 DESCRIPTION 1293 "Table of information about the PTP clock Current Datasets for 1294 all domains." 1295 ::= { ptpbaseMIBClockInfo 1 } 1297 ptpbaseClockCurrentDSEntry OBJECT-TYPE 1298 SYNTAX PtpbaseClockCurrentDSEntry 1299 MAX-ACCESS not-accessible 1300 STATUS current 1301 DESCRIPTION 1302 "An entry in the table, containing information about a single 1303 PTP clock Current Datasets for a domain." 1304 REFERENCE "Section 8.2.2 currentDS data set member 1305 specifications of [IEEE 1588-2008]" 1306 INDEX { 1307 ptpbaseClockCurrentDSDomainIndex, 1308 ptpbaseClockCurrentDSClockTypeIndex, 1309 ptpbaseClockCurrentDSInstanceIndex 1310 } 1311 ::= { ptpbaseClockCurrentDSTable 1 } 1313 PtpbaseClockCurrentDSEntry ::= SEQUENCE { 1314 ptpbaseClockCurrentDSDomainIndex PtpClockDomainType, 1315 ptpbaseClockCurrentDSClockTypeIndex PtpClockType, 1316 ptpbaseClockCurrentDSInstanceIndex PtpClockInstanceType, 1317 ptpbaseClockCurrentDSStepsRemoved Unsigned32, 1318 ptpbaseClockCurrentDSOffsetFromMaster PtpClockTimeInterval, 1319 ptpbaseClockCurrentDSMeanPathDelay PtpClockTimeInterval 1320 } 1322 ptpbaseClockCurrentDSDomainIndex OBJECT-TYPE 1323 SYNTAX PtpClockDomainType 1324 MAX-ACCESS not-accessible 1325 STATUS current 1326 DESCRIPTION 1327 "This object specifies the domain number used to create a 1328 logical 1329 group of PTP devices." 1330 ::= { ptpbaseClockCurrentDSEntry 1 } 1332 ptpbaseClockCurrentDSClockTypeIndex OBJECT-TYPE 1333 SYNTAX PtpClockType 1334 MAX-ACCESS not-accessible 1335 STATUS current 1336 DESCRIPTION 1337 "This object specifies the clock type as defined in the 1338 Textual convention description." 1339 ::= { ptpbaseClockCurrentDSEntry 2 } 1341 ptpbaseClockCurrentDSInstanceIndex OBJECT-TYPE 1342 SYNTAX PtpClockInstanceType 1343 MAX-ACCESS not-accessible 1344 STATUS current 1345 DESCRIPTION 1346 "This object specifies the instance of the clock for this clock 1347 type in the given domain." 1348 ::= { ptpbaseClockCurrentDSEntry 3 } 1350 ptpbaseClockCurrentDSStepsRemoved OBJECT-TYPE 1351 SYNTAX Unsigned32 1352 UNITS "Steps" 1353 MAX-ACCESS read-only 1354 STATUS current 1355 DESCRIPTION 1356 "The current clock dataset StepsRemoved value. 1358 This object specifies the distance measured by the number of 1359 Boundary clocks between the local clock and the Foreign master 1360 as indicated in the stepsRemoved field of Announce messages." 1361 REFERENCE "Section 8.2.2.2 stepsRemoved of [IEEE 1588-2008]" 1362 ::= { ptpbaseClockCurrentDSEntry 4 } 1364 ptpbaseClockCurrentDSOffsetFromMaster OBJECT-TYPE 1365 SYNTAX PtpClockTimeInterval 1366 UNITS "Time Interval" 1367 MAX-ACCESS read-only 1368 STATUS current 1369 DESCRIPTION 1370 "This object specifies the current clock dataset ClockOffset 1371 value. The value of the computation of the offset in time 1372 between a slave and a master clock." 1373 REFERENCE "Section 8.2.2.3 currentDS.offsetFromMaster of 1374 [IEEE 1588-2008]" 1375 ::= { ptpbaseClockCurrentDSEntry 5 } 1377 ptpbaseClockCurrentDSMeanPathDelay OBJECT-TYPE 1378 SYNTAX PtpClockTimeInterval 1379 UNITS "Time Interval" 1380 MAX-ACCESS read-only 1381 STATUS current 1382 DESCRIPTION 1383 "This object specifies the current clock dataset 1384 MeanPathDelay value. 1386 The mean path delay between a pair of ports as measured by the 1387 delay request-response mechanism." 1388 REFERENCE "Section 8.2.2.4 currentDS.meanPathDelay mean path 1389 Delay of [IEEE1588-2008]" 1390 ::= { ptpbaseClockCurrentDSEntry 6 } 1392 ptpbaseClockParentDSTable OBJECT-TYPE 1393 SYNTAX SEQUENCE OF PtpbaseClockParentDSEntry 1394 MAX-ACCESS not-accessible 1395 STATUS current 1396 DESCRIPTION 1397 "Table of information about the PTP clock Parent Datasets for 1398 all domains." 1399 ::= { ptpbaseMIBClockInfo 2 } 1401 ptpbaseClockParentDSEntry OBJECT-TYPE 1402 SYNTAX PtpbaseClockParentDSEntry 1403 MAX-ACCESS not-accessible 1404 STATUS current 1405 DESCRIPTION 1406 "An entry in the table, containing information about a single 1407 PTP clock Parent Datasets for a domain." 1408 REFERENCE 1409 "Section 8.2.3 parentDS data set member specifications of 1410 [IEEE 1588-2008]" 1411 INDEX { 1412 ptpbaseClockParentDSDomainIndex, 1413 ptpbaseClockParentDSClockTypeIndex, 1414 ptpbaseClockParentDSInstanceIndex 1415 } 1416 ::= { ptpbaseClockParentDSTable 1 } 1418 PtpbaseClockParentDSEntry ::= SEQUENCE { 1419 ptpbaseClockParentDSDomainIndex PtpClockDomainType, 1420 ptpbaseClockParentDSClockTypeIndex PtpClockType, 1421 ptpbaseClockParentDSInstanceIndex PtpClockInstanceType, 1422 ptpbaseClockParentDSParentPortIdentity OCTET STRING, 1423 ptpbaseClockParentDSParentStats TruthValue, 1424 ptpbaseClockParentDSOffset PtpClockIntervalBase2, 1425 ptpbaseClockParentDSClockPhChRate Integer32, 1426 ptpbaseClockParentDSGMClockIdentity PtpClockIdentity, 1427 ptpbaseClockParentDSGMClockPriority1 Unsigned32, 1428 ptpbaseClockParentDSGMClockPriority2 Unsigned32, 1429 ptpbaseClockParentDSGMClockQualityClass PtpClockQualityClassType, 1430 ptpbaseClockParentDSGMClockQualityAccuracy 1431 PtpClockQualityAccuracyType, 1432 ptpbaseClockParentDSGMClockQualityOffset Unsigned32 1433 } 1435 ptpbaseClockParentDSDomainIndex OBJECT-TYPE 1436 SYNTAX PtpClockDomainType 1437 MAX-ACCESS not-accessible 1438 STATUS current 1439 DESCRIPTION 1440 "This object specifies the domain number used to create a 1441 logical 1442 group of PTP devices." 1443 ::= { ptpbaseClockParentDSEntry 1 } 1445 ptpbaseClockParentDSClockTypeIndex OBJECT-TYPE 1446 SYNTAX PtpClockType 1447 MAX-ACCESS not-accessible 1448 STATUS current 1449 DESCRIPTION 1450 "This object specifies the clock type as defined in the 1451 Textual convention description." 1452 ::= { ptpbaseClockParentDSEntry 2 } 1454 ptpbaseClockParentDSInstanceIndex OBJECT-TYPE 1455 SYNTAX PtpClockInstanceType 1456 MAX-ACCESS not-accessible 1457 STATUS current 1458 DESCRIPTION 1459 "This object specifies the instance of the clock for this clock 1460 type in the given domain." 1461 ::= { ptpbaseClockParentDSEntry 3 } 1463 ptpbaseClockParentDSParentPortIdentity OBJECT-TYPE 1464 SYNTAX OCTET STRING(SIZE(1..256)) 1465 MAX-ACCESS read-only 1466 STATUS current 1467 DESCRIPTION 1468 "This object specifies the value of portIdentity of the port on 1469 the master that issues the Sync messages used in synchronizing 1470 this clock." 1471 REFERENCE 1472 "Section 8.2.3.2 parentDS.parentPortIdentity of 1473 [IEEE 1588-2008]" 1474 ::= { ptpbaseClockParentDSEntry 4 } 1476 ptpbaseClockParentDSParentStats OBJECT-TYPE 1477 SYNTAX TruthValue 1478 MAX-ACCESS read-only 1479 STATUS current 1480 DESCRIPTION 1481 "This object specifies the Parent Dataset ParentStats value. 1483 This value indicates whether the values of ParentDSOffset 1484 and ParentDSClockPhChRate have been measured and are valid. 1485 A TRUE value shall indicate valid data." 1486 REFERENCE "Section 8.2.3.3 parentDS.parentStats of 1487 [IEEE 1588-2008]" 1488 ::= { ptpbaseClockParentDSEntry 5 } 1490 ptpbaseClockParentDSOffset OBJECT-TYPE 1491 SYNTAX PtpClockIntervalBase2 (-128..127) 1492 MAX-ACCESS read-only 1493 STATUS current 1494 DESCRIPTION 1495 "This object specifies the Parent Dataset 1496 ParentOffsetScaledLogVariance value. 1498 This value is the variance of the parent clock's phase as 1499 measured by the local clock." 1500 REFERENCE 1501 "Section 8.2.3.4 1502 parentDS.observedParentOffsetScaledLogVariance 1503 [IEEE 1588-2008]" 1504 ::= { ptpbaseClockParentDSEntry 6 } 1506 ptpbaseClockParentDSClockPhChRate OBJECT-TYPE 1507 SYNTAX Integer32 1508 MAX-ACCESS read-only 1509 STATUS current 1510 DESCRIPTION 1511 "This object specifies the clock's parent dataset 1512 ParentClockPhaseChangeRate value. 1514 This value is an estimate of the parent clock's phase change 1515 rate as measured by the slave clock." 1516 REFERENCE 1517 "Section 8.2.3.5 1518 parentDS.observedParentClockPhaseChangeRate of 1519 [IEEE 1588-2008]" 1520 ::= { ptpbaseClockParentDSEntry 7 } 1522 ptpbaseClockParentDSGMClockIdentity OBJECT-TYPE 1523 SYNTAX PtpClockIdentity 1524 MAX-ACCESS read-only 1525 STATUS current 1526 DESCRIPTION 1527 "This object specifies the parent dataset Grandmaster clock 1528 identity." 1529 REFERENCE 1530 "Section 8.2.3.6 parentDS.grandmasterIdentity of 1531 [IEEE 1588-2008]" 1532 ::= { ptpbaseClockParentDSEntry 8 } 1534 ptpbaseClockParentDSGMClockPriority1 OBJECT-TYPE 1535 SYNTAX Unsigned32 1536 MAX-ACCESS read-only 1537 STATUS current 1538 DESCRIPTION 1539 "This object specifies the parent dataset Grandmaster clock 1540 priority1." 1541 REFERENCE 1542 "Section 8.2.3.8 parentDS.grandmasterPriority1 of 1543 [IEEE 1588-2008]" 1544 ::= { ptpbaseClockParentDSEntry 9 } 1546 ptpbaseClockParentDSGMClockPriority2 OBJECT-TYPE 1547 SYNTAX Unsigned32 1548 MAX-ACCESS read-only 1549 STATUS current 1550 DESCRIPTION 1551 "This object specifies the parent dataset grandmaster clock 1552 priority2." 1553 REFERENCE 1554 "Section 8.2.3.9 parentDS.grandmasterPriority2 of 1555 [IEEE 1588-2008]" 1556 ::= { ptpbaseClockParentDSEntry 10 } 1558 ptpbaseClockParentDSGMClockQualityClass OBJECT-TYPE 1559 SYNTAX PtpClockQualityClassType (0..255) 1560 MAX-ACCESS read-only 1561 STATUS current 1562 DESCRIPTION 1563 "This object specifies the parent dataset grandmaster clock 1564 quality class." 1565 REFERENCE 1566 "Section 8.2.3.7 parentDS.grandmasterClockQuality of 1567 [IEEE 1588-2008]" 1568 ::= { ptpbaseClockParentDSEntry 11 } 1570 ptpbaseClockParentDSGMClockQualityAccuracy OBJECT-TYPE 1571 SYNTAX PtpClockQualityAccuracyType 1572 MAX-ACCESS read-only 1573 STATUS current 1574 DESCRIPTION 1575 "This object specifies the parent dataset grandmaster clock 1576 quality accuracy." 1577 REFERENCE 1578 "Section 8.2.3.7 parentDS.grandmasterClockQuality of 1579 [IEEE 1588-2008]" 1580 ::= { ptpbaseClockParentDSEntry 12 } 1582 ptpbaseClockParentDSGMClockQualityOffset OBJECT-TYPE 1583 SYNTAX Unsigned32 1584 MAX-ACCESS read-only 1585 STATUS current 1586 DESCRIPTION 1587 "This object specifies the parent dataset grandmaster clock 1588 quality offset." 1589 REFERENCE 1590 "Section 8.2.3.7 parentDS.grandmasterClockQuality of 1591 [IEEE 1588-2008]" 1592 ::= { ptpbaseClockParentDSEntry 13 } 1594 ptpbaseClockDefaultDSTable OBJECT-TYPE 1595 SYNTAX SEQUENCE OF PtpbaseClockDefaultDSEntry 1596 MAX-ACCESS not-accessible 1597 STATUS current 1598 DESCRIPTION 1599 "Table of information about the PTP clock Default Datasets for 1600 all domains." 1601 ::= { ptpbaseMIBClockInfo 3 } 1603 ptpbaseClockDefaultDSEntry OBJECT-TYPE 1604 SYNTAX PtpbaseClockDefaultDSEntry 1605 MAX-ACCESS not-accessible 1606 STATUS current 1607 DESCRIPTION 1608 "An entry in the table, containing information about a single 1609 PTP clock Default Datasets for a domain." 1611 INDEX { 1612 ptpbaseClockDefaultDSDomainIndex, 1613 ptpbaseClockDefaultDSClockTypeIndex, 1614 ptpbaseClockDefaultDSInstanceIndex 1615 } 1616 ::= { ptpbaseClockDefaultDSTable 1 } 1618 PtpbaseClockDefaultDSEntry ::= SEQUENCE { 1619 ptpbaseClockDefaultDSDomainIndex PtpClockDomainType, 1620 ptpbaseClockDefaultDSClockTypeIndex PtpClockType, 1621 ptpbaseClockDefaultDSInstanceIndex PtpClockInstanceType, 1622 ptpbaseClockDefaultDSTwoStepFlag TruthValue, 1623 ptpbaseClockDefaultDSClockIdentity PtpClockIdentity, 1624 ptpbaseClockDefaultDSPriority1 Unsigned32, 1625 ptpbaseClockDefaultDSPriority2 Unsigned32, 1626 ptpbaseClockDefaultDSSlaveOnly TruthValue, 1627 ptpbaseClockDefaultDSQualityClass PtpClockQualityClassType, 1628 ptpbaseClockDefaultDSQualityAccuracy 1629 PtpClockQualityAccuracyType, 1630 ptpbaseClockDefaultDSQualityOffset Integer32 1631 } 1633 ptpbaseClockDefaultDSDomainIndex OBJECT-TYPE 1634 SYNTAX PtpClockDomainType 1635 MAX-ACCESS not-accessible 1636 STATUS current 1637 DESCRIPTION 1638 "This object specifies the domain number used to create a 1639 logical 1640 group of PTP devices." 1641 ::= { ptpbaseClockDefaultDSEntry 1 } 1643 ptpbaseClockDefaultDSClockTypeIndex OBJECT-TYPE 1644 SYNTAX PtpClockType 1645 MAX-ACCESS not-accessible 1646 STATUS current 1647 DESCRIPTION 1648 "This object specifies the clock type as defined in the 1649 Textual convention description." 1650 ::= { ptpbaseClockDefaultDSEntry 2 } 1652 ptpbaseClockDefaultDSInstanceIndex OBJECT-TYPE 1653 SYNTAX PtpClockInstanceType 1654 MAX-ACCESS not-accessible 1655 STATUS current 1656 DESCRIPTION 1657 "This object specifies the instance of the clock for this clock 1658 type in the given domain." 1659 ::= { ptpbaseClockDefaultDSEntry 3 } 1661 ptpbaseClockDefaultDSTwoStepFlag OBJECT-TYPE 1662 SYNTAX TruthValue 1663 MAX-ACCESS read-only 1664 STATUS current 1665 DESCRIPTION 1666 "This object specifies whether the Two Step process is used." 1667 ::= { ptpbaseClockDefaultDSEntry 4 } 1669 ptpbaseClockDefaultDSClockIdentity OBJECT-TYPE 1670 SYNTAX PtpClockIdentity 1671 MAX-ACCESS read-only 1672 STATUS current 1673 DESCRIPTION 1674 "This object specifies the default Datasets clock identity." 1675 ::= { ptpbaseClockDefaultDSEntry 5 } 1677 ptpbaseClockDefaultDSPriority1 OBJECT-TYPE 1678 SYNTAX Unsigned32 1679 MAX-ACCESS read-only 1680 STATUS current 1681 DESCRIPTION 1682 "This object specifies the default Datasets clock Priority1." 1683 ::= { ptpbaseClockDefaultDSEntry 6 } 1685 ptpbaseClockDefaultDSPriority2 OBJECT-TYPE 1686 SYNTAX Unsigned32 1687 MAX-ACCESS read-only 1688 STATUS current 1689 DESCRIPTION 1690 "This object specifies the default Datasets clock Priority2." 1691 ::= { ptpbaseClockDefaultDSEntry 7 } 1693 ptpbaseClockDefaultDSSlaveOnly OBJECT-TYPE 1694 SYNTAX TruthValue 1695 MAX-ACCESS read-only 1696 STATUS current 1697 DESCRIPTION 1698 "Whether the SlaveOnly flag is set." 1699 ::= { ptpbaseClockDefaultDSEntry 8 } 1701 ptpbaseClockDefaultDSQualityClass OBJECT-TYPE 1702 SYNTAX PtpClockQualityClassType (0..255) 1703 MAX-ACCESS read-only 1704 STATUS current 1705 DESCRIPTION 1706 "This object specifies the default dataset Quality Class." 1707 ::= { ptpbaseClockDefaultDSEntry 9 } 1709 ptpbaseClockDefaultDSQualityAccuracy OBJECT-TYPE 1710 SYNTAX PtpClockQualityAccuracyType 1711 MAX-ACCESS read-only 1712 STATUS current 1713 DESCRIPTION 1714 "This object specifies the default dataset Quality Accuracy." 1715 ::= { ptpbaseClockDefaultDSEntry 10 } 1717 ptpbaseClockDefaultDSQualityOffset OBJECT-TYPE 1718 SYNTAX Integer32 1719 MAX-ACCESS read-only 1720 STATUS current 1721 DESCRIPTION 1722 "This object specifies the default dataset Quality offset." 1723 ::= { ptpbaseClockDefaultDSEntry 11 } 1725 ptpbaseClockRunningTable OBJECT-TYPE 1726 SYNTAX SEQUENCE OF PtpbaseClockRunningEntry 1727 MAX-ACCESS not-accessible 1728 STATUS current 1729 DESCRIPTION 1730 "Table of information about the PTP clock Running Datasets for 1731 all domains." 1732 ::= { ptpbaseMIBClockInfo 4 } 1734 ptpbaseClockRunningEntry OBJECT-TYPE 1735 SYNTAX PtpbaseClockRunningEntry 1736 MAX-ACCESS not-accessible 1737 STATUS current 1738 DESCRIPTION 1739 "An entry in the table, containing information about a single 1740 PTP clock running Datasets for a domain." 1741 INDEX { 1742 ptpbaseClockRunningDomainIndex, 1743 ptpbaseClockRunningClockTypeIndex, 1744 ptpbaseClockRunningInstanceIndex 1745 } 1746 ::= { ptpbaseClockRunningTable 1 } 1748 PtpbaseClockRunningEntry ::= SEQUENCE { 1749 ptpbaseClockRunningDomainIndex PtpClockDomainType, 1750 ptpbaseClockRunningClockTypeIndex PtpClockType, 1751 ptpbaseClockRunningInstanceIndex PtpClockInstanceType, 1752 ptpbaseClockRunningState PtpClockStateType, 1753 ptpbaseClockRunningPacketsSent Counter64, 1754 ptpbaseClockRunningPacketsReceived Counter64 1755 } 1757 ptpbaseClockRunningDomainIndex OBJECT-TYPE 1758 SYNTAX PtpClockDomainType 1759 MAX-ACCESS not-accessible 1760 STATUS current 1761 DESCRIPTION 1762 "This object specifies the domain number used to create a 1763 logical 1764 group of PTP devices." 1765 ::= { ptpbaseClockRunningEntry 1 } 1767 ptpbaseClockRunningClockTypeIndex OBJECT-TYPE 1768 SYNTAX PtpClockType 1769 MAX-ACCESS not-accessible 1770 STATUS current 1771 DESCRIPTION 1772 "This object specifies the clock type as defined in the 1773 Textual convention description." 1774 ::= { ptpbaseClockRunningEntry 2 } 1776 ptpbaseClockRunningInstanceIndex OBJECT-TYPE 1777 SYNTAX PtpClockInstanceType 1778 MAX-ACCESS not-accessible 1779 STATUS current 1780 DESCRIPTION 1781 "This object specifies the instance of the clock for this clock 1782 type in the given domain." 1783 ::= { ptpbaseClockRunningEntry 3 } 1785 ptpbaseClockRunningState OBJECT-TYPE 1786 SYNTAX PtpClockStateType 1787 MAX-ACCESS read-only 1788 STATUS current 1789 DESCRIPTION 1790 "This object specifies the Clock state returned by a PTP engine 1791 which was described earlier. 1793 Freerun state. Applies to a slave device that is not locked to 1794 a master. This is the initial state a slave starts out with 1795 when it is not getting any PTP packets from the master, or 1796 because of some other input error (erroneous packets, etc). 1798 Holdover state. In this state the slave device is locked to a 1799 master but communication with the master has been lost or the 1800 timestamps in the PTP packets are incorrect. Since the 1801 slave was previously locked to the master, it can run in this 1802 state, with similar accuracy for some time. If communication 1803 with the master is not restored for an extended period 1804 (dependent on the clock implementation), the device should move 1805 to the FREERUN state. 1807 Acquiring state. The slave device is receiving packets from a 1808 master and is trying to acquire a lock. 1810 Freq_locked state. Slave device is locked to the Master with 1811 respect to frequency, but not phase aligned 1813 Phase_aligned state. Locked to the master with respect to 1814 frequency and phase." 1815 ::= { ptpbaseClockRunningEntry 4 } 1817 ptpbaseClockRunningPacketsSent OBJECT-TYPE 1818 SYNTAX Counter64 1819 MAX-ACCESS read-only 1820 STATUS current 1821 DESCRIPTION 1822 "This object specifies the total number of all unicast and 1823 multicast packets that have been sent out for this clock in this 1824 domain for this type." 1825 ::= { ptpbaseClockRunningEntry 5 } 1827 ptpbaseClockRunningPacketsReceived OBJECT-TYPE 1828 SYNTAX Counter64 1829 MAX-ACCESS read-only 1830 STATUS current 1831 DESCRIPTION 1832 "This object specifies the total number of all unicast and 1833 multicast packets that have been received for this clock in this 1834 domain for this type." 1835 ::= { ptpbaseClockRunningEntry 6 } 1837 ptpbaseClockTimePropertiesDSTable OBJECT-TYPE 1838 SYNTAX SEQUENCE OF PtpbaseClockTimePropertiesDSEntry 1839 MAX-ACCESS not-accessible 1840 STATUS current 1841 DESCRIPTION 1842 "Table of information about the PTP clock time properties 1843 datasets for all domains." 1844 ::= { ptpbaseMIBClockInfo 5 } 1846 ptpbaseClockTimePropertiesDSEntry OBJECT-TYPE 1847 SYNTAX PtpbaseClockTimePropertiesDSEntry 1848 MAX-ACCESS not-accessible 1849 STATUS current 1850 DESCRIPTION 1851 "An entry in the table, containing information about a single 1852 PTP clock timeproperties Datasets for a domain." 1853 REFERENCE "Section 8.2.4 timePropertiesDS data set member 1854 specifications of [IEEE 1588-2008]" 1855 INDEX { 1856 ptpbaseClockTimePropertiesDSDomainIndex, 1857 ptpbaseClockTimePropertiesDSClockTypeIndex, 1858 ptpbaseClockTimePropertiesDSInstanceIndex 1859 } 1860 ::= { ptpbaseClockTimePropertiesDSTable 1 } 1862 PtpbaseClockTimePropertiesDSEntry ::= SEQUENCE { 1863 ptpbaseClockTimePropertiesDSDomainIndex PtpClockDomainType, 1864 ptpbaseClockTimePropertiesDSClockTypeIndex PtpClockType, 1865 ptpbaseClockTimePropertiesDSInstanceIndex 1866 PtpClockInstanceType, 1867 ptpbaseClockTimePropertiesDSCurrentUTCOffsetValid TruthValue, 1868 ptpbaseClockTimePropertiesDSCurrentUTCOffset Integer32, 1869 ptpbaseClockTimePropertiesDSLeap59 TruthValue, 1870 ptpbaseClockTimePropertiesDSLeap61 TruthValue, 1871 ptpbaseClockTimePropertiesDSTimeTraceable TruthValue, 1872 ptpbaseClockTimePropertiesDSFreqTraceable TruthValue, 1873 ptpbaseClockTimePropertiesDSPTPTimescale TruthValue, 1874 ptpbaseClockTimePropertiesDSSource 1875 PtpClockTimeSourceType 1876 } 1878 ptpbaseClockTimePropertiesDSDomainIndex OBJECT-TYPE 1879 SYNTAX PtpClockDomainType 1880 MAX-ACCESS not-accessible 1881 STATUS current 1882 DESCRIPTION 1883 "This object specifies the domain number used to create a 1884 logical 1885 group of PTP devices." 1886 ::= { ptpbaseClockTimePropertiesDSEntry 1 } 1888 ptpbaseClockTimePropertiesDSClockTypeIndex OBJECT-TYPE 1889 SYNTAX PtpClockType 1890 MAX-ACCESS not-accessible 1891 STATUS current 1892 DESCRIPTION 1893 "This object specifies the clock type as defined in the 1894 Textual convention description." 1895 ::= { ptpbaseClockTimePropertiesDSEntry 2 } 1897 ptpbaseClockTimePropertiesDSInstanceIndex OBJECT-TYPE 1898 SYNTAX PtpClockInstanceType 1899 MAX-ACCESS not-accessible 1900 STATUS current 1901 DESCRIPTION 1902 "This object specifies the instance of the clock for this clock 1903 type in the given domain." 1904 ::= { ptpbaseClockTimePropertiesDSEntry 3 } 1906 ptpbaseClockTimePropertiesDSCurrentUTCOffsetValid OBJECT-TYPE 1907 SYNTAX TruthValue 1908 MAX-ACCESS read-only 1909 STATUS current 1910 DESCRIPTION 1911 "This object specifies the timeproperties dataset value of 1912 whether the current UTC offset is valid." 1913 REFERENCE "Section 8.2.4.2 timePropertiesDS.currentUtcOffset 1914 of [IEEE 1588-2008]" 1915 ::= { ptpbaseClockTimePropertiesDSEntry 4 } 1917 ptpbaseClockTimePropertiesDSCurrentUTCOffset OBJECT-TYPE 1918 SYNTAX Integer32 1919 MAX-ACCESS read-only 1920 STATUS current 1921 DESCRIPTION 1922 "This object specifies the timeproperties dataset value of 1923 the current UTC offset. 1925 In PTP systems whose epoch is the PTP epoch, the value of 1926 timePropertiesDS.currentUtcOffset is the offset 1927 between TAI and UTC; otherwise the value has no meaning. The 1928 value shall be in units of seconds. 1929 The initialization value shall be selected as follows: 1930 a) If the timePropertiesDS.ptpTimescale (see 8.2.4.8) is TRUE, 1931 the value is the value obtained from a 1932 primary reference if the value is known at the time of 1933 initialization, else, 1934 b) The value shall be the current number of leap seconds (7.2.3) 1935 when the node is designed." 1936 REFERENCE "Section 8.2.4.3 1937 timePropertiesDS.currentUtcOffsetValid 1938 of [IEEE 1588-2008]" 1939 ::= { ptpbaseClockTimePropertiesDSEntry 5 } 1941 ptpbaseClockTimePropertiesDSLeap59 OBJECT-TYPE 1942 SYNTAX TruthValue 1943 MAX-ACCESS read-only 1944 STATUS current 1945 DESCRIPTION 1946 "This object specifies the Leap59 value in the clock Current 1947 Dataset." 1948 REFERENCE "Section 8.2.4.4 timePropertiesDS.leap59 of [IEEE 1949 1588-2008]" 1950 ::= { ptpbaseClockTimePropertiesDSEntry 6 } 1952 ptpbaseClockTimePropertiesDSLeap61 OBJECT-TYPE 1953 SYNTAX TruthValue 1954 MAX-ACCESS read-only 1955 STATUS current 1956 DESCRIPTION 1957 "This object specifies the Leap61 value in the clock Current 1958 Dataset." 1959 REFERENCE "Section 8.2.4.5 timePropertiesDS.leap61 of 1960 [IEEE 1588-2008]" 1961 ::= { ptpbaseClockTimePropertiesDSEntry 7 } 1963 ptpbaseClockTimePropertiesDSTimeTraceable OBJECT-TYPE 1964 SYNTAX TruthValue 1965 MAX-ACCESS read-only 1966 STATUS current 1967 DESCRIPTION 1968 "This object specifies the Timetraceable value in the clock 1969 Current Dataset." 1970 REFERENCE "Section 8.2.4.6 timePropertiesDS.timeTraceable of 1971 [IEEE 1588-2008]" 1972 ::= { ptpbaseClockTimePropertiesDSEntry 8 } 1974 ptpbaseClockTimePropertiesDSFreqTraceable OBJECT-TYPE 1975 SYNTAX TruthValue 1976 MAX-ACCESS read-only 1977 STATUS current 1978 DESCRIPTION 1979 "This object specifies the Frequency Traceable value in the 1980 clock Current Dataset." 1981 REFERENCE "Section 8.2.4.7 timePropertiesDS.frequencyTraceable 1982 of [IEEE 1588-2008]" 1983 ::= { ptpbaseClockTimePropertiesDSEntry 9 } 1985 ptpbaseClockTimePropertiesDSPTPTimescale OBJECT-TYPE 1986 SYNTAX TruthValue 1987 MAX-ACCESS read-only 1988 STATUS current 1989 DESCRIPTION 1990 "This object specifies the PTP Timescale value in the clock 1991 Current Dataset." 1992 REFERENCE "Section 8.2.4.8 timePropertiesDS.ptpTimescale of 1993 [IEEE 1588-2008]" 1995 ::= { ptpbaseClockTimePropertiesDSEntry 10 } 1997 ptpbaseClockTimePropertiesDSSource OBJECT-TYPE 1998 SYNTAX PtpClockTimeSourceType 1999 MAX-ACCESS read-only 2000 STATUS current 2001 DESCRIPTION 2002 "This object specifies the Timesource value in the clock Current 2003 Dataset." 2004 REFERENCE "Section 8.2.4.9 timePropertiesDS.timeSource of 2005 [IEEE 1588-2008]" 2006 ::= { ptpbaseClockTimePropertiesDSEntry 11 } 2008 ptpbaseClockTransDefaultDSTable OBJECT-TYPE 2009 SYNTAX SEQUENCE OF PtpbaseClockTransDefaultDSEntry 2010 MAX-ACCESS not-accessible 2011 STATUS current 2012 DESCRIPTION 2013 "Table of information about the PTP Transparent clock Default 2014 Datasets for all domains." 2015 ::= { ptpbaseMIBClockInfo 6 } 2017 ptpbaseClockTransDefaultDSEntry OBJECT-TYPE 2018 SYNTAX PtpbaseClockTransDefaultDSEntry 2019 MAX-ACCESS not-accessible 2020 STATUS current 2021 DESCRIPTION 2022 "An entry in the table, containing information about a single 2023 PTP Transparent clock Default Datasets for a domain." 2024 REFERENCE "Section 8.3.2 transparentClockDefaultDS data set 2025 member specifications of [IEEE 1588-2008]" 2026 INDEX { 2027 ptpbaseClockTransDefaultDSDomainIndex, 2028 ptpbaseClockTransDefaultDSInstanceIndex 2029 } 2030 ::= { ptpbaseClockTransDefaultDSTable 1 } 2032 PtpbaseClockTransDefaultDSEntry ::= SEQUENCE { 2033 ptpbaseClockTransDefaultDSDomainIndex PtpClockDomainType, 2034 ptpbaseClockTransDefaultDSInstanceIndex PtpClockInstanceType, 2035 ptpbaseClockTransDefaultDSClockIdentity PtpClockIdentity, 2036 ptpbaseClockTransDefaultDSNumOfPorts Counter32, 2037 ptpbaseClockTransDefaultDSDelay PtpClockMechanismType, 2038 ptpbaseClockTransDefaultDSPrimaryDomain PtpClockDomainType 2039 } 2041 ptpbaseClockTransDefaultDSDomainIndex OBJECT-TYPE 2042 SYNTAX PtpClockDomainType 2043 MAX-ACCESS not-accessible 2044 STATUS current 2045 DESCRIPTION 2046 "This object specifies the domain number used to create a 2047 logical 2048 group of PTP devices." 2049 ::= { ptpbaseClockTransDefaultDSEntry 1 } 2051 ptpbaseClockTransDefaultDSInstanceIndex OBJECT-TYPE 2052 SYNTAX PtpClockInstanceType 2053 MAX-ACCESS not-accessible 2054 STATUS current 2055 DESCRIPTION 2056 "This object specifies the instance of the clock for this clock 2057 type in the given domain." 2058 ::= { ptpbaseClockTransDefaultDSEntry 2 } 2060 ptpbaseClockTransDefaultDSClockIdentity OBJECT-TYPE 2061 SYNTAX PtpClockIdentity 2062 MAX-ACCESS read-only 2063 STATUS current 2064 DESCRIPTION 2065 "This object specifies the value of the clockIdentity attribute 2066 of the local clock." 2067 REFERENCE "Section 8.3.2.2.1 2068 transparentClockDefaultDS.clockIdentity of [IEEE 1588-2008]" 2069 ::= { ptpbaseClockTransDefaultDSEntry 3 } 2071 ptpbaseClockTransDefaultDSNumOfPorts OBJECT-TYPE 2072 SYNTAX Counter32 2073 MAX-ACCESS read-only 2074 STATUS current 2075 DESCRIPTION 2076 "This object specifies the number of PTP ports of the device." 2077 REFERENCE 2078 "Section 8.3.2.2.2 transparentClockDefaultDS.numberPorts of 2080 [IEEE 1588-2008]" 2081 ::= { ptpbaseClockTransDefaultDSEntry 4 } 2083 ptpbaseClockTransDefaultDSDelay OBJECT-TYPE 2084 SYNTAX PtpClockMechanismType 2085 MAX-ACCESS read-only 2086 STATUS current 2087 DESCRIPTION 2088 "This object, if the transparent clock is an end-to-end 2089 transparent clock, has the value of E2E; if the 2090 transparent clock is a peer-to-peer transparent clock, the 2091 value 2092 shall be P2P." 2093 REFERENCE 2094 "Section 8.3.2.3.1 transparentClockDefaultDS.delayMechanism of 2095 [IEEE 1588-2008]" 2096 ::= { ptpbaseClockTransDefaultDSEntry 5 } 2098 ptpbaseClockTransDefaultDSPrimaryDomain OBJECT-TYPE 2099 SYNTAX PtpClockDomainType 2100 MAX-ACCESS read-only 2101 STATUS current 2102 DESCRIPTION 2103 "This object specifies the value of the primary syntonization 2104 domain. The initialization value shall be 0." 2105 REFERENCE 2106 "Section 8.3.2.3.2 transparentClockDefaultDS.primaryDomain of 2107 [IEEE 1588-2008]" 2108 ::= { ptpbaseClockTransDefaultDSEntry 6 } 2110 ptpbaseClockPortTable OBJECT-TYPE 2111 SYNTAX SEQUENCE OF PtpbaseClockPortEntry 2112 MAX-ACCESS not-accessible 2113 STATUS current 2114 DESCRIPTION 2115 "Table of information about the clock ports for a particular 2116 domain." 2117 ::= { ptpbaseMIBClockInfo 7 } 2119 ptpbaseClockPortEntry OBJECT-TYPE 2120 SYNTAX PtpbaseClockPortEntry 2121 MAX-ACCESS not-accessible 2122 STATUS current 2123 DESCRIPTION 2124 "An entry in the table, containing information about a single 2125 clock port." 2126 INDEX { 2127 ptpbaseClockPortDomainIndex, 2128 ptpbaseClockPortClockTypeIndex, 2129 ptpbaseClockPortClockInstanceIndex, 2130 ptpbaseClockPortTablePortNumberIndex 2131 } 2132 ::= { ptpbaseClockPortTable 1 } 2134 PtpbaseClockPortEntry ::= SEQUENCE { 2135 ptpbaseClockPortDomainIndex PtpClockDomainType, 2136 ptpbaseClockPortClockTypeIndex PtpClockType, 2137 ptpbaseClockPortClockInstanceIndex PtpClockInstanceType, 2138 ptpbaseClockPortTablePortNumberIndex PtpClockPortNumber, 2139 ptpbaseClockPortName DisplayString, 2140 ptpbaseClockPortRole PtpClockRoleType, 2141 ptpbaseClockPortSyncTwoStep TruthValue, 2142 ptpbaseClockPortCurrentPeerAddressType AutonomousType, 2143 ptpbaseClockPortCurrentPeerAddress 2144 PtpClockPortTransportTypeAddress, 2145 ptpbaseClockPortNumOfAssociatedPorts Gauge32 2146 } 2148 ptpbaseClockPortDomainIndex OBJECT-TYPE 2149 SYNTAX PtpClockDomainType 2150 MAX-ACCESS not-accessible 2151 STATUS current 2152 DESCRIPTION 2153 "This object specifies the domain number used to create a 2154 logical 2155 group of PTP devices." 2156 ::= { ptpbaseClockPortEntry 1 } 2158 ptpbaseClockPortClockTypeIndex OBJECT-TYPE 2159 SYNTAX PtpClockType 2160 MAX-ACCESS not-accessible 2161 STATUS current 2162 DESCRIPTION 2163 "This object specifies the clock type as defined in the 2164 Textual convention description." 2165 ::= { ptpbaseClockPortEntry 2 } 2167 ptpbaseClockPortClockInstanceIndex OBJECT-TYPE 2168 SYNTAX PtpClockInstanceType 2169 MAX-ACCESS not-accessible 2170 STATUS current 2171 DESCRIPTION 2172 "This object specifies the instance of the clock for this clock 2173 type in the given domain." 2174 ::= { ptpbaseClockPortEntry 3 } 2176 ptpbaseClockPortTablePortNumberIndex OBJECT-TYPE 2177 SYNTAX PtpClockPortNumber 2178 MAX-ACCESS not-accessible 2179 STATUS current 2180 DESCRIPTION 2181 "This object specifies the PTP Portnumber for this port." 2182 ::= { ptpbaseClockPortEntry 4 } 2184 ptpbaseClockPortName OBJECT-TYPE 2185 SYNTAX DisplayString (SIZE (1..64)) 2186 MAX-ACCESS read-only 2187 STATUS current 2188 DESCRIPTION 2189 "This object specifies the PTP clock port name configured on the 2190 node." 2191 ::= { ptpbaseClockPortEntry 5 } 2193 ptpbaseClockPortRole OBJECT-TYPE 2194 SYNTAX PtpClockRoleType 2195 MAX-ACCESS read-only 2196 STATUS current 2197 DESCRIPTION 2198 "This object describes the current role (slave/master) of the 2199 port." 2200 ::= { ptpbaseClockPortEntry 6 } 2202 ptpbaseClockPortSyncTwoStep OBJECT-TYPE 2203 SYNTAX TruthValue 2204 MAX-ACCESS read-only 2205 STATUS current 2206 DESCRIPTION 2207 "This object specifies that two-step clock operation between 2208 the PTP master and slave device is enabled." 2209 ::= { ptpbaseClockPortEntry 7 } 2211 ptpbaseClockPortCurrentPeerAddressType OBJECT-TYPE 2212 SYNTAX AutonomousType 2213 MAX-ACCESS read-only 2214 STATUS current 2215 DESCRIPTION 2216 "This object specifies the current peer's network address type 2217 used for PTP communication." 2218 ::= { ptpbaseClockPortEntry 8 } 2220 ptpbaseClockPortCurrentPeerAddress OBJECT-TYPE 2221 SYNTAX PtpClockPortTransportTypeAddress 2222 MAX-ACCESS read-only 2223 STATUS current 2224 DESCRIPTION 2225 "This object specifies the current peer's network address used 2226 for PTP communication." 2227 ::= { ptpbaseClockPortEntry 9 } 2229 ptpbaseClockPortNumOfAssociatedPorts OBJECT-TYPE 2230 SYNTAX Gauge32 2231 MAX-ACCESS read-only 2232 STATUS current 2233 DESCRIPTION 2234 "This object specifies - 2235 For a master port - the number of PTP slave sessions (peers) 2236 associated with this PTP port. 2237 For a slave port - the number of masters available to this slave 2238 port (might or might not be peered)." 2239 ::= { ptpbaseClockPortEntry 10 } 2241 ptpbaseClockPortDSTable OBJECT-TYPE 2242 SYNTAX SEQUENCE OF PtpbaseClockPortDSEntry 2243 MAX-ACCESS not-accessible 2244 STATUS current 2245 DESCRIPTION 2246 "Table of information about the clock ports dataset for a 2247 particular domain." 2249 ::= { ptpbaseMIBClockInfo 8 } 2251 ptpbaseClockPortDSEntry OBJECT-TYPE 2252 SYNTAX PtpbaseClockPortDSEntry 2253 MAX-ACCESS not-accessible 2254 STATUS current 2255 DESCRIPTION 2256 "An entry in the table, containing port dataset information for 2257 a single clock port." 2258 INDEX { 2259 ptpbaseClockPortDSDomainIndex, 2260 ptpbaseClockPortDSClockTypeIndex, 2261 ptpbaseClockPortDSClockInstanceIndex, 2262 ptpbaseClockPortDSPortNumberIndex 2263 } 2264 ::= { ptpbaseClockPortDSTable 1 } 2266 PtpbaseClockPortDSEntry ::= SEQUENCE { 2267 ptpbaseClockPortDSDomainIndex PtpClockDomainType, 2268 ptpbaseClockPortDSClockTypeIndex PtpClockType, 2269 ptpbaseClockPortDSClockInstanceIndex PtpClockInstanceType, 2270 ptpbaseClockPortDSPortNumberIndex PtpClockPortNumber, 2271 ptpbaseClockPortDSName DisplayString, 2272 ptpbaseClockPortDSPortIdentity OCTET STRING, 2273 ptpbaseClockPortDSlogAnnouncementInterval PtpClockIntervalBase2, 2274 ptpbaseClockPortDSAnnounceRctTimeout Integer32, 2275 ptpbaseClockPortDSlogSyncInterval PtpClockIntervalBase2, 2276 ptpbaseClockPortDSMinDelayReqInterval Integer32, 2277 ptpbaseClockPortDSPeerDelayReqInterval Integer32, 2278 ptpbaseClockPortDSDelayMech PtpClockMechanismType, 2279 ptpbaseClockPortDSPeerMeanPathDelay PtpClockTimeInterval, 2280 ptpbaseClockPortDSGrantDuration Unsigned32, 2281 ptpbaseClockPortDSPTPVersion Unsigned32 2282 } 2284 ptpbaseClockPortDSDomainIndex OBJECT-TYPE 2285 SYNTAX PtpClockDomainType 2286 MAX-ACCESS not-accessible 2287 STATUS current 2288 DESCRIPTION 2289 "This object specifies the domain number used to create a 2290 logical 2291 group of PTP devices." 2293 ::= { ptpbaseClockPortDSEntry 1 } 2295 ptpbaseClockPortDSClockTypeIndex OBJECT-TYPE 2296 SYNTAX PtpClockType 2297 MAX-ACCESS not-accessible 2298 STATUS current 2299 DESCRIPTION 2300 "This object specifies the clock type as defined in the 2301 Textual convention description." 2302 ::= { ptpbaseClockPortDSEntry 2 } 2304 ptpbaseClockPortDSClockInstanceIndex OBJECT-TYPE 2305 SYNTAX PtpClockInstanceType 2306 MAX-ACCESS not-accessible 2307 STATUS current 2308 DESCRIPTION 2309 "This object specifies the instance of the clock for this clock 2310 type in the given domain." 2311 ::= { ptpbaseClockPortDSEntry 3 } 2313 ptpbaseClockPortDSPortNumberIndex OBJECT-TYPE 2314 SYNTAX PtpClockPortNumber 2315 MAX-ACCESS not-accessible 2316 STATUS current 2317 DESCRIPTION 2318 "This object specifies the PTP portnumber associated with this 2319 PTP port." 2320 ::= { ptpbaseClockPortDSEntry 4 } 2322 ptpbaseClockPortDSName OBJECT-TYPE 2323 SYNTAX DisplayString (SIZE (1..64)) 2324 MAX-ACCESS read-only 2325 STATUS current 2326 DESCRIPTION 2327 "This object specifies the PTP clock port dataset name." 2328 ::= { ptpbaseClockPortDSEntry 5 } 2330 ptpbaseClockPortDSPortIdentity OBJECT-TYPE 2331 SYNTAX OCTET STRING(SIZE(1..256)) 2332 MAX-ACCESS read-only 2333 STATUS current 2334 DESCRIPTION 2335 "This object specifies the PTP clock port Identity." 2337 ::= { ptpbaseClockPortDSEntry 6 } 2339 ptpbaseClockPortDSlogAnnouncementInterval OBJECT-TYPE 2340 SYNTAX PtpClockIntervalBase2 2341 UNITS "Time Interval" 2342 MAX-ACCESS read-only 2343 STATUS current 2344 DESCRIPTION 2345 "This object specifies the Announce message transmission 2346 interval associated with this clock port." 2347 ::= { ptpbaseClockPortDSEntry 7 } 2349 ptpbaseClockPortDSAnnounceRctTimeout OBJECT-TYPE 2350 SYNTAX Integer32 2351 MAX-ACCESS read-only 2352 STATUS current 2353 DESCRIPTION 2354 "This object specifies the Announce receipt timeout associated 2355 with this clock port." 2356 ::= { ptpbaseClockPortDSEntry 8 } 2358 ptpbaseClockPortDSlogSyncInterval OBJECT-TYPE 2359 SYNTAX PtpClockIntervalBase2 2360 UNITS "Time Interval" 2361 MAX-ACCESS read-only 2362 STATUS current 2363 DESCRIPTION 2364 "This object specifies the Sync message transmission interval." 2365 ::= { ptpbaseClockPortDSEntry 9 } 2367 ptpbaseClockPortDSMinDelayReqInterval OBJECT-TYPE 2368 SYNTAX Integer32 2369 MAX-ACCESS read-only 2370 STATUS current 2371 DESCRIPTION 2372 "This object specifies the Delay_Req message transmission 2373 interval." 2374 ::= { ptpbaseClockPortDSEntry 10 } 2376 ptpbaseClockPortDSPeerDelayReqInterval OBJECT-TYPE 2377 SYNTAX Integer32 2378 MAX-ACCESS read-only 2379 STATUS current 2380 DESCRIPTION 2381 "This object specifies the Pdelay_Req message transmission 2382 interval." 2383 ::= { ptpbaseClockPortDSEntry 11 } 2385 ptpbaseClockPortDSDelayMech OBJECT-TYPE 2386 SYNTAX PtpClockMechanismType 2387 MAX-ACCESS read-only 2388 STATUS current 2389 DESCRIPTION 2390 "This object specifies the delay mechanism used. If the clock 2391 is an end-to-end clock, the value of the is e2e, else if the 2392 clock is a peer to-peer clock, the value shall be p2p." 2393 ::= { ptpbaseClockPortDSEntry 12 } 2395 ptpbaseClockPortDSPeerMeanPathDelay OBJECT-TYPE 2396 SYNTAX PtpClockTimeInterval 2397 UNITS "Time Interval" 2398 MAX-ACCESS read-only 2399 STATUS current 2400 DESCRIPTION 2401 "This object specifies the peer meanPathDelay." 2402 ::= { ptpbaseClockPortDSEntry 13 } 2404 ptpbaseClockPortDSGrantDuration OBJECT-TYPE 2405 SYNTAX Unsigned32 2406 UNITS "seconds" 2407 MAX-ACCESS read-only 2408 STATUS current 2409 DESCRIPTION 2410 "This object specifies the grant duration allocated by the 2411 master." 2412 ::= { ptpbaseClockPortDSEntry 14 } 2414 ptpbaseClockPortDSPTPVersion OBJECT-TYPE 2415 SYNTAX Unsigned32 2416 MAX-ACCESS read-only 2417 STATUS current 2418 DESCRIPTION 2419 "This object specifies the PTP version being used." 2420 ::= { ptpbaseClockPortDSEntry 15 } 2422 ptpbaseClockPortRunningTable OBJECT-TYPE 2423 SYNTAX SEQUENCE OF PtpbaseClockPortRunningEntry 2424 MAX-ACCESS not-accessible 2425 STATUS current 2426 DESCRIPTION 2427 "Table of information about the clock ports running datasets for 2428 a particular domain." 2429 ::= { ptpbaseMIBClockInfo 9 } 2431 ptpbaseClockPortRunningEntry OBJECT-TYPE 2432 SYNTAX PtpbaseClockPortRunningEntry 2433 MAX-ACCESS not-accessible 2434 STATUS current 2435 DESCRIPTION 2436 "An entry in the table, containing running dataset information 2437 about a single clock port." 2438 INDEX { 2439 ptpbaseClockPortRunningDomainIndex, 2440 ptpbaseClockPortRunningClockTypeIndex, 2441 ptpbaseClockPortRunningClockInstanceIndex, 2442 ptpbaseClockPortRunningPortNumberIndex 2443 } 2444 ::= { ptpbaseClockPortRunningTable 1 } 2446 PtpbaseClockPortRunningEntry ::= SEQUENCE { 2447 ptpbaseClockPortRunningDomainIndex PtpClockDomainType, 2448 ptpbaseClockPortRunningClockTypeIndex PtpClockType, 2449 ptpbaseClockPortRunningClockInstanceIndex PtpClockInstanceType, 2450 ptpbaseClockPortRunningPortNumberIndex PtpClockPortNumber, 2451 ptpbaseClockPortRunningName DisplayString, 2452 ptpbaseClockPortRunningState PtpClockPortState, 2453 ptpbaseClockPortRunningRole PtpClockRoleType, 2454 ptpbaseClockPortRunningInterfaceIndex InterfaceIndexOrZero, 2455 ptpbaseClockPortRunningTransport AutonomousType, 2456 ptpbaseClockPortRunningEncapsulationType AutonomousType, 2457 ptpbaseClockPortRunningTxMode PtpClockTxModeType, 2458 ptpbaseClockPortRunningRxMode PtpClockTxModeType, 2459 ptpbaseClockPortRunningPacketsReceived Counter64, 2460 ptpbaseClockPortRunningPacketsSent Counter64 2461 } 2463 ptpbaseClockPortRunningDomainIndex OBJECT-TYPE 2464 SYNTAX PtpClockDomainType 2465 MAX-ACCESS not-accessible 2466 STATUS current 2467 DESCRIPTION 2468 "This object specifies the domain number used to create a 2469 logical 2470 group of PTP devices." 2471 ::= { ptpbaseClockPortRunningEntry 1 } 2473 ptpbaseClockPortRunningClockTypeIndex OBJECT-TYPE 2474 SYNTAX PtpClockType 2475 MAX-ACCESS not-accessible 2476 STATUS current 2477 DESCRIPTION 2478 "This object specifies the clock type as defined in the 2479 Textual convention description." 2480 ::= { ptpbaseClockPortRunningEntry 2 } 2482 ptpbaseClockPortRunningClockInstanceIndex OBJECT-TYPE 2483 SYNTAX PtpClockInstanceType 2484 MAX-ACCESS not-accessible 2485 STATUS current 2486 DESCRIPTION 2487 "This object specifies the instance of the clock for this clock 2488 type in the given domain." 2489 ::= { ptpbaseClockPortRunningEntry 3 } 2491 ptpbaseClockPortRunningPortNumberIndex OBJECT-TYPE 2492 SYNTAX PtpClockPortNumber 2493 MAX-ACCESS not-accessible 2494 STATUS current 2495 DESCRIPTION 2496 "This object specifies the PTP portnumber associated with this 2497 clock port." 2498 ::= { ptpbaseClockPortRunningEntry 4 } 2500 ptpbaseClockPortRunningName OBJECT-TYPE 2501 SYNTAX DisplayString (SIZE (1..64)) 2502 MAX-ACCESS read-only 2503 STATUS current 2504 DESCRIPTION 2505 "This object specifies the PTP clock port name." 2506 ::= { ptpbaseClockPortRunningEntry 5 } 2508 ptpbaseClockPortRunningState OBJECT-TYPE 2509 SYNTAX PtpClockPortState 2510 MAX-ACCESS read-only 2511 STATUS current 2512 DESCRIPTION 2513 "This object specifies the port state returned by PTP engine. 2515 initializing - In this state a port initializes 2516 its data sets, hardware, and 2517 communication facilities. 2518 faulty - The fault state of the protocol. 2519 disabled - The port shall not place any 2520 messages on its communication path. 2521 listening - The port is waiting for the 2522 announceReceiptTimeout to expire or 2523 to receive an Announce message from 2524 a master. 2525 preMaster - The port shall behave in all respects 2526 as though it were in the MASTER state 2527 except that it shall not place any 2528 messages on its communication path 2529 except for Pdelay_Req, Pdelay_Resp, 2530 Pdelay_Resp_Follow_Up, signaling, or 2531 management messages. 2532 master - The port is behaving as a master port. 2533 passive - The port shall not place any 2534 messages on its communication path 2535 except for Pdelay_Req, Pdelay_Resp, 2536 Pdelay_Resp_Follow_Up, or signaling 2537 messages, or management messages 2538 that are a required response to 2539 another management message 2540 uncalibrated - The local port is preparing to 2541 synchronize to the master port. 2542 slave - The port is synchronizing to the 2543 selected master port." 2544 ::= { ptpbaseClockPortRunningEntry 6 } 2546 ptpbaseClockPortRunningRole OBJECT-TYPE 2547 SYNTAX PtpClockRoleType 2548 MAX-ACCESS read-only 2549 STATUS current 2550 DESCRIPTION 2551 "This object specifies the Clock Role." 2552 ::= { ptpbaseClockPortRunningEntry 7 } 2554 ptpbaseClockPortRunningInterfaceIndex OBJECT-TYPE 2555 SYNTAX InterfaceIndexOrZero 2556 MAX-ACCESS read-only 2557 STATUS current 2558 DESCRIPTION 2559 "This object specifies the interface on the node being used by 2560 the PTP Clock for PTP communication." 2561 ::= { ptpbaseClockPortRunningEntry 8 } 2563 ptpbaseClockPortRunningTransport OBJECT-TYPE 2564 SYNTAX AutonomousType 2565 MAX-ACCESS read-only 2566 STATUS current 2567 DESCRIPTION 2568 "This object specifies the transport protocol being used for PTP 2569 communication (the mapping used)." 2570 ::= { ptpbaseClockPortRunningEntry 9 } 2572 ptpbaseClockPortRunningEncapsulationType OBJECT-TYPE 2573 SYNTAX AutonomousType 2574 MAX-ACCESS read-only 2575 STATUS current 2576 DESCRIPTION 2577 "This object specifies the type of encapsulation if the 2578 interface is adding extra layers (e.g., VLAN, Pseudowire 2579 encapsulation...) for the PTP messages." 2580 ::= { ptpbaseClockPortRunningEntry 10 } 2582 ptpbaseClockPortRunningTxMode OBJECT-TYPE 2583 SYNTAX PtpClockTxModeType 2584 MAX-ACCESS read-only 2585 STATUS current 2586 DESCRIPTION 2587 "This object specifies the clock transmission mode as 2589 unicast: Using unicast communication channel. 2590 multicast: Using Multicast communication channel. 2591 multicast-mix: Using multicast-unicast communication channel" 2592 ::= { ptpbaseClockPortRunningEntry 11 } 2594 ptpbaseClockPortRunningRxMode OBJECT-TYPE 2595 SYNTAX PtpClockTxModeType 2596 MAX-ACCESS read-only 2597 STATUS current 2598 DESCRIPTION 2599 "This object specifies the clock receive mode as 2601 unicast: Using unicast communication channel. 2602 multicast: Using Multicast communication channel. 2603 multicast-mix: Using multicast-unicast communication channel" 2604 ::= { ptpbaseClockPortRunningEntry 12 } 2606 ptpbaseClockPortRunningPacketsReceived OBJECT-TYPE 2607 SYNTAX Counter64 2608 UNITS "packets" 2609 MAX-ACCESS read-only 2610 STATUS current 2611 DESCRIPTION 2612 "This object specifies the packets received on the clock port 2613 (cumulative)." 2614 ::= { ptpbaseClockPortRunningEntry 13 } 2616 ptpbaseClockPortRunningPacketsSent OBJECT-TYPE 2617 SYNTAX Counter64 2618 UNITS "packets" 2619 MAX-ACCESS read-only 2620 STATUS current 2621 DESCRIPTION 2622 "This object specifies the packets sent on the clock port 2623 (cumulative)." 2624 ::= { ptpbaseClockPortRunningEntry 14 } 2626 ptpbaseClockPortTransDSTable OBJECT-TYPE 2627 SYNTAX SEQUENCE OF PtpbaseClockPortTransDSEntry 2628 MAX-ACCESS not-accessible 2629 STATUS current 2630 DESCRIPTION 2631 "Table of information about the Transparent clock ports running 2632 dataset for a particular domain." 2633 ::= { ptpbaseMIBClockInfo 10 } 2635 ptpbaseClockPortTransDSEntry OBJECT-TYPE 2636 SYNTAX PtpbaseClockPortTransDSEntry 2637 MAX-ACCESS not-accessible 2638 STATUS current 2639 DESCRIPTION 2640 "An entry in the table, containing clock port Transparent 2641 dataset information about a single clock port" 2642 INDEX { 2643 ptpbaseClockPortTransDSDomainIndex, 2644 ptpbaseClockPortTransDSInstanceIndex, 2645 ptpbaseClockPortTransDSPortNumberIndex 2646 } 2647 ::= { ptpbaseClockPortTransDSTable 1 } 2649 PtpbaseClockPortTransDSEntry ::= SEQUENCE { 2650 ptpbaseClockPortTransDSDomainIndex PtpClockDomainType, 2651 ptpbaseClockPortTransDSInstanceIndex PtpClockInstanceType, 2652 ptpbaseClockPortTransDSPortNumberIndex PtpClockPortNumber, 2653 ptpbaseClockPortTransDSPortIdentity PtpClockIdentity, 2654 ptpbaseClockPortTransDSlogMinPdelayReqInt PtpClockIntervalBase2, 2655 ptpbaseClockPortTransDSFaultyFlag TruthValue, 2656 ptpbaseClockPortTransDSPeerMeanPathDelay PtpClockTimeInterval 2657 } 2659 ptpbaseClockPortTransDSDomainIndex OBJECT-TYPE 2660 SYNTAX PtpClockDomainType 2661 MAX-ACCESS not-accessible 2662 STATUS current 2663 DESCRIPTION 2664 "This object specifies the domain number used to create a 2665 logical 2666 group of PTP devices." 2667 ::= { ptpbaseClockPortTransDSEntry 1 } 2669 ptpbaseClockPortTransDSInstanceIndex OBJECT-TYPE 2670 SYNTAX PtpClockInstanceType 2671 MAX-ACCESS not-accessible 2672 STATUS current 2673 DESCRIPTION 2674 "This object specifies the instance of the clock for this clock 2675 type in the given domain." 2676 ::= { ptpbaseClockPortTransDSEntry 2 } 2678 ptpbaseClockPortTransDSPortNumberIndex OBJECT-TYPE 2679 SYNTAX PtpClockPortNumber 2680 MAX-ACCESS not-accessible 2681 STATUS current 2682 DESCRIPTION 2683 "This object specifies the PTP port number associated with this 2684 port." 2685 REFERENCE "Section 7.5.2 Port Identity of [IEEE 1588-2008]" 2686 ::= { ptpbaseClockPortTransDSEntry 3 } 2688 ptpbaseClockPortTransDSPortIdentity OBJECT-TYPE 2689 SYNTAX PtpClockIdentity 2690 MAX-ACCESS read-only 2691 STATUS current 2692 DESCRIPTION 2693 "This object specifies the value of the PortIdentity 2694 attribute of the local port." 2695 REFERENCE 2696 "Section 8.3.3.2.1 transparentClockPortDS.portIdentity of 2697 [IEEE 1588-2008]" 2698 ::= { ptpbaseClockPortTransDSEntry 4 } 2700 ptpbaseClockPortTransDSlogMinPdelayReqInt OBJECT-TYPE 2701 SYNTAX PtpClockIntervalBase2 2702 MAX-ACCESS read-only 2703 STATUS current 2704 DESCRIPTION 2705 "This object specifies the value of the logarithm to the 2706 base 2 of the minPdelayReqInterval." 2707 REFERENCE 2708 "Section 8.3.3.3.1 2709 transparentClockPortDS.logMinPdelayReqInterval of 2710 [IEEE 1588-2008]" 2711 ::= { ptpbaseClockPortTransDSEntry 5 } 2713 ptpbaseClockPortTransDSFaultyFlag OBJECT-TYPE 2714 SYNTAX TruthValue 2715 MAX-ACCESS read-only 2716 STATUS current 2717 DESCRIPTION 2718 "This object specifies the value TRUE if the port is faulty 2719 and FALSE if the port is operating normally." 2721 REFERENCE 2722 "Section 8.3.3.3.2 transparentClockPortDS.faultyFlag of 2723 [IEEE 1588-2008]" 2724 ::= { ptpbaseClockPortTransDSEntry 6 } 2726 ptpbaseClockPortTransDSPeerMeanPathDelay OBJECT-TYPE 2727 SYNTAX PtpClockTimeInterval 2728 UNITS "Time Interval" 2729 MAX-ACCESS read-only 2730 STATUS current 2731 DESCRIPTION 2732 "This object specifies, if the delayMechanism used is P2P, the 2733 value of the estimate of the current one-way propagation delay, 2734 i.e., on the link attached to this port, 2735 computed using the peer delay mechanism. If the value of the 2736 delayMechanism used is E2E, then the value will be zero." 2737 REFERENCE 2738 "Section 8.3.3.3.3 transparentClockPortDS.peerMeanPathDelay of 2739 [IEEE 1588-2008]" 2740 ::= { ptpbaseClockPortTransDSEntry 7 } 2742 ptpbaseClockPortAssociateTable OBJECT-TYPE 2743 SYNTAX SEQUENCE OF PtpbaseClockPortAssociateEntry 2744 MAX-ACCESS not-accessible 2745 STATUS current 2746 DESCRIPTION 2747 "Table of information about a given port's associated ports. 2749 For a master port: multiple slave ports that have established 2750 sessions with the current master port. 2751 For a slave port: the list of masters available for a given 2752 slave port. 2754 Session information (packets, errors) to be displayed based on 2755 availability and scenario." 2756 ::= { ptpbaseMIBClockInfo 11 } 2758 -- 2759 -- Well Known transport types for PTP communication. 2760 -- 2761 ptpbaseWellKnownTransportTypes OBJECT IDENTIFIER ::= { 2762 ptpbaseMIBClockInfo 12 } 2764 ptpbaseTransportTypeIPversion4 OBJECT-IDENTITY 2765 STATUS current 2766 DESCRIPTION 2767 "IP version 4" 2768 ::= { ptpbaseWellKnownTransportTypes 1 } 2770 ptpbaseTransportTypeIPversion6 OBJECT-IDENTITY 2771 STATUS current 2772 DESCRIPTION 2773 "IP version 6" 2774 ::= { ptpbaseWellKnownTransportTypes 2 } 2776 ptpbaseTransportTypeEthernet OBJECT-IDENTITY 2777 STATUS current 2778 DESCRIPTION 2779 "Ethernet" 2780 ::= { ptpbaseWellKnownTransportTypes 3 } 2782 ptpbaseTransportTypeDeviceNET OBJECT-IDENTITY 2783 STATUS current 2784 DESCRIPTION 2785 "Device NET" 2786 ::= { ptpbaseWellKnownTransportTypes 4 } 2788 ptpbaseTransportTypeControlNET OBJECT-IDENTITY 2789 STATUS current 2790 DESCRIPTION 2791 "Control NET" 2792 ::= { ptpbaseWellKnownTransportTypes 5 } 2794 ptpbaseTransportTypeIEC61158 OBJECT-IDENTITY 2795 STATUS current 2796 DESCRIPTION 2797 "IEC61158" 2798 ::= { ptpbaseWellKnownTransportTypes 6 } 2800 -- 2801 -- Well Known encapsulation types for PTP communication. 2803 -- 2804 ptpbaseWellKnownEncapsulationTypes OBJECT IDENTIFIER ::= { 2805 ptpbaseMIBClockInfo 13 } 2807 ptpbaseEncapsulationTypeEthernet OBJECT-IDENTITY 2808 STATUS current 2809 DESCRIPTION 2810 "Ethernet Encapsulation type." 2811 ::= { ptpbaseWellKnownEncapsulationTypes 1 } 2813 ptpbaseEncapsulationTypeVLAN OBJECT-IDENTITY 2814 STATUS current 2815 DESCRIPTION 2816 "VLAN Encapsulation type." 2817 ::= { ptpbaseWellKnownEncapsulationTypes 2 } 2819 ptpbaseEncapsulationTypeUDPIPLSP OBJECT-IDENTITY 2820 STATUS current 2821 DESCRIPTION 2822 "UDP/IP over MPLS Encapsulation type." 2823 ::= { ptpbaseWellKnownEncapsulationTypes 3 } 2825 ptpbaseEncapsulationTypePWUDPIPLSP OBJECT-IDENTITY 2826 STATUS current 2827 DESCRIPTION 2828 "UDP/IP Pseudowire over MPLS Encapsulation type." 2829 ::= { ptpbaseWellKnownEncapsulationTypes 4 } 2831 ptpbaseEncapsulationTypePWEthernetLSP OBJECT-IDENTITY 2832 STATUS current 2833 DESCRIPTION 2834 "Ethernet Pseudowire over MPLS Encapsulation type." 2835 ::= { ptpbaseWellKnownEncapsulationTypes 5 } 2837 ptpbaseClockPortAssociateEntry OBJECT-TYPE 2838 SYNTAX PtpbaseClockPortAssociateEntry 2839 MAX-ACCESS not-accessible 2840 STATUS current 2841 DESCRIPTION 2842 "An entry in the table, containing information about a single 2843 associated port for the given clockport." 2844 INDEX { 2845 ptpClockPortCurrentDomainIndex, 2846 ptpClockPortCurrentClockTypeIndex, 2847 ptpClockPortCurrentClockInstanceIndex, 2848 ptpClockPortCurrentPortNumberIndex, 2849 ptpbaseClockPortAssociatePortIndex 2850 } 2851 ::= { ptpbaseClockPortAssociateTable 1 } 2853 PtpbaseClockPortAssociateEntry ::= SEQUENCE { 2854 ptpClockPortCurrentDomainIndex PtpClockDomainType, 2855 ptpClockPortCurrentClockTypeIndex PtpClockType, 2856 ptpClockPortCurrentClockInstanceIndex PtpClockInstanceType, 2857 ptpClockPortCurrentPortNumberIndex PtpClockPortNumber, 2858 ptpbaseClockPortAssociatePortIndex Unsigned32, 2859 ptpbaseClockPortAssociateAddressType AutonomousType, 2860 ptpbaseClockPortAssociateAddress 2861 PtpClockPortTransportTypeAddress, 2862 ptpbaseClockPortAssociatePacketsSent Counter64, 2863 ptpbaseClockPortAssociatePacketsReceived Counter64, 2864 ptpbaseClockPortAssociateInErrors Counter64, 2865 ptpbaseClockPortAssociateOutErrors Counter64 2866 } 2868 ptpClockPortCurrentDomainIndex OBJECT-TYPE 2869 SYNTAX PtpClockDomainType 2870 MAX-ACCESS not-accessible 2871 STATUS current 2872 DESCRIPTION 2873 "This object specifies the given port's domain number." 2874 ::= { ptpbaseClockPortAssociateEntry 1 } 2876 ptpClockPortCurrentClockTypeIndex OBJECT-TYPE 2877 SYNTAX PtpClockType 2878 MAX-ACCESS not-accessible 2879 STATUS current 2880 DESCRIPTION 2881 "This object specifies the given port's clock type." 2882 ::= { ptpbaseClockPortAssociateEntry 2 } 2884 ptpClockPortCurrentClockInstanceIndex OBJECT-TYPE 2885 SYNTAX PtpClockInstanceType 2886 MAX-ACCESS not-accessible 2887 STATUS current 2888 DESCRIPTION 2889 "This object specifies the instance of the clock for this clock 2890 type in the given domain." 2891 ::= { ptpbaseClockPortAssociateEntry 3 } 2893 ptpClockPortCurrentPortNumberIndex OBJECT-TYPE 2894 SYNTAX PtpClockPortNumber 2895 MAX-ACCESS not-accessible 2896 STATUS current 2897 DESCRIPTION 2898 "This object specifies the PTP Port Number for the given port." 2899 ::= { ptpbaseClockPortAssociateEntry 4 } 2901 ptpbaseClockPortAssociatePortIndex OBJECT-TYPE 2902 SYNTAX Unsigned32 (1..65535) 2903 MAX-ACCESS not-accessible 2904 STATUS current 2905 DESCRIPTION 2906 "This object specifies the associated port's serial number in 2907 the current port's context." 2908 ::= { ptpbaseClockPortAssociateEntry 5 } 2910 ptpbaseClockPortAssociateAddressType OBJECT-TYPE 2911 SYNTAX AutonomousType 2912 MAX-ACCESS read-only 2913 STATUS current 2914 DESCRIPTION 2915 "This object specifies the peer port's network address type used 2916 for PTP communication." 2917 ::= { ptpbaseClockPortAssociateEntry 6 } 2919 ptpbaseClockPortAssociateAddress OBJECT-TYPE 2920 SYNTAX PtpClockPortTransportTypeAddress 2921 MAX-ACCESS read-only 2922 STATUS current 2923 DESCRIPTION 2924 "This object specifies the peer port's network address used for 2925 PTP communication." 2926 ::= { ptpbaseClockPortAssociateEntry 7 } 2928 ptpbaseClockPortAssociatePacketsSent OBJECT-TYPE 2929 SYNTAX Counter64 2930 UNITS "packets" 2931 MAX-ACCESS read-only 2932 STATUS current 2933 DESCRIPTION 2934 "The number of packets sent to this peer port from the current 2935 port." 2936 ::= { ptpbaseClockPortAssociateEntry 8 } 2938 ptpbaseClockPortAssociatePacketsReceived OBJECT-TYPE 2939 SYNTAX Counter64 2940 UNITS "packets" 2941 MAX-ACCESS read-only 2942 STATUS current 2943 DESCRIPTION 2944 "The number of packets received from this peer port by the 2945 current port." 2946 ::= { ptpbaseClockPortAssociateEntry 9 } 2948 ptpbaseClockPortAssociateInErrors OBJECT-TYPE 2949 SYNTAX Counter64 2950 UNITS "packets" 2951 MAX-ACCESS read-only 2952 STATUS current 2953 DESCRIPTION 2954 "This object specifies the input errors associated with the 2955 peer port." 2956 ::= { ptpbaseClockPortAssociateEntry 10 } 2958 ptpbaseClockPortAssociateOutErrors OBJECT-TYPE 2959 SYNTAX Counter64 2960 UNITS "packets" 2961 MAX-ACCESS read-only 2962 STATUS current 2963 DESCRIPTION 2964 "This object specifies the output errors associated with the 2965 peer port." 2966 ::= { ptpbaseClockPortAssociateEntry 11 } 2968 -- Conformance Information Definition 2970 ptpbaseMIBCompliances OBJECT IDENTIFIER 2971 ::= { ptpbaseMIBConformance 1 } 2973 ptpbaseMIBGroups OBJECT IDENTIFIER 2974 ::= { ptpbaseMIBConformance 2 } 2976 ptpbaseMIBCompliancesSystemInfo MODULE-COMPLIANCE 2977 STATUS current 2978 DESCRIPTION 2979 "Compliance statement for agents that provide read-only support 2980 for PTPBASE-MIB to provide system level information of clock 2981 devices. 2982 Such devices can only be monitored using this MIB module. 2984 The Module is implemented with support for read-only. In other 2985 words, only monitoring is available by implementing this 2986 MODULE-COMPLIANCE." 2987 MODULE -- this module 2988 MANDATORY-GROUPS { ptpbaseMIBSystemInfoGroup } 2989 ::= { ptpbaseMIBCompliances 1 } 2991 ptpbaseMIBCompliancesClockInfo MODULE-COMPLIANCE 2992 STATUS current 2993 DESCRIPTION 2994 "Compliance statement for agents that provide read-only support 2995 for PTPBASE-MIB to provide clock related information. 2996 Such devices can only be monitored using this MIB module. 2998 The Module is implemented with support for read-only. In other 2999 words, only monitoring is available by implementing this 3000 MODULE-COMPLIANCE." 3001 MODULE -- this module 3002 MANDATORY-GROUPS { 3003 ptpbaseMIBClockCurrentDSGroup, 3004 ptpbaseMIBClockParentDSGroup, 3005 ptpbaseMIBClockDefaultDSGroup, 3006 ptpbaseMIBClockRunningGroup, 3007 ptpbaseMIBClockTimepropertiesGroup 3008 } 3009 ::= { ptpbaseMIBCompliances 2 } 3011 ptpbaseMIBCompliancesClockPortInfo MODULE-COMPLIANCE 3012 STATUS current 3013 DESCRIPTION 3014 "Compliance statement for agents that provide read-only support 3015 for PTPBASE-MIB to provide clock port related information. 3016 Such devices can only be monitored using this MIB module. 3018 The Module is implemented with support for read-only. In other 3019 words, only monitoring is available by implementing this 3020 MODULE-COMPLIANCE." 3021 MODULE -- this module 3022 MANDATORY-GROUPS { 3023 ptpbaseMIBClockPortGroup, 3024 ptpbaseMIBClockPortDSGroup, 3025 ptpbaseMIBClockPortRunningGroup, 3026 ptpbaseMIBClockPortAssociateGroup 3027 } 3028 ::= { ptpbaseMIBCompliances 3 } 3030 ptpbaseMIBCompliancesTransparentClockInfo MODULE-COMPLIANCE 3031 STATUS current 3032 DESCRIPTION 3033 "Compliance statement for agents that provide read-only support 3034 for PTPBASE-MIB to provide Transparent clock related 3035 information. 3036 Such devices can only be monitored using this MIB module. 3038 The Module is implemented with support for read-only. In other 3039 words, only monitoring is available by implementing this 3040 MODULE-COMPLIANCE." 3041 MODULE -- this module 3042 MANDATORY-GROUPS { 3043 ptpbaseMIBClockTranparentDSGroup, 3044 ptpbaseMIBClockPortTransDSGroup 3045 } 3046 ::= { ptpbaseMIBCompliances 4 } 3048 ptpbaseMIBSystemInfoGroup OBJECT-GROUP 3049 OBJECTS { 3050 ptpbaseSystemDomainTotals, 3051 ptpDomainClockPortsTotal, 3052 ptpbaseSystemProfile 3053 } 3054 STATUS current 3055 DESCRIPTION 3056 "Group which aggregates objects describing system-wide 3057 information" 3058 ::= { ptpbaseMIBGroups 1 } 3060 ptpbaseMIBClockCurrentDSGroup OBJECT-GROUP 3061 OBJECTS { 3062 ptpbaseClockCurrentDSStepsRemoved, 3063 ptpbaseClockCurrentDSOffsetFromMaster, 3064 ptpbaseClockCurrentDSMeanPathDelay 3065 } 3066 STATUS current 3067 DESCRIPTION 3068 "Group which aggregates objects describing PTP Current Dataset 3069 information" 3070 ::= { ptpbaseMIBGroups 2 } 3072 ptpbaseMIBClockParentDSGroup OBJECT-GROUP 3073 OBJECTS { 3074 ptpbaseClockParentDSParentPortIdentity, 3075 ptpbaseClockParentDSParentStats, 3076 ptpbaseClockParentDSOffset, 3077 ptpbaseClockParentDSClockPhChRate, 3078 ptpbaseClockParentDSGMClockIdentity, 3079 ptpbaseClockParentDSGMClockPriority1, 3080 ptpbaseClockParentDSGMClockPriority2, 3081 ptpbaseClockParentDSGMClockQualityClass, 3082 ptpbaseClockParentDSGMClockQualityAccuracy, 3083 ptpbaseClockParentDSGMClockQualityOffset 3084 } 3085 STATUS current 3086 DESCRIPTION 3087 "Group which aggregates objects describing PTP Parent Dataset 3088 information" 3089 ::= { ptpbaseMIBGroups 3 } 3091 ptpbaseMIBClockDefaultDSGroup OBJECT-GROUP 3092 OBJECTS { 3093 ptpbaseClockDefaultDSTwoStepFlag, 3094 ptpbaseClockDefaultDSClockIdentity, 3095 ptpbaseClockDefaultDSPriority1, 3096 ptpbaseClockDefaultDSPriority2, 3097 ptpbaseClockDefaultDSSlaveOnly, 3098 ptpbaseClockDefaultDSQualityClass, 3099 ptpbaseClockDefaultDSQualityAccuracy, 3100 ptpbaseClockDefaultDSQualityOffset 3101 } 3102 STATUS current 3103 DESCRIPTION 3104 "Group which aggregates objects describing PTP Default Dataset 3105 information" 3106 ::= { ptpbaseMIBGroups 4 } 3108 ptpbaseMIBClockRunningGroup OBJECT-GROUP 3109 OBJECTS { 3110 ptpbaseClockRunningState, 3111 ptpbaseClockRunningPacketsSent, 3112 ptpbaseClockRunningPacketsReceived 3113 } 3114 STATUS current 3115 DESCRIPTION 3116 "Group which aggregates objects describing PTP running state 3117 information" 3118 ::= { ptpbaseMIBGroups 5 } 3120 ptpbaseMIBClockTimepropertiesGroup OBJECT-GROUP 3121 OBJECTS { 3122 ptpbaseClockTimePropertiesDSCurrentUTCOffsetValid, 3123 ptpbaseClockTimePropertiesDSCurrentUTCOffset, 3124 ptpbaseClockTimePropertiesDSLeap59, 3125 ptpbaseClockTimePropertiesDSLeap61, 3126 ptpbaseClockTimePropertiesDSTimeTraceable, 3127 ptpbaseClockTimePropertiesDSFreqTraceable, 3128 ptpbaseClockTimePropertiesDSPTPTimescale, 3129 ptpbaseClockTimePropertiesDSSource 3130 } 3131 STATUS current 3132 DESCRIPTION 3133 "Group which aggregates objects describing PTP Time Properties 3134 information" 3135 ::= { ptpbaseMIBGroups 6 } 3137 ptpbaseMIBClockTranparentDSGroup OBJECT-GROUP 3138 OBJECTS { 3139 ptpbaseClockTransDefaultDSClockIdentity, 3140 ptpbaseClockTransDefaultDSNumOfPorts, 3141 ptpbaseClockTransDefaultDSDelay, 3142 ptpbaseClockTransDefaultDSPrimaryDomain 3143 } 3144 STATUS current 3145 DESCRIPTION 3146 "Group which aggregates objects describing PTP Transparent 3147 Dataset 3148 information" 3149 ::= { ptpbaseMIBGroups 7 } 3151 ptpbaseMIBClockPortGroup OBJECT-GROUP 3152 OBJECTS { 3153 ptpbaseClockPortName, 3154 ptpbaseClockPortSyncTwoStep, 3155 ptpbaseClockPortCurrentPeerAddress, 3156 ptpbaseClockPortNumOfAssociatedPorts, 3157 ptpbaseClockPortCurrentPeerAddressType, 3158 ptpbaseClockPortRole 3159 } 3160 STATUS current 3161 DESCRIPTION 3162 "Group which aggregates objects describing information for a 3163 given PTP Port." 3164 ::= { ptpbaseMIBGroups 8 } 3166 ptpbaseMIBClockPortDSGroup OBJECT-GROUP 3167 OBJECTS { 3168 ptpbaseClockPortDSName, 3169 ptpbaseClockPortDSPortIdentity, 3170 ptpbaseClockPortDSlogAnnouncementInterval, 3171 ptpbaseClockPortDSAnnounceRctTimeout, 3172 ptpbaseClockPortDSlogSyncInterval, 3173 ptpbaseClockPortDSMinDelayReqInterval, 3174 ptpbaseClockPortDSPeerDelayReqInterval, 3175 ptpbaseClockPortDSDelayMech, 3176 ptpbaseClockPortDSPeerMeanPathDelay, 3177 ptpbaseClockPortDSGrantDuration, 3178 ptpbaseClockPortDSPTPVersion 3179 } 3180 STATUS current 3181 DESCRIPTION 3182 "Group which aggregates objects describing PTP Port Dataset 3183 information" 3184 ::= { ptpbaseMIBGroups 9 } 3186 ptpbaseMIBClockPortRunningGroup OBJECT-GROUP 3187 OBJECTS { 3188 ptpbaseClockPortRunningName, 3189 ptpbaseClockPortRunningState, 3190 ptpbaseClockPortRunningRole, 3191 ptpbaseClockPortRunningInterfaceIndex, 3192 ptpbaseClockPortRunningTransport, 3193 ptpbaseClockPortRunningEncapsulationType, 3194 ptpbaseClockPortRunningTxMode, 3195 ptpbaseClockPortRunningRxMode, 3196 ptpbaseClockPortRunningPacketsReceived, 3197 ptpbaseClockPortRunningPacketsSent 3198 } 3199 STATUS current 3200 DESCRIPTION 3201 "Group which aggregates objects describing PTP running interface 3202 information" 3203 ::= { ptpbaseMIBGroups 10 } 3205 ptpbaseMIBClockPortTransDSGroup OBJECT-GROUP 3206 OBJECTS { 3207 ptpbaseClockPortTransDSPortIdentity, 3208 ptpbaseClockPortTransDSlogMinPdelayReqInt, 3209 ptpbaseClockPortTransDSFaultyFlag, 3210 ptpbaseClockPortTransDSPeerMeanPathDelay 3211 } 3212 STATUS current 3213 DESCRIPTION 3214 "Group which aggregates objects describing PTP TransparentDS 3215 information" 3216 ::= { ptpbaseMIBGroups 11 } 3218 ptpbaseMIBClockPortAssociateGroup OBJECT-GROUP 3219 OBJECTS { 3220 ptpbaseClockPortAssociatePacketsSent, 3221 ptpbaseClockPortAssociatePacketsReceived, 3222 ptpbaseClockPortAssociateAddress, 3223 ptpbaseClockPortAssociateAddressType, 3224 ptpbaseClockPortAssociateInErrors, 3225 ptpbaseClockPortAssociateOutErrors 3226 } 3227 STATUS current 3228 DESCRIPTION 3229 "Group which aggregates objects describing information on peer 3230 PTP ports for a given PTP clock-port." 3231 ::= { ptpbaseMIBGroups 12 } 3233 END 3235 5. Security Considerations 3237 There are no management objects defined in this MIB module that have 3238 a MAX-ACCESS clause of read-write and/or read-create. So, if this 3239 MIB module is implemented correctly, then there is no risk that an 3240 intruder can alter or create any management objects of this MIB 3241 module via direct SNMP SET operations. 3243 Some of the readable objects in this MIB module (i.e., objects with a 3244 MAX-ACCESS other than not-accessible) may be considered sensitive or 3245 vulnerable in some network environments. It is thus important to 3246 control even GET and/or NOTIFY access to these objects and possibly 3247 to even encrypt the values of these objects when sending them over 3248 the network via SNMP. 3250 SNMP versions prior to SNMPv3 did not include adequate security. 3251 Even if the network itself is secure (for example by using IPSec), 3252 even then, there is no control as to who on the secure network is 3253 allowed to access and GET (read) the objects in this MIB module. 3255 Implementations SHOULD provide the security features described by the 3256 SNMPv3 framework (see [RFC 3410]), and implementations claiming 3257 compliance to the SNMPv3 standard MUST include full support for 3258 authentication and privacy via the User-based Security Model (USM) 3259 [RFC 3414] with the AES cipher algorithm [RFC 3826]. Implementations 3260 MAY also provide support for the Transport Security Model (TSM) 3261 [RFC 5591] in combination with a secure transport such as SSH 3262 [RFC 5592] or TLS/DTLS [RFC 6353]. 3264 Further, deployment of SNMP versions prior to SNMPv3 is NOT 3265 recommended. Instead, it is recommended to deploy SNMPv3 and to 3266 enable cryptographic security. It is then a customer/operator 3267 responsibility to ensure that the SNMP entity giving access to an 3268 instance of this MIB module is properly configured to give access to 3269 those objects only to those principals (users) that have legitimate 3270 rights to access them. 3272 6. IANA Considerations 3274 The MIB module defined in this document uses the following IANA- 3275 assigned OBJECT IDENTIFIER value recorded in the SMI Numbers 3276 registry: 3278 Descriptor OBJECT IDENTIFIER value 3279 ---------- ----------------------- 3280 ptpbaseMIB { mib-2 xxx } 3282 [NOTE for IANA: Please allocate an object identifier at 3283 http://www.iana.org/assignments/smi-numbers for object ptpbaseMIB.] 3285 7. References 3287 7.1. Normative References 3289 [IEEE 1588-2008] "IEEE Standard for A Precision Clock Synchronization 3290 Protocol for Networked Measurement and Control Systems", IEEE Std. 3291 1588(TM)-2008, 24 July 2008 3293 7.2. Informative References 3295 [RFC 1155] Rose, M., and K. McCloghrie, "Structure and Identification 3296 of Management Information for TCP/IP-based Internets", STD 16, RFC 3297 1155, Performance Systems International, Hughes LAN Systems, May 1990 3299 [RFC 1157] Case, J., Fedor, M., Schoffstall, M., and J. Davin, 3300 "Simple Network Management Protocol", STD 15, RFC 1157, SNMP 3301 Research, Performance Systems International, Performance Systems 3302 International, MIT Laboratory for Computer Science, May 1990. 3304 [RFC 1212] Rose, M., and K. McCloghrie, "Concise MIB Definitions", 3305 STD 16, RFC 1212, Performance Systems International, Hughes LAN 3306 Systems, March 1991 3308 [RFC 1215] M. Rose, "A Convention for Defining Traps for use with the 3309 SNMP", RFC 1215, Performance Systems International, March 1991 3311 [RFC 1901] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., 3312 and S. Waldbusser, "Introduction to Community-based SNMPv2", RFC 3313 1901, SNMP Research, Inc., Cisco Systems, Inc., Dover Beach 3314 Consulting, Inc., International Network Services, January 1996. 3316 [RFC 1906] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., 3317 and S. Waldbusser, "Transport Mappings for Version 2 of the Simple 3318 Network Management Protocol (SNMPv2)", RFC 1906, SNMP Research, Inc., 3319 Cisco Systems, Inc., Dover Beach Consulting, Inc., International 3320 Network Services, January 1996. 3322 [RFC 2119] Bradner, S., "Key words for use in RFCs to Indicate 3323 Requirement Levels", RFC 2119 Harvard University, March 1997. 3325 [RFC 2578] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 3326 "Structure of Management Information Version 2 (SMIv2)", STD 58, RFC 3327 2578, April 1999. 3329 [RFC 2579] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 3330 "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999. 3332 [RFC 2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, 3333 "Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999. 3335 [RFC 3410] Case, J., Mundy, R., Partain, D., and B. Stewart, 3336 "Introduction and Applicability Statements for Internet Standard 3337 Management Framework", RFC 3410 SNMP Research, Inc., Network 3338 Associates Laboratories, Ericsson, December 2002. 3340 [RFC 3411] Harrington, D., Presuhn, R., and B. Wijnen, "An 3341 Architecture for Describing Simple Network Management Protocol (SNMP) 3342 Management Frameworks", STD 62, RFC 3411, Enterasys Networks, BMC 3343 Software, Inc., Lucent Technologies, December 2002 3345 [RFC 3412] Case, J., Harrington D., Presuhn R., and B. Wijnen, 3346 "Message Processing and Dispatching for the Simple Network Management 3347 Protocol (SNMP)", STD 62, RFC 3412, SNMP Research, Inc., Enterasys 3348 Networks, BMC Software, Inc., Lucent Technologies, December 2002. 3350 [RFC 3413] Levi, D., Meyer, P., and B. Stewart, "Simple Network 3351 Management Protocol (SNMP) Applications", STD 62, RFC 3413, Nortel 3352 Networks, Secure Computing Corporation, December 2002. 3354 [RFC 3414] Blumenthal, U., and B. Wijnen, "User-based Security Model 3355 (USM) for version 3 of the Simple Network Management Protocol 3356 (SNMPv3)", STD 62, RFC 3414, Lucent Technologies, December 2002. 3358 [RFC 3415] Wijnen, B., Presuhn, R., and K. McCloghrie, "View-based 3359 Access Control Model (VACM) for the Simple Network Management 3360 Protocol (SNMP)", STD 62, RFC 3415, Lucent Technologies, BMC 3361 Software, Inc., Cisco Systems, Inc., December 2002. 3363 [RFC 3416] Presuhn, R. (Ed.), "Version 2 of the Protocol Operations 3364 for the Simple Network Management Protocol (SNMP)", STD 62, RFC 3416, 3365 BMC Software, Inc., December 2002. 3367 [RFC 3417] Presuhn, R. (Ed.), "Transport Mappings for the Simple 3368 Network Management Protocol (SNMP)", STD 62, RFC 3417, BMC Software, 3369 Inc., December 2002. 3371 [RFC 3826] Blumenthal, U., Maino, F, and K. McCloghrie, "The Advanced 3372 Encryption Standard (AES) Cipher Algorithm in the SNMP User-based 3373 Security Model", RFC 3826, Lucent Technologies, Andiamo Systems, 3374 Inc., Cisco Systems, Inc., June 2004. 3376 [RFC 5591] Harrington, D., and W. Hardraker, "Transport Security 3377 Model for the Simple Network Management Protocol (SNMP)", RFC 5591, 3378 Huawei Technologies (USA), Cobham Analytic Solutions, June 2009. 3380 [RFC 5592] Harrington, D., Salowey, J., and W. Hardraker, "Secure 3381 Shell Transport Model for the Simple Network Management Protocol 3382 (SNMP) ", RFC 5592, Huawei Technologies (USA), Cisco Systems, Cobham 3383 Analytic Solutions, June 2009. 3385 [RFC 5905] David L. Mills, "Network Time Protocol Version 4: Protocol 3386 and Algorithms Specification", RFC 5905, University of Delaware, June 3387 2010. 3389 [RFC 6353] Hardraker, W., "Transport Layer Security (TLS) Transport 3390 Model for the Simple Network Management Protocol (SNMP)", RFC 6353, 3391 SPARTA, Inc., July 2011. 3393 [IEEE 802.3-2012] "IEEE Standard for Ethernet", IEEE Std. 802.3 - 3394 2012, 30 August 2012 3396 [G.8265.1] "Precision time protocol telecom profile for frequency 3397 synchronization", ITU-T Recommendation G.8265.1, July 2014. 3399 8. Acknowledgements 3401 Thanks to John Linton and Danny Lee for valuable comments, and to 3402 Bert Wijnen, Kevin Gross, Alan Luchuk, Chris Elliot, Brian Haberman 3403 and Dan Romascanu for their reviews of this MIB module. 3405 9. Author's Addresses 3407 Vinay Shankarkumar 3408 Cisco Systems, 3409 7100-9 Kit Creek Road, 3410 Research Triangle Park, 3411 NC 27709, 3412 USA. 3414 Email: vinays@cisco.com 3416 Laurent Montini, 3417 Cisco Systems, 3418 11, rue Camille Desmoulins, 3419 92782 Issy-les-Moulineaux, 3420 France. 3422 Email: lmontini@cisco.com 3424 Tim Frost, 3425 Calnex Solutions Ltd., 3426 Oracle Campus, 3427 Linlithgow, 3428 EH49 7LR, 3429 UK. 3431 Email: tim.frost@calnexsol.com 3433 Greg Dowd, 3434 Microsemi Inc., 3435 3870 North First Street, 3436 San Jose, 3437 CA 95134, 3438 USA. 3440 Email: greg.dowd@microsemi.com