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
|
--
-- (C) 2019-22 - ntop.org
--
local alert_severities = require "alert_severities"
local alert_consts = require("alert_consts")
local alerts_api = require("alerts_api")
local snmp_utils = require "snmp_utils"
-- This is a user script executed by scripts/callbacks/system/snmp_device.lua .
-- The SNMP devices must be already configured from the System -> SNMP page.
-- Changes to this script must be applied by reloading the plugins from
-- http://127.0.0.1:3000/lua/plugins_overview.lua
local global_state = nil
-- #################################################################
local script = {
-- Script category, see checks.check_categories for all available categories
category = checks.check_categories.other,
-- This module is enabled by default
default_enabled = true,
-- The default configuration for this plugin. The current configuration
-- is passed to the script hooks as the second parameter.
default_value = {
-- This configuration is specific of this script
some_setting = "my custom config value",
},
-- A user script must be attached some hooks in order to be executed.
-- This is only a placeholder, see below for the hooks definitions.
-- NOTE: the "all" hook is a virtual hook which causes the script to
-- be attached to all the available hooks.
hooks = {},
-- GUI specific stuff. If this section is missing, the user script
-- will not be shown in the gui.
gui = {
-- A title for this user script
i18n_title = "example.snmp_script_title",
-- A description for this user script
i18n_description = "example.snmp_script_description",
},
----------------------------------------------------------------------
-- If true, the script will be automatically disabled when alerts are
-- disabled.
-- If true, this script will only be executed on packet interfaces
packet_interface_only = false,
-- If true, this script will only be executed in nEdge
nedge_only = false,
-- If true, this script will not be executed in nEdge
nedge_exclude = false,
-- If true, this script will not be available on Windows.
windows_exclude = false,
----------------------------------------------------------------------
-- Skip virtual interfaces (e.g. loopback) in the "snmpDeviceInterface" hook
skip_virtual_interfaces = true,
}
-- #################################################################
-- @brief Called when the script is going to be loaded.
-- @return true if the script should be loaded, false otherwise
-- @notes Can be used to init some script global state or to skip the script
-- execution on some particular conditions
function script.setup()
local is_enabled = true -- your custom condition here
global_state = {}
return(is_enabled)
end
-- #################################################################
-- An hook executed at every poll of the SNMP device.
-- @param device_ip the SNMP device IP address
-- @param info information about the device and its interfaces.
function script.hooks.snmpDevice(device_ip, info)
local device_name = snmp_utils.get_snmp_device_sysname(device_ip)
print("SNMP:snmpDevice hook called: " .. device_ip)
local alert_info = {
alert_type = alert_consts.alert_types.alert_example,
alert_severity = alert_severities.notice,
alert_granularity = info.granularity,
alert_type_params = {
device = device_ip,
device_name = device_name,
},
}
if isSNMPDeviceUnresponsive(device_ip) then
-- Trigger alert
alerts_api.trigger(info.alert_entity, alert_info)
else
-- Release previously triggered alert
alerts_api.release(info.alert_entity, alert_info)
end
end
-- #################################################################
-- An hook executed at every poll of the SNMP device, for each interface.
-- @param device_ip the SNMP device IP address
-- @param device_name the SNMP device name
-- @param if_index numeric index of the interface
-- @param info information about the interface
-- @notes Check out skip_virtual_interfaces
function script.hooks.snmpDeviceInterface(device_ip, if_index, info)
local device_name = snmp_utils.get_snmp_device_sysname(device_ip)
print("SNMP:snmpDeviceInterface hook called: " .. device_ip .. "@" .. if_index)
alerts_api.store(info.alert_entity, {
alert_type = alert_consts.alert_types.alert_example,
alert_severity = alert_severities.warning,
alert_type_params = {
device = device_ip,
device_name = device_name,
interface = if_index,
interface_name = info["name"],
},
})
end
-- #################################################################
return script
|
