xref: /illumos-gate/usr/src/lib/fm/libfmd_snmp/mibs/SUN-FM-MIB.mib (revision c3e9074d863038c38dc15c3af85b017f42133816)
1--
2-- CDDL HEADER START
3--
4-- The contents of this file are subject to the terms of the
5-- Common Development and Distribution License (the "License").
6-- You may not use this file except in compliance with the License.
7--
8-- You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9-- or http://www.opensolaris.org/os/licensing.
10-- See the License for the specific language governing permissions
11-- and limitations under the License.
12--
13-- When distributing Covered Code, include this CDDL HEADER in each
14-- file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15-- If applicable, add the following below this CDDL HEADER, with the
16-- fields enclosed by brackets "[]" replaced with your own identifying
17-- information: Portions Copyright [yyyy] [name of copyright owner]
18--
19-- CDDL HEADER END
20--
21
22--
23-- Copyright (c) 2008, 2010,  Oracle and/or its affiliates. All rights reserved.
24--
25
26SUN-FM-MIB DEFINITIONS ::= BEGIN
27
28IMPORTS
29	products
30		FROM SUN-MIB
31	Gauge32, Unsigned32, OBJECT-TYPE, NOTIFICATION-TYPE, MODULE-IDENTITY
32		FROM SNMPv2-SMI
33	TEXTUAL-CONVENTION, DateAndTime, DisplayString
34		FROM SNMPv2-TC
35	OBJECT-GROUP, NOTIFICATION-GROUP
36		FROM SNMPv2-CONF
37	URLString
38		FROM NETWORK-SERVICES-MIB;
39
40sunFmMIB MODULE-IDENTITY
41	LAST-UPDATED	"200808040000Z"
42	ORGANIZATION	"Oracle Corporation"
43	CONTACT-INFO	"Oracle Corporation
44			 500 Oracle Parkway
45			 Redwood Shores, CA 94065
46
47			 1.650.506.7000 or
48			 1.800.392.2999
49
50			 http://www.oracle.com
51			 or contact your local support representative"
52	DESCRIPTION
53		"Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
54
55		MIB providing access to Oracle Fault Manager information"
56	REVISION	"200808040000Z"
57	DESCRIPTION	"Version: 1.1"
58	::= { fm 1 }
59
60fm OBJECT IDENTIFIER ::= { products 195 }
61
62SunFmUuidString ::= TEXTUAL-CONVENTION
63	STATUS	current
64	DESCRIPTION
65		"Represents a Universal Unique Identifier (UUID)."
66	SYNTAX	OCTET STRING (SIZE (0..64))
67
68SunFmModuleState ::= TEXTUAL-CONVENTION
69	STATUS	current
70	DESCRIPTION
71		"Represents the status of an fmd(1M) module."
72	SYNTAX	INTEGER {
73		other(1),	-- Unknown or unsupported
74		active(2),
75		failed(3)
76	}
77
78SunFmResourceState ::= TEXTUAL-CONVENTION
79	STATUS	current
80	DESCRIPTION
81		"Represents the status of a system resource as diagnosed
82		by the fault manager."
83	SYNTAX	INTEGER {
84		other(1),	-- Unknown or unsupported
85		ok(2),
86		degraded(3),
87		unknown(4),
88		faulted(5)
89	}
90
91SunFmEventState ::= TEXTUAL-CONVENTION
92	STATUS	current
93	DESCRIPTION
94		"Represents the status of a suspect as diagnosed
95		by the fault manager."
96	SYNTAX	INTEGER {
97		other(1),	-- Unknown or unsupported
98		faulty(2),
99		removed(3),
100		replaced(4),
101		repaired(5),
102		acquitted(6)
103	}
104
105--
106-- The problem table is analogous to the output of fmadm faulty organized
107-- by the UUID of the case in which the faulty diagnosis was made.  The
108-- list of events contributing to this diagnosis is in a separate table
109-- (fmFaultEventTable).  Because SNMP does not allow nested tables, we
110-- indicate here only the number of events contributing to the diagnosis.
111--
112
113sunFmProblemTable OBJECT-TYPE
114	SYNTAX		SEQUENCE OF SunFmProblemEntry
115	MAX-ACCESS	not-accessible
116	STATUS		current
117	DESCRIPTION
118		"Table listing all of the known problems that have been
119		diagnosed by the fault manager associated with this managed
120		system element that are still present in that system."
121	::= { sunFmMIB 1 }
122
123sunFmProblemEntry OBJECT-TYPE
124	SYNTAX		SunFmProblemEntry
125	MAX-ACCESS	not-accessible
126	STATUS		current
127	DESCRIPTION
128		"A problem diagnosed by the fault manager and still
129		present in the system."
130	INDEX 		{ sunFmProblemUUIDIndex }
131	::= { sunFmProblemTable 1 }
132
133SunFmProblemEntry ::= SEQUENCE {
134	sunFmProblemUUIDIndex		SunFmUuidString,
135	sunFmProblemUUID		SunFmUuidString,
136	sunFmProblemCode		DisplayString,
137	sunFmProblemURL			URLString,
138	sunFmProblemDiagEngine		URLString,
139	sunFmProblemDiagTime		DateAndTime,
140	sunFmProblemSuspectCount	Gauge32
141}
142
143sunFmProblemUUIDIndex OBJECT-TYPE
144	SYNTAX		SunFmUuidString
145	MAX-ACCESS	not-accessible
146	STATUS		current
147	DESCRIPTION
148		"The Universal Unique Identifier (UUID) for this problem, as
149		recorded by fmd(1M) and shown by fmadm(1M) or fmdump(1M).
150		This is the index into sunFmProblemTable."
151	::= { sunFmProblemEntry 1 }
152
153sunFmProblemUUID OBJECT-TYPE
154	SYNTAX		SunFmUuidString
155	MAX-ACCESS	read-only
156	STATUS		current
157	DESCRIPTION
158		"The Universal Unique Identifier (UUID) for this problem, as
159		recorded by fmd(1M) and shown by fmadm(1M) or fmdump(1M)."
160	::= { sunFmProblemEntry 2 }
161
162sunFmProblemCode OBJECT-TYPE
163	SYNTAX		DisplayString
164	MAX-ACCESS	read-only
165	STATUS		current
166	DESCRIPTION
167		"The SUNW-MSG-ID static message identifier for this class of
168		problem, as recorded by fmd(1M) and shown by fmdump(1M).  The
169		message identifier can be used as a key at http://sun.com/msg/"
170	::= { sunFmProblemEntry 3 }
171
172sunFmProblemURL OBJECT-TYPE
173	SYNTAX		URLString
174	MAX-ACCESS	read-only
175	STATUS		current
176	DESCRIPTION
177		"The URL of an appropriate knowledge article providing more
178		detailed information about this problem."
179	::= { sunFmProblemEntry 4 }
180
181sunFmProblemDiagEngine OBJECT-TYPE
182	SYNTAX		URLString
183	MAX-ACCESS	read-only
184	STATUS		current
185	DESCRIPTION
186		"The Sun FMRI of the Fault Manager diagnosis engine that
187		performed the diagnosis of this problem, including its version."
188	::= { sunFmProblemEntry 5 }
189
190sunFmProblemDiagTime OBJECT-TYPE
191	SYNTAX		DateAndTime
192	MAX-ACCESS	read-only
193	STATUS		current
194	DESCRIPTION
195		"The date and time at which the problem was diagnosed."
196	::= { sunFmProblemEntry 6 }
197
198sunFmProblemSuspectCount OBJECT-TYPE
199	SYNTAX		Gauge32
200	MAX-ACCESS	read-only
201	STATUS		current
202	DESCRIPTION
203		"The number of individual suspect defects or faults
204		associated with this problem diagnosis, as shown by
205		fmdump(1M) -v -u <UUID>."
206	::= { sunFmProblemEntry 7 }
207
208--
209-- Events are indexed by the associated problem UUID and an index ranging
210-- from 1 to sunFmProblemEntry.fmProblemSuspectCount.<UUID> for easy retrieval
211-- and reconstruction of the information available via fmdump -v.  A
212-- fault appears once for each diagnosis referencing it.
213--
214
215sunFmFaultEventTable OBJECT-TYPE
216	SYNTAX		SEQUENCE OF SunFmFaultEventEntry
217	MAX-ACCESS	not-accessible
218	STATUS		current
219	DESCRIPTION
220		"List of individual suspect defects or faults associated with
221		a problem diagnosis, as shown by fmdump(1M) -v -u <UUID>."
222	::= { sunFmMIB 2 }
223
224sunFmFaultEventEntry OBJECT-TYPE
225	SYNTAX		SunFmFaultEventEntry
226	MAX-ACCESS	not-accessible
227	STATUS		current
228	DESCRIPTION
229		"Sun Fault Management fault or defect event containing a
230		suspect problem and the corresponding FRU and ASRU."
231	INDEX	{ sunFmFaultEventUUIDIndex, sunFmFaultEventIndex }
232	::= { sunFmFaultEventTable 1 }
233
234SunFmFaultEventEntry ::= SEQUENCE {
235	sunFmFaultEventUUIDIndex	SunFmUuidString,
236	sunFmFaultEventIndex		Unsigned32,
237	sunFmFaultEventProblemUUID	SunFmUuidString,
238	sunFmFaultEventClass		DisplayString,
239	sunFmFaultEventCertainty	Gauge32,
240	sunFmFaultEventASRU		URLString,
241	sunFmFaultEventFRU		URLString,
242	sunFmFaultEventResource		URLString,
243	sunFmFaultEventStatus		SunFmEventState,
244	sunFmFaultEventLocation		URLString
245}
246
247sunFmFaultEventUUIDIndex OBJECT-TYPE
248	SYNTAX		SunFmUuidString
249	MAX-ACCESS	not-accessible
250	STATUS		current
251	DESCRIPTION
252		"UUID of a problem diagnosis with which this event is
253		associated.  An event may appear multiple times in association
254		with different diagnoses.  This is an index into
255		sunFmFaultEventTable."
256	::= { sunFmFaultEventEntry 1 }
257
258sunFmFaultEventIndex OBJECT-TYPE
259	SYNTAX		Unsigned32
260	MAX-ACCESS	not-accessible
261	STATUS		current
262	DESCRIPTION
263		"Index number of this event with respect to the problem
264		diagnosis."
265	::= { sunFmFaultEventEntry 2 }
266
267sunFmFaultEventProblemUUID OBJECT-TYPE
268	SYNTAX		SunFmUuidString
269	MAX-ACCESS	read-only
270	STATUS		current
271	DESCRIPTION
272		"UUID of a problem diagnosis with which this event is
273		associated.  An event may appear multiple times in association
274		with different diagnoses."
275	::= { sunFmFaultEventEntry 3 }
276
277sunFmFaultEventClass OBJECT-TYPE
278	SYNTAX		DisplayString
279	MAX-ACCESS	read-only
280	STATUS		current
281	DESCRIPTION
282		"Sun Fault Management event class string."
283	::= { sunFmFaultEventEntry 4 }
284
285sunFmFaultEventCertainty OBJECT-TYPE
286	SYNTAX		Gauge32 (0..100)
287	MAX-ACCESS	read-only
288	STATUS		current
289	DESCRIPTION
290		"Percentage likelihood associated with this suspect for
291		this diagnosis."
292	::= { sunFmFaultEventEntry 5 }
293
294sunFmFaultEventASRU OBJECT-TYPE
295	SYNTAX		URLString
296	MAX-ACCESS	read-only
297	STATUS		current
298	DESCRIPTION
299		"Sun FMRI of the Automated System Reconfiguration Unit (ASRU)
300		that is believed to contain the specified fault or defect."
301	::= { sunFmFaultEventEntry 6 }
302
303sunFmFaultEventFRU OBJECT-TYPE
304	SYNTAX		URLString
305	MAX-ACCESS	read-only
306	STATUS		current
307	DESCRIPTION
308		"Sun FMRI of the Field Replaceable Unit (FRU) that should be
309		replaced in order to repair the specified fault or defect."
310	::= { sunFmFaultEventEntry 7 }
311
312sunFmFaultEventResource OBJECT-TYPE
313	SYNTAX		URLString
314	MAX-ACCESS	read-only
315	STATUS		current
316	DESCRIPTION
317		"Sun FMRI of the resource responsible for the generation of
318		the telemetry leading to the diagnosis."
319	::= { sunFmFaultEventEntry 8 }
320
321sunFmFaultEventStatus OBJECT-TYPE
322	SYNTAX		SunFmEventState
323	MAX-ACCESS	read-only
324	STATUS		current
325	DESCRIPTION
326		"The current status of this suspect for this diagnosis.
327		See fmadm(1M) faulty."
328	::= { sunFmFaultEventEntry 9 }
329
330sunFmFaultEventLocation OBJECT-TYPE
331	SYNTAX		URLString
332	MAX-ACCESS	read-only
333	STATUS		current
334	DESCRIPTION
335		"Label of the Field Replaceable Unit (FRU) that should be
336                replaced in order to repair the specified fault or defect."
337	::= { sunFmFaultEventEntry 10 }
338
339--
340-- sunFmModuleTable provides fmd configuration information equivalent to
341-- the output of fmadm config.
342--
343
344sunFmModuleTable OBJECT-TYPE
345	SYNTAX		SEQUENCE OF SunFmModuleEntry
346	MAX-ACCESS	not-accessible
347	STATUS		current
348	DESCRIPTION
349		"List of modules configured in fmd(1M)."
350	::= { sunFmMIB 3 }
351
352sunFmModuleEntry OBJECT-TYPE
353	SYNTAX		SunFmModuleEntry
354	MAX-ACCESS	not-accessible
355	STATUS		current
356	DESCRIPTION
357		"A module which has been loaded into fmd(1M) to handle events.
358		The information provided is equivalent to the output of
359		fmadm(1) config'"
360	INDEX	{ sunFmModuleIndex }
361	::= { sunFmModuleTable 1 }
362
363SunFmModuleEntry ::= SEQUENCE {
364	sunFmModuleIndex		Unsigned32,
365	sunFmModuleName			DisplayString,
366	sunFmModuleVersion		DisplayString,
367	sunFmModuleStatus		SunFmModuleState,
368	sunFmModuleDescription		DisplayString
369}
370
371sunFmModuleIndex OBJECT-TYPE
372	SYNTAX		Unsigned32
373	MAX-ACCESS	not-accessible
374	STATUS		current
375	DESCRIPTION
376		"Unique integer index associated with this fault management
377		module's entry."
378	::= { sunFmModuleEntry 1 }
379
380sunFmModuleName OBJECT-TYPE
381	SYNTAX		DisplayString (SIZE(0..64))
382	MAX-ACCESS	read-only
383	STATUS		current
384	DESCRIPTION
385		"Name of the fault management module."
386	::= { sunFmModuleEntry 2 }
387
388sunFmModuleVersion OBJECT-TYPE
389	SYNTAX		DisplayString
390	MAX-ACCESS	read-only
391	STATUS		current
392	DESCRIPTION
393		"Version string associated with the fault management module."
394	::= { sunFmModuleEntry 3 }
395
396sunFmModuleStatus OBJECT-TYPE
397	SYNTAX		SunFmModuleState
398	MAX-ACCESS	read-only
399	STATUS		current
400	DESCRIPTION
401		"Current status of the fault management module."
402	::= { sunFmModuleEntry 4 }
403
404sunFmModuleDescription OBJECT-TYPE
405	SYNTAX		DisplayString
406	MAX-ACCESS	read-only
407	STATUS		current
408	DESCRIPTION
409		"A text description of the fault management module."
410	::= { sunFmModuleEntry 5 }
411
412sunFmResourceCount OBJECT-TYPE
413	SYNTAX		Gauge32
414	MAX-ACCESS	read-only
415	STATUS		current
416	DESCRIPTION
417		"The number of managed elements currently believed by
418		the fault manager to be faulty."
419	::= { sunFmMIB 4 }
420
421sunFmResourceTable OBJECT-TYPE
422	SYNTAX		SEQUENCE OF SunFmResourceEntry
423	MAX-ACCESS	not-accessible
424	STATUS		current
425	DESCRIPTION
426		"A table containing information about all resources for which
427		the fault manager has received telemetry.  This is the same
428		information provided by the fmadm(1M) faulty command."
429	::= { sunFmMIB 5 }
430
431sunFmResourceEntry OBJECT-TYPE
432	SYNTAX		SunFmResourceEntry
433	MAX-ACCESS	not-accessible
434	STATUS		current
435	DESCRIPTION
436		"Information about the state of a resource the fault manager
437		believes to be faulty."
438	INDEX		{ sunFmResourceIndex }
439	::= { sunFmResourceTable 1 }
440
441SunFmResourceEntry ::= SEQUENCE {
442	sunFmResourceIndex		Unsigned32,
443	sunFmResourceFMRI		DisplayString,
444	sunFmResourceStatus		SunFmResourceState,
445	sunFmResourceDiagnosisUUID	SunFmUuidString
446}
447
448sunFmResourceIndex OBJECT-TYPE
449	SYNTAX		Unsigned32
450	MAX-ACCESS	not-accessible
451	STATUS		current
452	DESCRIPTION
453		"Index of the resource in the resource table."
454	::= { sunFmResourceEntry 1 }
455
456sunFmResourceFMRI OBJECT-TYPE
457	SYNTAX		DisplayString (SIZE(0..255))
458	MAX-ACCESS	read-only
459	STATUS		current
460	DESCRIPTION
461		"Sun FMRI of the Automated System Reconfiguration Unit (ASRU)
462		which the fault manager believes to be faulty."
463	::= { sunFmResourceEntry 2 }
464
465sunFmResourceStatus OBJECT-TYPE
466	SYNTAX		SunFmResourceState
467	MAX-ACCESS	read-only
468	STATUS		current
469	DESCRIPTION
470		"The current status of the resource.  See fmadm(1M) faulty."
471	::= { sunFmResourceEntry 3 }
472
473sunFmResourceDiagnosisUUID OBJECT-TYPE
474	SYNTAX		SunFmUuidString
475	MAX-ACCESS	read-only
476	STATUS		current
477	DESCRIPTION
478		"The Universal Unique Identifier (UUID) for the problem
479		associated with the fault in this resource, as recorded by
480		fmd(1M) and shown by fmadm(1M)."
481	::= { sunFmResourceEntry 4 }
482
483sunFmObjectGroups OBJECT IDENTIFIER ::= { sunFmMIB 6 }
484
485sunFmObjectGroup OBJECT-GROUP OBJECTS {
486		sunFmProblemUUID,
487		sunFmProblemCode,
488		sunFmProblemURL,
489		sunFmProblemDiagEngine,
490		sunFmProblemDiagTime,
491		sunFmProblemSuspectCount,
492		sunFmFaultEventProblemUUID,
493		sunFmFaultEventClass,
494		sunFmFaultEventCertainty,
495		sunFmFaultEventASRU,
496		sunFmFaultEventFRU,
497		sunFmFaultEventResource,
498		sunFmFaultEventStatus,
499		sunFmFaultEventLocation,
500		sunFmModuleName,
501		sunFmModuleVersion,
502		sunFmModuleStatus,
503		sunFmModuleDescription,
504		sunFmResourceCount,
505		sunFmResourceFMRI,
506		sunFmResourceStatus,
507		sunFmResourceDiagnosisUUID
508	}
509	STATUS	current
510	DESCRIPTION
511		"A collection of objects providing access to Sun Fault
512		Manager operational data."
513	::= { sunFmObjectGroups 1 }
514
515
516--
517-- RFC 3584 requires that the next-to-last sub-ID be zero to allow for
518-- mapping v2/v3 notifications to v1 traps.
519--
520
521sunFmTraps OBJECT IDENTIFIER ::= { sunFmMIB 7 0 }
522
523sunFmProblemTrap NOTIFICATION-TYPE
524	OBJECTS	{
525		sunFmProblemUUID,
526		sunFmProblemCode,
527		sunFmProblemURL
528	}
529	STATUS	current
530	DESCRIPTION
531		"Trap notification that a diagnosis has been made or the
532		fault manager fmd(1M) has restarted and the corresponding
533		problem is still believed to be present in the managed entity."
534	::= { sunFmTraps 1 }
535
536sunFmNotificationGroup NOTIFICATION-GROUP NOTIFICATIONS {
537		sunFmProblemTrap
538	}
539	STATUS	current
540	DESCRIPTION
541		"A collection of notifications provided by the Sun Fault
542		Manager."
543	::= { sunFmObjectGroups 2 }
544
545END
546
547