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