Blame mibs/ietf/ENTITY-STATE-MIB

Packit 022b05
ENTITY-STATE-MIB DEFINITIONS ::= BEGIN
Packit 022b05
Packit 022b05
  IMPORTS
Packit 022b05
      MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, mib-2
Packit 022b05
          FROM SNMPv2-SMI
Packit 022b05
      DateAndTime
Packit 022b05
          FROM SNMPv2-TC
Packit 022b05
      MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
Packit 022b05
           FROM SNMPv2-CONF
Packit 022b05
      entPhysicalIndex
Packit 022b05
           FROM ENTITY-MIB
Packit 022b05
      EntityAdminState, EntityOperState, EntityUsageState,
Packit 022b05
      EntityAlarmStatus, EntityStandbyStatus
Packit 022b05
           FROM ENTITY-STATE-TC-MIB;
Packit 022b05
Packit 022b05
  entityStateMIB MODULE-IDENTITY
Packit 022b05
      LAST-UPDATED "200511220000Z"
Packit 022b05
      ORGANIZATION "IETF Entity MIB Working Group"
Packit 022b05
Packit 022b05
Packit 022b05
      CONTACT-INFO
Packit 022b05
              " General Discussion: entmib@ietf.org
Packit 022b05
                To Subscribe:
Packit 022b05
                http://www.ietf.org/mailman/listinfo/entmib
Packit 022b05
Packit 022b05
                http://www.ietf.org/html.charters/entmib-charter.html
Packit 022b05
Packit 022b05
                Sharon Chisholm
Packit 022b05
                Nortel Networks
Packit 022b05
                PO Box 3511 Station C
Packit 022b05
                Ottawa, Ont.  K1Y 4H7
Packit 022b05
                Canada
Packit 022b05
                schishol@nortel.com
Packit 022b05
Packit 022b05
                David T. Perkins
Packit 022b05
                548 Qualbrook Ct
Packit 022b05
                San Jose, CA 95110
Packit 022b05
                USA
Packit 022b05
                Phone: 408 394-8702
Packit 022b05
                dperkins@snmpinfo.com
Packit 022b05
               "
Packit 022b05
      DESCRIPTION
Packit 022b05
          "This MIB defines a state extension to the Entity MIB.
Packit 022b05
Packit 022b05
           Copyright (C) The Internet Society 2005.  This version
Packit 022b05
           of this MIB module is part of RFC 4268; see the RFC
Packit 022b05
           itself for full legal notices."
Packit 022b05
      REVISION    "200511220000Z"
Packit 022b05
      DESCRIPTION
Packit 022b05
          "Initial version, published as RFC 4268."
Packit 022b05
      ::= { mib-2 131 }
Packit 022b05
Packit 022b05
Packit 022b05
  -- Entity State Objects
Packit 022b05
Packit 022b05
  entStateObjects OBJECT IDENTIFIER ::= { entityStateMIB 1 }
Packit 022b05
Packit 022b05
  entStateTable OBJECT-TYPE
Packit 022b05
   SYNTAX      SEQUENCE OF EntStateEntry
Packit 022b05
   MAX-ACCESS  not-accessible
Packit 022b05
   STATUS      current
Packit 022b05
   DESCRIPTION
Packit 022b05
       "A table of information about state/status of entities.
Packit 022b05
        This is a sparse augment of the entPhysicalTable.  Entries
Packit 022b05
        appear in this table for values of
Packit 022b05
        entPhysicalClass [RFC4133] that in this implementation
Packit 022b05
        are able to report any of the state or status stored in
Packit 022b05
        this table.
Packit 022b05
Packit 022b05
Packit 022b05
        "
Packit 022b05
   ::= { entStateObjects 1 }
Packit 022b05
Packit 022b05
Packit 022b05
    entStateEntry OBJECT-TYPE
Packit 022b05
       SYNTAX      EntStateEntry
Packit 022b05
       MAX-ACCESS  not-accessible
Packit 022b05
       STATUS      current
Packit 022b05
       DESCRIPTION
Packit 022b05
           "State information about this physical entity."
Packit 022b05
       INDEX       { entPhysicalIndex }
Packit 022b05
       ::= { entStateTable 1 }
Packit 022b05
Packit 022b05
    EntStateEntry ::= SEQUENCE {
Packit 022b05
        entStateLastChanged DateAndTime,
Packit 022b05
        entStateAdmin       EntityAdminState,
Packit 022b05
        entStateOper        EntityOperState,
Packit 022b05
        entStateUsage       EntityUsageState,
Packit 022b05
        entStateAlarm       EntityAlarmStatus,
Packit 022b05
        entStateStandby     EntityStandbyStatus
Packit 022b05
       }
Packit 022b05
Packit 022b05
  entStateLastChanged OBJECT-TYPE
Packit 022b05
   SYNTAX      DateAndTime
Packit 022b05
   MAX-ACCESS  read-only
Packit 022b05
   STATUS      current
Packit 022b05
   DESCRIPTION
Packit 022b05
     "The value of this object is the date and
Packit 022b05
      time when the value of any of entStateAdmin,
Packit 022b05
      entStateOper, entStateUsage, entStateAlarm,
Packit 022b05
      or entStateStandby changed for this entity.
Packit 022b05
Packit 022b05
      If there has been no change since
Packit 022b05
      the last re-initialization of the local system,
Packit 022b05
      this object contains the date and time of
Packit 022b05
      local system initialization.  If there has been
Packit 022b05
      no change since the entity was added to the
Packit 022b05
      local system, this object contains the date and
Packit 022b05
      time of the insertion."
Packit 022b05
   ::= { entStateEntry 1 }
Packit 022b05
Packit 022b05
entStateAdmin OBJECT-TYPE
Packit 022b05
       SYNTAX      EntityAdminState
Packit 022b05
       MAX-ACCESS  read-write
Packit 022b05
       STATUS      current
Packit 022b05
       DESCRIPTION
Packit 022b05
            "The administrative state for this entity.
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
             This object refers to an entities administrative
Packit 022b05
             permission to service both other entities within
Packit 022b05
             its containment hierarchy as well other users of
Packit 022b05
             its services defined by means outside the scope
Packit 022b05
             of this MIB.
Packit 022b05
Packit 022b05
             Setting this object to 'notSupported' will result
Packit 022b05
             in an 'inconsistentValue' error.  For entities that
Packit 022b05
             do not support administrative state, all set
Packit 022b05
             operations will result in an 'inconsistentValue'
Packit 022b05
             error.
Packit 022b05
Packit 022b05
             Some physical entities exhibit only a subset of the
Packit 022b05
             remaining administrative state values.  Some entities
Packit 022b05
             cannot be locked, and hence this object exhibits only
Packit 022b05
             the 'unlocked' state.  Other entities cannot be shutdown
Packit 022b05
             gracefully, and hence this object does not exhibit the
Packit 022b05
             'shuttingDown' state.  A value of 'inconsistentValue'
Packit 022b05
             will be returned if attempts are made to set this
Packit 022b05
             object to values not supported by its administrative
Packit 022b05
             model."
Packit 022b05
       ::= { entStateEntry 2 }
Packit 022b05
Packit 022b05
 entStateOper OBJECT-TYPE
Packit 022b05
       SYNTAX      EntityOperState
Packit 022b05
       MAX-ACCESS  read-only
Packit 022b05
       STATUS      current
Packit 022b05
       DESCRIPTION
Packit 022b05
           "The operational state for this entity.
Packit 022b05
Packit 022b05
            Note that unlike the state model used within the
Packit 022b05
            Interfaces MIB [RFC2863], this object does not follow
Packit 022b05
            the administrative state.  An administrative state of
Packit 022b05
            down does not predict an operational state
Packit 022b05
            of disabled.
Packit 022b05
Packit 022b05
            A value of 'testing' means that entity currently being
Packit 022b05
            tested and cannot therefore report whether it is
Packit 022b05
            operational or not.
Packit 022b05
Packit 022b05
            A value of 'disabled' means that an entity is totally
Packit 022b05
            inoperable and unable to provide service both to entities
Packit 022b05
            within its containment hierarchy, or to other receivers
Packit 022b05
            of its service as defined in ways outside the scope of
Packit 022b05
            this MIB.
Packit 022b05
Packit 022b05
            A value of 'enabled' means that an entity is fully or
Packit 022b05
            partially operable and able to provide service both to
Packit 022b05
Packit 022b05
Packit 022b05
            entities within its containment hierarchy, or to other
Packit 022b05
            receivers of its service as defined in ways outside the
Packit 022b05
            scope of this MIB.
Packit 022b05
Packit 022b05
            Note that some implementations may not be able to
Packit 022b05
            accurately report entStateOper while the
Packit 022b05
            entStateAdmin object has a value other than 'unlocked'.
Packit 022b05
            In these cases, this object MUST have a value
Packit 022b05
            of 'unknown'."
Packit 022b05
       ::= { entStateEntry 3 }
Packit 022b05
Packit 022b05
 entStateUsage OBJECT-TYPE
Packit 022b05
       SYNTAX      EntityUsageState
Packit 022b05
       MAX-ACCESS  read-only
Packit 022b05
       STATUS      current
Packit 022b05
       DESCRIPTION
Packit 022b05
           "The usage state for this entity.
Packit 022b05
Packit 022b05
            This object refers to an entity's ability to service more
Packit 022b05
            physical entities in a containment hierarchy.  A value
Packit 022b05
            of 'idle' means this entity is able to contain other
Packit 022b05
            entities but that no other entity is currently
Packit 022b05
            contained within this entity.
Packit 022b05
Packit 022b05
            A value of 'active' means that at least one entity is
Packit 022b05
            contained within this entity, but that it could handle
Packit 022b05
            more.  A value of 'busy' means that the entity is unable
Packit 022b05
            to handle any additional entities being contained in it.
Packit 022b05
Packit 022b05
            Some entities will exhibit only a subset of the
Packit 022b05
            usage state values.  Entities that are unable to ever
Packit 022b05
            service any entities within a containment hierarchy will
Packit 022b05
            always have a usage state of 'busy'.  Some entities will
Packit 022b05
            only ever be able to support one entity within its
Packit 022b05
            containment hierarchy and will therefore only exhibit
Packit 022b05
            values of 'idle' and 'busy'."
Packit 022b05
          ::= { entStateEntry 4 }
Packit 022b05
Packit 022b05
 entStateAlarm OBJECT-TYPE
Packit 022b05
       SYNTAX      EntityAlarmStatus
Packit 022b05
       MAX-ACCESS  read-only
Packit 022b05
       STATUS      current
Packit 022b05
       DESCRIPTION
Packit 022b05
           "The alarm status for this entity.  It does not include
Packit 022b05
            the alarms raised on child components within its
Packit 022b05
            containment hierarchy.
Packit 022b05
Packit 022b05
            A value of 'unknown' means that this entity is
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
            unable to report alarm state.  Note that this differs
Packit 022b05
            from 'indeterminate', which means that alarm state
Packit 022b05
            is supported and there are alarms against this entity,
Packit 022b05
            but the severity of some of the alarms is not known.
Packit 022b05
Packit 022b05
            If no bits are set, then this entity supports reporting
Packit 022b05
            of alarms, but there are currently no active alarms
Packit 022b05
            against this entity."
Packit 022b05
       ::= { entStateEntry 5 }
Packit 022b05
Packit 022b05
entStateStandby OBJECT-TYPE
Packit 022b05
       SYNTAX EntityStandbyStatus
Packit 022b05
       MAX-ACCESS read-only
Packit 022b05
       STATUS current
Packit 022b05
       DESCRIPTION
Packit 022b05
            "The standby status for this entity.
Packit 022b05
Packit 022b05
            Some entities will exhibit only a subset of the
Packit 022b05
            remaining standby state values.  If this entity
Packit 022b05
            cannot operate in a standby role, the value of this
Packit 022b05
            object will always be 'providingService'."
Packit 022b05
  ::= { entStateEntry 6 }
Packit 022b05
Packit 022b05
-- Notifications
Packit 022b05
 entStateNotifications OBJECT IDENTIFIER ::= { entityStateMIB 0 }
Packit 022b05
Packit 022b05
entStateOperEnabled NOTIFICATION-TYPE
Packit 022b05
   OBJECTS { entStateAdmin,
Packit 022b05
             entStateAlarm
Packit 022b05
           }
Packit 022b05
   STATUS             current
Packit 022b05
   DESCRIPTION
Packit 022b05
           "An entStateOperEnabled notification signifies that the
Packit 022b05
            SNMP entity, acting in an agent role, has detected that
Packit 022b05
            the entStateOper object for one of its entities has
Packit 022b05
            transitioned into the 'enabled' state.
Packit 022b05
Packit 022b05
            The entity this notification refers can be identified by
Packit 022b05
            extracting the entPhysicalIndex from one of the
Packit 022b05
            variable bindings.  The entStateAdmin and entStateAlarm
Packit 022b05
            varbinds may be examined to find out additional
Packit 022b05
            information on the administrative state at the time of
Packit 022b05
            the operation state change as well as to find out whether
Packit 022b05
            there were any known alarms against the entity at that
Packit 022b05
            time that may explain why the physical entity has become
Packit 022b05
            operationally disabled."
Packit 022b05
  ::= { entStateNotifications 1 }
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
entStateOperDisabled NOTIFICATION-TYPE
Packit 022b05
   OBJECTS { entStateAdmin,
Packit 022b05
             entStateAlarm }
Packit 022b05
   STATUS             current
Packit 022b05
   DESCRIPTION
Packit 022b05
           "An entStateOperDisabled notification signifies that the
Packit 022b05
            SNMP entity, acting in an agent role, has detected that
Packit 022b05
            the entStateOper object for one of its entities has
Packit 022b05
            transitioned into the 'disabled' state.
Packit 022b05
Packit 022b05
            The entity this notification refers can be identified by
Packit 022b05
            extracting the entPhysicalIndex from one of the
Packit 022b05
            variable bindings.  The entStateAdmin and entStateAlarm
Packit 022b05
            varbinds may be examined to find out additional
Packit 022b05
            information on the administrative state at the time of
Packit 022b05
            the operation state change as well as to find out whether
Packit 022b05
            there were any known alarms against the entity at that
Packit 022b05
            time that may affect the physical entity's
Packit 022b05
            ability to stay operationally enabled."
Packit 022b05
  ::= { entStateNotifications 2 }
Packit 022b05
Packit 022b05
-- Conformance and Compliance
Packit 022b05
Packit 022b05
entStateConformance OBJECT IDENTIFIER ::= { entityStateMIB 2 }
Packit 022b05
Packit 022b05
entStateCompliances OBJECT IDENTIFIER
Packit 022b05
                  ::= { entStateConformance 1 }
Packit 022b05
Packit 022b05
entStateCompliance MODULE-COMPLIANCE
Packit 022b05
      STATUS  current
Packit 022b05
      DESCRIPTION
Packit 022b05
          "The compliance statement for systems supporting
Packit 022b05
          the Entity State MIB."
Packit 022b05
      MODULE -- this module
Packit 022b05
          MANDATORY-GROUPS {
Packit 022b05
           entStateGroup
Packit 022b05
          }
Packit 022b05
      GROUP       entStateNotificationsGroup
Packit 022b05
         DESCRIPTION
Packit 022b05
             "This group is optional."
Packit 022b05
      OBJECT entStateAdmin
Packit 022b05
       MIN-ACCESS  read-only
Packit 022b05
       DESCRIPTION
Packit 022b05
           "Write access is not required."
Packit 022b05
   ::= { entStateCompliances 1 }
Packit 022b05
Packit 022b05
entStateGroups OBJECT IDENTIFIER ::= { entStateConformance 2 }
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
Packit 022b05
entStateGroup OBJECT-GROUP
Packit 022b05
   OBJECTS {
Packit 022b05
           entStateLastChanged,
Packit 022b05
           entStateAdmin,
Packit 022b05
           entStateOper,
Packit 022b05
           entStateUsage,
Packit 022b05
           entStateAlarm,
Packit 022b05
           entStateStandby
Packit 022b05
           }
Packit 022b05
    STATUS   current
Packit 022b05
    DESCRIPTION
Packit 022b05
         "Standard Entity State group."
Packit 022b05
    ::= { entStateGroups 1}
Packit 022b05
Packit 022b05
entStateNotificationsGroup NOTIFICATION-GROUP
Packit 022b05
   NOTIFICATIONS {
Packit 022b05
           entStateOperEnabled,
Packit 022b05
           entStateOperDisabled
Packit 022b05
           }
Packit 022b05
    STATUS   current
Packit 022b05
    DESCRIPTION
Packit 022b05
         "Standard Entity State Notification group."
Packit 022b05
    ::= { entStateGroups 2}
Packit 022b05
Packit 022b05
END