mibs/ietf/ENTITY-SENSOR-MIB

   1 ENTITY-SENSOR-MIB DEFINITIONS ::= BEGIN
   2
   3 IMPORTS
   4         MODULE-IDENTITY, OBJECT-TYPE,
   5         Integer32, Unsigned32, mib-2
   6                 FROM SNMPv2-SMI
   7         MODULE-COMPLIANCE, OBJECT-GROUP
   8                 FROM SNMPv2-CONF
   9         TEXTUAL-CONVENTION, TimeStamp
  10                 FROM SNMPv2-TC
  11         entPhysicalIndex, entityPhysicalGroup
  12                 FROM ENTITY-MIB
  13         SnmpAdminString
  14                 FROM SNMP-FRAMEWORK-MIB;
  15
  16 entitySensorMIB MODULE-IDENTITY
  17     LAST-UPDATED    "200212160000Z"
  18     ORGANIZATION    "IETF Entity MIB Working Group"
  19     CONTACT-INFO
  20             "        Andy Bierman
  21                      Cisco Systems, Inc.
  22                 Tel: +1 408-527-3711
  23              E-mail: abierman@cisco.com
  24              Postal: 170 West Tasman Drive
  25                      San Jose, CA USA 95134
  26
  27                      Dan Romascanu
  28                      Avaya Inc.
  29                 Tel: +972-3-645-8414
  30               Email: dromasca@avaya.com
  31              Postal: Atidim technology Park, Bldg. #3
  32                      Tel Aviv, Israel, 61131
  33
  34                      K.C. Norseth
  35                      L-3 Communications
  36                 Tel: +1 801-594-2809
  37               Email: kenyon.c.norseth@L-3com.com
  38              Postal: 640 N. 2200 West.
  39
  40
  41
  42                      Salt Lake City, Utah 84116-0850
  43
  44              Send comments to <entmib@ietf.org>
  45              Mailing list subscription info:
  46                http://www.ietf.org/mailman/listinfo/entmib "
  47     DESCRIPTION
  48             "This module defines Entity MIB extensions for physical
  49              sensors.
  50
  51              Copyright (C) The Internet Society (2002). This version
  52              of this MIB module is part of RFC 3433; see the RFC
  53              itself for full legal notices."
  54
  55     REVISION        "200212160000Z"
  56     DESCRIPTION
  57             "Initial version of the Entity Sensor MIB module, published
  58              as RFC 3433."
  59     ::= { mib-2 99 }
  60
  61 entitySensorObjects              OBJECT IDENTIFIER
  62      ::= { entitySensorMIB 1 }
  63
  64 -- entitySensorNotifications        OBJECT IDENTIFIER
  65 --     ::= { entitySensorMIB 2 }
  66 entitySensorConformance          OBJECT IDENTIFIER
  67      ::= { entitySensorMIB 3 }
  68
  69 --
  70 -- Textual Conventions
  71 --
  72
  73 EntitySensorDataType ::= TEXTUAL-CONVENTION
  74     STATUS       current
  75     DESCRIPTION
  76             "An object using this data type represents the Entity Sensor
  77             measurement data type associated with a physical sensor
  78             value. The actual data units are determined by examining an
  79             object of this type together with the associated
  80             EntitySensorDataScale object.
  81
  82             An object of this type SHOULD be defined together with
  83             objects of type EntitySensorDataScale and
  84             EntitySensorPrecision.  Together, associated objects of
  85             these three types are used to identify the semantics of an
  86             object of type EntitySensorValue.
  87
  88
  89
  90
  91
  92
  93             Valid values are:
  94
  95                other(1):        a measure other than those listed below
  96                unknown(2):      unknown measurement, or arbitrary,
  97                                 relative numbers
  98                voltsAC(3):      electric potential
  99                voltsDC(4):      electric potential
 100                amperes(5):      electric current
 101                watts(6):        power
 102                hertz(7):        frequency
 103                celsius(8):      temperature
 104                percentRH(9):    percent relative humidity
 105                rpm(10):         shaft revolutions per minute
 106                cmm(11),:        cubic meters per minute (airflow)
 107                truthvalue(12):  value takes { true(1), false(2) }
 108
 109             "
 110     SYNTAX INTEGER {
 111         other(1),
 112         unknown(2),
 113         voltsAC(3),
 114         voltsDC(4),
 115         amperes(5),
 116         watts(6),
 117         hertz(7),
 118         celsius(8),
 119         percentRH(9),
 120         rpm(10),
 121         cmm(11),
 122         truthvalue(12)
 123     }
 124
 125 EntitySensorDataScale ::= TEXTUAL-CONVENTION
 126     STATUS       current
 127     DESCRIPTION
 128             "An object using this data type represents a data scaling
 129             factor, represented with an International System of Units
 130             (SI) prefix.  The actual data units are determined by
 131             examining an object of this type together with the
 132             associated EntitySensorDataType object.
 133
 134             An object of this type SHOULD be defined together with
 135             objects of type EntitySensorDataType and
 136             EntitySensorPrecision.  Together, associated objects of
 137             these three types are used to identify the semantics of an
 138             object of type EntitySensorValue."
 139     REFERENCE
 140             "The International System of Units (SI),
 141
 142
 143
 144             National Institute of Standards and Technology,
 145             Spec. Publ. 330, August 1991."
 146     SYNTAX INTEGER {
 147         yocto(1),   -- 10^-24
 148         zepto(2),   -- 10^-21
 149         atto(3),    -- 10^-18
 150         femto(4),   -- 10^-15
 151         pico(5),    -- 10^-12
 152         nano(6),    -- 10^-9
 153         micro(7),   -- 10^-6
 154         milli(8),   -- 10^-3
 155         units(9),   -- 10^0
 156         kilo(10),   -- 10^3
 157         mega(11),   -- 10^6
 158         giga(12),   -- 10^9
 159         tera(13),   -- 10^12
 160         exa(14),    -- 10^15
 161         peta(15),   -- 10^18
 162         zetta(16),  -- 10^21
 163         yotta(17)   -- 10^24
 164     }
 165
 166 EntitySensorPrecision ::= TEXTUAL-CONVENTION
 167     STATUS       current
 168     DESCRIPTION
 169             "An object using this data type represents a sensor
 170             precision range.
 171
 172             An object of this type SHOULD be defined together with
 173             objects of type EntitySensorDataType and
 174             EntitySensorDataScale.  Together, associated objects of
 175             these three types are used to identify the semantics of an
 176             object of type EntitySensorValue.
 177
 178             If an object of this type contains a value in the range 1 to
 179             9, it represents the number of decimal places in the
 180             fractional part of an associated EntitySensorValue fixed-
 181             point number.
 182
 183             If an object of this type contains a value in the range -8
 184             to -1, it represents the number of accurate digits in the
 185             associated EntitySensorValue fixed-point number.
 186
 187             The value zero indicates the associated EntitySensorValue
 188             object is not a fixed-point number.
 189
 190             Agent implementors must choose a value for the associated
 191             EntitySensorPrecision object so that the precision and
 192
 193
 194
 195             accuracy of the associated EntitySensorValue object is
 196             correctly indicated.
 197
 198             For example, a physical entity representing a temperature
 199             sensor that can measure 0 degrees to 100 degrees C in 0.1
 200             degree increments, +/- 0.05 degrees, would have an
 201             EntitySensorPrecision value of '1', an EntitySensorDataScale
 202             value of 'units(9)', and an EntitySensorValue ranging from
 203             '0' to '1000'.  The EntitySensorValue would be interpreted
 204             as 'degrees C * 10'."
 205     SYNTAX Integer32 (-8..9)
 206
 207 EntitySensorValue ::= TEXTUAL-CONVENTION
 208     STATUS       current
 209     DESCRIPTION
 210             "An object using this data type represents an Entity Sensor
 211             value.
 212             An object of this type SHOULD be defined together with
 213             objects of type EntitySensorDataType, EntitySensorDataScale
 214             and EntitySensorPrecision.  Together, associated objects of
 215             those three types are used to identify the semantics of an
 216             object of this data type.
 217
 218             The semantics of an object using this data type are
 219             determined by the value of the associated
 220             EntitySensorDataType object.
 221
 222             If the associated EntitySensorDataType object is equal to
 223             'voltsAC(3)', 'voltsDC(4)', 'amperes(5)', 'watts(6),
 224             'hertz(7)', 'celsius(8)', or 'cmm(11)', then an object of
 225             this type MUST contain a fixed point number ranging from
 226             -999,999,999 to +999,999,999.  The value -1000000000
 227             indicates an underflow error. The value +1000000000
 228             indicates an overflow error.  The EntitySensorPrecision
 229             indicates how many fractional digits are represented in the
 230             associated EntitySensorValue object.
 231
 232             If the associated EntitySensorDataType object is equal to
 233             'percentRH(9)', then an object of this type MUST contain a
 234             number ranging from 0 to 100.
 235
 236             If the associated EntitySensorDataType object is equal to
 237             'rpm(10)', then an object of this type MUST contain a number
 238             ranging from -999,999,999 to +999,999,999.
 239
 240             If the associated EntitySensorDataType object is equal to
 241             'truthvalue(12)', then an object of this type MUST contain
 242             either the value 'true(1)' or the value 'false(2)'.
 243
 244
 245
 246             If the associated EntitySensorDataType object is equal to
 247             'other(1)' or unknown(2)', then an object of this type MUST
 248             contain a number ranging from -1000000000 to 1000000000."
 249     SYNTAX Integer32 (-1000000000..1000000000)
 250
 251 EntitySensorStatus ::= TEXTUAL-CONVENTION
 252     STATUS       current
 253     DESCRIPTION
 254             "An object using this data type represents the operational
 255             status of a physical sensor.
 256
 257             The value 'ok(1)' indicates that the agent can obtain the
 258             sensor value.
 259
 260             The value 'unavailable(2)' indicates that the agent
 261             presently cannot obtain the sensor value.
 262
 263             The value 'nonoperational(3)' indicates that the agent
 264             believes the sensor is broken.  The sensor could have a hard
 265             failure (disconnected wire), or a soft failure such as out-
 266             of-range, jittery, or wildly fluctuating readings."
 267     SYNTAX INTEGER {
 268         ok(1),
 269         unavailable(2),
 270         nonoperational(3)
 271     }
 272
 273 --
 274 -- Entity Sensor Table
 275 --
 276
 277 entPhySensorTable OBJECT-TYPE
 278     SYNTAX        SEQUENCE OF EntPhySensorEntry
 279     MAX-ACCESS    not-accessible
 280     STATUS        current
 281     DESCRIPTION
 282             "This table contains one row per physical sensor represented
 283             by an associated row in the entPhysicalTable."
 284     ::= { entitySensorObjects 1 }
 285
 286 entPhySensorEntry OBJECT-TYPE
 287     SYNTAX        EntPhySensorEntry
 288     MAX-ACCESS    not-accessible
 289     STATUS        current
 290     DESCRIPTION
 291             "Information about a particular physical sensor.
 292
 293
 294
 295
 296
 297             An entry in this table describes the present reading of a
 298             sensor, the measurement units and scale, and sensor
 299             operational status.
 300
 301             Entries are created in this table by the agent.  An entry
 302             for each physical sensor SHOULD be created at the same time
 303             as the associated entPhysicalEntry.  An entry SHOULD be
 304             destroyed if the associated entPhysicalEntry is destroyed."
 305     INDEX  { entPhysicalIndex }    -- SPARSE-AUGMENTS
 306     ::= { entPhySensorTable 1 }
 307
 308 EntPhySensorEntry ::= SEQUENCE {
 309         entPhySensorType            EntitySensorDataType,
 310         entPhySensorScale           EntitySensorDataScale,
 311         entPhySensorPrecision       EntitySensorPrecision,
 312         entPhySensorValue           EntitySensorValue,
 313         entPhySensorOperStatus      EntitySensorStatus,
 314         entPhySensorUnitsDisplay    SnmpAdminString,
 315         entPhySensorValueTimeStamp  TimeStamp,
 316         entPhySensorValueUpdateRate Unsigned32
 317 }
 318
 319 entPhySensorType OBJECT-TYPE
 320     SYNTAX        EntitySensorDataType
 321     MAX-ACCESS    read-only
 322     STATUS        current
 323     DESCRIPTION
 324             "The type of data returned by the associated
 325             entPhySensorValue object.
 326
 327             This object SHOULD be set by the agent during entry
 328             creation, and the value SHOULD NOT change during operation."
 329     ::= { entPhySensorEntry 1 }
 330
 331 entPhySensorScale OBJECT-TYPE
 332     SYNTAX        EntitySensorDataScale
 333     MAX-ACCESS    read-only
 334     STATUS        current
 335     DESCRIPTION
 336             "The exponent to apply to values returned by the associated
 337             entPhySensorValue object.
 338
 339             This object SHOULD be set by the agent during entry
 340             creation, and the value SHOULD NOT change during operation."
 341     ::= { entPhySensorEntry 2 }
 342
 343
 344
 345
 346
 347
 348 entPhySensorPrecision OBJECT-TYPE
 349     SYNTAX        EntitySensorPrecision
 350     MAX-ACCESS    read-only
 351     STATUS        current
 352     DESCRIPTION
 353             "The number of decimal places of precision in fixed-point
 354             sensor values returned by the associated entPhySensorValue
 355             object.
 356
 357             This object SHOULD be set to '0' when the associated
 358             entPhySensorType value is not a fixed-point type: e.g.,
 359             'percentRH(9)', 'rpm(10)', 'cmm(11)', or 'truthvalue(12)'.
 360
 361             This object SHOULD be set by the agent during entry
 362             creation, and the value SHOULD NOT change during operation."
 363     ::= { entPhySensorEntry 3 }
 364
 365 entPhySensorValue OBJECT-TYPE
 366     SYNTAX        EntitySensorValue
 367     MAX-ACCESS    read-only
 368     STATUS        current
 369     DESCRIPTION
 370             "The most recent measurement obtained by the agent for this
 371             sensor.
 372
 373             To correctly interpret the value of this object, the
 374             associated entPhySensorType, entPhySensorScale, and
 375             entPhySensorPrecision objects must also be examined."
 376     ::= { entPhySensorEntry 4 }
 377
 378 entPhySensorOperStatus OBJECT-TYPE
 379     SYNTAX        EntitySensorStatus
 380     MAX-ACCESS    read-only
 381     STATUS        current
 382     DESCRIPTION
 383             "The operational status of the sensor."
 384     ::= { entPhySensorEntry 5 }
 385
 386 entPhySensorUnitsDisplay OBJECT-TYPE
 387     SYNTAX      SnmpAdminString
 388     MAX-ACCESS  read-only
 389     STATUS      current
 390     DESCRIPTION
 391             "A textual description of the data units that should be used
 392             in the display of entPhySensorValue."
 393     ::= { entPhySensorEntry 6 }
 394
 395
 396
 397
 398
 399 entPhySensorValueTimeStamp OBJECT-TYPE
 400     SYNTAX        TimeStamp
 401     MAX-ACCESS    read-only
 402     STATUS        current
 403     DESCRIPTION
 404             "The value of sysUpTime at the time the status and/or value
 405             of this sensor was last obtained by the agent."
 406     ::= { entPhySensorEntry 7 }
 407
 408 entPhySensorValueUpdateRate  OBJECT-TYPE
 409     SYNTAX        Unsigned32
 410     UNITS         "milliseconds"
 411     MAX-ACCESS    read-only
 412     STATUS        current
 413     DESCRIPTION
 414             "An indication of the frequency that the agent updates the
 415             associated entPhySensorValue object, representing in
 416             milliseconds.
 417
 418             The value zero indicates:
 419
 420                 - the sensor value is updated on demand (e.g.,
 421                   when polled by the agent for a get-request),
 422                 - the sensor value is updated when the sensor
 423                   value changes (event-driven),
 424                 - the agent does not know the update rate.
 425
 426             "
 427     ::= { entPhySensorEntry 8 }
 428
 429 --
 430 -- Conformance Section
 431 --
 432
 433 entitySensorCompliances OBJECT IDENTIFIER
 434     ::= { entitySensorConformance 1 }
 435 entitySensorGroups      OBJECT IDENTIFIER
 436     ::= { entitySensorConformance 2 }
 437
 438 entitySensorCompliance MODULE-COMPLIANCE
 439     STATUS  current
 440     DESCRIPTION
 441             "Describes the requirements for conformance to the Entity
 442             Sensor MIB module."
 443     MODULE  -- this module
 444         MANDATORY-GROUPS { entitySensorValueGroup }
 445
 446
 447
 448
 449
 450     MODULE ENTITY-MIB
 451         MANDATORY-GROUPS { entityPhysicalGroup }
 452
 453     ::= { entitySensorCompliances 1 }
 454
 455 -- Object Groups
 456
 457 entitySensorValueGroup OBJECT-GROUP
 458     OBJECTS {
 459              entPhySensorType,
 460              entPhySensorScale,
 461              entPhySensorPrecision,
 462              entPhySensorValue,
 463              entPhySensorOperStatus,
 464              entPhySensorUnitsDisplay,
 465              entPhySensorValueTimeStamp,
 466              entPhySensorValueUpdateRate
 467     }
 468     STATUS  current
 469     DESCRIPTION
 470             "A collection of objects representing physical entity sensor
 471             information."
 472     ::= { entitySensorGroups 1 }
 473
 474 END