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