-
Notifications
You must be signed in to change notification settings - Fork 0
/
smartctlmon.tar
1698 lines (1426 loc) · 70 KB
/
smartctlmon.tar
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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
opt/smartctlmon/ 0000755 0000000 0000000 00000000000 13201331311 012705 5 ustar root root opt/smartctlmon/snmp/ 0000755 0000000 0000000 00000000000 13201322306 013666 5 ustar root root opt/smartctlmon/snmp/sbin/ 0000755 0000000 0000000 00000000000 13201303767 014633 5 ustar root root opt/smartctlmon/snmp/sbin/snmpd-smartctl-connector 0000755 0000000 0000000 00000017634 13201276162 021532 0 ustar root root #!/bin/bash -u
# Include snmpd-connector-lib.sh or die.
[[ ! -r ${SNMPD_CONNECTOR_LIB:=/opt/smartctlmon/snmp/lib/snmpd-connector-lib.sh} ]] && echo "Unable to find ${SNMPD_CONNECTOR_LIB}" && exit 1
source ${SNMPD_CONNECTOR_LIB}
# Helper function to get the device path from the devices array using a 1 based index
#
# @in_param $1 - The 1 based index of the device
# @out_param $2 - The path of this device
#
function get_device_path
{
local AINDEX=$((${1} - 1))
eval $2=${DEVICES[${AINDEX}]}
}
# Helper function to get the device file base path from the devices array using a 1 based index
#
# @in_param $1 - The 1 based index of the device
# @out_param $2 - The path of this device
#
function get_device_file_basepath
{
local DEVPATH DEVFILE
# Make the device info filename
get_device_path ${1} DEVPATH
DEVFILE=${DEVPATH##\/}
DEVFILE=${CACHEDIR}/${DEVFILE//\//_}
eval $2=${DEVFILE}
}
# Function to send the index value
#
# @in_param $1 - The OID to send before this data
# @in_param $2 - The index value
#
function send_index
{
# If the index is in range...
if (( $# > 1 )); then
if (( ${2} <= ${#DEVICES[@]} )); then
# Send the OID and the index number.
send_integer ${1} ${2}
return
fi
fi
# Send the OID and NONE.
send_none ${1}
}
# Function to send the device path
#
# @in_param $1 - The OID to send before this data
# @in_param $2 - The index value
#
function send_device_path
{
local DEVPATH
get_device_path ${2} DEVPATH
send_string ${1} ${DEVPATH}
}
# Function to send device info - called: send_device_info OID DEVICE "Info String"
#
# @in_param $1 - The STRING to search for
# @in_param $2 - The OID to send before this data
# @in_param $3 - The index value
function send_device_info
{
local DEVFNAME VALUE
# Make the device info filename
get_device_file_basepath ${3} DEVFNAME
DEVFNAME="${DEVFNAME}_info"
# Find the entry in above file
VALUE=$(grep "${1}" < ${DEVFNAME})
VALUE=${VALUE#${1}}
send_string ${2} "${VALUE}"
}
# Function to send device health - called: send_device_hlth OID DEVICE
#
# @in_param $1 - The OID to send before this data
# @in_param $2 - The index value
#
function send_device_hlth
{
local DEVFNAME VALUES
# Make the device info filename
get_device_file_basepath ${2} DEVFNAME
DEVFNAME="${DEVFNAME}_state"
# Report any marginal errors as not OK
if grep FAILING_NOW < ${DEVFNAME} >/dev/null; then
send_boolean ${1} "F"
return
fi
# Find the entry in above file
VALUES=($(grep "result:" < ${DEVFNAME}))
# If device has no health status, report as OK (would be better to skip OID entirely?)
if [[ "${#VALUES[*]}" -eq 0 ]]; then
send_boolean ${1} "T"
return
fi
[[ "${VALUES[5]}" == "PASSED" ]] && send_boolean ${1} "T" || send_boolean ${1} "F"
}
# Function to send device attribute - called: send_device_attr OID DEVICE "Attribute String" R[aw]|L[ife]
#
# @in_param $1 - The STRING to search for
# @in_param $2 - R to send RAW value, L to send LIFETIME value
# @in_param $3 - The OID to send before this data
# @in_param $4 - The index value
#
function send_device_attr
{
local DEVFNAME VALUES
# Make the device info filename
get_device_file_basepath ${4} DEVFNAME
DEVFNAME="${DEVFNAME}_attr"
# Find the entry in above file
if VALUES=($(grep "${1}" < ${DEVFNAME})); then
case "${2}" in
"R")
if is_positive_integer "${VALUES[9]}"; then
send_gauge "${3}" "${VALUES[9]}"
else
send_gauge "${3}" -1
fi
;;
"L")
if is_positive_integer "${VALUES[3]##0}" && is_positive_integer "${VALUES[5]##0}"; then
send_gauge "${3}" $((${VALUES[3]##0} - ${VALUES[5]##0}))
else
send_gauge "${3}" -1
fi
;;
*)
send_gauge ${3} -1
;;
esac
else
send_gauge ${3} -1
fi
}
# Function to send device temperature - called: send_device_temp OID DEVICE
#
# @in_param $1 - The OID to send before this data
# @in_param $2 - The index value
#
function send_device_temp
{
local DEVFNAME VALUES
# Make the device info filename
get_device_file_basepath ${2} DEVFNAME
DEVFNAME="${DEVFNAME}_attr"
# Find the entry in above file
VALUES=($(grep "Temperature_Celsius" < ${DEVFNAME})) || \
VALUES=($(grep "Airflow_Temperature" < ${DEVFNAME}))
if is_positive_integer "${VALUES[9]}"; then
send_gauge "${1}" "${VALUES[9]}"
else
send_gauge "${1}" -1
fi
}
# Function to get the next index value
#
# @in_param $1 - The (optional) starting index value
# @echo - The new index or nothing if out of range
#
function get_next_index
{
debug_function_enter "get_next_index" ${@}
# If we still have more than one element in the request array then something
# is wrong so log an error and return 0.
if (( $# > 1 )); then
error_echo "get_next_index: called with $# request array elements!"
debug_function_return
return
fi
# If we were passed a starting index...
if (( $# > 0 )); then
# If the passed index is less than the number of devices then return it +1,
# otherwise return 0 to indicate that the index would be out of range.
if (( ${1} < ${#DEVICES[@]} )); then
RETVAL=$(( ${1} + 1 ))
debug_echo "next index is in range, returning ${RETVAL}"
echo "${RETVAL}"
debug_function_return
return
else
debug_echo "next index would be out of range, returning zero"
debug_function_return
return
fi
fi
# If we got this far then we were not passed an index so return the first
# available index.
debug_echo "no index supplied, returning first index"
echo "1"
debug_function_return
return
}
# Init local vars
CMDNAME=$(basename ${0})
CONFIG="/opt/smartctlmon/snmp/etc/snmpd-smartctl-connector"
DEVICES=""
CACHEDIR=""
SNMP_TRANSLATE=""
# Read the config file if we can
[[ -r ${CONFIG} ]] && source ${CONFIG} || die "Unable to read configuration file [${CONFIG}]"
# Check for config values.
[[ -z "${DEVICES}" ]] && die "No DEVICES configured in ${CONFIG}"
[[ -z "${CACHEDIR}" ]] && die "No CACHEDIR configured in ${CONFIG}"
[[ ! -d "${CACHEDIR}" ]] && die "Cache directory [${CACHEDIR}] is not a directory"
[[ ! -r "${CACHEDIR}" ]] && die "Cache directory [${CACHEDIR}] is not readable by $(whoami)"
[[ -z "${SNMP_TRANSLATE}" ]] && die "No SNMP_TRANSLATE command configured in ${CONFIG}"
# Configure base address
BASE_MIB="SMARTCTL-MIB::smartCtl"
# Declare the tables
RTABLE[2]="#ETABLE"
ETABLE[1]="#FTABLE"
FTABLE_INDEX="get_next_index" # Internal function to get next index
FTABLE[1]="send_index" # It is an index request.
FTABLE[2]="send_device_path" # It is for the mapped device path.
FTABLE[3]="send_device_info 'Model Family:'" # It is for the device model-family.
FTABLE[4]="send_device_info 'Device Model:'" # It is for the device device-model.
FTABLE[5]="send_device_info 'Serial Number:'" # It is for the device serial number.
FTABLE[6]="send_device_info 'User Capacity:'" # It is for the device user capacity.
FTABLE[7]="send_device_info 'ATA Version is:'" # It is for the device ATA version.
FTABLE[8]="send_device_hlth" # It is for the overall SMART health state.
FTABLE[9]="send_device_temp" # It is for the device temperature.
FTABLE[10]="send_device_attr 'Reallocated_Sector_Ct' R" # It is for the Reallocated Sector Count of this device.
FTABLE[11]="send_device_attr 'Current_Pending_Sector' R" # It is for the Current Pending Sector count of this device.
FTABLE[12]="send_device_attr 'Offline_Uncorrectable' R" # It is for the Off-line Uncorrectable count of this device.
FTABLE[13]="send_device_attr 'UDMA_CRC_Error_Count' R" # It is for the UDMA CRC Error count of this device.
FTABLE[14]="send_device_attr 'Read_Error_Rate' L" # It is for the Read Error Rate (lifetime) of this device.
FTABLE[15]="send_device_attr 'Seek_Error_Rate' L" # It is for the Seek Error Rate (lifetime) of this device.
FTABLE[16]="send_device_attr 'Hardware_ECC_Recovered' L" # It is for the Hardware ECC recovered (lifetime) of this device.
FTABLE[17]="send_device_info 'Firmware Version:'" # It is for the Firmware Version installed on this device.
# Start the loop
the_loop
opt/smartctlmon/snmp/sbin/update-smartctl-cache 0000755 0000000 0000000 00000010163 13201276435 020735 0 ustar root root #!/bin/bash
function versioninfo
{
VERSION="$Revision$"
VERSION="${VERSION%\ \$}"; VERSION="${VERSION#\:}"; VERSION="${VERSION##\ }"
VERSION="(CVS revision $VERSION)"
NAME="$Name$"
NAME="${NAME%\ \$}"; NAME="${NAME#\:}"; NAME="${NAME##\ }"; NAME="${NAME##release-}"; NAME="${NAME//-/.}"
[[ -n $NAME ]] && NAME="Version $NAME "
echo ${CMDNAME}
echo ${NAME}${VERSION}
echo -e "\n smartctlmon by it community"
echo "This is free software: you are free to change and redistribute it. MIT license"
}
function helpscreen
{
echo "Usage: ${CMDNAME} [OPTION]..."
echo "Maintaines cache files of SMART data for configured devices."
echo
echo " -i, --info-rebuild force a rebuild of the info cache file for all"
echo " devices in addition to the normal attribute and"
echo " health files"
echo " --help display this help and exit"
echo " --version output version information and exit"
}
function error_exit
{
echo "Error: $1" >&2
exit $2
}
# Init local vars
CMDNAME=$(basename ${0})
CONFIG="/opt/smartctlmon/snmp/etc/snmpd-smartctl-connector"
# Read the config file if we can
[[ -r $CONFIG ]] && source $CONFIG
# Process command line switches
while (( $# > 0 ))
do
case $1 in
-i|--info-rebuild)
INFO_REBUILD="YES"
shift 1
;;
--version)
versioninfo
exit
;;
*)
helpscreen
shift 1
exit
;;
esac
done
# If we couldn't open the config file then complain and exit.
[[ ! -r $CONFIG ]] && error_exit "Unable to open configuration file [$CONFIG]" 1
# Check for sensible configuration values.
[[ -z ${DEVICES} ]] && error_exit "No DEVICES defined in $CONFIG" 2
[[ -z ${CACHEDIR} ]] && error_exit "No CACHEDIR defined in $CONFIG" 3
[[ -z ${SMARTCMD} ]] && error_exit "No SMARTCMD defined in $CONFIG" 4
# Check that the cache directory exists and is writable
if [[ ! -d ${CACHEDIR} ]]; then
mkdir -p ${CACHEDIR} || error_exit "Cache directory [$CACHEDIR] does not exist and could not be created" 5
fi
[[ ! -w ${CACHEDIR} ]] && error_exit "Cache directory [$CACHEDIR] is not writable" 6
# Check that the devices list exists...
if [[ -f ${CACHEDIR}/devices ]]; then
# Compare the stored list of devices to the current list.
if [[ "$(cat ${CACHEDIR}/devices)" = ${DEVICES[@]} ]]; then
# Check that the info cache exists for all devices...
for DEVICE in ${DEVICES[@]}; do
DEVFNAME=${DEVICE##\/}
DEVFNAME=${CACHEDIR}/${DEVFNAME//\//_}_info
# ...and set the INFO_REBUILD flag if it doesn't exist or is older than the device node.
if [[ ! -f ${DEVFNAME} ]]; then
INFO_REBUILD="YES"
else
[[ ${DEVFNAME} -ot ${DEVICE} ]] && INFO_REBUILD="YES"
fi
done
else
# The device list doesn't match.
INFO_REBUILD="YES"
fi
else
# The device list doesn't exist.
INFO_REBUILD="YES"
fi
# If the INFO_REBUILD flag is set then completely clean the cache and rebuild the info files for all devices.
if [[ ! -z ${INFO_REBUILD} ]]; then
echo -n "Cleaning cache files..."
rm ${CACHEDIR}/* &> /dev/null
echo "done."
echo -n "Storing device list..."
echo ${DEVICES[@]} > ${CACHEDIR}/devices
echo "done."
echo -n "Rebuilding info files..."
for DEVICE in ${DEVICES[@]}; do
DEVFNAME=${DEVICE##\/}
DEVFNAME=${CACHEDIR}/${DEVFNAME//\//_}_info
${SMARTCMD} -i ${DEVICE} > ${DEVFNAME}
done
echo "done."
fi
# Rebuild the status cache for all devices.
echo -n "Rebuilding state files..."
for DEVICE in ${DEVICES[@]}; do
DEVFNAME=${DEVICE##\/}
DEVFNAME=${CACHEDIR}/${DEVFNAME//\//_}_state
TDEVFNAME=${DEVFNAME}.tmp
${SMARTCMD} -H ${DEVICE} > ${TDEVFNAME}
mv ${TDEVFNAME} ${DEVFNAME}
done
echo "done."
# Rebuild the attribute cache for all devices.
echo -n "Rebuilding attribute files..."
for DEVICE in ${DEVICES[@]}; do
DEVFNAME=${DEVICE##\/}
DEVFNAME=${CACHEDIR}/${DEVFNAME//\//_}_attr
TDEVFNAME=${DEVFNAME}.tmp
${SMARTCMD} -A ${DEVICE} > ${TDEVFNAME}
mv ${TDEVFNAME} ${DEVFNAME}
done
echo "done."
# If the INFO_REBUILD flag is set kill any connector processes.
if [[ ! -z ${INFO_REBUILD} ]]; then
echo -n "Killing any running connectors..."
killall snmpd-smartctl-connector
echo "done."
fi
opt/smartctlmon/snmp/etc/ 0000755 0000000 0000000 00000000000 13201322537 014447 5 ustar root root opt/smartctlmon/snmp/etc/snmpd-smartctl-connector 0000644 0000000 0000000 00000000473 13201275772 021346 0 ustar root root # List (or glob) of disk devices to monitor
DEVICES=(/dev/sd*[a-z])
# Path to cache directory
CACHEDIR=/opt/smartctlmon/snmp/var/lib/smartctl
# Command to run smartctl
SMARTCMD="/usr/sbin/smartctl"
# Command to run snmptranslate
SNMP_TRANSLATE="/usr/bin/snmptranslate"
# Define debug to log lots
# DEBUG="true"
opt/smartctlmon/snmp/etc/snmpd.conf 0000600 0000000 0000000 00000000340 13201322525 016421 0 ustar root root pass .1.3.6.1.4.1.10876 /opt/Supermicro/SuperDoctor5/libs/native/snmpagent
pass_persist .1.3.6.1.4.1.38696.2.1 /bin/bash /opt/smartctlmon/snmp/sbin/snmpd-smartctl-connector
#example community
rocommunity public localhost
opt/smartctlmon/snmp/lib/ 0000755 0000000 0000000 00000000000 13201322260 014433 5 ustar root root opt/smartctlmon/snmp/lib/snmpd-connector-lib.sh 0000640 0000000 0000000 00000035776 13201322235 020664 0 ustar root root # Check if we have been included already
[[ -n "${SNMPD_CONNECTOR_LIB_LOADED+x}" ]] && return || SNMPD_CONNECTOR_LIB_LOADED="true"
# We rely on some functions from hk-bash.sh
[[ -r ${SMARTCTL_MON_LIB_PATH:=/opt/smartctlmon/snmp/lib/hk-bash.sh} ]] && \
source ${SMARTCTL_MON_LIB_PATH} || \
{ echo "Unable to find ${SMARTCTL_MON_LIB_PATH}"; exit 1; }
# Functions to handle request types
function handle_ping
{
echo "PONG"
}
# Function to handle an unknown query
#
# @in_param $1 - The query type.
#
function handle_unknown_query
{
error_echo "ERROR [Unknown Query]"
[[ -n ${DEBUG} ]] && logger -p local1.warn "Unknown query: ${1}"
}
# Function to handle a query for an unknown OID
#
# @in_param $1 - The OID this query was for.
#
function handle_unknown_oid
{
send_none
debug_echo "GET request for unknown OID: ${1}"
}
# Function to handle a SET request.
#
function handle_set
{
local OID VALUE
read OID
read VALUE
echo "not-writable"
debug_echo "Attempt to SET ${OID} to ${VALUE}"
}
# Function to get the request OID
#
function get_request_oid
{
local TOID
# Read the OID this request is for
read TOID
eval $1=${TOID}
}
# Function to split the requested OID into component parts
#
# @in_param $1 - The base OID which this should be a request for
# @in_param $2 - The OID to split
# @out_param $3 - An array containing the request elements
#
function split_request_oid
{
local ROID RFA BWD
# If the requested OID doesn't start with our base OID then we're done already.
if [[ "${2}" != ${1}* ]]; then
send_none
debug_echo "unknown base OID: ${2}"
return 1
fi
# Split off our BASE_OID to get a R[elative]OID and then remove the leading "." of that ROID.
BWD="${1}"
ROID=${2#${BWD}}
ROID=${ROID#.}
# If we got no R[elative]OID then we're done already.
[[ -z "${ROID}" ]] && return 2
# Split the ROID around the dots to get the fields for this request to get a R[equest]F[ield]A[rray].
IFS="."
RFA=(${ROID})
unset IFS
# If we got some array elements then place them in $3 and indicate success
if (( ${#RFA[@]} > 0 )); then
eval "$3=(${RFA[@]})"
return
fi
# Indicate failure.
return 3
}
# Function to get and split the request OID
#
# @in_param $1 - The base OID to split off first
# @out_param $2 - The complete OID
# @out_param $3 - An array containing the request elements
#
function get_and_split_request_oid
{
local TOID RAY=""
# Read the OID this request is for
read TOID
# If we were passed an empty string then we're done already.
[[ -z "${TOID}" ]] && return 1
eval "$2=\"${TOID}\""
split_request_oid $1 ${TOID} RAY
[[ $? ]] && eval "$3=(${RAY[@]})" || return 2
}
# Helper function to send NONE
#
# @in_param $1 - The (optional) OID to send before the data
#
function send_none
{
if (( $# > 0 )); then
echo ${1}
echo "NONE"
echo "N/A"
debug_echo "Sent [${1}] NONE N/A"
else
echo "NONE"
debug_echo "Sent NONE"
fi
}
# Helper function to send an integer - called: send_integer OID value
#
# @in_param $1 - The OID to send before the data
# @in_param $2 - The VALUE to send
#
function send_integer
{
debug_echo "Sent ${1} INTEGER ${2}"
echo ${1}
echo "integer"
echo ${2}
}
# Helper function to send an integer - called: send_boolean OID value
#
# @in_param $1 - The OID to send before the data
# @in_param $2 - The VALUE to send (T for true, F for false)
#
function send_boolean
{
debug_echo "Sent ${1} TruthValue ${2}"
echo ${1}
echo "integer"
[[ ${2} == "T" ]] && echo 1 || echo 2
}
# Helper function to send a string - called: send_string OID value
#
# @in_param $1 - The OID to send before the data
# @in_param $2 - The VALUE to send
#
function send_string
{
debug_echo "Sent ${1} STRING ${2}"
echo ${1}
echo "string"
echo ${2}
}
# Helper function to send a gauge - called: send_gauge OID value
#
# @in_param $1 - The OID to send before the data
# @in_param $2 - The VALUE to send
#
function send_gauge
{
debug_echo "Sent ${1} GAUGE ${2}"
echo ${1}
echo "gauge"
echo ${2}
}
# Function to handle GETNEXT requests
#
# @in_param $1 - The name of an array, prefixed with a #, from which to retrieve
# either the command to execute or the name of another array.
# @in_param $2 - The OID to send along with this request
# @in_param $3 - The base OID this is a request for
# @in_param $+ - An array containing the request elements
#
function handle_getnext
{
debug_function_enter "handle_getnext" ${@}
local TABLE SOID BOID RA NEXTOID
# Extract parameters
TABLE="${1}"; shift
SOID="${1}"; shift
BOID="${1}"; shift
RA="${@}"
# If we were not passed the name of a table in $1 then we're done so log an
# error, send NONE and return.
if [[ "${TABLE}" != \#* ]]; then
error_echo "handle_getnext: parameter 1 is not a table!"
send_none
debug_function_return 1
return 1
fi
# Get the next OID.
NEXTOID=$(get_next_oid ${TABLE} ${BOID} ${RA})
[[ -n "${NEXTOID}" ]] && debug_echo "got NEXTOID = ${NEXTOID}"
# If we didn't get a next OID then log a warning and send NONE instead and
# return.
if [[ -z "${NEXTOID}" ]]; then
debug_echo "got no NEXTOID, using NONE instead"
send_none
debug_function_return 1
return 1
fi
# Handle the new request.
local RARRAY
split_request_oid ${BOID} ${NEXTOID} RARRAY
handle_get ${TABLE} ${NEXTOID} ${BOID} ${RARRAY[@]}
debug_function_return
}
# Function to get the next OID
#
# @in_param $1 - The name of an array, prefixed with a #, from which to retrieve
# either the command to execute or the name of another array.
# @in_param $2 - The base OID this is a request for.
# @in_param $+ - An array containing the request elements, if any.
#
function get_next_oid
{
debug_function_enter "get_next_oid" ${@}
local TABLE BOID INDEX DTABLE NEWOID NINDEX
# Extract parameters, ${@} will now contain the request elements (if any).
TABLE="${1}"; shift
TABLE="${TABLE#\#}"
BOID="${1}"; shift
# If we have no request elements then this is a speculative query to find the first OID
if (( $# == 0 )); then
debug_echo "got speculative request"
# Find the first index in the table
INDEX=$(get_next_array_index $TABLE)
debug_echo "found first index [${INDEX}]"
DTABLE="${TABLE}[${INDEX}]"
debug_echo "calculated table variable: ${DTABLE}"
# If the deferenced value of DTABLE starts with a # then it is a redirect to
# another table.
if [[ "${!DTABLE}" == \#* ]]; then
debug_echo "found a redirect to a table: ${!DTABLE}"
NEWOID=$(get_next_oid ${!DTABLE} ${BOID}.${INDEX})
debug_echo "got new OID: ${NEWOID}"
echo ${NEWOID}
debug_function_return
return
fi
# If we got this far then we have found a command in the table, not a redirect to
# another table. To see if it is an indexed command (a table) we will look for an
# index function.
local INDEX_FUNCTION_VARIABLE
debug_echo "found a command"
INDEX_FUNCTION_VARIABLE="${TABLE}_INDEX"
is_defined_and_set ${INDEX_FUNCTION_VARIABLE}
if (( $? == 0 )); then
debug_echo "found an index function: ${!INDEX_FUNCTION_VARIABLE}"
NINDEX=$(${!INDEX_FUNCTION_VARIABLE})
debug_echo "got next table index: ${NINDEX}"
NEWOID="${BOID}.${INDEX}.${NINDEX}"
debug_echo "calculated OID: ${NEWOID}"
echo ${NEWOID}
debug_function_return
return
fi
# If we got this far then we have found a command in the table, not a redirect to
# another table AND it is NOT an indexed command (a table). We can return the
# BASE OID + the index we calculated earlier.
debug_echo "no index function found"
NEWOID="${BOID}.${INDEX}"
debug_echo "calculated OID: ${NEWOID}"
echo ${NEWOID}
debug_function_return
return
fi
# If we got this far then we have some request elements in ${@}.
debug_echo "got addressed request"
INDEX="${1}"
shift
debug_echo "passed index [${INDEX}]"
# If the index value is zero then use the first available index.
(( ${INDEX} == 0 )) && INDEX=$(get_next_array_index $TABLE)
# Calculate table variable
DTABLE="${TABLE}[${INDEX}]"
debug_echo "calculated table variable: ${DTABLE}"
# If the deferenced value of DTABLE starts with a # then it is a redirect to
# another table.
if [[ "${!DTABLE}" == \#* ]]; then
# Try to get the next OID from this table
debug_echo "found a redirect to a table: ${!DTABLE}"
NEWOID=$(get_next_oid ${!DTABLE} ${BOID}.${INDEX} ${@})
# If we got a new OID then...
if [[ -n "${NEWOID}" ]]; then
debug_echo "got new OID: ${NEWOID}"
echo ${NEWOID}
debug_function_return
return
fi
# We didn't get a new OID so try to find the next OID from the next entry
# in the current table.
debug_echo "no new OID"
NINDEX=$(get_next_array_index $TABLE $INDEX)
if [[ -n "${NINDEX}" ]]; then
DTABLE="${TABLE}[${NINDEX}]"
debug_echo "using next table entry: ${DTABLE}"
# If the deferenced value of DTABLE starts with a # then it is a redirect to
# another table.
if [[ "${!DTABLE}" == \#* ]]; then
debug_echo "found a redirect to a table: ${!DTABLE}"
NEWOID=$(get_next_oid ${!DTABLE} ${BOID}.${NINDEX})
debug_echo "got new OID: ${NEWOID}"
else
NEWOID="${BOID}.${NINDEX}"
debug_echo "calculated new OID: ${NEWOID}"
fi
echo ${NEWOID}
debug_function_return
return
fi
debug_echo "no next table entry after: ${TABLE}[${INDEX}]"
debug_function_return
return
fi
# If we got this far then we have found a command in the table, not a redirect to
# another table. To see if it is an indexed command (a table) we will look for an
# index function.
local INDEX_FUNCTION_VARIABLE
debug_echo "found a command"
INDEX_FUNCTION_VARIABLE="${TABLE}_INDEX"
is_defined_and_set ${INDEX_FUNCTION_VARIABLE}
if (( $? == 0 )); then
debug_echo "found an index function: ${!INDEX_FUNCTION_VARIABLE}"
# If we have a starting index use it, otherwise get the first index
(( $# > 0 )) && NINDEX=$(${!INDEX_FUNCTION_VARIABLE} ${1}) || NINDEX=$(${!INDEX_FUNCTION_VARIABLE})
# If we got a next index from the index function then return it.
if [[ -n "${NINDEX}" ]]; then
debug_echo "got next table index: ${NINDEX}"
NEWOID="${BOID}.${INDEX}.${NINDEX}"
debug_echo "calculated OID: ${NEWOID}"
echo ${NEWOID}
debug_function_return
return
fi
# If we got this far then the index would be out of range so we need to move on
# to the next table entry.
debug_echo "next index would be out of range"
NINDEX=$(get_next_array_index $TABLE $INDEX)
if [[ -n "${NINDEX}" ]]; then
DTABLE="${TABLE}[${NINDEX}]"
debug_echo "using next table entry: ${DTABLE}"
NTINDEX=$(${!INDEX_FUNCTION_VARIABLE})
NEWOID="${BOID}.${NINDEX}.${NTINDEX}"
debug_echo "calculated OID: ${NEWOID}"
echo ${NEWOID}
fi
debug_function_return
return
fi
# If we got this far then we have found a command in the table, not a redirect to
# another table AND it is NOT an indexed command (a table).
debug_echo "no index function found"
# Calculate the new index
NINDEX=$(get_next_array_index $TABLE $INDEX)
# If we got a new index then create a new OID and return it.
if [[ -n "${NINDEX}" ]]; then
NEWOID="${BOID}.${NINDEX}"
debug_echo "calculated OID: ${NEWOID}"
echo ${NEWOID}
debug_function_return
return
fi
# If we got this far then we have no next index so return nothing.
debug_echo "no next index found after: ${TABLE}[${INDEX}]"
debug_function_return
}
# Function to handle GET requests
#
# @in_param $1 - The name of an array, prefixed with a #, from which to retrieve
# either the command to execute or the name of another array.
# @in_param $2 - The OID to send along with this request
# @in_param $3 - The base OID this is a request for
# @in_param $+ - An array containing the request elements
#
function handle_get
{
debug_function_enter "handle_get" ${@}
local BOID SOID TABLE RA COMMAND
# Extract parameters
TABLE="${1}"; shift
SOID="${1}"; shift
BOID="${1}"; shift
RA=(${@})
# If we were not passed the name of a table in $1 then we're done so log an
# error, send NONE and return.
if [[ "${TABLE}" != \#* ]]; then
error_echo "handle_get: parameter 1 is not a table!"
send_none ${SOID}
debug_function_return 1
return 1
fi
# If the R[equest]A[array] does not contain any elements then we're done so
# log an error, send NONE and return.
if (( ${#RA[@]} == 0 )); then
debug_echo "R[equest]A[array] is empty already!"
send_none ${SOID}
debug_function_return 1
return 1
fi
# If the next R[equest]A[array] element is 0 then it is an index request so
# send the OID and NONE.
if (( ${RA[0]} == 0 )); then
debug_echo "RA[0] is zero, index request"
send_none ${SOID}
debug_function_return
return
fi
# We were passed the name of a table so strip the leading #, make the variable
# name.
TABLE="${TABLE#\#}"
TABLE="${TABLE}[${RA[0]}]"
debug_echo "calculated table variable: ${TABLE}"
# Check that something is defined for this entry. If it isn't log an error,
# send NONE and return.
if [[ -z ${!TABLE+defined} ]]; then
debug_echo "table entry is empty!"
send_none ${SOID}
debug_function_return 1
return 1
fi
# If the deferenced value of TABLE starts with a # then it is a redirect to
# another table, if not it is a command.
if [[ "${!TABLE}" == \#* ]]; then
# We have another table. Simply call handle_get with the new table name,
# BOID and RA.
handle_get ${!TABLE} ${SOID} ${BOID}.${RA[0]} ${RA[@]:1}
else
# We have a command. Get it from the table, add the SOID, new BOID and
# remaining R[equest]A[array] and eval it.
COMMAND="${!TABLE} ${SOID} ${RA[@]:1}"
debug_echo "found command in table: \"${COMMAND}\""
eval "${COMMAND}"
fi
debug_function_return
}
# Main functional loop
function the_loop
{
# Declare local variables
local QUIT QUERY BASE_OID OID RARRAY
# Try to resolve the numeric base oid from the base mib.
BASE_OID="$(${SNMP_TRANSLATE} -On ${BASE_MIB})"
(( $? != 0 )) && die "Unable to resolve base OID from ${BASE_MIB}"
# Loop until we are instructed to quit
QUIT=0
while (( ${QUIT} == 0 )); do
# Get the SNMP query type and convert to lower case.
read QUERY
QUERY=${QUERY,,}
# What kind of request is this?
case ${QUERY} in
"ping") # Handle PING request
handle_ping
;;
"quit"|"exit"|"") # Handle QUIT or EXIT request
echo "Bye"
exit
;;
"get") # Handle GET requests
get_and_split_request_oid ${BASE_OID} OID RARRAY
(( ${#RARRAY[@]} > 0)) && handle_get "#RTABLE" ${OID} ${BASE_OID} ${RARRAY[@]} || send_none ${OID}
;;
"getnext") # Handle GETNEXT requests
get_and_split_request_oid ${BASE_OID} OID RARRAY
(( ${#RARRAY[@]} > 0)) && RARRAY="${RARRAY[@]}" || RARRAY=""
handle_getnext "#RTABLE" ${OID} ${BASE_OID} ${RARRAY}
;;
"set") # Handle SET requests
handle_set
;;
*) # Handle unknown commands
handle_unknown_query ${QUERY}
;;
esac
done
}
function test_walk_oids
{