contrib/bsnmp/snmp_ntp/NTP-MIB.txt

   1 --
   2 -- NTP MIB, Revision 0.2, 7/25/97
   3 --
   4
   5 NTP-MIB DEFINITIONS ::= BEGIN
   6
   7 IMPORTS
   8     Integer32, IpAddress, MODULE-IDENTITY, OBJECT-TYPE, Unsigned32,
   9     enterprises
  10         FROM SNMPv2-SMI
  11
  12     TEXTUAL-CONVENTION, TruthValue
  13         FROM SNMPv2-TC;
  14
  15 ntpMIB MODULE-IDENTITY
  16     LAST-UPDATED "199707251530Z"
  17     ORGANIZATION
  18         "University of Delaware"
  19     CONTACT-INFO
  20         "Adarsh Sethi
  21          Department of Computer & Information Sciences
  22          University of Delaware
  23          Newark, DE 19716
  24          Tel: +1 302 831 1945
  25          E-mail: sethi@cis.udel.edu
  26
  27          David Mills
  28          Department of Electrical Engineering
  29          University of Delaware
  30          Newark, DE 19716
  31          Tel: +1 302 831 ????
  32          E-mail: mills@ee.udel.edu"
  33     DESCRIPTION
  34         "This MIB module defines a MIB which provides mechanisms to
  35          monitor and control an NTP server."
  36     ::= { udel 3 }
  37
  38 --
  39 -- Position within the OID hierarchy of this MIB:
  40 --
  41 udel OBJECT IDENTIFIER
  42     ::= { enterprises 1277 }
  43
  44 --
  45 -- The various groups defined within this MIB definition:
  46 --
  47 ntpSystem OBJECT IDENTIFIER
  48     ::= { ntpMIB 1 }
  49
  50 ntpPeers OBJECT IDENTIFIER
  51     ::= { ntpMIB 2 }
  52
  53 ntpFilter OBJECT IDENTIFIER
  54     ::= { ntpMIB 3 }
  55
  56 --
  57 -- Textual conventions:
  58 --
  59
  60 NTPTimeStamp ::= TEXTUAL-CONVENTION
  61     DISPLAY-HINT "4x.4x"
  62     STATUS      current
  63     DESCRIPTION
  64         ""
  65     SYNTAX      OCTET STRING (SIZE(8))
  66
  67 NTPLeapIndicator ::= TEXTUAL-CONVENTION
  68     STATUS      current
  69     DESCRIPTION
  70         ""
  71     SYNTAX      INTEGER {
  72                     noWarning(0),
  73                     addSecond(1),
  74                     subtractSecond(2),
  75                     alarm(3) }
  76
  77 --
  78 -- System Group
  79 --
  80
  81 ntpSysLeap OBJECT-TYPE
  82     SYNTAX      NTPLeapIndicator
  83     MAX-ACCESS  read-only
  84     STATUS      current
  85     DESCRIPTION
  86         " two-bit code warning of an impending leap
  87          second to be inserted in the NTP timescale."
  88     ::= { ntpSystem 1 }
  89
  90 ntpSysStratum OBJECT-TYPE
  91     SYNTAX      Integer32 (0..255)
  92     MAX-ACCESS  read-only
  93     STATUS      current
  94     DESCRIPTION
  95         " indicating the stratum of the local clock.
  96          0, unspecified
  97          1, primary reference (e.g.,, calibrated atomic clock,
  98             radio clock)
  99          2-255, secondary reference (via NTP)"
 100     ::= { ntpSystem 2 }
 101
 102 ntpSysPrecision OBJECT-TYPE
 103     SYNTAX      Integer32
 104     MAX-ACCESS  read-only
 105     STATUS      current
 106     DESCRIPTION
 107         "signed integer indicating the precision
 108          of the various clocks, in seconds to the nearest power
 109          of two."
 110     ::= { ntpSystem 3 }
 111
 112 ntpSysRootDelay OBJECT-TYPE
 113     SYNTAX      OCTET STRING
 114     MAX-ACCESS  read-only
 115     STATUS      current
 116     DESCRIPTION
 117         "the total roundtrip delay to the primary
 118          reference source at the root of the synchronization
 119          subnet, in seconds"
 120     ::= { ntpSystem 4 }
 121
 122 ntpSysRootDispersion OBJECT-TYPE
 123     SYNTAX      OCTET STRING
 124     MAX-ACCESS  read-only
 125     STATUS      current
 126     DESCRIPTION
 127         "the maximum error relative to the primary
 128          reference source at the root of the synchronization
 129          subnet, in seconds. Only positive values greater
 130          than zero are possible"
 131     ::= { ntpSystem 5 }
 132
 133 ntpSysRefId OBJECT-TYPE
 134     SYNTAX      OCTET STRING
 135     MAX-ACCESS  read-only
 136     STATUS      current
 137     DESCRIPTION
 138         " the particular reference clock. In the case of
 139          stratum 0 (unspecified) or stratum 1 (primary reference
 140          source), this is a four-octet, left-justified,zero-padded
 141          ASCII string.In the case of stratum 2 and greater (secondary
 142          reference) this is the four-octet Internet address of the
 143          peer selected for synchronization."
 144     ::= { ntpSystem 6 }
 145
 146 ntpSysRefTime OBJECT-TYPE
 147     SYNTAX      NTPTimeStamp
 148     MAX-ACCESS  read-only
 149     STATUS      current
 150     DESCRIPTION
 151         " the local time when the local clock was last
 152          updated. If the local clock has neverbeen synchronized,
 153          the value is zero."
 154     ::= { ntpSystem 7 }
 155
 156 ntpSysPoll OBJECT-TYPE
 157     SYNTAX      Integer32
 158     MAX-ACCESS  read-only
 159     STATUS      current
 160     DESCRIPTION
 161         " the minimum interval between transmitted
 162          messages, in seconds as a power of two. For instance,
 163          a value of six indicates a minimum interval of 64 seconds."
 164     ::= { ntpSystem 8 }
 165
 166 ntpSysPeer OBJECT-TYPE
 167     SYNTAX      Unsigned32
 168     MAX-ACCESS  read-only
 169     STATUS      current
 170     DESCRIPTION
 171         " the current synchronization source. Usually
 172          this will be a pointer to a structure containing the peer
 173          variables. The special value NULL indicates there is no
 174          currently valid synchronization source."
 175     ::= { ntpSystem 9 }
 176
 177 ntpSysPhase OBJECT-TYPE
 178     SYNTAX      OCTET STRING
 179     MAX-ACCESS  read-only
 180     STATUS      current
 181     DESCRIPTION
 182         ""
 183     ::= { ntpSystem 10 }
 184
 185 ntpSysFreq OBJECT-TYPE
 186     SYNTAX      OCTET STRING
 187     MAX-ACCESS  read-only
 188     STATUS      current
 189     DESCRIPTION
 190         ""
 191     ::= { ntpSystem 11 }
 192
 193 ntpSysError OBJECT-TYPE
 194     SYNTAX      OCTET STRING
 195     MAX-ACCESS  read-only
 196     STATUS      current
 197     DESCRIPTION
 198         ""
 199     ::= { ntpSystem 12 }
 200
 201 ntpSysClock OBJECT-TYPE
 202     SYNTAX      NTPTimeStamp
 203     MAX-ACCESS  read-only
 204     STATUS      current
 205     DESCRIPTION
 206         "the current local time. Local time is derived
 207          from the hardware clock of the particular machine and
 208          increments at intervals depending on the design used."
 209     ::= { ntpSystem 13 }
 210
 211 ntpSysSystem OBJECT-TYPE
 212     SYNTAX      OCTET STRING
 213     MAX-ACCESS  read-only
 214     STATUS      current
 215     DESCRIPTION
 216         " the type of the local Operating System"
 217     ::= { ntpSystem 14 }
 218
 219 ntpSysProcessor OBJECT-TYPE
 220     SYNTAX      OCTET STRING
 221     MAX-ACCESS  read-only
 222     STATUS      current
 223     DESCRIPTION
 224         " the type of the local Processor"
 225     ::= { ntpSystem 15 }
 226
 227 --
 228 -- Peers Group
 229 --
 230
 231 --
 232 -- Peer Variables Table
 233 --
 234
 235 ntpPeersVarTable OBJECT-TYPE
 236     SYNTAX      SEQUENCE OF NtpPeersVarEntry
 237     MAX-ACCESS  not-accessible
 238     STATUS      current
 239     DESCRIPTION
 240         ""
 241     ::= { ntpPeers 1 }
 242
 243 ntpPeersVarEntry OBJECT-TYPE
 244     SYNTAX      NtpPeersVarEntry
 245     MAX-ACCESS  not-accessible
 246     STATUS      current
 247     DESCRIPTION
 248         ""
 249     INDEX       { ntpPeersAssocId }
 250     ::= { ntpPeersVarTable 1 }
 251
 252 NtpPeersVarEntry ::= SEQUENCE {
 253     ntpPeersAssocId         Unsigned32,
 254     ntpPeersConfigured      TruthValue,
 255     ntpPeersPeerAddress     IpAddress,
 256     ntpPeersPeerPort        Unsigned32,
 257     ntpPeersHostAddress     IpAddress,
 258     ntpPeersHostPort        Unsigned32,
 259     ntpPeersLeap            NTPLeapIndicator,
 260     ntpPeersMode            INTEGER,
 261     ntpPeersStratum         Integer32,
 262     ntpPeersPeerPoll        Integer32,
 263     ntpPeersHostPoll        Integer32,
 264     ntpPeersPrecision       Integer32,
 265     ntpPeersRootDelay       OCTET STRING,
 266     ntpPeersRootDispersion  OCTET STRING,
 267     ntpPeersRefId           OCTET STRING,
 268     ntpPeersRefTime         NTPTimeStamp,
 269     ntpPeersOrgTime         NTPTimeStamp,
 270     ntpPeersReceiveTime     NTPTimeStamp,
 271     ntpPeersTransmitTime    NTPTimeStamp,
 272     ntpPeersUpdateTime      NTPTimeStamp,
 273     ntpPeersReach           Unsigned32,
 274     ntpPeersTimer           Integer32,
 275     ntpPeersOffset          OCTET STRING,
 276     ntpPeersDelay           OCTET STRING,
 277     ntpPeersDispersion      OCTET STRING
 278 }
 279
 280 ntpPeersAssocId OBJECT-TYPE
 281     SYNTAX      Unsigned32
 282     MAX-ACCESS  not-accessible
 283     STATUS      current
 284     DESCRIPTION
 285         ""
 286     ::= { ntpPeersVarEntry 1 }
 287
 288 ntpPeersConfigured OBJECT-TYPE
 289     SYNTAX      TruthValue
 290     MAX-ACCESS  read-only
 291     STATUS      current
 292     DESCRIPTION
 293         " This is a bit indicating that the association
 294          was created from configuration information and should not
 295          be demobilized if the peer becomes unreachable."
 296     ::= { ntpPeersVarEntry 2 }
 297
 298 ntpPeersPeerAddress OBJECT-TYPE
 299     SYNTAX      IpAddress
 300     MAX-ACCESS  read-only
 301     STATUS      current
 302     DESCRIPTION
 303         " the Internet address of the peer"
 304     ::= { ntpPeersVarEntry 3 }
 305
 306 ntpPeersPeerPort OBJECT-TYPE
 307     SYNTAX      Unsigned32
 308     MAX-ACCESS  read-only
 309     STATUS      current
 310     DESCRIPTION
 311         " 16-bit port number of the peer."
 312     ::= { ntpPeersVarEntry 4 }
 313
 314 ntpPeersHostAddress OBJECT-TYPE
 315     SYNTAX      IpAddress
 316     MAX-ACCESS  read-only
 317     STATUS      current
 318     DESCRIPTION
 319         " the Internet address of the host"
 320     ::= { ntpPeersVarEntry 5 }
 321
 322 ntpPeersHostPort OBJECT-TYPE
 323     SYNTAX      Unsigned32
 324     MAX-ACCESS  read-only
 325     STATUS      current
 326     DESCRIPTION
 327         " 16-bit port number of the host"
 328     ::= { ntpPeersVarEntry 6 }
 329
 330 ntpPeersLeap OBJECT-TYPE
 331     SYNTAX      NTPLeapIndicator
 332     MAX-ACCESS  read-only
 333     STATUS      current
 334     DESCRIPTION
 335         " two-bit code warning of an impending leap
 336          second to be inserted in the NTP timescale."
 337     ::= { ntpPeersVarEntry 7 }
 338
 339 ntpPeersMode OBJECT-TYPE
 340     SYNTAX      INTEGER {
 341                    unspecified(0),
 342                    symmetricActive(1),
 343                    symmetricPassive(2),
 344                    client(3),
 345                    server(4),
 346                    broadcast(5),
 347                    reservedControl(6),
 348                    reservedPrivate(7)
 349                 }
 350     MAX-ACCESS  read-only
 351     STATUS      current
 352     DESCRIPTION
 353         " the association mode,with values coded as
 354          follows:
 355          0, unspecified
 356          1, symmetric active
 357          2, symmetric passive
 358          3, client
 359          4, server
 360          5, broadcast
 361          6, reserved for NTP control messages
 362          7, reserved for private use
 363          "
 364     ::= { ntpPeersVarEntry 8 }
 365
 366 ntpPeersStratum OBJECT-TYPE
 367     SYNTAX      Integer32 (0..255)
 368     MAX-ACCESS  read-only
 369     STATUS      current
 370     DESCRIPTION
 371         " indicating the stratum of the peer clock.
 372          0, unspecified
 373          1, primary reference (e.g.,, calibrated atomic clock,
 374          radio clock)
 375          2-255, secondary reference (via NTP)"
 376     ::= { ntpPeersVarEntry 9 }
 377
 378 ntpPeersPeerPoll OBJECT-TYPE
 379     SYNTAX      Integer32
 380     MAX-ACCESS  read-only
 381     STATUS      current
 382     DESCRIPTION
 383         "poll interval of the peer"
 384     ::= { ntpPeersVarEntry 10 }
 385
 386 ntpPeersHostPoll OBJECT-TYPE
 387     SYNTAX      Integer32
 388     MAX-ACCESS  read-only
 389     STATUS      current
 390     DESCRIPTION
 391         "poll interval of the host"
 392     ::= { ntpPeersVarEntry 11 }
 393
 394 ntpPeersPrecision OBJECT-TYPE
 395     SYNTAX      Integer32
 396     MAX-ACCESS  read-only
 397     STATUS      current
 398     DESCRIPTION
 399         "the same as the systemPrecision except this is
 400          for the peer"
 401     ::= { ntpPeersVarEntry 12 }
 402
 403 ntpPeersRootDelay OBJECT-TYPE
 404     SYNTAX      OCTET STRING
 405     MAX-ACCESS  read-only
 406     STATUS      current
 407     DESCRIPTION
 408         "the same as the systemRootDealy except this is for
 409          the peer"
 410     ::= { ntpPeersVarEntry 13 }
 411
 412 ntpPeersRootDispersion OBJECT-TYPE
 413     SYNTAX      OCTET STRING
 414     MAX-ACCESS  read-only
 415     STATUS      current
 416     DESCRIPTION
 417         "the same as the systemDispersion except this is for
 418          the peer"
 419     ::= { ntpPeersVarEntry 14 }
 420
 421 ntpPeersRefId OBJECT-TYPE
 422     SYNTAX      OCTET STRING
 423     MAX-ACCESS  read-only
 424     STATUS      current
 425     DESCRIPTION
 426         "the same as the systemRefid except this is for
 427          the peer"
 428     ::= { ntpPeersVarEntry 15 }
 429
 430 ntpPeersRefTime OBJECT-TYPE
 431     SYNTAX      NTPTimeStamp
 432     MAX-ACCESS  read-only
 433     STATUS      current
 434     DESCRIPTION
 435         "the same as the systemRefTime except this is for
 436          the peer"
 437     ::= { ntpPeersVarEntry 16 }
 438
 439 ntpPeersOrgTime OBJECT-TYPE
 440     SYNTAX      NTPTimeStamp
 441     MAX-ACCESS  read-only
 442     STATUS      current
 443     DESCRIPTION
 444         " the local time at the peer when its latest
 445          NTP message was sent. If the peer becomes unreachable the
 446          value is set to zero."
 447     ::= { ntpPeersVarEntry 17 }
 448
 449 ntpPeersReceiveTime OBJECT-TYPE
 450     SYNTAX      NTPTimeStamp
 451     MAX-ACCESS  read-only
 452     STATUS      current
 453     DESCRIPTION
 454         "the local time when the latest NTP message
 455          from the peer arrived. If the peer becomes unreachable the
 456          value is set to zero."
 457     ::= { ntpPeersVarEntry 18 }
 458
 459 ntpPeersTransmitTime OBJECT-TYPE
 460     SYNTAX      NTPTimeStamp
 461     MAX-ACCESS  read-only
 462     STATUS      current
 463     DESCRIPTION
 464         "the local time at which the NTP message
 465          departed the sender."
 466     ::= { ntpPeersVarEntry 19 }
 467
 468 ntpPeersUpdateTime OBJECT-TYPE
 469     SYNTAX      NTPTimeStamp
 470     MAX-ACCESS  read-only
 471     STATUS      current
 472     DESCRIPTION
 473         " "
 474     ::= { ntpPeersVarEntry 20 }
 475
 476 ntpPeersReach OBJECT-TYPE
 477     SYNTAX      Unsigned32
 478     MAX-ACCESS  read-only
 479     STATUS      current
 480     DESCRIPTION
 481         "a shift register of NTP.WINDOW bits used to determine
 482          the reachability status of the peer, with bits entering
 483          from the least significant (rightmost) end. A peer is
 484          considered reachable if at least one bit in this register is
 485          set to one."
 486     ::= { ntpPeersVarEntry 21 }
 487
 488 ntpPeersTimer OBJECT-TYPE
 489     SYNTAX      Integer32
 490     MAX-ACCESS  read-only
 491     STATUS      current
 492     DESCRIPTION
 493         ""
 494     ::= { ntpPeersVarEntry 22 }
 495
 496 ntpPeersOffset OBJECT-TYPE
 497     SYNTAX      OCTET STRING
 498     MAX-ACCESS  read-only
 499     STATUS      current
 500     DESCRIPTION
 501         ""
 502     ::= { ntpPeersVarEntry 23 }
 503
 504 ntpPeersDelay OBJECT-TYPE
 505     SYNTAX      OCTET STRING
 506     MAX-ACCESS  read-only
 507     STATUS      current
 508     DESCRIPTION
 509         ""
 510     ::= { ntpPeersVarEntry 24 }
 511
 512 ntpPeersDispersion OBJECT-TYPE
 513     SYNTAX      OCTET STRING
 514     MAX-ACCESS  read-only
 515     STATUS      current
 516     DESCRIPTION
 517         ""
 518     ::= { ntpPeersVarEntry 25 }
 519
 520 --
 521 -- Filter Group
 522 --
 523 -- Implementation of this group is optional. It must be implemented
 524 -- when the filter and selection algorithms described in Section 4
 525 -- of RFC 1305 are used.
 526 --
 527
 528 --
 529 -- Filter Group Peer Variables Table
 530 --
 531 ntpFilterPeersVarTable OBJECT-TYPE
 532     SYNTAX      SEQUENCE OF NtpFilterPeersVarEntry
 533     MAX-ACCESS  not-accessible
 534     STATUS      current
 535     DESCRIPTION
 536         "This table is an extension of the Peer Variables Table
 537          in the Peer Group."
 538     ::= { ntpFilter 1 }
 539
 540 ntpFilterPeersVarEntry OBJECT-TYPE
 541     SYNTAX      NtpFilterPeersVarEntry
 542     MAX-ACCESS  not-accessible
 543     STATUS      current
 544     DESCRIPTION
 545         ""
 546     AUGMENTS    { ntpPeersVarEntry }
 547     ::= { ntpFilterPeersVarTable 1 }
 548
 549 NtpFilterPeersVarEntry ::= SEQUENCE {
 550     ntpFilterValidEntries   Integer32
 551 }
 552
 553 ntpFilterValidEntries OBJECT-TYPE
 554     SYNTAX      Integer32
 555     MAX-ACCESS  read-only
 556     STATUS      current
 557     DESCRIPTION
 558         "The number of valid entries for a peer in the Filter Register Table."
 559     ::= { ntpFilterPeersVarEntry 1 }
 560
 561 --
 562 -- Filter Register Table
 563 --
 564
 565 ntpFilterRegisterTable OBJECT-TYPE
 566     SYNTAX      SEQUENCE OF NtpFilterRegisterEntry
 567     MAX-ACCESS  not-accessible
 568     STATUS      current
 569     DESCRIPTION
 570         ""
 571     ::= { ntpFilter 2 }
 572
 573 ntpFilterRegisterEntry OBJECT-TYPE
 574     SYNTAX      NtpFilterRegisterEntry
 575     MAX-ACCESS  not-accessible
 576     STATUS      current
 577     DESCRIPTION
 578         ""
 579     INDEX       { ntpPeersAssocId, ntpFilterIndex }
 580     ::= { ntpFilterRegisterTable 1 }
 581
 582 NtpFilterRegisterEntry ::= SEQUENCE {
 583     ntpFilterIndex              Unsigned32,
 584     ntpFilterPeersOffset        OCTET STRING,
 585     ntpFilterPeersDelay         OCTET STRING,
 586     ntpFilterPeersDispersion    OCTET STRING
 587 }
 588
 589 ntpFilterIndex OBJECT-TYPE
 590     SYNTAX      Unsigned32
 591     MAX-ACCESS  not-accessible
 592     STATUS      current
 593     DESCRIPTION
 594         ""
 595     ::= { ntpFilterRegisterEntry 1 }
 596
 597 ntpFilterPeersOffset OBJECT-TYPE
 598     SYNTAX      OCTET STRING
 599     MAX-ACCESS  read-only
 600     STATUS      current
 601     DESCRIPTION
 602         "the offset of the peer clock relative to the
 603          local clock in seconds"
 604     ::= { ntpFilterRegisterEntry 2 }
 605
 606 ntpFilterPeersDelay OBJECT-TYPE
 607     SYNTAX      OCTET STRING
 608     MAX-ACCESS  read-only
 609     STATUS      current
 610     DESCRIPTION
 611         "roundtrip delay of the peer clock relative to the
 612          local clock over the network path between them, in seconds.
 613          this variable can take on both positive and negative values,
 614          depending on clock precision and skew-error accumulation."
 615     ::= { ntpFilterRegisterEntry 3 }
 616
 617 ntpFilterPeersDispersion OBJECT-TYPE
 618     SYNTAX      OCTET STRING
 619     MAX-ACCESS  read-only
 620     STATUS      current
 621     DESCRIPTION
 622         "the maximum error of the peer clock relative to the
 623          local clock over the network path between them, in seconds.
 624          Only positive values greater than zero are possible."
 625     ::= { ntpFilterRegisterEntry 4 }
 626
 627 END