external/bsd/ntp/dist/ntpsnmpd/ntpv4-mib.mib

   1 -- *********************************************************************
   2 --
   3 --Id: draft-ietf-ntp-ntpv4-mib-05.xml 1.12 2007/11/28 00:00:00Z chelliot
   4 --$Name: UDEL $
   5 --
   6 --    The Network Time Protocol Version 4
   7 --    Management Information Base (MIB)
   8 --
   9 --    Authors: Heiko Gerstung (heiko.gerstung@meinberg.de)
  10 --             Chris Elliott (chelliot@cisco.com)
  11 --
  12 --    for the Internet Engineering Task Force (IETF)
  13 --    NTP Working Group (ntpwg)
  14 --
  15 --
  16 -- *********************************************************************
  17 --
  18 --  $Log: draft-ietf-ntp-ntpv4-mib-05.xml $
  19 --  Revision 1.14  2008/08/29 00:00:00Z heiko
  20 --  Re-submitted after expiration:
  21 --    - The working group agreed to forward this draft in its current form (04),
  22 --       but it expired before that could be done
  23 --  Revision 1.13  2008/02/25 00:00:00Z chelliot
  24 --  MIB:
  25 --    - Added statistics table on a per-packet mode basis
  26 --      (ntpEntStatPktModeTable)
  27 --  Revision 1.12  2007/11/28 00:00:00Z chelliot
  28 --  MIB:
  29 --    - Added protocol statistics at the entity and association level
  30 --  XML/RFC:
  31 --    - Changed a couple of instances of "instance" to "entity" and "srv"
  32 --      to "ent".
  33 --    - Changed Meinberg address and Heiko's phone number.
  34 --  Revision 1.11  2007/07/23 00:00:00Z chelliot
  35 --  MIB:
  36 --    - Modified Contact Info
  37 --    - Added Stratum and NTP time TCs
  38 --    - Changed ntpEntNotifNotInSync to ntpEntNotifCurrentMode and
  39 --      deleted ntpEntNotifEntityStarted and ntpEntNotifEntityStopped
  40 --    - Added compliance for SNTP entities
  41 --    - Changed ntpTime to ntpDateTime
  42 --  Revision 1.10  2007/07/09 00:00:00Z chelliot
  43 --  XML/RFC:
  44 --    - Changed RFC to Internet
  45 --    - Changed service and service instance* to entity/entities
  46 --    - Revised the Security Considerations to include read-write object
  47 --      security considerations
  48 --    - Added Chris Elliott as an author
  49 --    - Fixed several lines to be 72 characters long or less
  50 --  MIB:
  51 --    - Changed "service" and "service instance" to "entity",
  52 --      and Srv to Ent
  53 --    - Changed status to mode
  54 --    - Added association status object
  55 --    - Added leap second objects
  56 --  Revision 1.9  2007/03/04 06:59:44Z  chelliot
  57 --  MIB:
  58 --    - Added time objects, comments, changed notifications
  59 --    - Changed server to service
  60 --  Revision 1.8  2006/10/23 03:37:44Z  chelliot
  61 --  MIB:
  62 --    - Changed various object types, added notification control object
  63 --  Revision 1.7  2006/06/16 07:13:50Z  heiko
  64 --  XML/RFC:
  65 --    - Added/changed comments about the to-be-done IANA SMI assignment
  66 --  Revision 1.6  2006/06/16 07:04:43Z  heiko
  67 --  RFC/XML:
  68 --    - phone number corrected
  69 --    - removed unused references
  70 --  MIB:
  71 --    - added ntpSrvTimePrecision
  72 --    - changed INTEGER objects to Integer32
  73 --    - changed default value for ntpSrvStatusStratum from 99 to 16
  74 --    - changed default value for ntpSrvStatusActiveRefclockId from 99-0
  75 --    - changed object names to ntpSrvStatusActiveRefSourceName
  76 --      (from ntpSrvStatusActiveRefclockName) and to
  77 --      ntpSrvStatusNumberOfRefSources (from
  78 --      ntpSrvStatusNumberOfRefclocks)
  79 --    - removed ntpSrvStatusAuthKeyId object
  80 --    - added ntpSrvStatusDispersion to provide the current root
  81 --      dispersion
  82 --    - major rework of section 3 (Status of associations) to compile
  83 --      cleanly,including:
  84 --      - added dispersion to the association dataset
  85 --      - renaming of objects
  86 --      - added an index to the association table
  87 --      - formal changes
  88 --    - traps are now reverse mappable
  89 --    - traps are now define with payload where applicable
  90 --    - added compliance statements
  91 --  Revision 1.5  2006/02/27 08:28:16Z  heiko
  92 --    - changed to RFC format and added header as well as
  93 --      introduction and technical description
  94 --    - added other necessary RFC components (copyright statement etc.)
  95 --  Revision 1.4  2006/02/27 07:06:49Z  heiko
  96 --    - removed all objects with data type REAL
  97 --    - everything that needs to be floating point is now defined as
  98 --      DisplayString
  99 --  Revision 1.2  2006/01/23 08:58:11Z  heiko
 100 --    - changed the datatype of offset, jitter and delay objects from
 101 --      Integer32 to REAL
 102 --
 103 -- *********************************************************************
 104
 105 NTPv4-MIB DEFINITIONS ::= BEGIN
 106
 107
 108 IMPORTS
 109     MODULE-IDENTITY, OBJECT-TYPE , enterprises, mib-2, Integer32, NOTIFICATION-TYPE,
 110     Unsigned32, Counter32
 111         FROM SNMPv2-SMI
 112     MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
 113         FROM SNMPv2-CONF
 114     DisplayString, TEXTUAL-CONVENTION
 115         FROM SNMPv2-TC
 116     InetAddressType, InetAddress
 117         FROM INET-ADDRESS-MIB;
 118
 119 ntpSnmpMIB MODULE-IDENTITY
 120     LAST-UPDATED "200802250000Z" -- February 25, 2008
 121
 122     ORGANIZATION "The IETF NTP Working Group (ntpwg)"
 123     CONTACT-INFO
 124             "     WG Email: ntpwg@lists.ntp.isc.org
 125                   Subscribe:
 126                    https://lists.ntp.isc.org/mailman/listinfo/ntpwg
 127
 128                   Heiko Gerstung
 129                   Meinberg Funkuhren Gmbh & Co. KG
 130                   Lange Wand 9
 131                   Bad Pyrmont  31812
 132                   Germany
 133
 134                   Phone: +49 5281 9309 25
 135                   Email: heiko.gerstung@meinberg.de
 136
 137                   Chris Elliott
 138                   Cisco Systems, Inc.
 139                   7025 Kit Creek Rd., P.O. Box 14987
 140                   Research Triangle Park  27709
 141                   USA
 142
 143                   Phone: +1 919-392-2146
 144                   Email: chelliot@cisco.com"
 145      DESCRIPTION
 146         "The Management Information Base for NTP time entities."
 147     REVISION     "200802250000Z"
 148     DESCRIPTION
 149         "Added ntpEntStatPktModeTable"
 150     REVISION     "200711280000Z"
 151     DESCRIPTION
 152         "Multiple proposed changes for IETF 70"
 153     REVISION     "200707230000Z"
 154     DESCRIPTION
 155         "Multiple proposed changes for IETF 69"
 156     REVISION     "200707090000Z"
 157     DESCRIPTION
 158         "Multiple changes from IETF 68"
 159     REVISION     "200703040000Z"
 160     DESCRIPTION
 161         "More MIB review modifications."
 162     REVISION     "200610230000Z"
 163     DESCRIPTION
 164         "Modifications from MIB review."
 165     REVISION     "200606190000Z"
 166     DESCRIPTION
 167         "First Draft Version"
 168     REVISION     "200512190000Z"
 169     DESCRIPTION
 170         "revised edition (added traps and stuff)"
 171     REVISION     "200511160000Z"
 172     DESCRIPTION
 173         "Initial draft"
 174     ::= { enterprises 5597 99 }
 175
 176
 177 ntpSnmpMIBObjects  OBJECT IDENTIFIER ::= { ntpSnmpMIB 1 }
 178
 179 -- MIB contains 6 groups
 180
 181 ntpEntInfo         OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 1 }
 182 ntpEntStatus       OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 2 }
 183 ntpAssociation     OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 3 }
 184 ntpEntControl      OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 4 }
 185 ntpEntNotifObjects OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 5 }
 186 ntpEntNotifPrefix  OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 6 }
 187
 188 --
 189 -- Textual Conventions
 190 --
 191
 192 NtpStratum ::= TEXTUAL-CONVENTION
 193     DISPLAY-HINT "d"
 194     STATUS      current
 195     DESCRIPTION
 196         "The NTP stratum, with 16 representing no stratum."
 197     SYNTAX      Unsigned32 (1..16)
 198
 199 NtpDateTime ::= TEXTUAL-CONVENTION
 200     DISPLAY-HINT "4d:4d:4d.4d"
 201     STATUS      current
 202     DESCRIPTION
 203         "NTP date/time on the device, in 128-bit
 204          NTP date format. Ref: draft-ietf-ntp-ntpv4-proto-06,
 205          section 6:
 206           It includes a 64-bit signed seconds field
 207           spanning 584 billion years and a 64-bit fraction
 208           field resolving .05 attosecond (i.e. 0.5e-18).
 209           For convenience in mapping between formats, the
 210           seconds field is divided into a 32-bit era field
 211           and a 32-bit timestamp field.
 212
 213          If time is not syncronized this field shall be a
 214          zero-length string.
 215
 216          This TC is not to be used for objects that are used
 217          to set the time of the node querying this object.
 218          NTP should be used for this--or at least SNTP."
 219     SYNTAX      OCTET STRING (SIZE (0 | 16))
 220
 221 --
 222 -- Section 1: General NTP Entity information objects
 223 --            (relatively static information)
 224 --
 225
 226 ntpEntSoftwareName OBJECT-TYPE
 227     SYNTAX      DisplayString
 228     MAX-ACCESS  read-only
 229     STATUS      current
 230     DESCRIPTION
 231         "The product name of the installed NTP version."
 232     -- the product name of the running ntp implementation, e.g. "ntpd"
 233     ::= { ntpEntInfo  1 }
 234
 235 ntpEntSoftwareVersion OBJECT-TYPE
 236     SYNTAX      DisplayString
 237     MAX-ACCESS  read-only
 238     STATUS      current
 239     DESCRIPTION
 240         "The software version of the installed NTP implementation."
 241     -- full version string, e.g. "ntpd-4.2.0b@1.1433 ..."
 242     ::= { ntpEntInfo  2 }
 243
 244 ntpEntSoftwareVersionVal OBJECT-TYPE
 245     SYNTAX      Unsigned32
 246     MAX-ACCESS  read-only
 247     STATUS      current
 248     DESCRIPTION
 249         "Software version of installed NTP as an unsigned integer
 250          value."
 251     -- e.g. if version string is "4.2.0b" this could be translated into
 252     --  4202. This could be useful to find out if version of entity on a
 253     --  is newer or older than version of the entity on b (without too
 254     --  much string parsing trouble)
 255     ::= { ntpEntInfo 3 }
 256
 257 ntpEntSoftwareVendor OBJECT-TYPE
 258     SYNTAX      DisplayString
 259     MAX-ACCESS  read-only
 260     STATUS      current
 261     DESCRIPTION
 262         "The vendor/author of the installed NTP version."
 263     ::= { ntpEntInfo  4 }
 264
 265 ntpEntSystemType OBJECT-TYPE
 266     SYNTAX      DisplayString
 267     MAX-ACCESS  read-only
 268     STATUS      current
 269     DESCRIPTION
 270         "General hardware/os platform information."
 271     -- e.g. "Linux 2.6.12 / x86"
 272     -- freely configurable, default is OS Version / Hardware platform
 273     ::= { ntpEntInfo  5 }
 274
 275 ntpEntTimeResolution OBJECT-TYPE
 276     SYNTAX      DisplayString
 277     MAX-ACCESS  read-only
 278     STATUS      current
 279     DESCRIPTION
 280         "A string describing the time resolution of the running NTP
 281          implementation."
 282     -- e.g. "100 ns"
 283     -- depends on the NTP implementation and the underlying OS. The
 284     --  current resolution should be used, so if the OS only supports
 285     --  10ms and ntpd is capable of 1ns, the 10ms should be advertised
 286     ::= { ntpEntInfo  6 }
 287
 288 ntpEntTimeResolutionVal OBJECT-TYPE
 289     SYNTAX      Unsigned32
 290     MAX-ACCESS  read-only
 291     STATUS      current
 292     DESCRIPTION
 293         "The time resolution in integer format."
 294     -- ntpEntTimeResolution in Integer format
 295     -- shows the resolution based on 1 second, e.g. "1ms" translates to
 296     --  1000
 297     ::= { ntpEntInfo  7 }
 298
 299 ntpEntTimePrecision OBJECT-TYPE
 300     SYNTAX      DisplayString
 301     MAX-ACCESS  read-only
 302     STATUS      current
 303     DESCRIPTION
 304         "A string describing the precision with which the NTP entity
 305          implementation/OS manages its time base."
 306     -- e.g. "-18" means 2^-18 = 0.000003814697265625 seconds
 307     --      "-5" means 2^-5 = 0.03125 seconds
 308     -- depends on the NTP implementation and the underlying OS.
 309     ::= { ntpEntInfo  8 }
 310
 311 ntpEntTimePrecisionVal OBJECT-TYPE
 312     SYNTAX      Integer32
 313     MAX-ACCESS  read-only
 314     STATUS      current
 315     DESCRIPTION
 316         "The entity's precision in integer format."
 317     -- ntpEntTimePrecision in signed Integer format
 318     -- shows the precision. A value of -5 would mean 2^-5 = 31.25 ms
 319     ::= { ntpEntInfo  9 }
 320
 321 ntpEntTimeDistance OBJECT-TYPE
 322     SYNTAX      DisplayString
 323     MAX-ACCESS  read-only
 324     STATUS      current
 325     DESCRIPTION
 326         "The distance from this NTP entity to the root time reference
 327         (stratum 0) source."
 328     -- including the unit
 329     -- e.g. "13.243 ms"
 330     ::= { ntpEntInfo  10 }
 331
 332 --
 333 -- Section 2: Current NTP status (dynamic information)
 334 --
 335
 336 ntpEntStatusCurrentMode OBJECT-TYPE
 337     SYNTAX      DisplayString
 338     MAX-ACCESS  read-only
 339     STATUS      current
 340     DESCRIPTION
 341         "The actual mode of NTP as a string"
 342     --- possible strings:
 343     --- "not running" : NTP is not running
 344     --- "not synchronized" : NTP is not synchronized to any time source
 345     ---   (stratum = 16)
 346     --- "none configured" : NTP is not synchronized and does not have a
 347     ---                     server configured
 348     ---   (stratum = 16)
 349     --- "sync to local" : NTP is synchronized to own local clock
 350     ---   (degraded reliability)
 351     --- "sync to refclock" : NTP is synchronized to a local hardware
 352     ---   refclock (e.g. GPS)
 353     --- "sync to remote server" : NTP is synchronized to a remote NTP
 354     ---   server ("upstream" server)
 355     --- "unknown" : The state of NTP is unknown.
 356     ::= { ntpEntStatus 1 }
 357
 358 ntpEntStatusCurrentModeVal OBJECT-TYPE
 359     SYNTAX      INTEGER {
 360                             notRunning(1),
 361                             notSynchronized(2),
 362                             noneConfigured(3),
 363                             syncToLocal(4),
 364                             syncToRefclock(5),
 365                             syncToRemoteServer(6),
 366                             unknown(99)
 367                         }
 368     MAX-ACCESS  read-only
 369     STATUS      current
 370     DESCRIPTION
 371         "The current mode of the NTP as integer value."
 372     -- see ntpEntStatusCurrentMode
 373     DEFVAL { 99 }
 374     ::= { ntpEntStatus 2 }
 375
 376 ntpEntStatusStratum OBJECT-TYPE
 377     SYNTAX      NtpStratum
 378     MAX-ACCESS  read-only
 379     STATUS      current
 380     DESCRIPTION
 381         "The NTP entity's own stratum value."
 382     -- should be stratum of syspeer + 1 (or 16 if no syspeer)
 383     DEFVAL { 16 }
 384     ::= { ntpEntStatus 3 }
 385
 386 ntpEntStatusActiveRefSourceId OBJECT-TYPE
 387     SYNTAX      Unsigned32 ( 0..99999 )
 388     MAX-ACCESS  read-only
 389     STATUS      current
 390     DESCRIPTION
 391         "The association ID of the current syspeer."
 392     DEFVAL { 0 }
 393     ::= { ntpEntStatus 4 }
 394
 395 ntpEntStatusActiveRefSourceName OBJECT-TYPE
 396     SYNTAX      DisplayString
 397     MAX-ACCESS  read-only
 398     STATUS      current
 399     DESCRIPTION
 400         "The hostname/descriptive name of the current reference source
 401          selected as syspeer."
 402     -- e.g. "ntp1.ptb.de" or "GPS" or "DCFi" ...
 403     -- maybe something like "RefClk(8)"="hardware clock using driver 8"
 404     -- would be nice
 405     ::= { ntpEntStatus 5 }
 406
 407 ntpEntStatusActiveOffset OBJECT-TYPE
 408     SYNTAX      DisplayString
 409     MAX-ACCESS  read-only
 410     STATUS      current
 411     DESCRIPTION
 412         "The Time offset to the current selected reference time source
 413          as a string."
 414     -- including unit, e.g. "0.032 ms" or "1.232 s"
 415     ::= { ntpEntStatus 6 }
 416
 417 ntpEntStatusNumberOfRefSources OBJECT-TYPE
 418     SYNTAX      Unsigned32 (0..99)
 419     MAX-ACCESS  read-only
 420     STATUS      current
 421     DESCRIPTION
 422         "The number of reference sources configured for NTP."
 423     DEFVAL { 0 }
 424     ::= { ntpEntStatus 7 }
 425
 426 ntpEntStatusDispersion OBJECT-TYPE
 427     SYNTAX      DisplayString
 428     MAX-ACCESS  read-only
 429     STATUS      current
 430     DESCRIPTION
 431         "The root dispersion of the running NTP entity."
 432     -- e.g. "6.927"
 433     DEFVAL { "n/a" }
 434     ::= { ntpEntStatus 8 }
 435
 436 ntpEntStatusEntityUptime OBJECT-TYPE
 437     SYNTAX      Unsigned32
 438     MAX-ACCESS  read-only
 439     STATUS      current
 440     DESCRIPTION
 441         "The uptime of the NTP entity in seconds."
 442     -- time since ntpd was (re-)started (not sysUptime!)
 443     DEFVAL { 0 }
 444     ::= { ntpEntStatus 9 }
 445
 446 ntpEntStatusDateTime OBJECT-TYPE
 447     SYNTAX      NtpDateTime
 448     MAX-ACCESS  read-only
 449     STATUS      current
 450     DESCRIPTION
 451         "The current NTP date/time on the device, in 128-bit
 452          NTP date format. Ref: draft-ietf-ntp-ntpv4-proto-06,
 453          section 6:
 454           It includes a 64-bit signed seconds field
 455           spanning 584 billion years and a 64-bit fraction
 456           field resolving .05 attosecond (i.e. 0.5e-18).
 457           For convenience in mapping between formats, the
 458           seconds field is divided into a 32-bit era field
 459           and a 32-bit timestamp field.
 460
 461          If time is not syncronized this field shall be a
 462          zero-length string.
 463
 464          This object can be used to timestamp events on this
 465          node and allow a management station to coorelate
 466          different time objects. For example, a management
 467          station could query this object and sysUpTime in
 468          the same operation to be able to relate sysUpTime
 469          to NTP time.
 470
 471          This object is not to be used to set the time of
 472          the node querying this object. NTP should be used
 473          for this--or at least SNTP."
 474     ::= { ntpEntStatus 10 }
 475
 476 ntpEntStatusLeapSecond OBJECT-TYPE
 477     SYNTAX      Integer32
 478     MAX-ACCESS  read-only
 479     STATUS      current
 480     DESCRIPTION
 481         "Date the next known leap second will occur. If there is
 482          no leap second announced then this object should be 0."
 483     DEFVAL { 0 }
 484     ::= { ntpEntStatus 11 }
 485
 486 ntpEntStatusLeapSecDirection OBJECT-TYPE
 487     SYNTAX      Integer32 (-1..1)
 488     MAX-ACCESS  read-only
 489     STATUS      current
 490     DESCRIPTION
 491         "Direction of next known leap second. If there is no
 492          leap second announced then this object should be 0."
 493     DEFVAL { 0 }
 494     ::= { ntpEntStatus 12 }
 495
 496 ntpEntStatusInPkts OBJECT-TYPE
 497     SYNTAX      Counter32
 498     MAX-ACCESS  read-only
 499     STATUS      current
 500     DESCRIPTION
 501         "The total number of NTP messages delivered to the
 502          NTP entity from the transport service."
 503     ::= { ntpEntStatus 13 }
 504
 505 ntpEntStatusOutPkts OBJECT-TYPE
 506     SYNTAX      Counter32
 507     MAX-ACCESS  read-only
 508     STATUS      current
 509     DESCRIPTION
 510         "The total number of NTP messages delivered to the
 511          transport service by this NTP entity."
 512     ::= { ntpEntStatus 14 }
 513
 514 ntpEntStatusBadVersion OBJECT-TYPE
 515     SYNTAX      Counter32
 516     MAX-ACCESS  read-only
 517     STATUS      current
 518     DESCRIPTION
 519         "The total number of NTP messages which were delivered
 520          to this NTP entity and were for an unsupported NTP
 521          version."
 522     ::= { ntpEntStatus 15 }
 523
 524 ntpEntStatusProtocolError OBJECT-TYPE
 525     SYNTAX      Counter32
 526     MAX-ACCESS  read-only
 527     STATUS      current
 528     DESCRIPTION
 529         "The total number of NTP messages which were delivered
 530          to this NTP entity and this entity was not able to
 531          process due to an NTP protocol error."
 532     ::= { ntpEntStatus 16 }
 533
 534 ntpEntStatusNotifications OBJECT-TYPE
 535     SYNTAX      Counter32
 536     MAX-ACCESS  read-only
 537     STATUS      current
 538     DESCRIPTION
 539         "The total number of SNMP notifications which this NTP
 540          entity has generated."
 541     ::= { ntpEntStatus 17 }
 542
 543 ntpEntStatPktModeTable OBJECT-TYPE
 544     SYNTAX           SEQUENCE OF NtpEntStatPktModeEntry
 545     MAX-ACCESS       not-accessible
 546     STATUS           current
 547     DESCRIPTION
 548         "The number of packets sent and received by packet mode."
 549     ::= { ntpEntStatus 18 }
 550
 551 ntpEntStatPktModeEntry OBJECT-TYPE
 552     SYNTAX      NtpEntStatPktModeEntry
 553     MAX-ACCESS  not-accessible
 554     STATUS      current
 555     DESCRIPTION
 556         "The number of packets sent and received by packet mode."
 557     INDEX       { ntpEntStatPktMode }
 558     ::= { ntpEntStatPktModeTable 1 }
 559
 560 NtpEntStatPktModeEntry   ::= SEQUENCE {
 561         ntpEntStatPktMode              INTEGER,
 562         ntpEntStatPktSent              Counter32,
 563         ntpEntStatPktReceived          Counter32
 564 }
 565
 566 ntpEntStatPktMode OBJECT-TYPE
 567     SYNTAX      INTEGER {
 568                     symetricactive(1),
 569                     symetricpassive(2),
 570                     client(3),
 571                     server(4),
 572                     broadcastserver(5),
 573                     broadcastclient(6)
 574                 }
 575     MAX-ACCESS  not-accessible
 576     STATUS      current
 577     DESCRIPTION
 578         "The NTP packet mode."
 579     ::= { ntpEntStatPktModeEntry 1 }
 580
 581 ntpEntStatPktSent OBJECT-TYPE
 582     SYNTAX      Counter32
 583     MAX-ACCESS  read-only
 584     STATUS      current
 585     DESCRIPTION
 586         "The number of NTP packets sent with this packet mode."
 587     ::= { ntpEntStatPktModeEntry 2 }
 588
 589 ntpEntStatPktReceived OBJECT-TYPE
 590     SYNTAX      Counter32
 591     MAX-ACCESS  read-only
 592     STATUS      current
 593     DESCRIPTION
 594         "The number of NTP packets received with this packet mode."
 595     ::= { ntpEntStatPktModeEntry 3 }
 596
 597 --
 598 -- Section 3: The status of all currently mobilized associations
 599 --
 600
 601 ntpAssociationTable OBJECT-TYPE
 602     SYNTAX           SEQUENCE OF NtpAssociationEntry
 603     MAX-ACCESS       not-accessible
 604     STATUS           current
 605     DESCRIPTION
 606         "The table of currently mobilized associations."
 607     ::= { ntpAssociation 1 }
 608
 609 ntpAssociationEntry OBJECT-TYPE
 610     SYNTAX      NtpAssociationEntry
 611     MAX-ACCESS  not-accessible
 612     STATUS      current
 613     DESCRIPTION
 614         "The table entry of currently mobilized associations."
 615     INDEX       { ntpAssocId }
 616     ::= { ntpAssociationTable 1 }
 617
 618 NtpAssociationEntry   ::= SEQUENCE {
 619         ntpAssocId                  Unsigned32,
 620         ntpAssocName                DisplayString,
 621         ntpAssocRefId               DisplayString,
 622         ntpAssocAddressType         InetAddressType,
 623         ntpAssocAddress             InetAddress,
 624         ntpAssocOffset              DisplayString,
 625         ntpAssocStratum             NtpStratum,
 626         ntpAssocStatusJitter        DisplayString,
 627         ntpAssocStatusDelay         DisplayString,
 628         ntpAssocStatusDispersion    DisplayString
 629 }
 630
 631 ntpAssocId      OBJECT-TYPE
 632     SYNTAX      Unsigned32 ( 1..99999 )
 633     MAX-ACCESS  not-accessible
 634     STATUS      current
 635     DESCRIPTION
 636         "The association ID. This is an internal, unique ID."
 637     ::= { ntpAssociationEntry 1 }
 638
 639 ntpAssocName    OBJECT-TYPE
 640     SYNTAX      DisplayString
 641     MAX-ACCESS  read-only
 642     STATUS      current
 643     DESCRIPTION
 644         "The hostname or other descriptive name for the association."
 645     ::= { ntpAssociationEntry 2 }
 646
 647 ntpAssocRefId   OBJECT-TYPE
 648     SYNTAX      DisplayString
 649     MAX-ACCESS  read-only
 650     STATUS      current
 651     DESCRIPTION
 652         "The refclock driver ID, if available."
 653     -- a refclock driver ID like "127.127.1.0" for non
 654     -- uni/multi/broadcast associations
 655     ::= { ntpAssociationEntry 3 }
 656
 657 ntpAssocAddressType OBJECT-TYPE
 658     SYNTAX      InetAddressType
 659     MAX-ACCESS  read-only
 660     STATUS      current
 661     DESCRIPTION
 662         "The type of address of the association."
 663     -- contains the type of address for uni/multi/broadcast associations
 664     ::= { ntpAssociationEntry 4 }
 665
 666 ntpAssocAddress OBJECT-TYPE
 667     SYNTAX      InetAddress
 668     MAX-ACCESS  read-only
 669     STATUS      current
 670     DESCRIPTION
 671         "The IP address (IPv4 or IPv6) of the association."
 672     -- contains IP address of uni/multi/broadcast associations
 673     ::= { ntpAssociationEntry 5 }
 674
 675 ntpAssocOffset  OBJECT-TYPE
 676     SYNTAX      DisplayString
 677     MAX-ACCESS  read-only
 678     STATUS      current
 679     DESCRIPTION
 680         "The time offset to the association as a string."
 681     -- including unit, e.g. "0.032 ms" or "1.232 s"
 682     ::= { ntpAssociationEntry 6 }
 683
 684 ntpAssocStratum OBJECT-TYPE
 685     SYNTAX      NtpStratum
 686     MAX-ACCESS  read-only
 687     STATUS      current
 688     DESCRIPTION
 689         "The association stratum value."
 690     ::= { ntpAssociationEntry 7 }
 691
 692 ntpAssocStatusJitter OBJECT-TYPE
 693     SYNTAX      DisplayString
 694     MAX-ACCESS  read-only
 695     STATUS      current
 696     DESCRIPTION
 697         "The jitter in miliseconds as a string."
 698     ::= { ntpAssociationEntry 8 }
 699
 700 ntpAssocStatusDelay OBJECT-TYPE
 701     SYNTAX      DisplayString
 702     MAX-ACCESS  read-only
 703     STATUS      current
 704     DESCRIPTION
 705         "The network delay in miliseconds as a string."
 706     ::= { ntpAssociationEntry 9 }
 707
 708 ntpAssocStatusDispersion OBJECT-TYPE
 709     SYNTAX      DisplayString
 710     MAX-ACCESS  read-only
 711     STATUS      current
 712     DESCRIPTION
 713         "The root dispersion of the association."
 714     -- e.g. "6.927"
 715     ::= { ntpAssociationEntry 10 }
 716
 717 ntpAssociationStatisticsTable OBJECT-TYPE
 718     SYNTAX           SEQUENCE OF NtpAssociationStatisticsEntry
 719     MAX-ACCESS       not-accessible
 720     STATUS           current
 721     DESCRIPTION
 722         "The table of statistics for current associations."
 723     ::= { ntpAssociation 2 }
 724
 725 ntpAssociationStatisticsEntry OBJECT-TYPE
 726     SYNTAX      NtpAssociationStatisticsEntry
 727     MAX-ACCESS  not-accessible
 728     STATUS      current
 729     DESCRIPTION
 730         "The table entry of statistics for current associations."
 731     INDEX       { ntpAssocId }
 732     ::= { ntpAssociationStatisticsTable 1 }
 733
 734 NtpAssociationStatisticsEntry   ::= SEQUENCE {
 735         ntpAssocStatInPkts          Counter32,
 736         ntpAssocStatOutPkts         Counter32,
 737         ntpAssocStatProtocolError   Counter32
 738 }
 739
 740 ntpAssocStatInPkts OBJECT-TYPE
 741     SYNTAX      Counter32
 742     MAX-ACCESS  read-only
 743     STATUS      current
 744     DESCRIPTION
 745         "The total number of NTP messages delivered to the
 746          NTP entity from this association."
 747     ::= { ntpAssociationStatisticsEntry 1 }
 748
 749 ntpAssocStatOutPkts OBJECT-TYPE
 750     SYNTAX      Counter32
 751     MAX-ACCESS  read-only
 752     STATUS      current
 753     DESCRIPTION
 754         "The total number of NTP messages delivered to the
 755          transport service by this NTP entity for this
 756          association."
 757     ::= { ntpAssociationStatisticsEntry 2 }
 758
 759 ntpAssocStatProtocolError OBJECT-TYPE
 760     SYNTAX      Counter32
 761     MAX-ACCESS  read-only
 762     STATUS      current
 763     DESCRIPTION
 764         "The total number of NTP messages which were delivered
 765          to this NTP entity from this association and this entity
 766          was not able to process due to an NTP protocol error."
 767     ::= { ntpAssociationStatisticsEntry 3 }
 768
 769 --
 770 -- Section 4: Control objects
 771 --
 772
 773 ntpEntHeartbeatInterval OBJECT-TYPE
 774     SYNTAX      Unsigned32
 775     MAX-ACCESS  read-write
 776     STATUS      current
 777     DESCRIPTION
 778         "The interval at which the ntpEntNotifHeartbeat notification
 779          should be sent, in seconds. If set to 0 and the
 780          entNotifHeartbeat bit in ntpEntNotifBits is 1 then
 781          ntpEntNotifHeartbeat is sent once."
 782     DEFVAL { 60 }
 783     ::= { ntpEntControl 1 }
 784
 785 ntpEntNotifBits OBJECT-TYPE
 786     SYNTAX       BITS {
 787                      notUsed(0), -- Used to sync up bit and notification
 788                                  -- indices
 789                      entNotifModeChange(1),
 790                      entNotifStratumChange(2),
 791                      entNotifSyspeerChanged(3),
 792                      entNotifAddAssociation(4),
 793                      entNotifRemoveAssociation(5),
 794                      entNotifConfigChanged(6),
 795                      entNotifLeapSecondAnnounced(7),
 796                      entNotifHeartbeat(8)
 797     }
 798     MAX-ACCESS  read-write
 799     STATUS      current
 800     DESCRIPTION
 801         "A bit for each notification. A 1 for a particular bit enables
 802          that particular notification, a 0 disables it."
 803     ::= { ntpEntControl 2 }
 804
 805 --
 806 -- Section 5: Notification objects
 807 --
 808
 809 ntpEntNotifMessage OBJECT-TYPE
 810     SYNTAX      DisplayString
 811     MAX-ACCESS  accessible-for-notify
 812     STATUS      current
 813     DESCRIPTION
 814         "Used as a payload object for all notifications. Holds a clear
 815          text event message."
 816     DEFVAL { "no event" }
 817     ::= { ntpEntNotifObjects 1 }
 818
 819 --
 820 -- SNMP notification definitions
 821 --
 822
 823 ntpEntNotifications OBJECT IDENTIFIER ::= { ntpEntNotifPrefix 0 }
 824
 825 ntpEntNotifModeChange NOTIFICATION-TYPE
 826     OBJECTS     { ntpEntStatusCurrentModeVal }
 827     STATUS      current
 828     DESCRIPTION
 829         "The notification to be sent when the NTP entity changes mode,
 830          including starting and stopping (if possible)"
 831     ::= { ntpEntNotifications 1 }
 832
 833 ntpEntNotifStratumChange NOTIFICATION-TYPE
 834     OBJECTS     { ntpEntStatusDateTime, ntpEntStatusStratum,
 835                   ntpEntNotifMessage }
 836     STATUS      current
 837     DESCRIPTION
 838         "The notification to be sent when stratum level of NTP changes."
 839     ::= { ntpEntNotifications 2 }
 840
 841 ntpEntNotifSyspeerChanged NOTIFICATION-TYPE
 842     OBJECTS     { ntpEntStatusDateTime, ntpEntStatusActiveRefSourceId,
 843                   ntpEntNotifMessage }
 844     STATUS      current
 845     DESCRIPTION
 846         "The notification to be sent when a (new) syspeer has been
 847          selected."
 848     ::= { ntpEntNotifications 3 }
 849
 850 ntpEntNotifAddAssociation NOTIFICATION-TYPE
 851     OBJECTS     { ntpEntStatusDateTime, ntpAssocName, ntpEntNotifMessage }
 852     STATUS      current
 853     DESCRIPTION
 854         "The notification to be sent when a new association is
 855          mobilized."
 856     ::= { ntpEntNotifications 4 }
 857
 858 ntpEntNotifRemoveAssociation NOTIFICATION-TYPE
 859     OBJECTS     { ntpEntStatusDateTime, ntpAssocName,  ntpEntNotifMessage }
 860     STATUS      current
 861     DESCRIPTION
 862         "The notification to be sent when an association is
 863          demobilized."
 864     ::= { ntpEntNotifications 5 }
 865
 866 ntpEntNotifConfigChanged NOTIFICATION-TYPE
 867     OBJECTS     { ntpEntStatusDateTime, ntpEntNotifMessage }
 868     STATUS      current
 869     DESCRIPTION
 870         "The notification to be sent when the NTP configuration has
 871          changed."
 872     -- e.g. when the system connected to the internet and was assigned
 873     -- a new IP address by the ISPs DHCP server
 874     ::= { ntpEntNotifications 6 }
 875
 876 ntpEntNotifLeapSecondAnnounced NOTIFICATION-TYPE
 877     OBJECTS     { ntpEntStatusDateTime, ntpEntNotifMessage }
 878     STATUS      current
 879     DESCRIPTION
 880         "The notification to be sent when a leap second has been
 881          announced."
 882     ::= { ntpEntNotifications 7 }
 883
 884 ntpEntNotifHeartbeat NOTIFICATION-TYPE
 885     OBJECTS     { ntpEntStatusDateTime, ntpEntStatusCurrentModeVal,
 886                   ntpEntHeartbeatInterval, ntpEntNotifMessage }
 887     STATUS      current
 888     DESCRIPTION
 889         "The notification to be sent periodically (as defined by
 890          ntpEntHeartbeatInterval) to indicate that the NTP entity is
 891          still alive."
 892     ::= { ntpEntNotifications 8 }
 893
 894 --
 895 -- Conformance/Compliance statements
 896 --
 897
 898 ntpEntConformance OBJECT IDENTIFIER ::= { ntpSnmpMIB 6 }
 899
 900 ntpEntCompliances OBJECT IDENTIFIER ::= { ntpEntConformance 1 }
 901 ntpEntGroups      OBJECT IDENTIFIER ::= { ntpEntConformance 2 }
 902
 903 ntpEntNTPCompliance MODULE-COMPLIANCE
 904     STATUS      current
 905     DESCRIPTION
 906         "The compliance statement for SNMP entities which use NTP and
 907          implement the NTP MIB"
 908     MODULE  -- this module
 909         MANDATORY-GROUPS {
 910                            ntpEntObjectsGroup1,
 911                            ntpEntObjectsGroup2,
 912                            ntpEntNotifPrefixGroup
 913         }
 914         ::= { ntpEntCompliances 1 }
 915
 916 ntpEntSNTPCompliance MODULE-COMPLIANCE
 917     STATUS      current
 918     DESCRIPTION
 919         "The compliance statement for SNMP entities which use SNTP and
 920          implement the NTP MIB"
 921     MODULE  -- this module
 922         MANDATORY-GROUPS {
 923                            ntpEntObjectsGroup1
 924         }
 925         ::= { ntpEntCompliances 2 }
 926
 927 ntpEntObjectsGroup1 OBJECT-GROUP
 928     OBJECTS {
 929               ntpEntSoftwareName,
 930               ntpEntSoftwareVersion,
 931               ntpEntSoftwareVersionVal,
 932               ntpEntSoftwareVendor,
 933               ntpEntSystemType,
 934               ntpEntStatusEntityUptime,
 935               ntpEntStatusDateTime,
 936               ntpAssocName,
 937               ntpAssocRefId,
 938               ntpAssocAddressType,
 939               ntpAssocAddress
 940     }
 941     STATUS      current
 942     DESCRIPTION
 943         "A collection of objects for the NTP MIB that all NTP
 944          or SNTP entities should implement."
 945     ::= { ntpEntGroups 1 }
 946
 947 ntpEntObjectsGroup2 OBJECT-GROUP
 948     OBJECTS {
 949               ntpEntTimeResolution,
 950               ntpEntTimeResolutionVal,
 951               ntpEntTimePrecision,
 952               ntpEntTimePrecisionVal,
 953               ntpEntTimeDistance,
 954               ntpEntStatusCurrentMode,
 955               ntpEntStatusCurrentModeVal,
 956               ntpEntStatusStratum,
 957               ntpEntStatusActiveRefSourceId,
 958               ntpEntStatusActiveRefSourceName,
 959               ntpEntStatusActiveOffset,
 960               ntpEntStatusNumberOfRefSources,
 961               ntpEntStatusDispersion,
 962               ntpEntStatusLeapSecond,
 963               ntpEntStatusLeapSecDirection,
 964               ntpEntStatusInPkts,
 965               ntpEntStatusOutPkts,
 966               ntpEntStatusBadVersion,
 967               ntpEntStatusProtocolError,
 968               ntpEntStatusNotifications,
 969               ntpEntStatPktSent,
 970               ntpEntStatPktReceived,
 971               ntpAssocOffset,
 972               ntpAssocStratum,
 973               ntpAssocStatusJitter,
 974               ntpAssocStatusDelay,
 975               ntpAssocStatusDispersion,
 976               ntpAssocStatInPkts,
 977               ntpAssocStatOutPkts,
 978               ntpAssocStatProtocolError,
 979               ntpEntHeartbeatInterval,
 980               ntpEntNotifBits,
 981               ntpEntNotifMessage
 982     }
 983     STATUS      current
 984     DESCRIPTION
 985         "A collection of objects for the NTP MIB that are optional
 986          for NTP or SNTP entities to implement."
 987     ::= { ntpEntGroups 2 }
 988
 989 ntpEntNotifPrefixGroup NOTIFICATION-GROUP
 990     NOTIFICATIONS {
 991                     ntpEntNotifModeChange,
 992                     ntpEntNotifStratumChange,
 993                     ntpEntNotifSyspeerChanged,
 994                     ntpEntNotifAddAssociation,
 995                     ntpEntNotifRemoveAssociation,
 996                     ntpEntNotifConfigChanged,
 997                     ntpEntNotifLeapSecondAnnounced,
 998                     ntpEntNotifHeartbeat
 999     }
1000     STATUS      current
1001     DESCRIPTION
1002         "A collection of notifications for the NTP MIB"
1003     ::= { ntpEntGroups 3 }
1004
1005 END