mibs/ietf/ENTITY-STATE-MIB

   1 ENTITY-STATE-MIB DEFINITIONS ::= BEGIN
   2
   3   IMPORTS
   4       MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, mib-2
   5           FROM SNMPv2-SMI
   6       DateAndTime
   7           FROM SNMPv2-TC
   8       MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
   9            FROM SNMPv2-CONF
  10       entPhysicalIndex
  11            FROM ENTITY-MIB
  12       EntityAdminState, EntityOperState, EntityUsageState,
  13       EntityAlarmStatus, EntityStandbyStatus
  14            FROM ENTITY-STATE-TC-MIB;
  15
  16   entityStateMIB MODULE-IDENTITY
  17       LAST-UPDATED "200511220000Z"
  18       ORGANIZATION "IETF Entity MIB Working Group"
  19
  20
  21       CONTACT-INFO
  22               " General Discussion: entmib@ietf.org
  23                 To Subscribe:
  24                 http://www.ietf.org/mailman/listinfo/entmib
  25
  26                 http://www.ietf.org/html.charters/entmib-charter.html
  27
  28                 Sharon Chisholm
  29                 Nortel Networks
  30                 PO Box 3511 Station C
  31                 Ottawa, Ont.  K1Y 4H7
  32                 Canada
  33                 schishol@nortel.com
  34
  35                 David T. Perkins
  36                 548 Qualbrook Ct
  37                 San Jose, CA 95110
  38                 USA
  39                 Phone: 408 394-8702
  40                 dperkins@snmpinfo.com
  41                "
  42       DESCRIPTION
  43           "This MIB defines a state extension to the Entity MIB.
  44
  45            Copyright (C) The Internet Society 2005.  This version
  46            of this MIB module is part of RFC 4268; see the RFC
  47            itself for full legal notices."
  48       REVISION    "200511220000Z"
  49       DESCRIPTION
  50           "Initial version, published as RFC 4268."
  51       ::= { mib-2 131 }
  52
  53
  54   -- Entity State Objects
  55
  56   entStateObjects OBJECT IDENTIFIER ::= { entityStateMIB 1 }
  57
  58   entStateTable OBJECT-TYPE
  59    SYNTAX      SEQUENCE OF EntStateEntry
  60    MAX-ACCESS  not-accessible
  61    STATUS      current
  62    DESCRIPTION
  63        "A table of information about state/status of entities.
  64         This is a sparse augment of the entPhysicalTable.  Entries
  65         appear in this table for values of
  66         entPhysicalClass [RFC4133] that in this implementation
  67         are able to report any of the state or status stored in
  68         this table.
  69
  70
  71         "
  72    ::= { entStateObjects 1 }
  73
  74
  75     entStateEntry OBJECT-TYPE
  76        SYNTAX      EntStateEntry
  77        MAX-ACCESS  not-accessible
  78        STATUS      current
  79        DESCRIPTION
  80            "State information about this physical entity."
  81        INDEX       { entPhysicalIndex }
  82        ::= { entStateTable 1 }
  83
  84     EntStateEntry ::= SEQUENCE {
  85         entStateLastChanged DateAndTime,
  86         entStateAdmin       EntityAdminState,
  87         entStateOper        EntityOperState,
  88         entStateUsage       EntityUsageState,
  89         entStateAlarm       EntityAlarmStatus,
  90         entStateStandby     EntityStandbyStatus
  91        }
  92
  93   entStateLastChanged OBJECT-TYPE
  94    SYNTAX      DateAndTime
  95    MAX-ACCESS  read-only
  96    STATUS      current
  97    DESCRIPTION
  98      "The value of this object is the date and
  99       time when the value of any of entStateAdmin,
 100       entStateOper, entStateUsage, entStateAlarm,
 101       or entStateStandby changed for this entity.
 102
 103       If there has been no change since
 104       the last re-initialization of the local system,
 105       this object contains the date and time of
 106       local system initialization.  If there has been
 107       no change since the entity was added to the
 108       local system, this object contains the date and
 109       time of the insertion."
 110    ::= { entStateEntry 1 }
 111
 112 entStateAdmin OBJECT-TYPE
 113        SYNTAX      EntityAdminState
 114        MAX-ACCESS  read-write
 115        STATUS      current
 116        DESCRIPTION
 117             "The administrative state for this entity.
 118
 119
 120
 121              This object refers to an entities administrative
 122              permission to service both other entities within
 123              its containment hierarchy as well other users of
 124              its services defined by means outside the scope
 125              of this MIB.
 126
 127              Setting this object to 'notSupported' will result
 128              in an 'inconsistentValue' error.  For entities that
 129              do not support administrative state, all set
 130              operations will result in an 'inconsistentValue'
 131              error.
 132
 133              Some physical entities exhibit only a subset of the
 134              remaining administrative state values.  Some entities
 135              cannot be locked, and hence this object exhibits only
 136              the 'unlocked' state.  Other entities cannot be shutdown
 137              gracefully, and hence this object does not exhibit the
 138              'shuttingDown' state.  A value of 'inconsistentValue'
 139              will be returned if attempts are made to set this
 140              object to values not supported by its administrative
 141              model."
 142        ::= { entStateEntry 2 }
 143
 144  entStateOper OBJECT-TYPE
 145        SYNTAX      EntityOperState
 146        MAX-ACCESS  read-only
 147        STATUS      current
 148        DESCRIPTION
 149            "The operational state for this entity.
 150
 151             Note that unlike the state model used within the
 152             Interfaces MIB [RFC2863], this object does not follow
 153             the administrative state.  An administrative state of
 154             down does not predict an operational state
 155             of disabled.
 156
 157             A value of 'testing' means that entity currently being
 158             tested and cannot therefore report whether it is
 159             operational or not.
 160
 161             A value of 'disabled' means that an entity is totally
 162             inoperable and unable to provide service both to entities
 163             within its containment hierarchy, or to other receivers
 164             of its service as defined in ways outside the scope of
 165             this MIB.
 166
 167             A value of 'enabled' means that an entity is fully or
 168             partially operable and able to provide service both to
 169
 170
 171             entities within its containment hierarchy, or to other
 172             receivers of its service as defined in ways outside the
 173             scope of this MIB.
 174
 175             Note that some implementations may not be able to
 176             accurately report entStateOper while the
 177             entStateAdmin object has a value other than 'unlocked'.
 178             In these cases, this object MUST have a value
 179             of 'unknown'."
 180        ::= { entStateEntry 3 }
 181
 182  entStateUsage OBJECT-TYPE
 183        SYNTAX      EntityUsageState
 184        MAX-ACCESS  read-only
 185        STATUS      current
 186        DESCRIPTION
 187            "The usage state for this entity.
 188
 189             This object refers to an entity's ability to service more
 190             physical entities in a containment hierarchy.  A value
 191             of 'idle' means this entity is able to contain other
 192             entities but that no other entity is currently
 193             contained within this entity.
 194
 195             A value of 'active' means that at least one entity is
 196             contained within this entity, but that it could handle
 197             more.  A value of 'busy' means that the entity is unable
 198             to handle any additional entities being contained in it.
 199
 200             Some entities will exhibit only a subset of the
 201             usage state values.  Entities that are unable to ever
 202             service any entities within a containment hierarchy will
 203             always have a usage state of 'busy'.  Some entities will
 204             only ever be able to support one entity within its
 205             containment hierarchy and will therefore only exhibit
 206             values of 'idle' and 'busy'."
 207           ::= { entStateEntry 4 }
 208
 209  entStateAlarm OBJECT-TYPE
 210        SYNTAX      EntityAlarmStatus
 211        MAX-ACCESS  read-only
 212        STATUS      current
 213        DESCRIPTION
 214            "The alarm status for this entity.  It does not include
 215             the alarms raised on child components within its
 216             containment hierarchy.
 217
 218             A value of 'unknown' means that this entity is
 219
 220
 221
 222             unable to report alarm state.  Note that this differs
 223             from 'indeterminate', which means that alarm state
 224             is supported and there are alarms against this entity,
 225             but the severity of some of the alarms is not known.
 226
 227             If no bits are set, then this entity supports reporting
 228             of alarms, but there are currently no active alarms
 229             against this entity."
 230        ::= { entStateEntry 5 }
 231
 232 entStateStandby OBJECT-TYPE
 233        SYNTAX EntityStandbyStatus
 234        MAX-ACCESS read-only
 235        STATUS current
 236        DESCRIPTION
 237             "The standby status for this entity.
 238
 239             Some entities will exhibit only a subset of the
 240             remaining standby state values.  If this entity
 241             cannot operate in a standby role, the value of this
 242             object will always be 'providingService'."
 243   ::= { entStateEntry 6 }
 244
 245 -- Notifications
 246  entStateNotifications OBJECT IDENTIFIER ::= { entityStateMIB 0 }
 247
 248 entStateOperEnabled NOTIFICATION-TYPE
 249    OBJECTS { entStateAdmin,
 250              entStateAlarm
 251            }
 252    STATUS             current
 253    DESCRIPTION
 254            "An entStateOperEnabled notification signifies that the
 255             SNMP entity, acting in an agent role, has detected that
 256             the entStateOper object for one of its entities has
 257             transitioned into the 'enabled' state.
 258
 259             The entity this notification refers can be identified by
 260             extracting the entPhysicalIndex from one of the
 261             variable bindings.  The entStateAdmin and entStateAlarm
 262             varbinds may be examined to find out additional
 263             information on the administrative state at the time of
 264             the operation state change as well as to find out whether
 265             there were any known alarms against the entity at that
 266             time that may explain why the physical entity has become
 267             operationally disabled."
 268   ::= { entStateNotifications 1 }
 269
 270
 271
 272
 273 entStateOperDisabled NOTIFICATION-TYPE
 274    OBJECTS { entStateAdmin,
 275              entStateAlarm }
 276    STATUS             current
 277    DESCRIPTION
 278            "An entStateOperDisabled notification signifies that the
 279             SNMP entity, acting in an agent role, has detected that
 280             the entStateOper object for one of its entities has
 281             transitioned into the 'disabled' state.
 282
 283             The entity this notification refers can be identified by
 284             extracting the entPhysicalIndex from one of the
 285             variable bindings.  The entStateAdmin and entStateAlarm
 286             varbinds may be examined to find out additional
 287             information on the administrative state at the time of
 288             the operation state change as well as to find out whether
 289             there were any known alarms against the entity at that
 290             time that may affect the physical entity's
 291             ability to stay operationally enabled."
 292   ::= { entStateNotifications 2 }
 293
 294 -- Conformance and Compliance
 295
 296 entStateConformance OBJECT IDENTIFIER ::= { entityStateMIB 2 }
 297
 298 entStateCompliances OBJECT IDENTIFIER
 299                   ::= { entStateConformance 1 }
 300
 301 entStateCompliance MODULE-COMPLIANCE
 302       STATUS  current
 303       DESCRIPTION
 304           "The compliance statement for systems supporting
 305           the Entity State MIB."
 306       MODULE -- this module
 307           MANDATORY-GROUPS {
 308            entStateGroup
 309           }
 310       GROUP       entStateNotificationsGroup
 311          DESCRIPTION
 312              "This group is optional."
 313       OBJECT entStateAdmin
 314        MIN-ACCESS  read-only
 315        DESCRIPTION
 316            "Write access is not required."
 317    ::= { entStateCompliances 1 }
 318
 319 entStateGroups OBJECT IDENTIFIER ::= { entStateConformance 2 }
 320
 321
 322
 323
 324 entStateGroup OBJECT-GROUP
 325    OBJECTS {
 326            entStateLastChanged,
 327            entStateAdmin,
 328            entStateOper,
 329            entStateUsage,
 330            entStateAlarm,
 331            entStateStandby
 332            }
 333     STATUS   current
 334     DESCRIPTION
 335          "Standard Entity State group."
 336     ::= { entStateGroups 1}
 337
 338 entStateNotificationsGroup NOTIFICATION-GROUP
 339    NOTIFICATIONS {
 340            entStateOperEnabled,
 341            entStateOperDisabled
 342            }
 343     STATUS   current
 344     DESCRIPTION
 345          "Standard Entity State Notification group."
 346     ::= { entStateGroups 2}
 347
 348 END