1. FREENAS-MIB DEFINITIONS ::= BEGIN
2.  
3. IMPORTS
4.     MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, enterprises,
5.     Integer32, Counter32, Counter64, Gauge32  FROM SNMPv2-SMI
6.  
7.     TEXTUAL-CONVENTION, DisplayString         FROM SNMPv2-TC;
8.  
9. freeNas MODULE-IDENTITY
10.     LAST-UPDATED "202212211800Z"
11.     ORGANIZATION "www.ixsystems.com"
12.     CONTACT-INFO
13.         "postal:   2490 Kruse Dr
14.                    San Jose, CA 95131
15.  
16.          email:    support@iXsystems.com"
17.     DESCRIPTION
18.         "FREENAS Specific MIBs"
19.     REVISION     "202212211800Z"
20.     DESCRIPTION
21.         ""
22.     ::= { enterprises 50536 }
23.  
24. AlertLevelType ::= TEXTUAL-CONVENTION
25.     STATUS     current
26.     DESCRIPTION
27.         ""
28.     SYNTAX  INTEGER {
29.                 info(1),
30.                 notice(2),
31.                 warning(3),
32.                 error(4),
33.                 critical(5),
34.                 alert(6),
35.                 emergency(7)
36.                 }
37.  
38. zfs     OBJECT IDENTIFIER ::= { freeNas 1 }
39.  
40. notifications       OBJECT IDENTIFIER ::= { freeNas 2 }
41. notificationPrefix  OBJECT IDENTIFIER ::= { notifications 1 }
42. notificationObjects OBJECT IDENTIFIER ::= { notifications 2 }
43.  
44. zpool   OBJECT IDENTIFIER ::= { zfs 1 }
45. dataset OBJECT IDENTIFIER ::= { zfs 2 }
46. zvol    OBJECT IDENTIFIER ::= { zfs 3 }
47. arc     OBJECT IDENTIFIER ::= { zfs 4 }
48. l2arc   OBJECT IDENTIFIER ::= { zfs 5 }
49. zil     OBJECT IDENTIFIER ::= { zfs 6 }
50.  
51. zpoolTable OBJECT-TYPE
52.     SYNTAX     SEQUENCE OF ZpoolEntry
53.     MAX-ACCESS not-accessible
54.     STATUS     current
55.     DESCRIPTION
56.         ""
57.     ::= { zpool 1 }
58.  
59. zpoolEntry OBJECT-TYPE
60.     SYNTAX     ZpoolEntry
61.     MAX-ACCESS not-accessible
62.     STATUS     current
63.     DESCRIPTION
64.         ""
65.     INDEX { zpoolIndex }
66.     ::= { zpoolTable 1 }
67.  
68. ZpoolEntry ::= SEQUENCE {
69.         zpoolIndex                    Integer32,
70.         zpoolName                     DisplayString,
71.         zpoolHealth                   DisplayString,
72.         zpoolReadOps                  Counter64,
73.         zpoolWriteOps                 Counter64,
74.         zpoolReadBytes                Counter64,
75.         zpoolWriteBytes               Counter64,
76.         zpoolReadOps1sec              Counter64,
77.         zpoolWriteOps1sec             Counter64,
78.         zpoolReadBytes1sec            Counter64,
79.         zpoolWriteBytes1sec           Counter64
80.     }
81.  
82. zpoolIndex OBJECT-TYPE
83.     SYNTAX     Integer32 (1..2147483647)
84.     MAX-ACCESS not-accessible
85.     STATUS     current
86.     DESCRIPTION
87.         ""
88.     ::= { zpoolEntry 1 }
89.  
90. zpoolName OBJECT-TYPE
91.     SYNTAX     DisplayString
92.     MAX-ACCESS read-only
93.     STATUS     current
94.     DESCRIPTION
95.         "The name of the zpool"
96.     ::= { zpoolEntry 2 }
97.  
98. zpoolHealth OBJECT-TYPE
99.     SYNTAX     DisplayString
100.     MAX-ACCESS read-only
101.     STATUS     current
102.     DESCRIPTION
103.         "The health of the zpool"
104.     ::= { zpoolEntry 3 }
105.  
106. zpoolReadOps OBJECT-TYPE
107.     SYNTAX Counter64
108.     MAX-ACCESS read-only
109.     STATUS current
110.     DESCRIPTION
111.         "The number of read I/O operations sent to the pool or device,
112.         including metadata requests (averaged since system booted)."
113.     ::= { zpoolEntry 4 }
114.  
115. zpoolWriteOps OBJECT-TYPE
116.     SYNTAX Counter64
117.     MAX-ACCESS read-only
118.     STATUS current
119.     DESCRIPTION
120.         "The number of write I/O operations sent to the pool or device
121.         (averaged since system booted)."
122.     ::= { zpoolEntry 5 }
123.  
124. zpoolReadBytes OBJECT-TYPE
125.     SYNTAX Counter64
126.     MAX-ACCESS read-only
127.     STATUS current
128.     DESCRIPTION
129.         "The bandwidth of all read operations (including metadata),
130.         expressed as units per second (averaged since system booted)"
131.     ::= { zpoolEntry 6 }
132.  
133. zpoolWriteBytes OBJECT-TYPE
134.     SYNTAX Counter64
135.     MAX-ACCESS read-only
136.     STATUS current
137.     DESCRIPTION
138.         "The bandwidth of all write operations, expressed as units per
139.         second (averaged since system booted)."
140.     ::= { zpoolEntry 7 }
141.  
142. zpoolReadOps1sec OBJECT-TYPE
143.     SYNTAX Counter64
144.     MAX-ACCESS read-only
145.     STATUS current
146.     DESCRIPTION
147.         "The number of read I/O operations sent to the pool or device,
148.         including metadata requests (over 1 second interval)."
149.     ::= { zpoolEntry 8 }
150.  
151. zpoolWriteOps1sec OBJECT-TYPE
152.     SYNTAX Counter64
153.     MAX-ACCESS read-only
154.     STATUS current
155.     DESCRIPTION
156.         "The number of write I/O operations sent to the pool or device
157.         (over 1 second interval)."
158.     ::= { zpoolEntry 9 }
159.  
160. zpoolReadBytes1sec OBJECT-TYPE
161.     SYNTAX Counter64
162.     MAX-ACCESS read-only
163.     STATUS current
164.     DESCRIPTION
165.         "The bandwidth of all read operations (including metadata),
166.         expressed as units per second (over 1 second interval)"
167.     ::= { zpoolEntry 10 }
168.  
169. zpoolWriteBytes1sec OBJECT-TYPE
170.     SYNTAX Counter64
171.     MAX-ACCESS read-only
172.     STATUS current
173.     DESCRIPTION
174.         "The bandwidth of all write operations, expressed as units per
175.         second (over 1 second interval)."
176.     ::= { zpoolEntry 11 }
177.  
178. datasetTable OBJECT-TYPE
179.     SYNTAX     SEQUENCE OF DatasetEntry
180.     MAX-ACCESS not-accessible
181.     STATUS     current
182.     DESCRIPTION
183.         ""
184.     ::= { dataset 1 }
185.  
186. datasetEntry OBJECT-TYPE
187.     SYNTAX     DatasetEntry
188.     MAX-ACCESS not-accessible
189.     STATUS     current
190.     DESCRIPTION
191.         ""
192.     INDEX { datasetIndex }
193.     ::= { datasetTable 1 }
194.  
195. DatasetEntry ::= SEQUENCE {
196.         datasetIndex                    Integer32,
197.         datasetDescr                    DisplayString,
198.         datasetUsedBytes                Counter64,
199.         datasetAvailableBytes           Counter64,
200.         datasetReferencedBytes          Counter64
201.     }
202.  
203. datasetIndex OBJECT-TYPE
204.     SYNTAX     Integer32 (1..2147483647)
205.     MAX-ACCESS not-accessible
206.     STATUS     current
207.     DESCRIPTION
208.         ""
209.     ::= { datasetEntry 1 }
210.  
211. datasetDescr OBJECT-TYPE
212.     SYNTAX     DisplayString
213.     MAX-ACCESS read-only
214.     STATUS     current
215.     DESCRIPTION
216.         "The name of the dataset"
217.     ::= { datasetEntry 2 }
218.  
219. datasetUsedBytes OBJECT-TYPE
220.     SYNTAX     Counter64
221.     MAX-ACCESS read-only
222.     STATUS     current
223.     DESCRIPTION
224.         "The zfs used property value"
225.     ::= { datasetEntry 3 }
226.  
227. datasetAvailableBytes OBJECT-TYPE
228.     SYNTAX     Counter64
229.     MAX-ACCESS read-only
230.     STATUS     current
231.     DESCRIPTION
232.         "The zfs available property value"
233.     ::= { datasetEntry 4 }
234.  
235. datasetReferencedBytes OBJECT-TYPE
236.     SYNTAX     Counter64
237.     MAX-ACCESS read-only
238.     STATUS     current
239.     DESCRIPTION
240.         "The zfs referenced property value"
241.     ::= { datasetEntry 5 }
242.  
243. zvolTable OBJECT-TYPE
244.     SYNTAX     SEQUENCE OF ZvolEntry
245.     MAX-ACCESS not-accessible
246.     STATUS     current
247.     DESCRIPTION
248.         ""
249.     ::= { zvol 1 }
250.  
251. zvolEntry OBJECT-TYPE
252.     SYNTAX     ZvolEntry
253.     MAX-ACCESS not-accessible
254.     STATUS     current
255.     DESCRIPTION
256.         ""
257.     INDEX { zvolIndex }
258.     ::= { zvolTable 1 }
259.  
260. ZvolEntry ::= SEQUENCE {
261.         zvolIndex                    Integer32,
262.         zvolDescr                    DisplayString,
263.         zvolUsedBytes                Counter64,
264.         zvolAvailableBytes           Counter64,
265.         zvolReferencedBytes          Counter64
266.     }
267.  
268. zvolIndex OBJECT-TYPE
269.     SYNTAX     Integer32 (1..2147483647)
270.     MAX-ACCESS not-accessible
271.     STATUS     current
272.     DESCRIPTION
273.         ""
274.     ::= { zvolEntry 1 }
275.  
276. zvolDescr OBJECT-TYPE
277.     SYNTAX     DisplayString
278.     MAX-ACCESS read-only
279.     STATUS     current
280.     DESCRIPTION
281.         "The name of the zvol"
282.     ::= { zvolEntry 2 }
283.  
284. zvolUsedBytes OBJECT-TYPE
285.     SYNTAX     Counter64
286.     MAX-ACCESS read-only
287.     STATUS     current
288.     DESCRIPTION
289.         "The zfs used property value"
290.     ::= { zvolEntry 3 }
291.  
292. zvolAvailableBytes OBJECT-TYPE
293.     SYNTAX     Counter64
294.     MAX-ACCESS read-only
295.     STATUS     current
296.     DESCRIPTION
297.         "The zfs available property value"
298.     ::= { zvolEntry 4 }
299.  
300. zvolReferencedBytes OBJECT-TYPE
301.     SYNTAX     Counter64
302.     MAX-ACCESS read-only
303.     STATUS     current
304.     DESCRIPTION
305.         "The zfs referenced property value"
306.     ::= { zvolEntry 5 }
307.  
308. zfsArcSize OBJECT-TYPE
309.     SYNTAX Gauge32
310.     MAX-ACCESS read-only
311.     STATUS     current
312.     DESCRIPTION
313.         ""
314.     ::= { arc 1 }
315.  
316. zfsArcMeta OBJECT-TYPE
317.     SYNTAX     Gauge32
318.     MAX-ACCESS read-only
319.     STATUS     current
320.     DESCRIPTION
321.         ""
322.     ::= { arc 2 }
323.  
324. zfsArcData OBJECT-TYPE
325.     SYNTAX     Gauge32
326.     MAX-ACCESS read-only
327.     STATUS     current
328.     DESCRIPTION
329.         ""
330.     ::= { arc 3 }
331.  
332. zfsArcHits OBJECT-TYPE
333.     SYNTAX     Gauge32
334.     MAX-ACCESS read-only
335.     STATUS     current
336.     DESCRIPTION
337.         ""
338.     ::= { arc 4 }
339.  
340. zfsArcMisses OBJECT-TYPE
341.     SYNTAX     Gauge32
342.     MAX-ACCESS read-only
343.     STATUS     current
344.     DESCRIPTION
345.         ""
346.     ::= { arc 5 }
347.  
348. zfsArcC OBJECT-TYPE
349.     SYNTAX     Gauge32
350.     MAX-ACCESS read-only
351.     STATUS     current
352.     DESCRIPTION
353.         ""
354.     ::= { arc 6 }
355.  
356. zfsArcP OBJECT-TYPE
357.     SYNTAX     Gauge32
358.     MAX-ACCESS read-only
359.     STATUS     current
360.     DESCRIPTION
361.         ""
362.     ::= { arc 7 }
363.  
364. zfsArcMissPercent OBJECT-TYPE
365.     SYNTAX     DisplayString
366.     MAX-ACCESS read-only
367.     STATUS     current
368.     DESCRIPTION
369.         "Arc Miss Percentage.
370.         (Note: Floating precision sent across SNMP as a String"
371.     ::= { arc 8 }
372.  
373. zfsArcCacheHitRatio OBJECT-TYPE
374.     SYNTAX     DisplayString
375.     MAX-ACCESS read-only
376.     STATUS     current
377.     DESCRIPTION
378.         "Arc Cache Hit Ration Percentage.
379.         (Note: Floating precision sent across SNMP as a String"
380.     ::= { arc 9 }
381.  
382. zfsArcCacheMissRatio OBJECT-TYPE
383.     SYNTAX     DisplayString
384.     MAX-ACCESS read-only
385.     STATUS     current
386.     DESCRIPTION
387.         "Arc Cache Miss Ration Percentage.
388.         (Note: Floating precision sent across SNMP as a String"
389.     ::= { arc 10 }
390.  
391. zfsL2ArcHits OBJECT-TYPE
392.     SYNTAX     Counter32
393.     MAX-ACCESS read-only
394.     STATUS     current
395.     DESCRIPTION
396.         ""
397.     ::= { l2arc 1 }
398.  
399. zfsL2ArcMisses OBJECT-TYPE
400.     SYNTAX     Counter32
401.     MAX-ACCESS read-only
402.     STATUS     current
403.     DESCRIPTION
404.         ""
405.     ::= { l2arc 2 }
406.  
407. zfsL2ArcRead OBJECT-TYPE
408.     SYNTAX     Counter32
409.     MAX-ACCESS read-only
410.     STATUS     current
411.     DESCRIPTION
412.         ""
413.     ::= { l2arc 3 }
414.  
415. zfsL2ArcWrite OBJECT-TYPE
416.     SYNTAX     Counter32
417.     MAX-ACCESS read-only
418.     STATUS     current
419.     DESCRIPTION
420.         ""
421.     ::= { l2arc 4 }
422.  
423. zfsL2ArcSize OBJECT-TYPE
424.     SYNTAX     Gauge32
425.     MAX-ACCESS read-only
426.     STATUS     current
427.     DESCRIPTION
428.         ""
429.     ::= { l2arc 5 }
430.  
431. zfsZilstatOps1sec OBJECT-TYPE
432.     SYNTAX     Counter64
433.     MAX-ACCESS read-only
434.     STATUS     current
435.     DESCRIPTION
436.         "The ops column parsed from the command zilstat 1 1"
437.     ::= { zil 1 }
438.  
439. zfsZilstatOps5sec OBJECT-TYPE
440.     SYNTAX     Counter64
441.     MAX-ACCESS read-only
442.     STATUS     current
443.     DESCRIPTION
444.         "The ops column parsed from the command zilstat 5 1"
445.     ::= { zil 2 }
446.  
447. zfsZilstatOps10sec OBJECT-TYPE
448.     SYNTAX     Counter64
449.     MAX-ACCESS read-only
450.     STATUS     current
451.     DESCRIPTION
452.         "The ops column parsed from the command zilstat 10 1"
453.     ::= { zil 3 }
454.  
455. alert NOTIFICATION-TYPE
456.     OBJECTS    { alertId, alertLevel, alertMessage }
457.     STATUS     current
458.     DESCRIPTION
459.         "An alert raised"
460.     ::= { notificationPrefix 1 }
461.  
462. alertId OBJECT-TYPE
463.     SYNTAX     DisplayString
464.     MAX-ACCESS read-only
465.     STATUS     current
466.     DESCRIPTION
467.         ""
468.     ::= { notificationObjects 1 }
469.  
470. alertLevel OBJECT-TYPE
471.     SYNTAX     AlertLevelType
472.     MAX-ACCESS read-only
473.     STATUS     current
474.     DESCRIPTION
475.         ""
476.     ::= { notificationObjects 2 }
477.  
478. alertMessage OBJECT-TYPE
479.     SYNTAX     DisplayString
480.     MAX-ACCESS read-only
481.     STATUS     current
482.     DESCRIPTION
483.         ""
484.     ::= { notificationObjects 3 }
485.  
486. alertCancellation NOTIFICATION-TYPE
487.     OBJECTS    { alertId }
488.     STATUS     current
489.     DESCRIPTION
490.         "An alert cancelled"
491.     ::= { notificationPrefix 2 }
492.  
493. hddTempTable OBJECT-TYPE
494.     SYNTAX      SEQUENCE OF HDDTempEntry
495.     MAX-ACCESS  not-accessible
496.     STATUS      current
497.     DESCRIPTION
498.         "Table of HDDs and their temperatures."
499.     ::= { freeNas 3 }
500.  
501. hddTempEntry OBJECT-TYPE
502.     SYNTAX      HDDTempEntry
503.     MAX-ACCESS  not-accessible
504.     STATUS      current
505.     DESCRIPTION
506.         "An entry containing a HDD and its temperature."
507.     INDEX       { hddTempIndex }
508.     ::= { hddTempTable 1 }
509.  
510. HDDTempEntry ::= SEQUENCE {
511.     hddTempIndex    Integer32,
512.     hddTempDevice   DisplayString,
513.     hddTempValue    Gauge32
514. }
515.  
516. hddTempIndex OBJECT-TYPE
517.     SYNTAX      Integer32 (0..65535)
518.     MAX-ACCESS  read-only
519.     STATUS      current
520.     DESCRIPTION
521.         "Reference index for each observed HDD."
522.     ::= { hddTempEntry 1 }
523.  
524. hddTempDevice OBJECT-TYPE
525.     SYNTAX      DisplayString
526.     MAX-ACCESS  read-only
527.     STATUS      current
528.     DESCRIPTION
529.         "The name of the HDD we are reading temperature from."
530.     ::= { hddTempEntry 2 }
531.  
532. hddTempValue OBJECT-TYPE
533.     SYNTAX      Gauge32
534.     MAX-ACCESS  read-only
535.     STATUS      current
536.     DESCRIPTION
537.         "The temperature of this HDD in mC."
538.     ::= { hddTempEntry 3 }
539.  
540. END