forked from prometheus/snmp_exporter
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgenerator.cisco.yml
532 lines (460 loc) · 15 KB
/
generator.cisco.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
# This is a configuration file for the
# https://github.com/jelmd/snmp-export/tree/main/generator
# (C) 2022 by Jens Elkner ([email protected])
# To translate it into a YAML spec conforming file, you need to pass it through
# https://github.com/jelmd/snakeyaml - this is a modified YAML file parser,
# which allows duplicated keys and in turn does what most normal people would
# do: merge its contents into a single basket and throw away the now redundant
# basket.
# The usual workflows used to create and test it were:
# export MIBDIRS=${HOME}/adm/snmp/mibs/cisco:${HOME}/adm/snmp/mibs/cisco/capa
# DST=mySNMPdeviceIP
#
# snmpbulkwalk -v 2c -c public -Pu -OX $DST mib-2 >/tmp/mib2.out
# snmpbulkwalk -v 2c -c public -Pu -OX $DST private >/tmp/priv.out
# snmptable -v 2c -c public -Pu -OX $DST ifTable >/tmp/iftbl.out
# snmptranslate -Tp -IR -Pu ifTable >/tmp/iftbltree.out
# ...
# Create/edit generator.cisco.yml using the output in /tmp/*.out etc. and check:
# snakeyaml generator.cisco.yml > /tmp/a
# snmp-export-cfg generate -f /tmp/a -o /tmp/c
# snmp-export -f /tmp/c
# Queries:
# curl -s "http://localhost:9116/snmp?compact&module=ifTables&target=$DSTa"
# curl -s "http://localhost:9116/snmp?compact&module=ifTables&target=$DSTb"
# curl -s "http://localhost:9116/snmp?compact&module=cisco_35xx&target=$DSTa"
# curl -s "http://localhost:9116/snmp?compact&module=cisco_n3k&target=$DSTb"
modules:
global_vars:
prefix: &prefix netsw
ifTable_template: # generic
walk: &ifTable_walk
- ifOperStatus # 1.3.6.1.2.1.2.2.1.8
- ifInDiscards # 1.3.6.1.2.1.2.2.1.13
- ifInErrors # 1.3.6.1.2.1.2.2.1.14
- ifInUnknownProtos # 1.3.6.1.2.1.2.2.1.15
- ifOutDiscards # 1.3.6.1.2.1.2.2.1.19
- ifOutErrors # 1.3.6.1.2.1.2.2.1.20
- udpInDatagrams # 1.3.6.1.2.1.7.1
- udpOutDatagrams # 1.3.6.1.2.1.7.4
- snmpInPkts # 1.3.6.1.2.1.11.1
- snmpOutPkts # 1.3.6.1.2.1.11.2
overrides: &ifTable_overrides
ifIndex:
ignore: true
ifDescr:
ignore: true
ifType:
ignore: true
ifMtu:
ignore: true
ifPhysAddress:
ignore: true
ifAdminStatus:
ignore: true
ifLastChange:
ignore: true
ifOutQLen:
ignore: true
ifSpecific:
ignore: true
# use 64-bit variants from ifXTable instead
ifSpeed:
ignore: true
ifInOctets:
ignore: true
ifInUcastPkts:
ignore: true
ifInNUcastPkts:
ignore: true
ifOutOctets:
ignore: true
ifOutUcastPkts:
ignore: true
ifOutNUcastPkts:
ignore: true
ifXTable_template: # generic
walk: &ifXTable_walk
- ifHCInOctets # 1.3.6.1.2.1.31.1.1.1.6
- ifHCInUcastPkts # 1.3.6.1.2.1.31.1.1.1.7
- ifHCInMulticastPkts # 1.3.6.1.2.1.31.1.1.1.8
- ifHCInBroadcastPkts # 1.3.6.1.2.1.31.1.1.1.9
- ifHCOutOctets # 1.3.6.1.2.1.31.1.1.1.10
- ifHCOutUcastPkts # 1.3.6.1.2.1.31.1.1.1.11
- ifHCOutMulticastPkts # 1.3.6.1.2.1.31.1.1.1.12
- ifHCOutBroadcastPkts # 1.3.6.1.2.1.31.1.1.1.13
- ifHighSpeed # 1.3.6.1.2.1.31.1.1.1.15
overrides: &ifXTable_overrides
ifAlias:
ignore: true # redundant/useless
ifConnectorPresent:
ignore: true
ifCounterDiscontinuityTime:
ignore: true
ifInBroadcastPkts:
ignore: true # use ifHCInBroadcastPkts
ifInMulticastPkts:
ignore: true # use ifHCInMulticastPkts
ifLinkUpDownTrapEnable:
ignore: true
ifName:
ignore: true # included as labels
ifOutBroadcastPkts:
ignore: true # use ifHCOutBroadcastPkts
ifOutMulticastPkts:
ignore: true # use ifHCOutMulticastPkts
ifPromiscuousMode:
ignore: true
lookups: &ifTable_lookups
- source_indexes: [ifIndex]
lookup: 1.3.6.1.2.1.31.1.1.1.1 # ifName
drop_source_indexes: true
mprefix: [if]
revalue:
regex: '(Eth|po|Vl)(ernet|rt-channel|an)(.*)'
value: '$1$3'
rename: nic
cisco_chassisModel_template:
overrides: &cisco_chassisModel_overrides
chassisModel:
regex_extracts:
'':
- regex: '.*'
value: '1'
lookups: &cisco_chassisModel_lookups
- source_indexes: []
mprefix: [chassisModel]
lookup: chassisModel
rename: name
cpmCPUTotalTable_template: # C35xx, N3K
walk: &cpmCPUTotalTable_walk
- cpmCPUTotal1minRev # 1.3.6.1.4.1.9.9.109.1.1.1.1.7
- cpmCPUTotal5minRev # 1.3.6.1.4.1.9.9.109.1.1.1.1.8
- cpmCPUTotal5secRev # 1.3.6.1.4.1.9.9.109.1.1.1.1.6
overrides: &cpmCPUTotalTable_overrides
cpmCPUMonInterval:
ignore: true # constant = 5s
cpmCPUTotalMonIntervalValue:
ignore: true # same as cpmCPUTotal5secRev
cpmCPUInterruptMonIntervalValue:
ignore: true # cpu utilzation is sufficient or now.
cpmCPUTotal1min:
ignore: true # same as cpmCPUTotal1minRev
cpmCPUTotal5min:
ignore: true # same as cpmCPUTotal5minRev
cpmCPUTotal5sec:
ignore: true # same as cpmCPUTotal5secRev
cpmCPUTotalPhysicalIndex:
ignore: true # use to resolve entPhysicalName, only.
lookups: &cpmCPUTotalTable_lookups
- source_indexes: [cpmCPUTotalIndex]
mprefix: [cpmCPU]
lookup: cpmCPUTotalPhysicalIndex¦entPhysicalName
rename: cpu
revalue:
regex: '([^ ]+).*'
value: '$1'
drop_source_indexes: true
ciscoMemoryPoolTable_template: # 35xx, !N3K
walk: &ciscoMemoryPoolTable_walk
- ciscoMemoryPoolUsed
- ciscoMemoryPoolFree
- ciscoMemoryPoolLargestFree
overrides: &ciscoMemoryPoolTable_overrides
ciscoMemoryPoolName:
ignore: true
ciscoMemoryPoolAlternate: # useless
ignore: true
ciscoMemoryPoolType:
ignore: true
ciscoMemoryPoolValid:
ignore: true
lookups: &ciscoMemoryPoolTable_lookups
- source_indexes: [ciscoMemoryPoolType]
lookup: ciscoMemoryPoolName
rename: pool
drop_source_indexes: true
cempMemPoolTable_template: # !35xx, N3K
walk: &cempMemPoolTable_walk
- cempMemPoolHCUsed
- cempMemPoolHCFree
- cempMemPoolHCLargestFree
- cempMemPoolHCLowestFree
- cempMemPoolHCUsedLowWaterMark
- cempMemPoolHCShared
overrides: &cempMemPoolTable_overrides
# ignore 32-bit values and use 64-bit aka HC values, only.
cempMemPoolFree:
ignore: true
cempMemPoolFreeOvrflw:
ignore: true
cempMemPoolLargestFree:
ignore: true
cempMemPoolLargestFreeOvrflw:
ignore: true
cempMemPoolLowestFree:
ignore: true
cempMemPoolLowestFreeOvrflw:
ignore: true
cempMemPoolShared:
ignore: true
cempMemPoolSharedOvrflw:
ignore: true
cempMemPoolUsedLowWaterMark:
ignore: true
cempMemPoolUsedLowWaterMarkOvrflw:
ignore: true
cempMemPoolUsed:
ignore: true
cempMemPoolUsedOvrflw:
ignore: true
# useless or redundant stuff
cempMemPoolPlatformMemory:
ignore: true
cempMemPoolAlternate:
ignore: true
cempMemPoolValid:
ignore: true
cempMemPoolAllocHit:
ignore: true
cempMemPoolAllocMiss:
ignore: true
cempMemPoolFreeHit:
ignore: true
cempMemPoolFreeMiss:
ignore: true
cempMemPoolType:
ignore: true
entPhysicalIndex:
ignore: true
cempMemPoolName:
ignore: true
lookups: &cempMemPoolTable_lookups
- source_indexes: [cempMemPoolIndex, entPhysicalIndex]
mprefix: [cempMemPoolHC]
# actually cempMemPoolName.entPhysicalIndex.cempMemPoolIndex but this
# is not yet supported. Since this is always the same, we hardcode it
# to a 35xx compatible value using a cheap index/lookup
lookup: cempMemPoolName
rename: pool
revalue:
regex: '.*'
value: 'Processor'
drop_source_indexes: true
# expensive, especially on more recent cisco Switches
# - source_indexes: [entPhysicalIndex]
# lookup: entPhysicalName
# rename: pool
# revalue:
# regex: '([^ ]+).*'
# value: '$1'
# drop_source_indexes: true
# ciscoEnvMonVoltageStatusTable_template: # 35xx, !N3K
# useless bloat
# walk:
# - ciscoEnvMonVoltageStatusTable
ciscoEnvMonTemperatureStatusTable_template: # 35xx, !N3K
walk: &ciscoEnvMonTemperatureStatusTable_walk
- ciscoEnvMonTemperatureStatusValue
- ciscoEnvMonTemperatureThreshold
overrides: &ciscoEnvMonTemperatureStatusTable_overrides
ciscoEnvMonTemperatureLastShutdown:
ignore: true
ciscoEnvMonTemperatureStatusDescr:
ignore: true
ciscoEnvMonTemperatureStatusValueRev1:
ignore: true
ciscoEnvMonTemperatureState:
ignore: true
lookups: &ciscoEnvMonTemperatureStatusTable_lookups
- source_indexes: [ciscoEnvMonTemperatureStatusIndex]
lookup: ciscoEnvMonTemperatureStatusDescr
rename: sensor
revalue:
regex: 'S[^0-9]*([0-9]+), S[^0-9]*([0-9]+).*'
value: '$1.$2'
drop_source_indexes: true
ciscoEnvMonFanStatusTable_template: # 35xx, !N3K
walk: &ciscoEnvMonFanStatusTable_walk
- ciscoEnvMonFanState
overrides: &ciscoEnvMonFanStatusTable_overrides
ciscoEnvMonFanStatusDescr:
ignore: true
# unknown(1), up(2), down(3), warning(4)
lookups: &ciscoEnvMonFanStatusTable_lookups
- source_indexes: [ciscoEnvMonFanStatusIndex]
lookup: ciscoEnvMonFanStatusDescr
rename: fan
revalue:
regex: 'Switch#([0-9]+), Fan#([0-9]+).*'
value: '$1.$2'
drop_source_indexes: true
cefcFanTrayStatusTable_template: # !35xx, N3K
walk: &cefcFanTrayStatusTable_walk
- cefcFanTrayOperStatus
lookups: &cefcFanTrayStatusTable_lookups
- source_indexes: [entPhysicalIndex]
mprefix: [cefcFanTrayOperStatus]
lookup: entPhysicalName
rename: fan
revalue:
regex: 'Fan[^0-9]*([0-9]+)'
value: '$1'
drop_source_indexes: true
ciscoEnvMonSupplyStatusTable_template: # 35xx, !N3K
walk: &ciscoEnvMonSupplyStatusTable_walk
- ciscoEnvMonSupplyState
overrides: &ciscoEnvMonSupplyStatusTable_overrides
ciscoEnvMonSupplyStatusDescr:
ignore: true
ciscoEnvMonSupplySource:
ignore: true
lookups: &ciscoEnvMonSupplyStatusTable_lookups
- source_indexes: [ciscoEnvMonSupplyStatusIndex]
lookup: ciscoEnvMonSupplyStatusDescr
rename: psu
revalue:
regex: 'S[^0-9]*([0-9]+), P[^0-9]*([0-9]+).*'
value: '$1.$2'
drop_source_indexes: true
# cefcFRUPowerSupplyGroupTable_template: !35xx, N3K
# values which do not make any sense wrt. real measured values. Junk!
# walk:
# - cefcFRUPowerSupplyGroupTable.*
entSensorValueTable_template: # !35xx, N3K
walk: &entSensorValueTable_walk
- entSensorValue
overrides: &entSensorValueTable_overrides
entSensorPrecision:
ignore: true # always 0
entSensorValueUpdateRate:
ignore: true # Transceiver: 180s, Other: 60s
entSensorScale:
ignore: true # Transceiver: Bias Current [mA],
# Receive|Transmit Power [dBm/mW],
# Temperature [mC], Voltage [mV]
# Other: °C
entSensorType:
ignore: true # see above
entSensorStatus:
ignore: true # 1 for all shown entries
entSensorValueTimeStamp:
ignore: true # in 100 Hz since boot - same value for all entries
lookups: &entSensorValueTable_lookups
- source_indexes: [entPhysicalIndex]
mprefix: [entSensorValue]
lookup: entPhysicalName
rename: name
revalue:
regex: '.*Transceiver.*' # don't need Xcvr stats
value: '@drop@'
drop_source_indexes: true
#- source_indexes: [entPhysicalIndex]
# lookup: entSensorScale
# rename: scale
# drop_source_indexes: true
#- source_indexes: [entPhysicalIndex]
# lookup: entSensorType
# rename: type
# drop_source_indexes: true
ifTables:
prefix: *prefix
max_repetitions: 50
walk: *ifTable_walk
walk: *ifXTable_walk
walk:
- _dummy
lookups: *ifTable_lookups
cisco_35xx: # ### C35xx , !C3232C
prefix: *prefix
max_repetitions: 50
walk:
- cpmCPUTotalTable
overrides:
<<: *cpmCPUTotalTable_overrides
lookups: *cpmCPUTotalTable_lookups
walk:
- ciscoMemoryPoolTable
overrides:
<<: *ciscoMemoryPoolTable_overrides
lookups: *ciscoMemoryPoolTable_lookups
walk:
- ciscoEnvMonTemperatureStatusTable
overrides:
<<: *ciscoEnvMonTemperatureStatusTable_overrides
lookups: *ciscoEnvMonTemperatureStatusTable_lookups
walk:
- ciscoEnvMonFanStatusTable
overrides:
<<: *ciscoEnvMonFanStatusTable_overrides
lookups: *ciscoEnvMonFanStatusTable_lookups
walk:
- ciscoEnvMonSupplyStatusTable
overrides:
<<: *ciscoEnvMonSupplyStatusTable_overrides
lookups: *ciscoEnvMonSupplyStatusTable_lookups
walk:
- chassisModel # 1.3.6.1.4.1.9.5.1.2.16
- sysUpTime
overrides:
<<: *cisco_chassisModel_overrides
sysUpTime:
type: uptime
regex_extracts:
.boot_time:
- regex: '(.*)'
value: '$1'
lookups: *cisco_chassisModel_lookups
# make snakeyaml happy
walk:
- _dummy
lookups:
- source_indexes: [_dummy]
lookup: _dummy
cisco_n3k: # ### C3232C, !C35xx
prefix: *prefix
max_repetitions: 50
# N3K has no 'chassisModel', so we need to lookit up via entPhysicalClass
walk:
- entPhysicalClass
- sysUpTime
lookups:
- source_indexes: [entPhysicalIndex]
lookup: entPhysicalName
rename: name # keep in sync with *prefix
mprefix: [entPhysicalClass]
drop_source_indexes: true
overrides:
entPhysicalClass:
type: DisplayString # actually it is an Integer
regex_extracts:
.chassisModel:
- regex: 3 # see snmptranslate -Pu -Tp -IR entPhysicalClass
value: 1
sysUpTime:
type: uptime
regex_extracts:
.boot_time:
- regex: '(.*)'
value: '$1'
walk:
- cpmCPUTotalTable
overrides:
<<: *cpmCPUTotalTable_overrides
lookups: *cpmCPUTotalTable_lookups
walk:
- cempMemPoolTable
overrides:
<<: *cempMemPoolTable_overrides
lookups: *cempMemPoolTable_lookups
walk:
- cefcFanTrayOperStatus
lookups: *cefcFanTrayStatusTable_lookups
walk: *entSensorValueTable_walk
lookups: *entSensorValueTable_lookups
# make snakeyaml happy
walk:
- _dummy
lookups:
- source_indexes: [_dummy]
lookup: _dummy