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