-- extracted from draft-ietf-entmib-state-00.txt -- at Wed Feb 5 06:11:59 2003 ENTITY-STATE-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, mib-2 FROM SNMPv2-SMI TEXTUAL-CONVENTION FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP FROM SNMPv2-CONF entPhysicalIndex FROM ENTITY-MIB; entityStateMIB MODULE-IDENTITY LAST-UPDATED "200301310000Z" ORGANIZATION "IETF Entity MIB Working Group" CONTACT-INFO " Sharon Chisholm Nortel Networks PO Box 3511 Station C Ottawa, Ont. K1Y 4H7 Canada schishol@nortelnetworks.com David T. Perkins Chisholm & Perkins Standards Track [Page 10]ü Entity State MIB January 2003 dperkins@dperkins.com " DESCRIPTION "This MIB defines a state extension to the entity MIB " REVISION "200301310000Z" DESCRIPTION "Initial version, published as RFC XXXX." ::= { mib-2 XX } -- Textual conventions AdminState ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION " Represents the various possible administrative states (ITU-T X.731). 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." SYNTAX INTEGER { locked(1), shuttingDown(2), unlocked(3) } OperState ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION " Represents the possible values of operational states (ITU-T X.731). A value of disabled means the resource is totally inoperable. A value of enabled means the resource is partially or fully operable." SYNTAX INTEGER { disabled(1), enabled(2) } UsageState ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION " Represents the possible values of usage states (ITU-T X.731). Chisholm & Perkins Standards Track [Page 11]ü Entity State MIB January 2003 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." SYNTAX INTEGER { idle(1), active(2), busy(3) } AlarmStatus ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION " Represents the possible values of alarm status (ITU-T X.731). When no values 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 alarm outstanding is set, one or more alarms is active against the resource. The fault may or may not be disabling. " SYNTAX BITS { underRepair(0), critical(1), major(2), minor(3), alarmOutstanding(4), warning (5), -- Not defined in X.731 indeterminate (6) -- Not defined in X.731 } StandbyStatus ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION " Represents the possible values of standby status (IU-T X.731). Chisholm & Perkins Standards Track [Page 12]ü Entity State MIB January 2003 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. " SYNTAX INTEGER { hotStandby(1), coldStandby(2), providingService(3) } -- 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. " ::= { 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 { entStateAdmin AdminState, entStateOper OperState, entStateUsage UsageState, entStateAlarm AlarmStatus, entStateStandby StandbyStatus } entStateAdmin OBJECT-TYPE SYNTAX AdminState MAX-ACCESS read-write Chisholm & Perkins Standards Track [Page 13]ü Entity State MIB January 2003 STATUS current DESCRIPTION "The administrative state for this entity." ::= { entStateEntry 1 } entStateOper OBJECT-TYPE SYNTAX OperState MAX-ACCESS read-only STATUS current DESCRIPTION "The operational state for this entity." ::= { entStateEntry 2 } entStateUsage OBJECT-TYPE SYNTAX UsageState MAX-ACCESS read-only STATUS current DESCRIPTION "The usage state for this entity." ::= { entStateEntry 3 } entStateAlarm OBJECT-TYPE SYNTAX AlarmStatus MAX-ACCESS read-only STATUS current DESCRIPTION "The alarm state for this entity. It does not include the severity of alarms raised on child components." ::= { entStateEntry 4 } entStateStandby OBJECT-TYPE SYNTAX StandbyStatus MAX-ACCESS read-only STATUS current DESCRIPTION üü "The standby status for this entity." ::= { entStateEntry 5 } -- Notifications entStateTraps OBJECT IDENTIFIER ::= { entityStateMIB 2 } entStateTrapPrefix OBJECT IDENTIFIER ::= { entStateTraps 0 } entStateOperEnabled NOTIFICATION-TYPE OBJECTS { entStateAdmin, entStateAlarm } STATUS current DESCRIPTION "The entity is operational. The entity this notification refers can be identified by extracting the entPhysicalIndex from one of the variable bindings." Chisholm & Perkins Standards Track [Page 14]ü Entity State MIB January 2003 ::= { entStateTrapPrefix 1 } entStateOperDisabled NOTIFICATION-TYPE OBJECTS { entStateAdmin, entStateAlarm } STATUS current DESCRIPTION "The entity is not operational. 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 } OBJECT entStateAdmin MIN-ACCESS read-only DESCRIPTION "Write access is not required." ::= { entStateCompliances 1 } entStateGroups OBJECT IDENTIFIER ::= { entStateConformance 2 } entStateGroup OBJECT-GROUP OBJECTS { entStateAdmin, entStateOper, entStateUsage, entStateAlarm, entStateStandby } STATUS current DESCRIPTION "Standard Entity State group." ::= { entStateGroups 1} entStateNotificationGroup NOTIFICATION-GROUP NOTIFICATIONS { Chisholm & Perkins Standards Track [Page 15]ü Entity State MIB January 2003 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. -- -- -- Chisholm & Perkins Standards Track [Page 18]ü -- Entity State MIB January 2003 -- -- -- -- 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. -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- Chisholm & Perkins Standards Track [Page 19]ü