Blame mibs/ietf/ENTITY-SENSOR-MIB

Packit 022b05
ENTITY-SENSOR-MIB DEFINITIONS ::= BEGIN
Packit 022b05
Packit 022b05
IMPORTS
Packit 022b05
        MODULE-IDENTITY, OBJECT-TYPE,
Packit 022b05
        Integer32, Unsigned32, mib-2
Packit 022b05
                FROM SNMPv2-SMI
Packit 022b05
        MODULE-COMPLIANCE, OBJECT-GROUP
Packit 022b05
                FROM SNMPv2-CONF
Packit 022b05
        TEXTUAL-CONVENTION, TimeStamp
Packit 022b05
                FROM SNMPv2-TC
Packit 022b05
        entPhysicalIndex, entityPhysicalGroup
Packit 022b05
                FROM ENTITY-MIB
Packit 022b05
        SnmpAdminString
Packit 022b05
                FROM SNMP-FRAMEWORK-MIB;
Packit 022b05
Packit 022b05
entitySensorMIB MODULE-IDENTITY
Packit 022b05
    LAST-UPDATED    "200212160000Z"
Packit 022b05
    ORGANIZATION    "IETF Entity MIB Working Group"
Packit 022b05
    CONTACT-INFO
Packit 022b05
            "        Andy Bierman
Packit 022b05
                     Cisco Systems, Inc.
Packit 022b05
                Tel: +1 408-527-3711
Packit 022b05
             E-mail: abierman@cisco.com
Packit 022b05
             Postal: 170 West Tasman Drive
Packit 022b05
                     San Jose, CA USA 95134
Packit 022b05
Packit 022b05
                     Dan Romascanu
Packit 022b05
                     Avaya Inc.
Packit 022b05
                Tel: +972-3-645-8414
Packit 022b05
              Email: dromasca@avaya.com
Packit 022b05
             Postal: Atidim technology Park, Bldg. #3
Packit 022b05
                     Tel Aviv, Israel, 61131
Packit 022b05
Packit 022b05
                     K.C. Norseth
Packit 022b05
                     L-3 Communications
Packit 022b05
                Tel: +1 801-594-2809
Packit 022b05
              Email: kenyon.c.norseth@L-3com.com
Packit 022b05
             Postal: 640 N. 2200 West.
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
                     Salt Lake City, Utah 84116-0850
Packit 022b05
Packit 022b05
             Send comments to <entmib@ietf.org>
Packit 022b05
             Mailing list subscription info:
Packit 022b05
               http://www.ietf.org/mailman/listinfo/entmib "
Packit 022b05
    DESCRIPTION
Packit 022b05
            "This module defines Entity MIB extensions for physical
Packit 022b05
             sensors.
Packit 022b05
Packit 022b05
             Copyright (C) The Internet Society (2002). This version
Packit 022b05
             of this MIB module is part of RFC 3433; see the RFC
Packit 022b05
             itself for full legal notices."
Packit 022b05
Packit 022b05
    REVISION        "200212160000Z"
Packit 022b05
    DESCRIPTION
Packit 022b05
            "Initial version of the Entity Sensor MIB module, published
Packit 022b05
             as RFC 3433."
Packit 022b05
    ::= { mib-2 99 }
Packit 022b05
Packit 022b05
entitySensorObjects              OBJECT IDENTIFIER
Packit 022b05
     ::= { entitySensorMIB 1 }
Packit 022b05
Packit 022b05
-- entitySensorNotifications        OBJECT IDENTIFIER
Packit 022b05
--     ::= { entitySensorMIB 2 }
Packit 022b05
entitySensorConformance          OBJECT IDENTIFIER
Packit 022b05
     ::= { entitySensorMIB 3 }
Packit 022b05
Packit 022b05
--
Packit 022b05
-- Textual Conventions
Packit 022b05
--
Packit 022b05
Packit 022b05
EntitySensorDataType ::= TEXTUAL-CONVENTION
Packit 022b05
    STATUS       current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "An object using this data type represents the Entity Sensor
Packit 022b05
            measurement data type associated with a physical sensor
Packit 022b05
            value. The actual data units are determined by examining an
Packit 022b05
            object of this type together with the associated
Packit 022b05
            EntitySensorDataScale object.
Packit 022b05
Packit 022b05
            An object of this type SHOULD be defined together with
Packit 022b05
            objects of type EntitySensorDataScale and
Packit 022b05
            EntitySensorPrecision.  Together, associated objects of
Packit 022b05
            these three types are used to identify the semantics of an
Packit 022b05
            object of type EntitySensorValue.
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
            Valid values are:
Packit 022b05
Packit 022b05
               other(1):        a measure other than those listed below
Packit 022b05
               unknown(2):      unknown measurement, or arbitrary,
Packit 022b05
                                relative numbers
Packit 022b05
               voltsAC(3):      electric potential
Packit 022b05
               voltsDC(4):      electric potential
Packit 022b05
               amperes(5):      electric current
Packit 022b05
               watts(6):        power
Packit 022b05
               hertz(7):        frequency
Packit 022b05
               celsius(8):      temperature
Packit 022b05
               percentRH(9):    percent relative humidity
Packit 022b05
               rpm(10):         shaft revolutions per minute
Packit 022b05
               cmm(11),:        cubic meters per minute (airflow)
Packit 022b05
               truthvalue(12):  value takes { true(1), false(2) }
Packit 022b05
Packit 022b05
            "
Packit 022b05
    SYNTAX INTEGER {
Packit 022b05
        other(1),
Packit 022b05
        unknown(2),
Packit 022b05
        voltsAC(3),
Packit 022b05
        voltsDC(4),
Packit 022b05
        amperes(5),
Packit 022b05
        watts(6),
Packit 022b05
        hertz(7),
Packit 022b05
        celsius(8),
Packit 022b05
        percentRH(9),
Packit 022b05
        rpm(10),
Packit 022b05
        cmm(11),
Packit 022b05
        truthvalue(12)
Packit 022b05
    }
Packit 022b05
Packit 022b05
EntitySensorDataScale ::= TEXTUAL-CONVENTION
Packit 022b05
    STATUS       current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "An object using this data type represents a data scaling
Packit 022b05
            factor, represented with an International System of Units
Packit 022b05
            (SI) prefix.  The actual data units are determined by
Packit 022b05
            examining an object of this type together with the
Packit 022b05
            associated EntitySensorDataType object.
Packit 022b05
Packit 022b05
            An object of this type SHOULD be defined together with
Packit 022b05
            objects of type EntitySensorDataType and
Packit 022b05
            EntitySensorPrecision.  Together, associated objects of
Packit 022b05
            these three types are used to identify the semantics of an
Packit 022b05
            object of type EntitySensorValue."
Packit 022b05
    REFERENCE
Packit 022b05
            "The International System of Units (SI),
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
            National Institute of Standards and Technology,
Packit 022b05
            Spec. Publ. 330, August 1991."
Packit 022b05
    SYNTAX INTEGER {
Packit 022b05
        yocto(1),   -- 10^-24
Packit 022b05
        zepto(2),   -- 10^-21
Packit 022b05
        atto(3),    -- 10^-18
Packit 022b05
        femto(4),   -- 10^-15
Packit 022b05
        pico(5),    -- 10^-12
Packit 022b05
        nano(6),    -- 10^-9
Packit 022b05
        micro(7),   -- 10^-6
Packit 022b05
        milli(8),   -- 10^-3
Packit 022b05
        units(9),   -- 10^0
Packit 022b05
        kilo(10),   -- 10^3
Packit 022b05
        mega(11),   -- 10^6
Packit 022b05
        giga(12),   -- 10^9
Packit 022b05
        tera(13),   -- 10^12
Packit 022b05
        exa(14),    -- 10^15
Packit 022b05
        peta(15),   -- 10^18
Packit 022b05
        zetta(16),  -- 10^21
Packit 022b05
        yotta(17)   -- 10^24
Packit 022b05
    }
Packit 022b05
Packit 022b05
EntitySensorPrecision ::= TEXTUAL-CONVENTION
Packit 022b05
    STATUS       current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "An object using this data type represents a sensor
Packit 022b05
            precision range.
Packit 022b05
Packit 022b05
            An object of this type SHOULD be defined together with
Packit 022b05
            objects of type EntitySensorDataType and
Packit 022b05
            EntitySensorDataScale.  Together, associated objects of
Packit 022b05
            these three types are used to identify the semantics of an
Packit 022b05
            object of type EntitySensorValue.
Packit 022b05
Packit 022b05
            If an object of this type contains a value in the range 1 to
Packit 022b05
            9, it represents the number of decimal places in the
Packit 022b05
            fractional part of an associated EntitySensorValue fixed-
Packit 022b05
            point number.
Packit 022b05
Packit 022b05
            If an object of this type contains a value in the range -8
Packit 022b05
            to -1, it represents the number of accurate digits in the
Packit 022b05
            associated EntitySensorValue fixed-point number.
Packit 022b05
Packit 022b05
            The value zero indicates the associated EntitySensorValue
Packit 022b05
            object is not a fixed-point number.
Packit 022b05
Packit 022b05
            Agent implementors must choose a value for the associated
Packit 022b05
            EntitySensorPrecision object so that the precision and
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
            accuracy of the associated EntitySensorValue object is
Packit 022b05
            correctly indicated.
Packit 022b05
Packit 022b05
            For example, a physical entity representing a temperature
Packit 022b05
            sensor that can measure 0 degrees to 100 degrees C in 0.1
Packit 022b05
            degree increments, +/- 0.05 degrees, would have an
Packit 022b05
            EntitySensorPrecision value of '1', an EntitySensorDataScale
Packit 022b05
            value of 'units(9)', and an EntitySensorValue ranging from
Packit 022b05
            '0' to '1000'.  The EntitySensorValue would be interpreted
Packit 022b05
            as 'degrees C * 10'."
Packit 022b05
    SYNTAX Integer32 (-8..9)
Packit 022b05
Packit 022b05
EntitySensorValue ::= TEXTUAL-CONVENTION
Packit 022b05
    STATUS       current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "An object using this data type represents an Entity Sensor
Packit 022b05
            value.
Packit 022b05
            An object of this type SHOULD be defined together with
Packit 022b05
            objects of type EntitySensorDataType, EntitySensorDataScale
Packit 022b05
            and EntitySensorPrecision.  Together, associated objects of
Packit 022b05
            those three types are used to identify the semantics of an
Packit 022b05
            object of this data type.
Packit 022b05
Packit 022b05
            The semantics of an object using this data type are
Packit 022b05
            determined by the value of the associated
Packit 022b05
            EntitySensorDataType object.
Packit 022b05
Packit 022b05
            If the associated EntitySensorDataType object is equal to
Packit 022b05
            'voltsAC(3)', 'voltsDC(4)', 'amperes(5)', 'watts(6),
Packit 022b05
            'hertz(7)', 'celsius(8)', or 'cmm(11)', then an object of
Packit 022b05
            this type MUST contain a fixed point number ranging from
Packit 022b05
            -999,999,999 to +999,999,999.  The value -1000000000
Packit 022b05
            indicates an underflow error. The value +1000000000
Packit 022b05
            indicates an overflow error.  The EntitySensorPrecision
Packit 022b05
            indicates how many fractional digits are represented in the
Packit 022b05
            associated EntitySensorValue object.
Packit 022b05
Packit 022b05
            If the associated EntitySensorDataType object is equal to
Packit 022b05
            'percentRH(9)', then an object of this type MUST contain a
Packit 022b05
            number ranging from 0 to 100.
Packit 022b05
Packit 022b05
            If the associated EntitySensorDataType object is equal to
Packit 022b05
            'rpm(10)', then an object of this type MUST contain a number
Packit 022b05
            ranging from -999,999,999 to +999,999,999.
Packit 022b05
Packit 022b05
            If the associated EntitySensorDataType object is equal to
Packit 022b05
            'truthvalue(12)', then an object of this type MUST contain
Packit 022b05
            either the value 'true(1)' or the value 'false(2)'.
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
            If the associated EntitySensorDataType object is equal to
Packit 022b05
            'other(1)' or unknown(2)', then an object of this type MUST
Packit 022b05
            contain a number ranging from -1000000000 to 1000000000."
Packit 022b05
    SYNTAX Integer32 (-1000000000..1000000000)
Packit 022b05
Packit 022b05
EntitySensorStatus ::= TEXTUAL-CONVENTION
Packit 022b05
    STATUS       current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "An object using this data type represents the operational
Packit 022b05
            status of a physical sensor.
Packit 022b05
Packit 022b05
            The value 'ok(1)' indicates that the agent can obtain the
Packit 022b05
            sensor value.
Packit 022b05
Packit 022b05
            The value 'unavailable(2)' indicates that the agent
Packit 022b05
            presently cannot obtain the sensor value.
Packit 022b05
Packit 022b05
            The value 'nonoperational(3)' indicates that the agent
Packit 022b05
            believes the sensor is broken.  The sensor could have a hard
Packit 022b05
            failure (disconnected wire), or a soft failure such as out-
Packit 022b05
            of-range, jittery, or wildly fluctuating readings."
Packit 022b05
    SYNTAX INTEGER {
Packit 022b05
        ok(1),
Packit 022b05
        unavailable(2),
Packit 022b05
        nonoperational(3)
Packit 022b05
    }
Packit 022b05
Packit 022b05
--
Packit 022b05
-- Entity Sensor Table
Packit 022b05
--
Packit 022b05
Packit 022b05
entPhySensorTable OBJECT-TYPE
Packit 022b05
    SYNTAX        SEQUENCE OF EntPhySensorEntry
Packit 022b05
    MAX-ACCESS    not-accessible
Packit 022b05
    STATUS        current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "This table contains one row per physical sensor represented
Packit 022b05
            by an associated row in the entPhysicalTable."
Packit 022b05
    ::= { entitySensorObjects 1 }
Packit 022b05
Packit 022b05
entPhySensorEntry OBJECT-TYPE
Packit 022b05
    SYNTAX        EntPhySensorEntry
Packit 022b05
    MAX-ACCESS    not-accessible
Packit 022b05
    STATUS        current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "Information about a particular physical sensor.
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
            An entry in this table describes the present reading of a
Packit 022b05
            sensor, the measurement units and scale, and sensor
Packit 022b05
            operational status.
Packit 022b05
Packit 022b05
            Entries are created in this table by the agent.  An entry
Packit 022b05
            for each physical sensor SHOULD be created at the same time
Packit 022b05
            as the associated entPhysicalEntry.  An entry SHOULD be
Packit 022b05
            destroyed if the associated entPhysicalEntry is destroyed."
Packit 022b05
    INDEX  { entPhysicalIndex }    -- SPARSE-AUGMENTS
Packit 022b05
    ::= { entPhySensorTable 1 }
Packit 022b05
Packit 022b05
EntPhySensorEntry ::= SEQUENCE {
Packit 022b05
        entPhySensorType            EntitySensorDataType,
Packit 022b05
        entPhySensorScale           EntitySensorDataScale,
Packit 022b05
        entPhySensorPrecision       EntitySensorPrecision,
Packit 022b05
        entPhySensorValue           EntitySensorValue,
Packit 022b05
        entPhySensorOperStatus      EntitySensorStatus,
Packit 022b05
        entPhySensorUnitsDisplay    SnmpAdminString,
Packit 022b05
        entPhySensorValueTimeStamp  TimeStamp,
Packit 022b05
        entPhySensorValueUpdateRate Unsigned32
Packit 022b05
}
Packit 022b05
Packit 022b05
entPhySensorType OBJECT-TYPE
Packit 022b05
    SYNTAX        EntitySensorDataType
Packit 022b05
    MAX-ACCESS    read-only
Packit 022b05
    STATUS        current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "The type of data returned by the associated
Packit 022b05
            entPhySensorValue object.
Packit 022b05
Packit 022b05
            This object SHOULD be set by the agent during entry
Packit 022b05
            creation, and the value SHOULD NOT change during operation."
Packit 022b05
    ::= { entPhySensorEntry 1 }
Packit 022b05
Packit 022b05
entPhySensorScale OBJECT-TYPE
Packit 022b05
    SYNTAX        EntitySensorDataScale
Packit 022b05
    MAX-ACCESS    read-only
Packit 022b05
    STATUS        current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "The exponent to apply to values returned by the associated
Packit 022b05
            entPhySensorValue object.
Packit 022b05
Packit 022b05
            This object SHOULD be set by the agent during entry
Packit 022b05
            creation, and the value SHOULD NOT change during operation."
Packit 022b05
    ::= { entPhySensorEntry 2 }
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
entPhySensorPrecision OBJECT-TYPE
Packit 022b05
    SYNTAX        EntitySensorPrecision
Packit 022b05
    MAX-ACCESS    read-only
Packit 022b05
    STATUS        current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "The number of decimal places of precision in fixed-point
Packit 022b05
            sensor values returned by the associated entPhySensorValue
Packit 022b05
            object.
Packit 022b05
Packit 022b05
            This object SHOULD be set to '0' when the associated
Packit 022b05
            entPhySensorType value is not a fixed-point type: e.g.,
Packit 022b05
            'percentRH(9)', 'rpm(10)', 'cmm(11)', or 'truthvalue(12)'.
Packit 022b05
Packit 022b05
            This object SHOULD be set by the agent during entry
Packit 022b05
            creation, and the value SHOULD NOT change during operation."
Packit 022b05
    ::= { entPhySensorEntry 3 }
Packit 022b05
Packit 022b05
entPhySensorValue OBJECT-TYPE
Packit 022b05
    SYNTAX        EntitySensorValue
Packit 022b05
    MAX-ACCESS    read-only
Packit 022b05
    STATUS        current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "The most recent measurement obtained by the agent for this
Packit 022b05
            sensor.
Packit 022b05
Packit 022b05
            To correctly interpret the value of this object, the
Packit 022b05
            associated entPhySensorType, entPhySensorScale, and
Packit 022b05
            entPhySensorPrecision objects must also be examined."
Packit 022b05
    ::= { entPhySensorEntry 4 }
Packit 022b05
Packit 022b05
entPhySensorOperStatus OBJECT-TYPE
Packit 022b05
    SYNTAX        EntitySensorStatus
Packit 022b05
    MAX-ACCESS    read-only
Packit 022b05
    STATUS        current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "The operational status of the sensor."
Packit 022b05
    ::= { entPhySensorEntry 5 }
Packit 022b05
Packit 022b05
entPhySensorUnitsDisplay OBJECT-TYPE
Packit 022b05
    SYNTAX      SnmpAdminString
Packit 022b05
    MAX-ACCESS  read-only
Packit 022b05
    STATUS      current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "A textual description of the data units that should be used
Packit 022b05
            in the display of entPhySensorValue."
Packit 022b05
    ::= { entPhySensorEntry 6 }
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
entPhySensorValueTimeStamp OBJECT-TYPE
Packit 022b05
    SYNTAX        TimeStamp
Packit 022b05
    MAX-ACCESS    read-only
Packit 022b05
    STATUS        current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "The value of sysUpTime at the time the status and/or value
Packit 022b05
            of this sensor was last obtained by the agent."
Packit 022b05
    ::= { entPhySensorEntry 7 }
Packit 022b05
Packit 022b05
entPhySensorValueUpdateRate  OBJECT-TYPE
Packit 022b05
    SYNTAX        Unsigned32
Packit 022b05
    UNITS         "milliseconds"
Packit 022b05
    MAX-ACCESS    read-only
Packit 022b05
    STATUS        current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "An indication of the frequency that the agent updates the
Packit 022b05
            associated entPhySensorValue object, representing in
Packit 022b05
            milliseconds.
Packit 022b05
Packit 022b05
            The value zero indicates:
Packit 022b05
Packit 022b05
                - the sensor value is updated on demand (e.g.,
Packit 022b05
                  when polled by the agent for a get-request),
Packit 022b05
                - the sensor value is updated when the sensor
Packit 022b05
                  value changes (event-driven),
Packit 022b05
                - the agent does not know the update rate.
Packit 022b05
Packit 022b05
            "
Packit 022b05
    ::= { entPhySensorEntry 8 }
Packit 022b05
Packit 022b05
--
Packit 022b05
-- Conformance Section
Packit 022b05
--
Packit 022b05
Packit 022b05
entitySensorCompliances OBJECT IDENTIFIER
Packit 022b05
    ::= { entitySensorConformance 1 }
Packit 022b05
entitySensorGroups      OBJECT IDENTIFIER
Packit 022b05
    ::= { entitySensorConformance 2 }
Packit 022b05
Packit 022b05
entitySensorCompliance MODULE-COMPLIANCE
Packit 022b05
    STATUS  current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "Describes the requirements for conformance to the Entity
Packit 022b05
            Sensor MIB module."
Packit 022b05
    MODULE  -- this module
Packit 022b05
        MANDATORY-GROUPS { entitySensorValueGroup }
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
    MODULE ENTITY-MIB
Packit 022b05
        MANDATORY-GROUPS { entityPhysicalGroup }
Packit 022b05
Packit 022b05
    ::= { entitySensorCompliances 1 }
Packit 022b05
Packit 022b05
-- Object Groups
Packit 022b05
Packit 022b05
entitySensorValueGroup OBJECT-GROUP
Packit 022b05
    OBJECTS {
Packit 022b05
             entPhySensorType,
Packit 022b05
             entPhySensorScale,
Packit 022b05
             entPhySensorPrecision,
Packit 022b05
             entPhySensorValue,
Packit 022b05
             entPhySensorOperStatus,
Packit 022b05
             entPhySensorUnitsDisplay,
Packit 022b05
             entPhySensorValueTimeStamp,
Packit 022b05
             entPhySensorValueUpdateRate
Packit 022b05
    }
Packit 022b05
    STATUS  current
Packit 022b05
    DESCRIPTION
Packit 022b05
            "A collection of objects representing physical entity sensor
Packit 022b05
            information."
Packit 022b05
    ::= { entitySensorGroups 1 }
Packit 022b05
Packit 022b05
END