-- extracted from draft-ietf-entmib-state-02.txt -- at Thu Jan 8 06:16:13 2004 ENTITY-STATE-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, mib-2 FROM SNMPv2-SMI TEXTUAL-CONVENTION, DateAndTime FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP FROM SNMPv2-CONF entPhysicalIndex FROM ENTITY-MIB; entityStateMIB MODULE-IDENTITY LAST-UPDATED "200312180000Z" ORGANIZATION "IETF Entity MIB Working Group" CONTACT-INFO " General Discussion: entmib@ietf.org To Subscribe: http://www.ietf.org/mailman/listinfo/entmib http://www.ietf.org/html.charters/entmib-charter.html Sharon Chisholm Nortel Networks PO Box 3511 Station C Ottawa, Ont. K1Y 4H7 Canada schishol@nortelnetworks.com David T. Perkins 548 Qualbrook Ct San Jose, CA 95110 USA Phone: 408 394-8702 dperkins@snmpinfo.com " DESCRIPTION "This MIB defines a state extension to the Entity MIB. Copyright (C) The Internet Society 2003. This version of this MIB module is part of RFC yyyy; see the RFC itself for full legal notices." -- RFC Ed.: replace yyyy with actual RFC number & remove -- this note REVISION "200312180000Z" DESCRIPTION "Initial version, published as RFC YYYY." -- RFC-Editor assigns yyyy ::= { mib-2 XX } -- to be assigned by IANA -- Textual conventions AdminState ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION " Represents the various possible administrative states. A value of 'locked' means the resource is administratively prohibited from use. A value of 'shuttingDown' means that usage is administratively limited to current instances of use. A value of 'unlocked' means the resource is not administratively prohibited from use." REFERENCE "ITU Recommendation X.731, 'Information Technology - Open Systems Interconnection - System Management: State Management Function', 1992" SYNTAX INTEGER { notSupported(1), locked(2), shuttingDown(3), unlocked(4) } OperState ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION " Represents the possible values of operational states. A value of 'disabled' means the resource is totally inoperable. A value of 'enabled' means the resource is partially or fully operable." REFERENCE "ITU Recommendation X.731, 'Information Technology - Open Systems Interconnection - System Management: State Management Function', 1992" SYNTAX INTEGER { notSupported (1), disabled(2), enabled(3) } UsageState ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION " Represents the possible values of usage states. A value of 'idle' means the resource is servicing no users. A value of 'active' means the resource is currently in use and it has sufficient spare capacity to provide for additional users. A value of 'busy' means the resource is currently in use, but it currently has no spare capacity to provide for additional users." REFERENCE "ITU Recommendation X.731, 'Information Technology - Open Systems Interconnection - System Management: State Management Function', 1992" SYNTAX INTEGER { notSupported (1), idle(2), active(3), busy(4) } AlarmStatus ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "Represents the possible values of alarm status. When no bits of this attribute are set, then none of the status conditions described below are present. When the value of under repair is set, the resource is currently being repaired. When the value of 'critical' is set, one or more critical alarms are active against the resource. When the value of 'major' is set, one or more major alarms are active against the resource. When the value of 'minor' is set, one or more minor alarms are active against the resource. When the value of 'warning' is set, one or more warning alarms are active against the resource. When the value of 'indeterminate' is set, one or more alarms of indeterminate severity are active against the resource. When the value of 'alarmOutstanding' is set, one or more alarms is active against the resource. The fault may or may not be disabling. " REFERENCE "ITU Recommendation X.731, 'Information Technology - Open Systems Interconnection - System Management: State Management Function', 1992" SYNTAX BITS { notSupported (0), underRepair(1), critical(2), major(3), minor(4), alarmOutstanding(5), -- The following are not defined in X.733 warning (6), indeterminate (7) } StandbyStatus ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION " Represents the possible values of standby status. A value of 'hotStandby' means the resource is not providing service, but is will be immediately able to take over the role of the resource to be backed-up, without the need for initialization activity, and will contain the same information as the resource to be backed up. A value of 'coldStandy' means that the resource is to back-up another resource, but will not be immediately able to take over the role of a resource to be backed up, and will require some initialization activity. A value of 'providingService' means the resource is providing service." REFERENCE "ITU Recommendation X.731, 'Information Technology - Open Systems Interconnection - System Management: State Management Function', 1992" SYNTAX INTEGER { notSupported (1), hotStandby(2), coldStandby(3), providingService(4) } -- Entity State Objects entStateObjects OBJECT IDENTIFIER ::= { entityStateMIB 1 } entStateTable OBJECT-TYPE SYNTAX SEQUENCE OF EntStateEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of information about state/status of entities. This is a sparse augment of the entPhysicalTable. " ::= { entStateObjects 1 } entStateEntry OBJECT-TYPE SYNTAX EntStateEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "State information about this entity." INDEX { entPhysicalIndex } ::= { entStateTable 1 } EntStateEntry ::= SEQUENCE { entStateLastChanged DateAndTime, entStateAdmin AdminState, entStateOper OperState, entStateUsage UsageState, entStateAlarm AlarmStatus, entStateStandby StandbyStatus } entStateLastChanged OBJECT-TYPE SYNTAX DateAndTime MAX-ACCESS read-only STATUS current DESCRIPTION "The value of this object is the date and time when state/status of the entity last changed, or zero." ::= { entStateEntry 1 } entStateAdmin OBJECT-TYPE SYNTAX AdminState MAX-ACCESS read-write STATUS current DESCRIPTION "The administrative state for this entity. A value of 'notSupported' means that this entity is unable to report administrative state. This object can not be administratively set to 'notSupported'. For entities that do not support administrative state, changing the value of this object to something other than 'notSupported' is not permitted. A value of 'inconsistentValue' will be returned in either case. Some physical entities exhibit only a subset of the remaining administrative state values. Some entities cannot be locked, and hence this object exhibits only the 'unlocked' state. Other entities can not be shutdown gracefully, and hence this object does not exhibit the 'shuttingDown' state. A value of 'inconsistentValue' will be returned if attempts are made to set this object to values not supported by its administrative model." ::= { entStateEntry 2 } entStateOper OBJECT-TYPE SYNTAX OperState MAX-ACCESS read-only STATUS current DESCRIPTION "The operational state for this entity. A value of 'notSupported' means that this entity is unable to report operational state. Note that unlike the state model used within the Interfaces MIB [RFC2863], this object does not follow the administrative state. An administrative state of down does not predict an operational state of disabled. A value of 'disabled' means that an entity is totally inoperable and unable to provide service both to entities within its containment hierarchy, as defined by having a value of entPhysicalContainedIn that refers to this entity, or to other receivers of its service as defined in ways outside the scope of this MIB. A value of 'enabled' means that an entity is fully or partially operable and able to provide service both to entities within its containment hierarchy, as defined by having a value of entPhysicalContainedIn that refers to this entity, or to other receivers of its service as defined in ways outside the scope of this MIB." ::= { entStateEntry 3 } entStateUsage OBJECT-TYPE SYNTAX UsageState MAX-ACCESS read-only STATUS current DESCRIPTION "The usage state for this entity. A value of 'notSupported' means that this entity is unable to report usage state. Note that in the context of a physical entity, this object refers to an entity's ability to service more physical entities in a containment hierarchy. A value of 'idle' means this entity is able to contain other entities but that no other entity is currently contained within this entity, as would have been demonstrated by a value of entPhysicalContainedIn that referenced this entity. A value of 'active' means that at least one entity is contained within this entity and therefore has a value of entPhysicalContainedIn that references this entity, but that it could handle more. A value of 'busy' means that the entity is unable to handle any additional entities being contained in it, as demonstrated by having a value of entPhysicalContainedIn that refers to this entity. Some entities will exhibit only a subset of the usage state values. Entities that are unable to ever service any entities within a containment hierarchy will always have a usage state of 'busy'. Some entities will only ever be able to support one entity within its containment hierarchy and will therefore only exhibit values of 'idle' and 'busy'." ::= { entStateEntry 4 } entStateAlarm OBJECT-TYPE SYNTAX AlarmStatus MAX-ACCESS read-only STATUS current DESCRIPTION "The alarm status for this entity. It does not include the alarms raised on child components within its containment hierarchy, as defined by a value of entPhysicalContainedIn that references this entity. A value of 'notSupported' means that this entity is unable to report alarm state. Note that this differs from 'indeterminate' which means that that alarm state is supported and there are alarms against this entity, but the severity of some of the alarms is not known. If no bits are set, then this entity supports reporting of alarms, but there are currently no active alarms against this entity. " ::= { entStateEntry 5 } entStateStandby OBJECT-TYPE SYNTAX StandbyStatus MAX-ACCESS read-only STATUS current DESCRIPTION "The standby status for this entity. A value of 'notSupported' means that this entity is unable to report standby state. Some entities will exhibit only a subset of the remaining standby state values. If this entity does not have a standby, this object will always be 'providingService'." ::= { entStateEntry 6 } -- Notifications entStateTraps OBJECT IDENTIFIER ::= { entityStateMIB 2 } entStateTrapPrefix OBJECT IDENTIFIER ::= { entStateTraps 0 } entStateOperEnabled NOTIFICATION-TYPE OBJECTS { entStateAdmin, entStateAlarm } STATUS current DESCRIPTION "An entStateOperEnabled trap signifies that the SNMP entity, acting in an agent role, has detected that the entStateOper object for one of its entities has left the 'disabled' state and transitioned into the 'enabled' state. The entity this notification refers can be identified by extracting the entPhysicalIndex from one of the variable bindings." ::= { entStateTrapPrefix 1 } entStateOperDisabled NOTIFICATION-TYPE OBJECTS { entStateAdmin, entStateAlarm } STATUS current DESCRIPTION "An entStateOperDisabled trap signifies that the SNMP entity, acting in an agent role, has detected that the entStateOper object for one of its entities has left the 'enabled' state and transitioned into the 'disabled' state. The entity this notification refers can be identified by extracting the entPhysicalIndex from one of the variable bindings." ::= { entStateTrapPrefix 2 } -- Conformance and Compliance entStateConformance OBJECT IDENTIFIER ::= { entityStateMIB 3 } entStateCompliances OBJECT IDENTIFIER ::= { entStateConformance 1 } entStateCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for systems supporting the Entity State MIB." MODULE -- this module MANDATORY-GROUPS { entStateGroup } GROUP entStateNotificationsGroup DESCRIPTION "This group is optional." OBJECT entStateAdmin MIN-ACCESS read-only DESCRIPTION "Write access is not required." ::= { entStateCompliances 1 } entStateGroups OBJECT IDENTIFIER ::= { entStateConformance 2 } entStateGroup OBJECT-GROUP OBJECTS { entStateLastChanged, entStateAdmin, entStateOper, entStateUsage, entStateAlarm, entStateStandby } STATUS current DESCRIPTION "Standard Entity State group." ::= { entStateGroups 1} entStateNotificationGroup NOTIFICATION-GROUP NOTIFICATIONS { entStateOperEnabled, entStateOperDisabled } STATUS current DESCRIPTION "Standard Entity State Notification group." ::= { entStateGroups 2} END -- -- Copyright (C) The Internet Society (2003). All Rights Reserved. -- -- This document and translations of it may be copied and furnished to -- others, and derivative works that comment on or otherwise explain it -- or assist in its implementation may be prepared, copied, published -- and distributed, in whole or in part, without restriction of any kind, -- provided that the above copyright notice and this paragraph are -- included on all such copies and derivative works. However, this -- document itself may not be modified in any way, such as by removing -- the copyright notice or references to the Internet Society or other -- Internet organizations, except as needed for the purpose of -- developing Internet standards in which case the procedures for -- copyrights defined in the Internet Standards process must be followed, -- or as required to translate it into languages other than English. -- -- The limited permissions granted above are perpetual and will not be -- revoked by the Internet Society or its successors or assigns. -- -- This document and the information contained herein is provided on an -- "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING -- TASK FORCE DISCLAIMS 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.