-- extracted from draft-ietf-ntp-ntpv4-mib-02.txt -- at Tue Jul 24 06:08:49 2007 NTPv4-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE , mib-2, Integer32, NOTIFICATION-TYPE, Unsigned32 FROM SNMPv2-SMI MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP FROM SNMPv2-CONF DisplayString FROM SNMPv2-TC InetAddressType, InetAddress FROM INET-ADDRESS-MIB; ntpSnmpMIB MODULE-IDENTITY LAST-UPDATED "200707090000Z" -- July 9, 2007 ORGANIZATION "The IETF NTP Working Group (ntpwg)" CONTACT-INFO " WG Email: Subscribe: Editor 1 name Title Employeer Address Phone email Editor 2 name..." DESCRIPTION "The Management Information Base for NTP time entities." REVISION "200707090000Z" DESCRIPTION "Multiple changes from IETF 68" REVISION "200703040000Z" DESCRIPTION "More MIB review modifications." REVISION "200610230000Z" DESCRIPTION "Modifications from MIB review." REVISION "200606190000Z" DESCRIPTION "First Draft Version" REVISION "200512190000Z" DESCRIPTION "revised edition (added traps and stuff)" REVISION "200511160000Z" DESCRIPTION "Initial draft" ::= { mib-2 99999 } ntpSnmpMIBObjects OBJECT IDENTIFIER ::= { ntpSnmpMIB 1 } -- MIB contains 4 groups ntpEntInfo OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 1 } ntpEntStatus OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 2 } ntpAssociation OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 3 } ntpEntControl OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 4 } ntpEntNotifObjects OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 5 } ntpEntNotifPrefix OBJECT IDENTIFIER ::= { ntpSnmpMIBObjects 6 } -- -- Section 1: General NTP Entity information objects -- (relatively static information) -- ntpEntSoftwareName OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The product name of the installed NTP version." -- the product name of the running ntp implementation, e.g. "ntpd" ::= { ntpEntInfo 1 } ntpEntSoftwareVersion OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The software version of the installed NTP implementation." -- full version string, e.g. "ntpd-4.2.0b@1.1433 ..." ::= { ntpEntInfo 2 } ntpEntSoftwareVersionVal OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "Software version of installed NTP as an unsigned integer value." -- e.g. if version string is "4.2.0b" this could be translated into 4202 -- could be useful to find out if version of entity on a is newer or older -- than version of the entity on b (without too much string parsing trouble) ::= { ntpEntInfo 3 } ntpEntSoftwareVendor OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The vendor/author of the installed NTP version." ::= { ntpEntInfo 4 } ntpEntSystemType OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "General hardware/os platform information." -- e.g. "Linux 2.6.12 / x86" -- freely configurable, default is OS Version / Hardware platform ::= { ntpEntInfo 5 } ntpEntTimeResolution OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "A string describing the time resolution of the running NTP implementation." -- e.g. "100 ns" -- depends on the NTP implementation and the underlying OS. The current -- resolution should be used, so if the OS only supports 10ms and ntpd is -- capable of 1ns, the 10ms should be advertised ::= { ntpEntInfo 6 } ntpEntTimeResolutionVal OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "The time resolution in integer format." -- ntpEntTimeResolution in Integer format -- shows the resolution based on 1 second, e.g. "1ms" translates to 1000 ::= { ntpEntInfo 7 } ntpEntTimePrecision OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "A string describing the precision with which the NTP entity implementation/OS manages its time base." -- e.g. "-18" means 2^-18 = 0.000003814697265625 seconds -- "-5" means 2^-5 = 0.03125 seconds -- depends on the NTP implementation and the underlying OS. ::= { ntpEntInfo 8 } ntpEntTimePrecisionVal OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "The entity's precision in integer format." -- ntpEntTimePrecision in signed Integer format -- shows the precision. A value of -5 would mean 2^-5 = 31.25 ms ::= { ntpEntInfo 9 } ntpEntTimeDistance OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The distance from this NTP instance to the root time reference (stratum 0) source." -- including the unit -- e.g. "13.243 ms" ::= { ntpEntInfo 10 } -- -- Section 2: Current NTP status (dynamic information) -- ntpEntStatusCurrentMode OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The actual mode of NTP as a string" --- possible strings: --- "not running" : NTP is not running --- "not synchronized" : NTP is not synchronized to any time source --- (stratum = 16) --- "none configured" : NTP is not synchronized and does not have a server --- configured --- (stratum = 16) --- "sync to local" : NTP is synchronized to own local clock --- (degraded reliability) --- "sync to refclock" : NTP is synchronized to a local hardware refclock --- (e.g. GPS) --- "sync to remote server" : NTP is synchronized to a remote NTP server --- ("upstream" server) --- "unknown" : The state of NTP is unknown. ::= { ntpEntStatus 1 } ntpEntStatusCurrentModeVal OBJECT-TYPE SYNTAX INTEGER { notRunning(1), notSynchronized(2), noneConfigured(3), syncToLocal(4), syncToRefclock(5), syncToRemoteServer(6), unknown(99) } MAX-ACCESS read-only STATUS current DESCRIPTION "The current mode of the NTP as integer value." -- see ntpEntStatusCurrentMode DEFVAL { 99 } ::= { ntpEntStatus 2 } ntpEntStatusStratum OBJECT-TYPE SYNTAX Unsigned32 (1..16) MAX-ACCESS read-only STATUS current DESCRIPTION "The NTP entity's own stratum value." -- should be stratum of syspeer + 1 (or 16 if no syspeer) DEFVAL { 16 } ::= { ntpEntStatus 3 } ntpEntStatusActiveRefSourceId OBJECT-TYPE SYNTAX Unsigned32 ( 0..99999 ) MAX-ACCESS read-only STATUS current DESCRIPTION "The association ID of the current syspeer." DEFVAL { 0 } ::= { ntpEntStatus 4 } ntpEntStatusActiveRefSourceName OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The hostname/descriptive name of the current reference source selected as syspeer." -- e.g. "ntp1.ptb.de" or "GPS" or "DCFi" ... -- maybe something like "RefClk(8)" = "hardware clock using driver 8" -- would be nice ::= { ntpEntStatus 5 } ntpEntStatusActiveOffset OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The Time offset to the current selected reference time source as a string." -- including unit, e.g. "0.032 ms" or "1.232 s" ::= { ntpEntStatus 6 } ntpEntStatusNumberOfRefSources OBJECT-TYPE SYNTAX Unsigned32 (0..99) MAX-ACCESS read-only STATUS current DESCRIPTION "The number of reference sources configured for NTP." DEFVAL { 0 } ::= { ntpEntStatus 7 } ntpEntStatusDispersion OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The root dispersion of the running NTP instance." -- e.g. "6.927" DEFVAL { "n/a" } ::= { ntpEntStatus 8 } ntpEntStatusEntityUptime OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "The uptime of the NTP entity in seconds." -- time since ntpd was (re-)started (not sysUptime!) DEFVAL { 0 } ::= { ntpEntStatus 9 } ntpEntStatusTime OBJECT-TYPE SYNTAX OCTET STRING (SIZE (0 | 16)) MAX-ACCESS read-only STATUS current DESCRIPTION "The current NTP time on the device, in 128-bit NTP date format. Ref: draft-ietf-ntp-ntpv4-proto-04, section 5: It includes a 64-bit signed seconds field spanning 584 billion years and a 64-bit fraction field resolving .05 attosecond (i.e. 0.5e-18). For convenience in mapping between formats, the seconds field is divided into a 32-bit era field and a 32-bit timestamp field. If time is not syncronized this field shall be a zero-length string. This object can be used to timestamp events on this node and allow a management station to coorelate different time objects. For example, a management station could query this object and sysUpTime in the same operation to be able to relate sysUpTime to NTP time. This object is not to be used to set the time of the node querying this object. NTP should be used for this--or at least SNTP." ::= { ntpEntStatus 10 } ntpEntStatusLeapSecond OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "Date the next known leap second will occur" DEFVAL { 0 } ::= { ntpEntStatus 11 } ntpEntStatusLeapSecDirection OBJECT-TYPE SYNTAX Integer32 (-1..1) MAX-ACCESS read-only STATUS current DESCRIPTION "Direction of next known leap second" DEFVAL { 0 } ::= { ntpEntStatus 12 } -- -- Section 3: The status of all currently mobilized associations -- ntpAssociationTable OBJECT-TYPE SYNTAX SEQUENCE OF NtpAssociationEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The table of currently mobilized associations." ::= { ntpAssociation 1 } ntpAssociationEntry OBJECT-TYPE SYNTAX NtpAssociationEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The table entry of currently mobilized associations." INDEX { ntpAssocId } ::= { ntpAssociationTable 1 } NtpAssociationEntry ::= SEQUENCE { ntpAssocId Unsigned32, ntpAssocName DisplayString, ntpAssocRefId DisplayString, ntpAssocAddressType InetAddressType, ntpAssocAddress InetAddress, ntpAssocOffset DisplayString, ntpAssocStratum Integer32, ntpAssocStatusJitter DisplayString, ntpAssocStatusDelay DisplayString, ntpAssocStatusDispersion DisplayString } ntpAssocId OBJECT-TYPE SYNTAX Unsigned32 ( 1..99999 ) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The association ID. This is an internal, unique ID." ::= { ntpAssociationEntry 1 } ntpAssocName OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The hostname or other descriptive name for the association." ::= { ntpAssociationEntry 2 } ntpAssocRefId OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The refclock driver ID, if available." -- a refclock driver ID like "127.127.1.0" for non uni/multi/broadcast -- associations ::= { ntpAssociationEntry 3 } ntpAssocAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "The type of address of the association." -- contains the type of address for uni/multi/broadcast associations ::= { ntpAssociationEntry 4 } ntpAssocAddress OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The IP address (IPv4 or IPv6) of the association." -- contains IP address of uni/multi/broadcast associations ::= { ntpAssociationEntry 5 } ntpAssocOffset OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The time offset to the association as a string." -- including unit, e.g. "0.032 ms" or "1.232 s" ::= { ntpAssociationEntry 6 } ntpAssocStratum OBJECT-TYPE SYNTAX Integer32 (1..16) MAX-ACCESS read-only STATUS current DESCRIPTION "The association stratum value." ::= { ntpAssociationEntry 7 } ntpAssocStatusJitter OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The jitter in miliseconds as a string." ::= { ntpAssociationEntry 8 } ntpAssocStatusDelay OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The network delay in miliseconds as a string." ::= { ntpAssociationEntry 9 } ntpAssocStatusDispersion OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "The root dispersion of the association." -- e.g. "6.927" ::= { ntpAssociationEntry 10 } -- -- Section 4: Control objects -- ntpEntHeartbeatInterval OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-write STATUS current DESCRIPTION "The interval at which the ntpEntNotifHeartbeat notification should be sent, in seconds. If set to 0 and the srvNotifHeartbeat bit in ntpEntNotifBits is 1 then ntpEntNotifHeartbeat is sent once." DEFVAL { 60 } ::= { ntpEntControl 1 } ntpEntNotifBits OBJECT-TYPE SYNTAX BITS { notUsed(0), -- Used to sync up bit and notification -- indices srvNotifNotSync(1), srvNotifEntityStarted(2), srvNotifEntityStopped(3), srvNotifStratumChange(4), srvNotifSyspeerChanged(5), srvNotifAddAssociation(6), srvNotifRemoveAssociation(7), srvNotifConfigChanged(8), srvNotifLeapSecondAnnounced(9), srvNotifHeartbeat(10) } MAX-ACCESS read-write STATUS current DESCRIPTION "A bit for each notification. A 1 for a particular bit enables that particular notification, a 0 disables it." ::= { ntpEntControl 2 } -- -- Section 5: Notification objects -- ntpEntNotifMessage OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS accessible-for-notify STATUS current DESCRIPTION "Used as a payload object for all notifications. Holds a clear text event message." DEFVAL { "no event" } ::= { ntpEntNotifObjects 1 } -- -- SNMP notification definitions -- ntpEntNotifications OBJECT IDENTIFIER ::= { ntpEntNotifPrefix 0 } ntpEntNotifNotInSync NOTIFICATION-TYPE OBJECTS { ntpEntStatusCurrentModeVal } STATUS current DESCRIPTION "The notification to be sent when the NTP entity transistions to not synchronised." ::= { ntpEntNotifications 1 } ntpEntNotifEntityStarted NOTIFICATION-TYPE OBJECTS { ntpEntNotifMessage } STATUS current DESCRIPTION "The notification to be sent when NTP starts up." ::= { ntpEntNotifications 2 } ntpEntNotifEntityStopped NOTIFICATION-TYPE OBJECTS { ntpEntNotifMessage } STATUS current DESCRIPTION "The notification to be sent when NTP stops." ::= { ntpEntNotifications 3 } ntpEntNotifStratumChange NOTIFICATION-TYPE OBJECTS { ntpEntStatusTime, ntpEntStatusStratum, ntpEntNotifMessage } STATUS current DESCRIPTION "The notification to be sent when stratum level of NTP changes." ::= { ntpEntNotifications 4 } ntpEntNotifSyspeerChanged NOTIFICATION-TYPE OBJECTS { ntpEntStatusTime, ntpEntStatusActiveRefSourceId, ntpEntNotifMessage } STATUS current DESCRIPTION "The notification to be sent when a (new) syspeer has been selected." ::= { ntpEntNotifications 5 } ntpEntNotifAddAssociation NOTIFICATION-TYPE OBJECTS { ntpEntStatusTime, ntpAssocName, ntpEntNotifMessage } STATUS current DESCRIPTION "The notification to be sent when a new association is mobilized." ::= { ntpEntNotifications 6 } ntpEntNotifRemoveAssociation NOTIFICATION-TYPE OBJECTS { ntpEntStatusTime, ntpAssocName, ntpEntNotifMessage } STATUS current DESCRIPTION "The notification to be sent when an association is demobilized." ::= { ntpEntNotifications 7 } ntpEntNotifConfigChanged NOTIFICATION-TYPE OBJECTS { ntpEntStatusTime, ntpEntNotifMessage } STATUS current DESCRIPTION "The notification to be sent when the NTP configuration has changed." -- e.g. when the system connected to the internet and was assigned -- a new IP address by the ISPs DHCP server ::= { ntpEntNotifications 8 } ntpEntNotifLeapSecondAnnounced NOTIFICATION-TYPE OBJECTS { ntpEntStatusTime, ntpEntNotifMessage } STATUS current DESCRIPTION "The notification to be sent when a leap second has been announced." ::= { ntpEntNotifications 9 } ntpEntNotifHeartbeat NOTIFICATION-TYPE OBJECTS { ntpEntStatusTime, ntpEntStatusCurrentModeVal, ntpEntHeartbeatInterval, ntpEntNotifMessage } STATUS current DESCRIPTION "The notification to be sent periodically (as defined by ntpEntHeartbeatInterval) to indicate that the NTP entity is still alive." ::= { ntpEntNotifications 10 } -- -- Conformance/Compliance statements -- ntpEntConformance OBJECT IDENTIFIER ::= { ntpSnmpMIB 6 } ntpEntCompliances OBJECT IDENTIFIER ::= { ntpEntConformance 1 } ntpEntGroups OBJECT IDENTIFIER ::= { ntpEntConformance 2 } ntpEntCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SNMP entities which implement the NTP MIB" MODULE -- this module MANDATORY-GROUPS { ntpEntObjectsGroup, ntpEntNotifPrefixGroup } ::= { ntpEntCompliances 1 } ntpEntObjectsGroup OBJECT-GROUP OBJECTS { ntpEntSoftwareName, ntpEntSoftwareVersion, ntpEntSoftwareVersionVal, ntpEntSoftwareVendor, ntpEntSystemType, ntpEntTimeResolution, ntpEntTimeResolutionVal, ntpEntTimePrecision, ntpEntTimePrecisionVal, ntpEntTimeDistance, ntpEntStatusCurrentMode, ntpEntStatusCurrentModeVal, ntpEntStatusStratum, ntpEntStatusActiveRefSourceId, ntpEntStatusActiveRefSourceName, ntpEntStatusActiveOffset, ntpEntStatusNumberOfRefSources, ntpEntStatusDispersion, ntpEntStatusEntityUptime, ntpEntStatusTime, ntpEntStatusLeapSecond, ntpEntStatusLeapSecDirection, ntpAssocName, ntpAssocRefId, ntpAssocAddressType, ntpAssocAddress, ntpAssocOffset, ntpAssocStratum, ntpAssocStatusJitter, ntpAssocStatusDelay, ntpAssocStatusDispersion, ntpEntHeartbeatInterval, ntpEntNotifBits, ntpEntNotifMessage } STATUS current DESCRIPTION "The collection of objects for the NTP MIB" ::= { ntpEntGroups 1 } ntpEntNotifPrefixGroup NOTIFICATION-GROUP NOTIFICATIONS { ntpEntNotifNotInSync, ntpEntNotifEntityStarted, ntpEntNotifEntityStopped, ntpEntNotifStratumChange, ntpEntNotifSyspeerChanged, ntpEntNotifAddAssociation, ntpEntNotifRemoveAssociation, ntpEntNotifConfigChanged, ntpEntNotifLeapSecondAnnounced, ntpEntNotifHeartbeat } STATUS current DESCRIPTION "The collection of notifications for the NTP MIB" ::= { ntpEntGroups 2 } END -- -- Copyright (C) The IETF Trust (2007). -- -- This document is subject to the rights, licenses and restrictions -- contained in BCP 78, and except as set forth therein, the authors -- retain all their rights. -- -- This document and the information contained herein are provided on an -- "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS -- OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND -- THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF -- THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED -- WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. -- -- -- Intellectual Property -- -- The IETF takes no position regarding the validity or scope of any -- Intellectual Property Rights or other rights that might be claimed to -- pertain to the implementation or use of the technology described in -- this document or the extent to which any license under such rights -- might or might not be available; nor does it represent that it has -- made any independent effort to identify any such rights. Information -- on the procedures with respect to rights in RFC documents can be -- found in BCP 78 and BCP 79. -- -- Copies of IPR disclosures made to the IETF Secretariat and any -- assurances of licenses to be made available, or the result of an -- attempt made to obtain a general license or permission for the use of -- such proprietary rights by implementers or users of this -- specification can be obtained from the IETF on-line IPR repository at -- http://www.ietf.org/ipr. -- -- The IETF invites any interested party to bring to its attention any -- copyrights, patents or patent applications, or other proprietary -- rights that may cover technology that may be required to implement -- this standard. Please address the information to the IETF at -- ietf-ipr@ietf.org. -- -- -- Acknowledgment -- -- Funding for the RFC Editor function is provided by the IETF -- Administrative Support Activity (IASA).