xref: /illumos-gate/usr/src/lib/fm/libfmd_snmp/mibs/SUN-FM-MIB.mib (revision f498645a3eecf2ddd304b4ea9c7f1b4c155ff79e)
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 2006 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	"200601130000Z"
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 2006 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	"200601130000Z"
61	DESCRIPTION	"Version: 1.0"
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
95--
96-- The problem table is analogous to the output of fmadm faulty organized
97-- by the UUID of the case in which the faulty diagnosis was made.  The
98-- list of events contributing to this diagnosis is in a separate table
99-- (fmFaultEventTable).  Because SNMP does not allow nested tables, we
100-- indicate here only the number of events contributing to the diagnosis.
101--
102
103sunFmProblemTable OBJECT-TYPE
104	SYNTAX		SEQUENCE OF SunFmProblemEntry
105	MAX-ACCESS	not-accessible
106	STATUS		current
107	DESCRIPTION
108		"Table listing all of the known problems that have been
109		diagnosed by the fault manager associated with this managed
110		system element that are still present in that system."
111	::= { sunFmMIB 1 }
112
113sunFmProblemEntry OBJECT-TYPE
114	SYNTAX		SunFmProblemEntry
115	MAX-ACCESS	not-accessible
116	STATUS		current
117	DESCRIPTION
118		"A problem diagnosed by the fault manager and still
119		present in the system."
120	INDEX 		{ sunFmProblemUUIDIndex }
121	::= { sunFmProblemTable 1 }
122
123SunFmProblemEntry ::= SEQUENCE {
124	sunFmProblemUUIDIndex		SunFmUuidString,
125	sunFmProblemUUID		SunFmUuidString,
126	sunFmProblemCode		DisplayString,
127	sunFmProblemURL			URLString,
128	sunFmProblemDiagEngine		URLString,
129	sunFmProblemDiagTime		DateAndTime,
130	sunFmProblemSuspectCount	Gauge32
131}
132
133sunFmProblemUUIDIndex OBJECT-TYPE
134	SYNTAX		SunFmUuidString
135	MAX-ACCESS	not-accessible
136	STATUS		current
137	DESCRIPTION
138		"The Universal Unique Identifier (UUID) for this problem, as
139		recorded by fmd(1M) and shown by fmadm(1M) or fmdump(1M).
140		This is the index into sunFmProblemTable."
141	::= { sunFmProblemEntry 1 }
142
143sunFmProblemUUID OBJECT-TYPE
144	SYNTAX		SunFmUuidString
145	MAX-ACCESS	read-only
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	::= { sunFmProblemEntry 2 }
151
152sunFmProblemCode OBJECT-TYPE
153	SYNTAX		DisplayString
154	MAX-ACCESS	read-only
155	STATUS		current
156	DESCRIPTION
157		"The SUNW-MSG-ID static message identifier for this class of
158		problem, as recorded by fmd(1M) and shown by fmdump(1M).  The
159		message identifier can be used as a key at http://sun.com/msg/"
160	::= { sunFmProblemEntry 3 }
161
162sunFmProblemURL OBJECT-TYPE
163	SYNTAX		URLString
164	MAX-ACCESS	read-only
165	STATUS		current
166	DESCRIPTION
167		"The URL of an appropriate knowledge article providing more
168		detailed information about this problem."
169	::= { sunFmProblemEntry 4 }
170
171sunFmProblemDiagEngine OBJECT-TYPE
172	SYNTAX		URLString
173	MAX-ACCESS	read-only
174	STATUS		current
175	DESCRIPTION
176		"The Sun FMRI of the Fault Manager diagnosis engine that
177		performed the diagnosis of this problem, including its version."
178	::= { sunFmProblemEntry 5 }
179
180sunFmProblemDiagTime OBJECT-TYPE
181	SYNTAX		DateAndTime
182	MAX-ACCESS	read-only
183	STATUS		current
184	DESCRIPTION
185		"The date and time at which the problem was diagnosed."
186	::= { sunFmProblemEntry 6 }
187
188sunFmProblemSuspectCount OBJECT-TYPE
189	SYNTAX		Gauge32
190	MAX-ACCESS	read-only
191	STATUS		current
192	DESCRIPTION
193		"The number of individual suspect defects or faults
194		associated with this problem diagnosis, as shown by
195		fmdump(1M) -v -u <UUID>."
196	::= { sunFmProblemEntry 7 }
197
198--
199-- Events are indexed by the associated problem UUID and an index ranging
200-- from 1 to sunFmProblemEntry.fmProblemSuspectCount.<UUID> for easy retrieval
201-- and reconstruction of the information available via fmdump -v.  A
202-- fault appears once for each diagnosis referencing it.
203--
204
205sunFmFaultEventTable OBJECT-TYPE
206	SYNTAX		SEQUENCE OF SunFmFaultEventEntry
207	MAX-ACCESS	not-accessible
208	STATUS		current
209	DESCRIPTION
210		"List of individual suspect defects or faults associated with
211		a problem diagnosis, as shown by fmdump(1M) -v -u <UUID>."
212	::= { sunFmMIB 2 }
213
214sunFmFaultEventEntry OBJECT-TYPE
215	SYNTAX		SunFmFaultEventEntry
216	MAX-ACCESS	not-accessible
217	STATUS		current
218	DESCRIPTION
219		"Sun Fault Management fault or defect event containing a
220		suspect problem and the corresponding FRU and ASRU."
221	INDEX	{ sunFmFaultEventUUIDIndex, sunFmFaultEventIndex }
222	::= { sunFmFaultEventTable 1 }
223
224SunFmFaultEventEntry ::= SEQUENCE {
225	sunFmFaultEventUUIDIndex	SunFmUuidString,
226	sunFmFaultEventIndex		Unsigned32,
227	sunFmFaultEventProblemUUID	SunFmUuidString,
228	sunFmFaultEventClass		DisplayString,
229	sunFmFaultEventCertainty	Gauge32,
230	sunFmFaultEventASRU		URLString,
231	sunFmFaultEventFRU		URLString,
232	sunFmFaultEventResource		URLString
233}
234
235sunFmFaultEventUUIDIndex OBJECT-TYPE
236	SYNTAX		SunFmUuidString
237	MAX-ACCESS	not-accessible
238	STATUS		current
239	DESCRIPTION
240		"UUID of a problem diagnosis with which this event is
241		associated.  An event may appear multiple times in association
242		with different diagnoses.  This is an index into
243		sunFmFaultEventTable."
244	::= { sunFmFaultEventEntry 1 }
245
246sunFmFaultEventIndex OBJECT-TYPE
247	SYNTAX		Unsigned32
248	MAX-ACCESS	not-accessible
249	STATUS		current
250	DESCRIPTION
251		"Index number of this event with respect to the problem
252		diagnosis."
253	::= { sunFmFaultEventEntry 2 }
254
255sunFmFaultEventProblemUUID OBJECT-TYPE
256	SYNTAX		SunFmUuidString
257	MAX-ACCESS	read-only
258	STATUS		current
259	DESCRIPTION
260		"UUID of a problem diagnosis with which this event is
261		associated.  An event may appear multiple times in association
262		with different diagnoses."
263	::= { sunFmFaultEventEntry 3 }
264
265sunFmFaultEventClass OBJECT-TYPE
266	SYNTAX		DisplayString
267	MAX-ACCESS	read-only
268	STATUS		current
269	DESCRIPTION
270		"Sun Fault Management event class string."
271	::= { sunFmFaultEventEntry 4 }
272
273sunFmFaultEventCertainty OBJECT-TYPE
274	SYNTAX		Gauge32 (0..100)
275	MAX-ACCESS	read-only
276	STATUS		current
277	DESCRIPTION
278		"Percentage likelihood associated with this suspect for
279		this diagnosis."
280	::= { sunFmFaultEventEntry 5 }
281
282sunFmFaultEventASRU OBJECT-TYPE
283	SYNTAX		URLString
284	MAX-ACCESS	read-only
285	STATUS		current
286	DESCRIPTION
287		"Sun FMRI of the Automated System Reconfiguration Unit (ASRU)
288		that is believed to contain the specified fault or defect."
289	::= { sunFmFaultEventEntry 6 }
290
291sunFmFaultEventFRU OBJECT-TYPE
292	SYNTAX		URLString
293	MAX-ACCESS	read-only
294	STATUS		current
295	DESCRIPTION
296		"Sun FMRI of the Field Replaceable Unit (FRU) that should be
297		replaced in order to repair the specified fault or defect."
298	::= { sunFmFaultEventEntry 7 }
299
300sunFmFaultEventResource OBJECT-TYPE
301	SYNTAX		URLString
302	MAX-ACCESS	read-only
303	STATUS		current
304	DESCRIPTION
305		"Sun FMRI of the resource responsible for the generation of
306		the telemetry leading to the diagnosis."
307	::= { sunFmFaultEventEntry 8 }
308
309--
310-- sunFmModuleTable provides fmd configuration information equivalent to
311-- the output of fmadm config.
312--
313
314sunFmModuleTable OBJECT-TYPE
315	SYNTAX		SEQUENCE OF SunFmModuleEntry
316	MAX-ACCESS	not-accessible
317	STATUS		current
318	DESCRIPTION
319		"List of modules configured in fmd(1M)."
320	::= { sunFmMIB 3 }
321
322sunFmModuleEntry OBJECT-TYPE
323	SYNTAX		SunFmModuleEntry
324	MAX-ACCESS	not-accessible
325	STATUS		current
326	DESCRIPTION
327		"A module which has been loaded into fmd(1M) to handle events.
328		The information provided is equivalent to the output of
329		fmadm(1) config'"
330	INDEX	{ sunFmModuleIndex }
331	::= { sunFmModuleTable 1 }
332
333SunFmModuleEntry ::= SEQUENCE {
334	sunFmModuleIndex		Unsigned32,
335	sunFmModuleName			DisplayString,
336	sunFmModuleVersion		DisplayString,
337	sunFmModuleStatus		SunFmModuleState,
338	sunFmModuleDescription		DisplayString
339}
340
341sunFmModuleIndex OBJECT-TYPE
342	SYNTAX		Unsigned32
343	MAX-ACCESS	not-accessible
344	STATUS		current
345	DESCRIPTION
346		"Unique integer index associated with this fault management
347		module's entry."
348	::= { sunFmModuleEntry 1 }
349
350sunFmModuleName OBJECT-TYPE
351	SYNTAX		DisplayString (SIZE(0..64))
352	MAX-ACCESS	read-only
353	STATUS		current
354	DESCRIPTION
355		"Name of the fault management module."
356	::= { sunFmModuleEntry 2 }
357
358sunFmModuleVersion OBJECT-TYPE
359	SYNTAX		DisplayString
360	MAX-ACCESS	read-only
361	STATUS		current
362	DESCRIPTION
363		"Version string associated with the fault management module."
364	::= { sunFmModuleEntry 3 }
365
366sunFmModuleStatus OBJECT-TYPE
367	SYNTAX		SunFmModuleState
368	MAX-ACCESS	read-only
369	STATUS		current
370	DESCRIPTION
371		"Current status of the fault management module."
372	::= { sunFmModuleEntry 4 }
373
374sunFmModuleDescription OBJECT-TYPE
375	SYNTAX		DisplayString
376	MAX-ACCESS	read-only
377	STATUS		current
378	DESCRIPTION
379		"A text description of the fault management module."
380	::= { sunFmModuleEntry 5 }
381
382sunFmResourceCount OBJECT-TYPE
383	SYNTAX		Gauge32
384	MAX-ACCESS	read-only
385	STATUS		current
386	DESCRIPTION
387		"The number of managed elements currently believed by
388		the fault manager to be faulty."
389	::= { sunFmMIB 4 }
390
391sunFmResourceTable OBJECT-TYPE
392	SYNTAX		SEQUENCE OF SunFmResourceEntry
393	MAX-ACCESS	not-accessible
394	STATUS		current
395	DESCRIPTION
396		"A table containing information about all resources for which
397		the fault manager has received telemetry.  This is the same
398		information provided by the fmadm(1M) faulty command."
399	::= { sunFmMIB 5 }
400
401sunFmResourceEntry OBJECT-TYPE
402	SYNTAX		SunFmResourceEntry
403	MAX-ACCESS	not-accessible
404	STATUS		current
405	DESCRIPTION
406		"Information about the state of a resource the fault manager
407		believes to be faulty."
408	INDEX		{ sunFmResourceIndex }
409	::= { sunFmResourceTable 1 }
410
411SunFmResourceEntry ::= SEQUENCE {
412	sunFmResourceIndex		Unsigned32,
413	sunFmResourceFMRI		DisplayString,
414	sunFmResourceStatus		SunFmResourceState,
415	sunFmResourceDiagnosisUUID	SunFmUuidString
416}
417
418sunFmResourceIndex OBJECT-TYPE
419	SYNTAX		Unsigned32
420	MAX-ACCESS	not-accessible
421	STATUS		current
422	DESCRIPTION
423		"Index of the resource in the resource table."
424	::= { sunFmResourceEntry 1 }
425
426sunFmResourceFMRI OBJECT-TYPE
427	SYNTAX		DisplayString (SIZE(0..255))
428	MAX-ACCESS	read-only
429	STATUS		current
430	DESCRIPTION
431		"Sun FMRI of the Automated System Reconfiguration Unit (ASRU)
432		which the fault manager believes to be faulty."
433	::= { sunFmResourceEntry 2 }
434
435sunFmResourceStatus OBJECT-TYPE
436	SYNTAX		SunFmResourceState
437	MAX-ACCESS	read-only
438	STATUS		current
439	DESCRIPTION
440		"The current status of the resource.  See fmadm(1M) faulty."
441	::= { sunFmResourceEntry 3 }
442
443sunFmResourceDiagnosisUUID OBJECT-TYPE
444	SYNTAX		SunFmUuidString
445	MAX-ACCESS	read-only
446	STATUS		current
447	DESCRIPTION
448		"The Universal Unique Identifier (UUID) for the problem
449		associated with the fault in this resource, as recorded by
450		fmd(1M) and shown by fmadm(1M)."
451	::= { sunFmResourceEntry 4 }
452
453sunFmObjectGroups OBJECT IDENTIFIER ::= { sunFmMIB 6 }
454
455sunFmObjectGroup OBJECT-GROUP OBJECTS {
456		sunFmProblemUUID,
457		sunFmProblemCode,
458		sunFmProblemURL,
459		sunFmProblemDiagEngine,
460		sunFmProblemDiagTime,
461		sunFmProblemSuspectCount,
462		sunFmFaultEventProblemUUID,
463		sunFmFaultEventClass,
464		sunFmFaultEventCertainty,
465		sunFmFaultEventASRU,
466		sunFmFaultEventFRU,
467		sunFmFaultEventResource,
468		sunFmModuleName,
469		sunFmModuleVersion,
470		sunFmModuleStatus,
471		sunFmModuleDescription,
472		sunFmResourceCount,
473		sunFmResourceFMRI,
474		sunFmResourceStatus,
475		sunFmResourceDiagnosisUUID
476	}
477	STATUS	current
478	DESCRIPTION
479		"A collection of objects providing access to Sun Fault
480		Manager operational data."
481	::= { sunFmObjectGroups 1 }
482
483
484--
485-- RFC 3584 requires that the next-to-last sub-ID be zero to allow for
486-- mapping v2/v3 notifications to v1 traps.
487--
488
489sunFmTraps OBJECT IDENTIFIER ::= { sunFmMIB 7 0 }
490
491sunFmProblemTrap NOTIFICATION-TYPE
492	OBJECTS	{
493		sunFmProblemUUID,
494		sunFmProblemCode,
495		sunFmProblemURL
496	}
497	STATUS	current
498	DESCRIPTION
499		"Trap notification that a diagnosis has been made or the
500		fault manager fmd(1M) has restarted and the corresponding
501		problem is still believed to be present in the managed entity."
502	::= { sunFmTraps 1 }
503
504sunFmNotificationGroup NOTIFICATION-GROUP NOTIFICATIONS {
505		sunFmProblemTrap
506	}
507	STATUS	current
508	DESCRIPTION
509		"A collection of notifications provided by the Sun Fault
510		Manager."
511	::= { sunFmObjectGroups 2 }
512
513END
514
515