Terminology¶
MONITORING PACKS:
A Monitoring Pack is a model or configuration profile of WOCU, which performs a certain monitoring function. They are created and designed according to the most actually technologies.
CATEGORY:
The Categories are a group of classes or attributes that allow group and filtered of Monitoring Packs according to technical and functional aspects. The Categories are not fixed, their creation is continuous and will depend on the appearance of new technological needs.
SERVICE:
A Service is each one of the checks that WOCU makes in a host, to associate an availability state after the check of each of them.
MACRO:
Macros are configurable elements through Packs, that WOCU uses internally to store properties and information of the monitored assets. There are two types:
- Simple Macro: stores a single value.
- Complex Macro: stores a multitude of values into a table.
CHECK COMMAND:
Commands launched to check the state of a specific parameter, that you want to know of a host (CPU, hard disk space, RAM used, etc.).
DISCOVER:
WOCU functionality to automatically set values for specific macros.
Introduction¶
WOCU is a monitoring system and network supervision, that provide detailed information about the status and availability of monitored assets, integrated into reduced or extended technological infrastructures. It can manage and monitor discovered assets automatically, running a fast process without failures, and most importantly without interaction by the user.
For that, the configuration and start-up of two elements is essential:
Import Tasks
These are automatic import systems, that trace and discover assets operating in the network, obtaining its most outstanding properties. They are configured through a few simple steps for the high massive and / or automatic asset updating from multiple sources.
The newly imported assets pass first and provisionally to the list of Pending Assets. Already integrated in WOCU they will not be monitored until their transfer to list of Active Assets or temporarily sent to Blacklisted Assets list, where they will be isolated and out of the monitoring. This process is manual and requires the supervision of a user.
Hosted in Pending Assets, or in Operative Assets, it is possible to configure the monitoring profile of the assets, assignment Monitoring Packs.
This independent process is important because it is the basis of our inventory of monitoring, and will be used in the next phase to give intelligence to the rest of the system.
Monitoring Packs
A Monitoring Pack is a model or configuration profile of WOCU, which performs a certain monitoring function. They are created and designed according to the most actually technologies.
When a host is imported through a Task, WOCU determines its typology or function and assigns it a Monitoring Packs. For this reason the configuration is simple, agile, fast and without having to resort to other external tools. Positioning WOCU as a totally self-sufficient and proactive tool.
The user can use the suggested Monitoring Packs, edit or complete their configuration, or choose other different packs that adapt to their needs.
There are Monitoring Packs designed for technologies or manufacturers (Cisco, Palo Alto, Linux, Windows, etc.), oriented at certain configurations of the hosts (MySQL-Server, http-Proxy, Hsrp-Cisco, etc.), for certain technical aspects (QOS, Networkdevice-Mem), or generic packs that are adapt to different types of hosts (Networkdevice-Traffic, Snmp-Generic, etc.).
Configuration
Each pack has a set of macros, configuration variables that WOCU applies internally to store properties of the monitored assets. These variables are associated with services, which according to the configuration of the macro, will change its behavior. For example, the macro _MEMORY_CRIT, which defines the critical percentage threshold of the physical memory used, affects the Memory service, which measures the memory of a host.
To obtain values, the services launch a Check_Command, to identify the appropriate commands for the request and return the results. In the previous example, the command should collect the percentage of memory used.
In conclusion, services and commands are preserved, but depending of the associated pack and configured macros, different results will be obtained for each monitored host.
Important
The documentation of this chapter is self-generated from the information stored in the own pack definitions. For this reason, it may contain some inconsistencies or missing information that will be completed and updated over time. Along with the rest of the documentation, this chapter is also written in english because all packs are registered and documented this way. The creation of packs is continuous and will depend on the appearance of new functional and technological requirements, so the packs catalog will grow.
Pack categories¶
Network¶
Allot_nms¶
DESCRIPTION
Gets metrics in Allot Network Management System devices using SNMP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Board Temperature Range | Checks the board temperature | board_temperatur e_range | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPU Average | Checks the average use of CPU | cpu_avg | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| FANs status | Checks the status of fans | fans_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Virtual channels | Checks the number of virtual channels | virtual_channels | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTVIRTUAL_C HANNELS_DEFAULT _WARNING _HOSTVIRTUAL_C HANNELS_DEFAULT _CRITICAL |
| Software status | Checks the software status | software_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Active lines | Checks the number of active lines | active_lines | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTLINES_WAR NING _HOSTLINES_CRI TICAL |
| Hardware status | Checks the hardware status | hardware_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Disk Usage | Checks the storage usage | disk_usage | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTDISK_WARN ING _HOSTDISK_CRIT ICAL |
| Protocol update licence | Checks the expiration date of Allot protocol update | protocol_update | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTPROTOCOL_ UPDATE_WARNING |
| allot_uptime | Checks the device uptime | uptime | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTUPTIME_WA RNING _HOSTUPTIME_CR ITICAL |
| Connection establishment rate | Checks the connection establishment rate | connection_est | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCONNECTION _WARNING _HOSTCONNECTION _CRITICAL |
| Pipes | Checks the number of pipes | pipes | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTPIPES_WAR NING _HOSTPIPES_CRI TICAL |
| PowerSupply status | Checks the status of power supplies | powersupply_stat us | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Sensors Temperature | Checks the temperature obtained from sensors | sensor_temperatu re | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTSENSOR_TE MP_WARNING _HOSTSENSOR_TE MP_CRITICAL |
| RAM Usage | Checks the main memory usage | mem_usage | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTRAM_WARNI NG _HOSTRAM_CRITI CAL |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _CPU_WARNING | CPU warning threshold (percentage) | percent |
| _CPU_CRITICAL | CPU critical threshold (percentage) | percent |
| _RAM_WARNING | RAM warning threshold (percentage) | percent |
| _RAM_CRITICAL | RAM critical threshold (percentage) | percent |
| _DISK_WARNING | Disk warning threshold (percentage) | percent |
| _DISK_CRITICAL | Disk critical threshold (percentage) | percent |
| _SENSOR_TEMP_WARNING | Temperature(celsius) warning threshold | integer |
| _SENSOR_TEMP_CRITICAL | Temperature(celsius) critical threshold | integer |
| _UPTIME_WARNING | Time (seconds) warning threshold | integer |
| _UPTIME_CRITICAL | Time (seconds) critical threshold | integer |
| _CONNECTION_WARNING | Connection establishment rate warning threshold | integer |
| _CONNECTION_CRITICAL | Connection establishment rate critical threshold | integer |
| _LINES_WARNING | Active lines warning threshold | integer |
| _LINES_CRITICAL | Active lines critical threshold | integer |
| _PIPES_WARNING | Total number of pipes warning threshold | integer |
| _PIPES_CRITICAL | Total number of pipes critical threshold | integer |
| _VIRTUAL_CHANNELS_DEFAULT_WA RNING | Total number of vc’s warning threshold | integer |
| _VIRTUAL_CHANNELS_DEFAULT_CR ITICAL | Total number of vc’s critical threshold | integer |
| _PROTOCOL_UPDATE_WARNING | Days to expire the license of Allot protocol update | integer |
Aruba-alcatel-wifi-controller¶
DESCRIPTION
Checks for Aruba/Alcatel Controllers and its associated APs
Supported devices: Aruba Mobility Controllers (7000 Series)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Controller_memor y | Checks the controller memory usage | check_aruba_alc atel_controller_mem | _HOSTSNMPCOMMUN ITY _HOSTMEM_WARNI NG_THRESHOLD _HOSTMEM_CRITI CAL_THRESHOLD _HOSTSNMPVERSIO N |
| Channel_utilizat ion $KEY$ | Checks the channel utilization | check_aruba_alc atel_channel_ut ilization | _HOSTSNMPCOMMUN ITY _HOSTCHANNEL_U TIL_WARNING_TH RESHOLD _HOSTCHANNEL_U TIL_CRITICAL_T HRESHOLD _HOSTSNMPVERSIO N _CHLIST |
| Controller_Fans | Checks the fans status from the controller | check_aruba_alc atel_controller_fans | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Channel_intefere nce $KEY$ | Checks the radio channel inteference | check_aruba_alc atel_channel_in terference | _HOSTSNMPCOMMUN ITY _HOSTCHANNEL_I NTERF_WARNING_ THRESHOLD _HOSTCHANNEL_I NTERF_CRITICAL_THRESHOLD _HOSTSNMPVERSIO N _CHLIST |
| AP_uptime $KEY$ | Checks the Access Point uptime | check_aruba_alc atel_ap_uptime | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTAP_MIN_U PTIME _APLIST |
| Controller_disks | Checks the controller storage usage | check_disks_aru ba_alcatel_cont roller | _HOSTSNMPCOMMUN ITY _HOSTDISKS_WAR NING_THRESHOLD _HOSTDISKS_CRI TICAL_THRESHOLD _HOSTSNMPVERSIO N |
| Channel_bandwidt h $KEY$ | Checks the bandwidth per radio channel | check_aruba_alc atel_channel_ba ndwidth | _HOSTSNMPCOMMUN ITY _HOSTCHANNEL_B W_WARNING_THRE SHOLD _HOSTCHANNEL_B W_CRITICAL_THR ESHOLD _HOSTSNMPVERSIO N _CHLIST |
| WLAN_ESSIDs | Shows the WLAN essids running in the controller | check_aruba_alc atel_essid | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Controller_ap_c ount | Checks the number of Access Points connected to the controller | check_ap_count_aruba_alcatel_ controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Radio_Bytes $KEY$ | Checks the bytes per radio channel | check_aruba_alc atel_controller_radio_bytes | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _CHLIST |
| Radio_TX_Bytes $KEY$ | Checks the TX bytes per radio channel | check_aruba_alc atel_controller_radio_bytes_tx | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _CHLIST |
| Controller_Power _Supply | Checks the status of controller power supplies | check_aruba_alc atel_controller_power_supply | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Radio_Info $KEY$ | Shows radio channel info | check_aruba_alc atel_ap_radio_ info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _CHLIST |
| AP_Info $KEY$ | Shows Access Point info | check_aruba_alc atel_ap_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _APLIST |
| AP_Clients $KEY$ | Checks the number of clients per Access Point | check_aruba_alc atel_ap_clients | _HOSTSNMPCOMMUN ITY _HOSTAP_CLIENT S_WARNING_THRE SHOLD _HOSTAP_CLIENT S_CRITICAL_THR ESHOLD _HOSTSNMPVERSIO N _APLIST |
| AP_status $KEY$ | Checks the Access Point status | check_aruba_alc atel_ap_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _APLIST |
| WLAN_Clients | Checks the clients connected per WLAN | check_aruba_alc atel_controller_wlan_clients | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTWLAN_CLIE NTS_WARNING _HOSTWLAN_CLIE NTS_CRITICAL |
| Channel_clients $KEY$ | Checks the number of clients per radio channel | check_aruba_alc atel_channel_cl ients | _HOSTSNMPCOMMUN ITY _HOSTCHANNEL_C LIENTS_WARNING_THRESHOLD _HOSTCHANNEL_C LIENTS_CRITICAL _THRESHOLD _HOSTSNMPVERSIO N _CHLIST |
| Radio_non_unica st $KEY$ | Checks the non unicast packets per radio channel | check_aruba_alc atel_controller_radio_non_unic ast | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTNON_UNICA ST_WARNING _HOSTNON_UNICA ST_CRITICAL _CHLIST |
| Radio_TX_Throug hput $KEY$ | Checks the TX throughput per radio channel | check_aruba_alc atel_controller_radio_tx | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTRADIO_TX_WARNING _HOSTRADIO_TX_CRITICAL _CHLIST |
| Controller_cpu | Checks the controller cpu usage | check_cpu_aruba _alcatel_contro ller | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG_THRESHOLD _HOSTCPU_CRITI CAL_THRESHOLD _HOSTSNMPVERSIO N |
| Radio_RX_Bytes $KEY$ | Checks the RX bytes per radio channel | check_aruba_alc atel_controller_radio_bytes_rx | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _CHLIST |
| AP_bandwidth $KEY$ | Checks the bandwidth per Access Point | check_aruba_alc atel_ap_bandwid th | _HOSTSNMPCOMMUN ITY _HOSTAP_BW_WA RNING_THRESHOLD _HOSTAP_BW_CR ITICAL_THRESHOL D _HOSTSNMPVERSIO N _APLIST |
| Controller_Temp | Checks the controller temperature | check_aruba_alc atel_controller_temp | _HOSTSNMPCOMMUN ITY _HOSTTEMP_WARN ING_THRESHOLD _HOSTTEMP_CRIT ICAL_THRESHOLD _HOSTSNMPVERSIO N |
| Radio_RX_Throug hput $KEY$ | Checks the RX throughput per radio channel | check_aruba_alc atel_controller_radio_rx | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTRADIO_RX_WARNING _HOSTRADIO_RX_CRITICAL _CHLIST |
| Client_SNR_avg | Checks the average of client Signal to Noise Ratio (SNR) | check_aruba_alc atel_client_snr _average | _HOSTSNMPCOMMUN ITY _HOSTCLIENT_SN R_WARNING_THRE SHOLD _HOSTCLIENT_SN R_CRITICAL_THR ESHOLD _HOSTSNMPVERSIO N |
| WLAN_Throughput | Checks the throughput per WLAN | check_aruba_alc atel_controller_wlan_throughput | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTWLAN_THRO UGHPUT_WARNING _HOSTWLAN_THRO UGHPUT_CRITICAL |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_APLIST:
wocu-discover-aruba-alcatel-wifi-aps.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$_CHLIST:
wocu-discover-aruba-wifi-controller-channels.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | SNMP version to use in the check | string |
| _CPU_WARNING_THRESHOLD | CPU warning threshold (percent) | percent |
| _CPU_CRITICAL_THRESHOLD | CPU critical threshold (percent) | percent |
| _MEM_WARNING_THRESHOLD | Memory warning threshold (percent) | percent |
| _MEM_CRITICAL_THRESHOLD | Memory critical threshold (percent) | percent |
| _DISKS_WARNING_THRESHOLD | Disks ocupation warning threshold (percent) | percent |
| _DISKS_CRITICAL_THRESHOLD | Disks ocupation critical threshold (percent) | percent |
| _AP_MIN_UPTIME | AP Critical below this number of second after boot time | integer |
| _CHANNEL_UTIL_WARNING_THRESH OLD | Channel utilization warning threshold (percent) | percent |
| _CHANNEL_UTIL_CRITICAL_THRES HOLD | Channel utilization critical threshold (percent) | percent |
| _CHANNEL_INTERF_WARNING_THRE SHOLD | Channel interference warning threshold | integer |
| _CHANNEL_INTERF_CRITICAL_THR ESHOLD | Channel interference critical threshold | integer |
| _CHANNEL_CLIENTS_WARNING_THR ESHOLD | Channel clients warning threshold | integer |
| _CHANNEL_CLIENTS_CRITICAL_TH RESHOLD | Channel clients critical threshold | integer |
| _AP_CLIENTS_WARNING_THRESHOL D | AP clients warning threshold | integer |
| _AP_CLIENTS_CRITICAL_THRESHO LD | AP clients critical threshold | integer |
| _CHANNEL_BW_WARNING_THRESHOL D | Channel bandwidth warning threshold (in kbps) | integer |
| _CHANNEL_BW_CRITICAL_THRESHO LD | Channel bandwidth critical threshold (in kbps) | integer |
| _AP_BW_WARNING_THRESHOLD | AP bandwidth warning threshold (in kbps) | integer |
| _AP_BW_CRITICAL_THRESHOLD | AP bandwidth critical threshold (in kbps) | integer |
| _CLIENT_SNR_WARNING_THRESHOL D | Client average SNR warning threshold | integer |
| _CLIENT_SNR_CRITICAL_THRESHO LD | Client average SNR critical threshold | integer |
| _TEMP_WARNING_THRESHOLD | Controller Temp warning threshold in Celsius | integer |
| _TEMP_CRITICAL_THRESHOLD | Controller Temp critical threshold in Celsius | integer |
| _WLAN_CLIENTS_WARNING | Client count warning threshold per WLAN | integer |
| _WLAN_CLIENTS_CRITICAL | Client count critical threshold per WLAN | integer |
| _WLAN_THROUGHPUT_WARNING | WLAN throughput warning threshold | integer |
| _WLAN_THROUGHPUT_CRITICAL | WLAN throughput critical threshold | integer |
| _NON_UNICAST_WARNING | Non unicast packets percent warning threshold | percent |
| _NON_UNICAST_CRITICAL | Non unicast packets percent critical threshold | percent |
| _RADIO_RX_WARNING | Radio RX throughput warning threshold | integer |
| _RADIO_RX_CRITICAL | Radio RX throughput critical threshold | integer |
| _RADIO_TX_WARNING | Radio TX throughput warning threshold | integer |
| _RADIO_TX_CRITICAL | Radio TX throughput critical threshold | integer |
COMPLEX MACROS
_APLIST
- Description: List of connected APs. If there are no connected APs, discover script does nothing
- Discover: wocu-discover-aruba-alcatel-wifi-aps.py
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the AP services | string |
| index | AP snmp real index (obtained via snmp) | string |
| name | AP device name (obtained via snmp) | string |
| address | AP device ip address (obtained via snmp) | string |
_CHLIST
- Description: List of active channels in connected APs. If there are no connected APs, discover script does nothing
- Discover: wocu-discover-aruba-wifi-controller-channels.py
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the AP services | string |
| index | AP snmp real index (obtained via snmp) | string |
| name | AP device name (obtained via snmp) | string |
| channel_index | Wifi channel index used in snmp queries | string |
| channel | Wifi channel (obtained via snmp) | string |
Aruba-alcatel-wifi-iap¶
DESCRIPTION
Checks for Alcatel Wifi iAPs and its connected APs
Supported devices: IAP-134, IAP-135, IAP-105, IAP-92 and IAP-93
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| AP_Uptime $KEY$ | Checks Access Point uptime | check_aruba_alc atel_iap_ap_up time | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTAP_UPTIME _WARNING _HOSTAP_UPTIME _CRITICAL _APLIST |
| AP_ap_count_up | Checks the number of connected Access Points with status UP | check_aruba_alc atel_iap_ap_co unt_up | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTAP_COUNT_UP_WARNING _HOSTAP_COUNT_UP_CRITICAL |
| AP_ap_count | Checks the number of connected Access Points | check_aruba_alc atel_iap_ap_co unt | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTAP_COUNT_WARNING _HOSTAP_COUNT_CRITICAL |
| WLAN_Clients | Checks the number of clients per WLAN | check_aruba_alc atel_iap_wlan_ clients | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTWLAN_CLIE NTS_WARNING _HOSTWLAN_CLIE NTS_CRITICAL |
| AP_MEM $KEY$ | Checks the Access Point memory usage | check_aruba_alc atel_iap_mem | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL _APLIST |
| Channel_util $KEY$ | Checks the radio channel utilization | check_aruba_alc atel_iap_channe l_util | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCHANNEL_U TIL_WARNING _HOSTCHANNEL_U TIL_CRITICAL _CHLIST |
| WLAN_ESSIDs | Shows the WLAN essids published by the controller | check_aruba_alc atel_iap_essid | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| AP_Status $KEY$ | Checks the Access Point status | check_aruba_alc atel_iap_ap_st atus | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _APLIST |
| AP_Info $KEY$ | Shows Access Point info | check_aruba_alc atel_iap_ap_in fo | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _APLIST |
| Channel_status $KEY$ | Checks the radio channel status | check_aruba_alc atel_iap_channe l_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _CHLIST |
| WLAN_TX_Through put | Checks the TX throughput per WLAN | check_aruba_alc atel_iap_wlan_ tx_throughput | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTTX_THROUG HPUT_WARNING _HOSTTX_THROUG HPUT_CRITICAL |
| Client_count | Checks the number of clients | check_aruba_alc atel_iap_client _count | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCLIENT_CO UNT_WARNING _HOSTCLIENT_CO UNT_CRITICAL |
| WLAN_RX_Through put | Checks the RX throughput per WLAN | check_aruba_alc atel_iap_wlan_ rx_throughput | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTRX_THROUG HPUT_WARNING _HOSTRX_THROUG HPUT_CRITICAL |
| AP_CPU $KEY$ | Checks the Access Point CPU usage | check_aruba_alc atel_iap_cpu | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL _APLIST |
| AP_Channel_snr_avg | Checks the average client Signal to Noise Ratio (SNR) | check_aruba_alc atel_iap_client _snr_avg | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCLIENT_SN R_WARNING _HOSTCLIENT_SN R_CRITICAL |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_APLIST:
wocu-discover-alcatel-wifi-aps.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$_CHLIST:
wocu-discover-aruba-wifi-iap-channels.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _CPU_WARNING | CPU usage warning threshold | percent |
| _CPU_CRITICAL | CPU usage critical threshold | percent |
| _MEM_WARNING | Memory usage warning threshold | percent |
| _MEM_CRITICAL | Memory usage critical threshold | percent |
| _AP_COUNT_WARNING | Warning counter for the number of aps connected to the virtual controller | integer |
| _AP_COUNT_CRITICAL | Critical counter for the number of aps connected to the virtual controller | integer |
| _AP_COUNT_UP_WARNING | Warning counter for the number of aps connected to the virtual controller and with status UP | integer |
| _AP_COUNT_UP_CRITICAL | Critical counter for the number of aps connected to the virtual controller and with status UP | integer |
| _CHANNEL_UTIL_WARNING | Channel utilization warning threshold | percent |
| _CHANNEL_UTIL_CRITICAL | Channel utilization critical threshold | percent |
| _CLIENT_SNR_WARNING | Average client Signal to Noise Ratio warning threshold | integer |
| _CLIENT_SNR_CRITICAL | Average client Signal to Noise Ratio critical threshold | integer |
| _CLIENT_COUNT_WARNING | Total connected client number warning threshold | integer |
| _CLIENT_COUNT_CRITICAL | Total connected client number critical threshold | integer |
| _WLAN_CLIENTS_WARNING | WLAN client number warning threshold | integer |
| _WLAN_CLIENTS_CRITICAL | WLAN client number critical threshold | integer |
| _TX_THROUGHPUT_WARNING | WLAN TX throughput warning threshold (in bps) | integer |
| _TX_THROUGHPUT_CRITICAL | WLAN TX throughput critical threshold (in bps) | integer |
| _RX_THROUGHPUT_WARNING | WLAN RX throughput warning threshold (in bps) | integer |
| _RX_THROUGHPUT_CRITICAL | WLAN RX throughput critical threshold (in bps) | integer |
| _AP_UPTIME_WARNING | AP Uptime warning threshold (in seconds) | integer |
| _AP_UPTIME_CRITICAL | AP Uptime critical threshold (in seconds) | integer |
COMPLEX MACROS
_APLIST
- Description: List of Access Points (APs) connected to the Wifi virtual Controller
- Discover: wocu-discover-alcatel-wifi-aps.py
| Fields | Description | Type |
|---|---|---|
| display name | Name to be shown in the web interface | string |
| index | Index for snmp queries | string |
| name | AP name | string |
_CHLIST
- Description: List of used Channels from Access Points (APs) connected to the Wifi virtual Controller
- Discover: wocu-discover-aruba-wifi-iap-channels.py
| Fields | Description | Type |
|---|---|---|
| display name | Name to be shown in the web interface | string |
| index | Index for snmp queries | string |
| name | AP name | string |
| channel | Channel index for snmp queries | string |
Bchannel-cisco¶
DESCRIPTION
Checks PRI/BRI B-Channel usage on Cisco gateways
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Bchannels Active_Calls | It shows the number of used, free and total ISDN B-channels | check_bchannels_cisco | _HOSTSNMPCOMMUN ITY _HOSTBCHANNEL_ WARNING_THRESHO LD _HOSTBCHANNEL_ CRITICAL_THRESH OLD |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _BCHANNEL_WARNING_THRESHOLD | <Number of free channels> : Below this number, raise a Warning status | integer |
| _BCHANNEL_CRITICAL_THRESHOLD | <Number of free channels> : Below this number, raise a Critical status | integer |
Bgp-cisco¶
DESCRIPTION
Checks BGP peer availability and session state in Cisco devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| BGP_State | Checks BGP peer and sessions state | check_bgp | _HOSTSNMPCOMMUNITY |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
Bgp-juniper¶
DESCRIPTION
Checks BGP peer state in Juniper devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| BGP Juniper - $KEY$ | Checks the Juniper BGP Peer state | check_bgp_junip er | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _BGP_JUNIPER_ PEER_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_BGP_JUNIPER_PEER_LIST:
wocu-discover-juniper-bgp.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
COMPLEX MACROS
_BGP_JUNIPER_PEER_LIST
- Description: List of BGP peers list
- Discover: wocu-discover-juniper-bgp.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| local_ip | Local IP Address | string |
| peer_ip | Peer IP Address | string |
Cisco-asr-health¶
DESCRIPTION
Hardware checks for Cisco ASR Devices (Fans, Temperature and Powersupply) via snmp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Cisco ASR fan sensors | Checks the Fans health | check_cisco_asr _health_fan | _HOSTSNMPCOMMUN ITY _HOSTDEVICEVEND OR _HOSTRPM_WARNI NG _HOSTRPM_CRITI CAL |
| Cisco ASR powersupply | Checks the Powersupply status | check_cisco_asr _health_powersu pply | _HOSTSNMPCOMMUN ITY |
| Cisco ASR Temp sensors | Checks the temp sensors | check_cisco_asr _health_temp | _HOSTSNMPCOMMUN ITY _HOSTDEVICEVEND OR _HOSTTEMP_WARN ING _HOSTTEMP_CRIT ICAL |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The snmp community read configured on remote device | string |
| _DEVICEVENDOR | Device vendor | string |
| _RPM_WARNING | Fan RPM warning threshold | integer |
| _RPM_CRITICAL | Fan RPM critical threshold | integer |
| _TEMP_WARNING | Temperature warning threshold (in Celsius) | integer |
| _TEMP_CRITICAL | Temperature critical threshold (in Celsius) | integer |
Cisco-interfaces-advanced-health¶
DESCRIPTION
Checks for the interface health on Cisco devices (Overrun/CRC/Giants/Collisions/Drops)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| CISCO_HEALTH_$K EY$ | Checks the interface health parameters | check_cisco_int erfaces_health | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTOVERRUN_I N_WARNING_THRE SHOLD _HOSTOVERRUN_I N_CRITICAL_THR ESHOLD _HOSTCRC_IN_W ARNING_THRESHOL D _HOSTCRC_IN_C RITICAL_THRESHO LD _HOSTGIANTS_IN _WARNING_THRES HOLD _HOSTGIANTS_IN _CRITICAL_THRE SHOLD _HOSTCOLLISIONS _OUT_WARNING_ THRESHOLD _HOSTCOLLISIONS _OUT_CRITICAL_THRESHOLD _HOSTDROPS_IN_WARNING_THRESH OLD _HOSTDROPS_IN_CRITICAL_THRES HOLD _HOSTDROPS_OUT _WARNING_THRES HOLD _HOSTDROPS_OUT _CRITICAL_THRE SHOLD _CISCO_HEALTH_INTERFACE_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_CISCO_HEALTH_INTERFACE_LIST:
wocu-discover-ifaces-ng.py -H $HOSTADDRESS$ -s $_SNMPVERSION$ -C $_SNMPCOMMUNITY$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -A $_SNMPAUTHKEY$ -x $_SNMPPRIVPROTOCOL$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ –exclude_nophysical_ifaces –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | SNMP version to use in the check | string |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _OVERRUN_IN_WARNING_THRESHOL D | Overrun input packets warning threshold value | integer |
| _OVERRUN_IN_CRITICAL_THRESHO LD | Overrun input packets critical threshold value | integer |
| _CRC_IN_WARNING_THRESHOLD | CRC error input packets warning threshold value | integer |
| _CRC_IN_CRITICAL_THRESHOLD | CRC error input packets critical threshold value | integer |
| _GIANTS_IN_WARNING_THRESHOLD | Giant input packets warning threshold value | integer |
| _GIANTS_IN_CRITICAL_THRESHOL D | Giant input packets critical threshold value | integer |
| _COLLISIONS_OUT_WARNING_THRE SHOLD | Output collisions warning threshold value | integer |
| _COLLISIONS_OUT_CRITICAL_THR ESHOLD | Output collisions critical threshold value | integer |
| _DROPS_IN_WARNING_THRESHOLD | Input dropped packets warning threshold value | integer |
| _DROPS_IN_CRITICAL_THRESHOLD | Input dropped packets critical threshold value | integer |
| _DROPS_OUT_WARNING_THRESHOLD | Output dropped packets warning threshold value | integer |
| _DROPS_OUT_CRITICAL_THRESHOL D | Output dropped packets critical threshold value | integer |
COMPLEX MACROS
_CISCO_HEALTH_INTERFACE_LIST
- Description: List of interfaces to be health checked
- Discover: wocu-discover-ifaces-ng.py
| Fields | Description | Type |
|---|---|---|
| descr | Custom Name appearing in the service (default ifDescr) | string |
| index | Device interface snmp index (obtained via snmp) | integer |
| type | Interface type (obtained via snmp) | string |
Cisco-wifi-controller¶
DESCRIPTION
Checks for the Cisco Airespace/Aironet controller and its asociated APs
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Controller_power _supply | Checks the controller powersupply status | check_power_sup ply_cisco_wifi_controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| AP_count | Checks the number of connected Access Points | check_ap_count_cisco_wifi_con troller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTAPS_CONNE CTED_WARNING_T HRESHOLD _HOSTAPS_CONNE CTED_CRITICAL_ THRESHOLD |
| AP_radio_client s $KEY$ | Checks the clients per Radio Channel | check_ap_radio_clients_cisco_ wifi_controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTAP_RADIO_CLIENTS_DEFAUL T_WARNING _HOSTAP_RADIO_CLIENTS_DEFAUL T_CRITICAL _CISCO_CHLIST |
| Controller_cpu | Checks the controller CPU usage | check_cpu_cisco _wifi_controlle r | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG_THRESHOLD _HOSTCPU_CRITI CAL_THRESHOLD _HOSTSNMPVERSIO N |
| Channel_interfer ence $KEY$ | Checks the Radio Channel interference | check_channel_i nterf_cisco_wif i_controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTAPS_CHANN EL_INTERFERENCE _WARNING_THRES HOLD _HOSTAPS_CHANN EL_INTERFERENCE _CRITICAL_THRE SHOLD _CISCO_CHLIST |
| Channel_utilizat ion $KEY$ | Checks the Radio Channel utilization | check_channel_u til_cisco_wifi_controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCHANNEL_U TIL_WARNING_TH RESHOLD _HOSTCHANNEL_U TIL_CRITICAL_T HRESHOLD _CISCO_CHLIST |
| AP_status $KEY$ | Checks the Access Point status | check_ap_status _cisco_wifi_co ntroller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _CISCO_APLIST |
| Controller_info | Shows controller info | check_info_cisc o_wifi_controll er | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| AP_info $KEY$ | Shows info from Access Point | check_ap_info_ cisco_wifi_cont roller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _CISCO_APLIST |
| WLAN_Clients | Checks the number of clients per WLAN | check_wlan_clie nts_cisco_wifi_controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTWLAN_CLIE NTS_DEFAULT_WA RNING _HOSTWLAN_CLIE NTS_DEFAULT_CR ITICAL |
| Controller_memor y | Checks the controller memory usage | check_mem_cisco _wifi_controlle r | _HOSTSNMPCOMMUN ITY _HOSTMEM_WARNI NG_THRESHOLD _HOSTMEM_CRITI CAL_THRESHOLD _HOSTSNMPVERSIO N |
| AP_radio_info $KEY$ | Shows info of the Radio Channels | check_ap_radio_info_cisco_wif i_controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _CISCO_CHLIST |
| Controller_temp | Checks the controller temperature | check_temp_cisc o_wifi_controll er | _HOSTSNMPCOMMUN ITY _HOSTTEMP_DEFA ULT_HIGH _HOSTTEMP_DEFA ULT_LOW _HOSTSNMPVERSIO N |
| Client_count | Checks the total number of clients | check_client_co unt_cisco_wifi_controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCLIENT_CO UNT_DEFAULT_WA RNING _HOSTCLIENT_CO UNT_DEFAULT_CR ITICAL |
| AP_clients $KEY$ | Checks the clients per Access Point | check_ap_client s_cisco_wifi_c ontroller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTAP_CLIENT S_WARNING_THRE SHOLD _HOSTAP_CLIENT S_CRITICAL_THR ESHOLD _CISCO_APLIST |
| Controller_essid | Shows the WLAN ESSIDs published in the controller | check_essid_cis co_wifi_control ler | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| AP_noise_power $KEY$ | Checks the average noise power in dBm on each channel per AP | check_ap_noise_power_cisco_wi fi_controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTAPS_CHANN EL_NOISE_POWER _WARNING_THRES HOLD _HOSTAPS_CHANN EL_NOISE_POWER _CRITICAL_THRE SHOLD _CISCO_APLIST |
| Client_SNR_avg $KEY$ | Checks the average Signal to Noise Ratio per Radio Channel | check_client_sn r_avg_cisco_wi fi_controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCLIENT_SN R_AVG_WARNING_THRESHOLD _HOSTCLIENT_SN R_AVG_CRITICAL _THRESHOLD _CISCO_CHLIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_CISCO_APLIST:
wocu-discover-cisco-wifi-aps.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$_CISCO_CHLIST:
wocu-discover-cisco-wifi-channels.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | SNMP version to use in the check | string |
| _CPU_WARNING_THRESHOLD | CPU warning threshold | percent |
| _CPU_CRITICAL_THRESHOLD | CPU critical threshold | percent |
| _MEM_WARNING_THRESHOLD | Memory warning threshold (percent) | percent |
| _MEM_CRITICAL_THRESHOLD | Memory critical threshold (percent) | percent |
| _APS_CONNECTED_WARNING_THRES HOLD | APs connected warning threshold | integer |
| _APS_CONNECTED_CRITICAL_THRE SHOLD | APs connected critical threshold | integer |
| _AP_CLIENTS_WARNING_THRESHOL D | Connected clients warning threshold | integer |
| _AP_CLIENTS_CRITICAL_THRESHO LD | Connected clients critical threshold | integer |
| _CHANNEL_UTIL_WARNING_THRESH OLD | Channel utilization warning threshold | percent |
| _CHANNEL_UTIL_CRITICAL_THRES HOLD | Channel utilization critical threshold | percent |
| _CLIENT_SNR_AVG_WARNING_THR ESHOLD | Average client SNR warning threshold | integer |
| _CLIENT_SNR_AVG_CRITICAL_TH RESHOLD | Average client SNR critical threshold | integer |
| _APS_CHANNEL_NOISE_POWER_CR ITICAL_THRESHOLD | APs channel noise power | integer |
| _APS_CHANNEL_NOISE_POWER_WA RNING_THRESHOLD | APs channel interference | integer |
| _APS_CHANNEL_INTERFERENCE_WA RNING_THRESHOLD | APs channel interference | integer |
| _APS_CHANNEL_INTERFERENCE_CR ITICAL_THRESHOLD | APs channel interference | integer |
| _TEMP_DEFAULT_HIGH | Controller temperature high threshold (Celsius) | integer |
| _TEMP_DEFAULT_LOW | Controller temperature low threshold (Celsius) | integer |
| _CLIENT_COUNT_DEFAULT_WARNIN G | Controller client count warning threshold | integer |
| _CLIENT_COUNT_DEFAULT_CRITIC AL | Controller client count critical threshold | integer |
| _WLAN_CLIENTS_DEFAULT_WARNIN G | WLAN client count warning threshold | integer |
| _WLAN_CLIENTS_DEFAULT_CRITIC AL | WLAN client count critical threshold | integer |
| _AP_RADIO_CLIENTS_DEFAULT_W ARNING | WLAN client count warning threshold | integer |
| _AP_RADIO_CLIENTS_DEFAULT_C RITICAL | WLAN client count critical threshold | integer |
COMPLEX MACROS
_CISCO_APLIST
- Description: List of connected/registered APs to the controller
- Discover: wocu-discover-cisco-wifi-aps.py
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the AP services | string |
| index | AP snmp real index (obtained via snmp) | string |
| name | AP device name (obtained via snmp) | string |
| address | AP device ip address (obtained via snmp) | string |
_CISCO_CHLIST
- Description: List of radio slots from connected/registered APs
- Discover: wocu-discover-cisco-wifi-channels.py
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the channel services | string |
| index | AP snmp real index (obtained via snmp) | string |
| name | AP and slot device name (obtained via snmp) | string |
| slot_index | Radio band slot index: 0 for Slot 0 or 1 for Slot1. Used for snmp queries | string |
F5-health¶
DESCRIPTION
Hardware checks for F5 BIGIP Devices (Fans, Temperature and PowerSupply) via snmp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| F5 PowerSupply | Checks PowerSupply(s) status | check_f5_health_powersupply | _HOSTSNMPCOMMUNI TY |
| F5 Fan | Checks Fan(s) status | check_f5_health_fan | _HOSTSNMPCOMMUNI TY _HOSTRPM_WARNIN G _HOSTRPM_CRITIC AL |
| F5 Temp | Checks hardware temperature(s) | check_f5_health_temp | _HOSTSNMPCOMMUNI TY _HOSTTEMP_WARNI NG _HOSTTEMP_CRITI CAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The snmp community read configured on remote device | string |
| _RPM_WARNING | Fan RPM warning threshold | integer |
| _RPM_CRITICAL | Fan RPM critical threshold | integer |
| _TEMP_WARNING | Temperature warning threshold (in Celsius) | integer |
| _TEMP_CRITICAL | Temperature critical threshold (in Celsius) | integer |
Fortigate-health¶
DESCRIPTION
Hardware checks for Fortigate (Fans, Temperature and PowerSupply) via snmp. Small models are not supported
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Fortigate Health - Temp | Checks hardware temperature(s) | check_fortigate_health_temp | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTTEMP_WARN ING _HOSTTEMP_CRIT ICAL |
| Fortigate Health - Fan | Checks Fan(s) status | check_fortigate_health_fan | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTRPM_WARNI NG _HOSTRPM_CRITI CAL |
| Fortigate Health - PowerSupply | Checks PowerSupply(s) status | check_fortigate_health_powersup ply | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _RPM_WARNING | Fan RPM warning threshold | integer |
| _RPM_CRITICAL | Fan RPM critical threshold | integer |
| _TEMP_WARNING | Temperature warning threshold (in Celsius) | integer |
| _TEMP_CRITICAL | Temperature critical threshold (in Celsius) | integer |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _SNMPCOMMUNITY | SNMP Community | string |
| _SNMPVERSION | Device SNMP version, supported 1, 2c and 3 | string |
Haproxy¶
DESCRIPTION
Custom checks for HAProxy services
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| haproxy-version | Checks HAProxy version information. | haproxy_version | _HOSTDPA_PORT _HOSTDPA_USERN AME _HOSTDPA_PASSW ORD |
| haproxy-backend- status | Checks HAProxy Backend Service information. | haproxy_backend_status | _HOSTDPA_PORT _HOSTDPA_USERN AME _HOSTDPA_PASSW ORD |
| TCP_$KEY$ | Checks HAProxy host port. | check_haproxy_t cp | _TCP_PORTS |
| haproxy-process- info | Checks HAProxy process information. | haproxy_process_info | _HOSTDPA_PORT _HOSTDPA_USERN AME _HOSTDPA_PASSW ORD |
| haproxy-frontend- status | Checks HAProxy Frontend Service information. | haproxy_frontend _status | _HOSTDPA_PORT _HOSTDPA_USERN AME _HOSTDPA_PASSW ORD |
| haproxy-uptime | Checks HAProxy uptime information. | haproxy_uptime | _HOSTDPA_PORT _HOSTDPA_USERN AME _HOSTDPA_PASSW ORD _HOSTUPTIME_WA RNING _HOSTUPTIME_CR ITICAL |
| haproxy-server- status | Checks HAProxy Servers information. | haproxy_server_ status | _HOSTDPA_PORT _HOSTDPA_USERN AME _HOSTDPA_PASSW ORD |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_TCP_PORTS:
wocu-discover-tcp-ports.py $HOSTADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _DPA_USERNAME | Username for API auth | string |
| _DPA_PASSWORD | Password for API auth | string |
| _DPA_PORT | Api port for HTTP requests | string |
| _UPTIME_WARNING | Uptime warning threshold | string |
| _UPTIME_CRITICAL | Uptime critical threshold | string |
COMPLEX MACROS
_TCP_PORTS
- Description: List of TCP ports to overwatch
- Discover: wocu-discover-tcp-ports.py
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| port | TCP port to monitor | integer |
Health-cisco¶
DESCRIPTION
Check hardware health status of cisco devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Health_$KEY$ | Checks the status of hardware sensors | check-cisco-health | _HOSTSNMPCOMMUNIT Y _HEALTHCHECKS |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
COMPLEX MACROS
_HEALTHCHECKS
- Description: List of health checks for Cisco devices. Must enter 2 fields: Name (Service Display Name) + Check (type of Health Check)
| Fields | Description | Type |
|---|---|---|
| name | Custom service display name | string |
| check | Checks available: temp / fan / ps / freeint / module | string |
Hsrp-cisco¶
DESCRIPTION
Monitors Cisco HSRP via snmp protocol
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| HSRP_State_$KEY $ | Checks Cisco HSRP status | check_hsrp_stat e | _HOSTSNMPCOMMUN ITY _HOSTHSRP_STAT E _HSRP_STATE |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _HSRP_STATE | -s, –state=master|backup|num,% Nokia ipso clustering : number of members, max % assigned to nodes. Other : check HSRP interface to be master or backup | string |
Infinera-edu¶
DESCRIPTION
Checks for Infinera EDU devices using SNMP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Layer2_rate_$KE Y$ | Checks the Layer 2 traffic rate | check_infinera_ edu_l2_rate | _HOSTSNMPCOMMUN ITY _HOSTLAYER2_RA TE_WARNING _HOSTLAYER2_RA TE_CRITICAL _INFINERA_PORT S_LIST |
| Port_drops_$KEY $ | Checks dropped packets | check_infinera_ edu_port_drops | _HOSTSNMPCOMMUN ITY _HOSTDROPS_WAR NING _HOSTDROPS_CRI TICAL _INFINERA_PORT S_LIST |
| Infinera-edu temp | Checks hardware temperature | check_infinera_ edu_temp | _HOSTSNMPCOMMUN ITY _HOSTTEMP_WARN ING _HOSTTEMP_CRIT ICAL |
| Layer1_rate_$KE Y$ | Checks the Layer 1 traffic rate | check_infinera_ edu_l1_rate | _HOSTSNMPCOMMUN ITY _HOSTLAYER1_RA TE_WARNING _HOSTLAYER1_RA TE_CRITICAL _INFINERA_PORT S_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_INFINERA_PORTS_LIST:
wocu-discover-infinera-ports.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP Community | string |
| _SNMPVERSION | SNMP version | string |
| _TEMP_WARNING | Temperature warning threshold (in Celsius) | integer |
| _TEMP_CRITICAL | Temperature critical threshold (in Celsius) | integer |
| _DROPS_WARNING | Packet drops increase warning threshold | integer |
| _DROPS_CRITICAL | Packet drops increase critical threshold | integer |
| _LAYER1_RATE_WARNING | Layer1 rate warning threshold (in Bps) | integer |
| _LAYER1_RATE_CRITICAL | Layer1 rate critical threshold (in Bps) | integer |
| _LAYER2_RATE_WARNING | Layer2 rate warning threshold (in Bps) | integer |
| _LAYER2_RATE_CRITICAL | Layer2 rate critical threshold (in Bps) | integer |
COMPLEX MACROS
_INFINERA_PORTS_LIST
- Description: List of ports to be checked
- Discover: wocu-discover-infinera-ports.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown as Service Description in the web interface | string |
| index | Infinera port index (integer) | integer |
| name | Port name | string |
Infinera-xtm¶
DESCRIPTION
Checks for Infinera XTM interface drop statistics via SNMP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Interface_drops_$KEY$ | Checks dropped packets | check_infinera_ xtm_ifaces_drop s | _HOSTSNMPCOMMUN ITY _HOSTDROPPED_B YTES_WARNING _HOSTDROPPED_B YTES_CRITICAL _HOSTDROPPED_F RAMES_WARNING _HOSTDROPPED_F RAMES_CRITICAL _INFINERA_IFAC ES_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_INFINERA_IFACES_LIST:
wocu-discover-infinera-ifaces.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP Community | string |
| _SNMPVERSION | SNMP version | string |
| _DROPPED_BYTES_WARNING | Dropped byte increase warning threshold | integer |
| _DROPPED_BYTES_CRITICAL | Dropped byte increase critical threshold | integer |
| _DROPPED_FRAMES_WARNING | Dropped frame increase warning threshold | integer |
| _DROPPED_FRAMES_CRITICAL | Dropped frame increase critical threshold | integer |
COMPLEX MACROS
_INFINERA_IFACES_LIST
- Description: List of interfaces to be checked
- Discover: wocu-discover-infinera-ifaces.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown as Service Description in the web interface | string |
| index | Index of Infinera interface (integer) | integer |
| name | Name of interface | string |
Infoblox¶
DESCRIPTION
Health and performance checks for Infoblox devices via snmp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| ip_state | Shows configured ip addresses of this appliance | check_infoblox_ip | _HOSTSNMPCOMMUNIT Y _HOSTCPU_WARNING _THRESHOLD _HOSTCPU_CRITICA L_THRESHOLD |
| ha_state | Checks High Availability (HA) status | check_infoblox_ha | _HOSTSNMPCOMMUNIT Y _HOSTCPU_WARNING _THRESHOLD _HOSTCPU_CRITICA L_THRESHOLD _HOSTHA_LOCAL_S TATE |
| temperature | Checks the temperature of the appliance | check_infoblox_te mp | _HOSTSNMPCOMMUNIT Y _HOSTTEMP_WARNIN G_THRESHOLD _HOSTTEMP_CRITIC AL_THRESHOLD |
| replication | Checks if replication between Infoblox appliances is working | check_infoblox_re plication | _HOSTSNMPCOMMUNIT Y _HOSTMEM_WARNING _THRESHOLD _HOSTMEM_CRITICA L_THRESHOLD |
| memory | Checks memory usage | check_infoblox_me m | _HOSTSNMPCOMMUNIT Y _HOSTMEM_WARNING _THRESHOLD _HOSTMEM_CRITICA L_THRESHOLD |
| Info | Shows general information about this appliance | check_infoblox_in fo | _HOSTSNMPCOMMUNIT Y _HOSTCPU_WARNING _THRESHOLD _HOSTCPU_CRITICA L_THRESHOLD |
| dhcp_stat | Shows DHCP statistics | check_infoblox_dh cp | _HOSTSNMPCOMMUNIT Y _HOSTCPU_WARNING _THRESHOLD _HOSTCPU_CRITICA L_THRESHOLD |
| dns_stat | Shows DNS statistics | check_infoblox_dn s | _HOSTSNMPCOMMUNIT Y _HOSTCPU_WARNING _THRESHOLD _HOSTCPU_CRITICA L_THRESHOLD _HOSTCHECK_DOMAI N |
| cpu | Checks CPU usage | check_infoblox_cp u | _HOSTSNMPCOMMUNIT Y _HOSTCPU_WARNING _THRESHOLD _HOSTCPU_CRITICA L_THRESHOLD |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_HA_LOCAL_STATE:
wocu-discover-ha-infoblox.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The read snmp community allowed on the linux server | string |
| _CPU_WARNING_THRESHOLD | CPU warning threshold (percentage) | percent |
| _CPU_CRITICAL_THRESHOLD | CPU critical threshold (percentage) | percent |
| _HA_LOCAL_STATE | Current device status HA State | string |
| _MEM_WARNING_THRESHOLD | Memory warning threshold (percentage) | percent |
| _MEM_CRITICAL_THRESHOLD | Memory critical threshold (percentage) | percent |
| _TEMP_WARNING_THRESHOLD | Temperature warning threshold (Celsius degrees) | integer |
| _TEMP_CRITICAL_THRESHOLD | Temperature critical threshold (Celsius degrees) | integer |
| _CHECK_DOMAIN | Check Domain | string |
Ipsla-cisco¶
DESCRIPTION
Check IPSLA rules (Jitter/RTT/Packets) in Cisco devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| IPSLA_$KEY$ | Checks the status and metrics of IPSLA sessions | check_cisco_ipsl a | _HOSTSNMPCOMMUNIT Y _HOSTSNMPVERSION _IPSLA_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_IPSLA_LIST:
wocu-discover-cisco-ipsla.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
COMPLEX MACROS
_IPSLA_LIST
- Description: List of IPSLA rules to be checked
- Discover: wocu-discover-cisco-ipsla.py
| Fields | Description | Type |
|---|---|---|
| display name | Name to be shown in the web interface | string |
| index | Index for snmp queries | integer |
| jitter_critical | Critical threshold for the average of positive and negative jitter values in SD and DS direction for latest operation | integer |
| jitter_warning | Warning threshold for the average of positive and negative jitter values in SD and DS direction for latest operation | integer |
| percent_loss_critical | Critical threshold for percent packet loss (SD + DS) | float.percent |
| name | Name to be shown in the web interface | string |
| percent_loss_warning | Warning threshold for percent packet loss (SD + DS) | float.percent |
| rtt_critical | Critical threshold for completion time of the latest RTT operation successfully completed | integer |
| rtt_warning | Warning threshold for completion time of the latest RTT operation successfully completed | integer |
| mos_critical | Critical threshold for Mean Opinion Scores (MOS) | integer |
| mos_warning | Warning threshold for Mean Opinion Scores (MOS) | integer |
Meraki-device¶
DESCRIPTION
Pack for checking Meraki devices using Dashboard API
Get the performance data of the Meraki devices using the Meraki Dashboard API. This pack needs the Organization API Key, the Organization ID, the Network ID and the device serial number.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Meraki_device_U SB_Status | Checks the USB port status | check_meraki_de vice_usb_status | _HOSTAPIKEY _HOSTORGID _HOSTNETWORKID _HOSTSERIAL |
| Meraki_device_C PU | Checks the CPU usage | check_meraki_de vice_cpu | _HOSTAPIKEY _HOSTORGID _HOSTNETWORKID _HOSTSERIAL _HOSTCPU_WARNI NG_THRESHOLD _HOSTCPU_CRITI CAL_THRESHOLD |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _APIKEY | Organization API Key | string |
| _ORGID | Organization ID | string |
| _NETWORKID | Network ID that includes the target device | string |
| _SERIAL | Device serial number | string |
| _CPU_WARNING_THRESHOLD | CPU warning threshold | integer |
| _CPU_CRITICAL_THRESHOLD | CPU critical threshold | integer |
Mikrotik¶
DESCRIPTION
Checks for Mikrotik Devices via snmp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Mikrotik mem usage | Checks Memory usage percent | check_mikrotik_ mem | _HOSTSNMPCOMMUN ITY _HOSTMEM_USAGE _WARNING _HOSTMEM_USAGE _CRITICAL |
| Mikrotik temperature | Checks hardware temperature | check_mikrotik_ temp | _HOSTSNMPCOMMUN ITY _HOSTTEMP_WARN ING _HOSTTEMP_CRIT ICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The snmp community read configured on remote device | string |
| _TEMP_WARNING | Temperature warning threshold (in Celsius) | integer |
| _TEMP_CRITICAL | Temperature critical threshold (in Celsius) | integer |
| _MEM_USAGE_WARNING | Memory usage warning threshold (percent) | percent |
| _MEM_USAGE_CRITICAL | Memory usage critical threshold (percent) | percent |
Networkdevice-adsl-metrics¶
DESCRIPTION
Checks metrics in ADSL interfaces from routers using SNMP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| ADSL_Channels_T X_Rates_$KEY$ | Checks ATU-C and ATU-R TX rates in ADSL interfaces | check_adsl_metr ics_rates | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _ADSL_METRICS_LIST |
| ADSL_Traffic_$K EY$ | Checks Line usage percent in ADSL associated interfaces | check_adsl_metr ics_traffic | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTADSL_TRAF FIC_WARNING _HOSTADSL_TRAF FIC_CRITICAL _ADSL_METRICS_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_ADSL_METRICS_LIST:
wocu-discover-adsl-ifaces.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The snmp community configured on remote device | string |
| _SNMPVERSION | The snmp version on remote device | string |
| _ADSL_TRAFFIC_WARNING | Traffic warning threshold (percentage) | percent |
| _ADSL_TRAFFIC_CRITICAL | Traffic critical threshold (percentage) | percent |
COMPLEX MACROS
_ADSL_METRICS_LIST
- Description: List of ADSL Interfaces
- Discover: wocu-discover-adsl-ifaces.py
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| index | ADSL interface index | integer |
| atuc_rate_warn | ATU-C Channel TX rate Warning threshold | integer |
| atuc_rate_crit | ATU-C Channel TX rate Critical threshold | integer |
| atur_rate_warn | ATU-R Channel TX rate Warning threshold | integer |
| atur_rate_crit | ATU-R Channel TX rate Critical threshold | integer |
| units | Thresholds and output units | string |
| index_traffic | Index for traffic associated ADSL iface | string |
Networkdevice-available-ports¶
DESCRIPTION
Check the available ports in a network device
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Available Ports | Checks the number and percent of not used physical ports | wocu-check- available-ports | _HOSTSNMPCOMMUNI TY _HOSTSNMPVERSION _HOSTAVAILABLE_ PORTS_WARNING_T HRESHOLD _HOSTAVAILABLE_ PORTS_CRITICAL_ THRESHOLD |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP, versions supported are: 1 and 2c | string |
| _AVAILABLE_PORTS_WARNING_THR ESHOLD | warning threshold of available ports in the device (percentage) | percent |
| _AVAILABLE_PORTS_CRITICAL_TH RESHOLD | critical threshold of available ports in the device (percentage) | percent |
Networkdevice-cpu¶
DESCRIPTION
Network device cpu checks
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| CPU | Checks the CPU usage | wocu-check-cpu | _HOSTSNMPCOMMUNITY _HOSTDEVICEVENDOR _HOSTSNMPVERSION _HOSTCPU_WARNING_THRESHOLD _HOSTCPU_CRITICAL_THRESHOL D |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
| _CPU_WARNING_THRESHOLD | CPU warning threshold | percent |
| _CPU_CRITICAL_THRESHOLD | CPU critical threshold | percent |
Networkdevice-cpu-1m¶
DESCRIPTION
Network device cpu checks (forced to 1 minute)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| CPU_1m | Checks the CPU usage. 1 minute check interval | wocu-check-cpu-1m | _HOSTSNMPCOMMUNITY _HOSTDEVICEVENDOR _HOSTSNMPVERSION _HOSTCPU_1M_WARNIN G_THRESHOLD _HOSTCPU_1M_CRITIC AL_THRESHOLD |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
| _CPU_1M_WARNING_THRESHOLD | CPU warning threshold (percentage) | percent |
| _CPU_1M_CRITICAL_THRESHOLD | CPU critical threshold (percentage) | percent |
Networkdevice-cpu-snmp3¶
DESCRIPTION
Network device cpu checks (only snmp version 3)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| CPU | Checks the CPU usage using SNMPv3 | wocu-check-cpu-snmp3 | _HOSTSNMP3USERNAME _HOSTSNMP3AUTHPASSWO RD _HOSTSNMP3AUTHPROTOC OL _HOSTSNMP3PRIVPASSWO RD _HOSTSNMP3PRIVPROTOC OL _HOSTCPU_WARNING_T HRESHOLD _HOSTCPU_CRITICAL_ THRESHOLD |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMP3USERNAME | The securityName for the USM security model, use $SNMP3USERNAME$ for the default username | string |
| _SNMP3AUTHPASSWORD | The authentication password, use $SNMP3AUTHPASSWORD$ for the default auth password | string |
| _SNMP3AUTHPROTOCOL | The authentication protocol (md5, sha), use $SNMP3AUTHPROTOCOL$ for the default auth protocol | string |
| _SNMP3PRIVPASSWORD | The password for authPriv security level, use $SNMP3PRIVPASSWORD$ for the default priv password | string |
| _SNMP3PRIVPROTOCOL | The private protocol (des, aes, aes128, 3des, 3desde), use $SNMP3PRIVPROTOCOL$ for the default priv protocol | string |
| _CPU_WARNING_THRESHOLD | CPU warning threshold | percent |
| _CPU_CRITICAL_THRESHOLD | CPU critical threshold | percent |
Networkdevice-hardware-health¶
DESCRIPTION
Hardware Health checks for network devices (Fans, Temperature and PowerSupply) via snmp
Hardware Health checks for network devices (Fans, Temperature, PowerSupply and Cards) via snmp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Hardware Health | Checks the status of all sensors detected in the hardware (temp, fan, powersupply, etc.) | check_networkdev ice_hardware_he alth | _HOSTSNMPCOMMUNI TY |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The snmp community read configured on remote device | string |
| _SNMPVERSION | SNMP version | string |
Networkdevice-mem¶
DESCRIPTION
Network device memory checks
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Memory | Checks the memory usage | wocu-check-mem | _HOSTSNMPCOMMUNITY _HOSTDEVICEVENDOR _HOSTSNMPVERSION _HOSTMEMFREE_WARNING_ THRESHOLD _HOSTMEMFREE_CRITICAL_THRESHOLD |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
| _MEMFREE_WARNING_THRESHOLD | Memory Free warning threshold (percentage) | percent |
| _MEMFREE_CRITICAL_THRESHOLD | Memory Free critical threshold (percentage) | percent |
Networkdevice-mem-1m¶
DESCRIPTION
Network device memory checks (forced to 1m)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Memory_1m | Checks the memory usage. 1 minute check interval | wocu-check-mem-1m | _HOSTSNMPCOMMUNITY _HOSTDEVICEVENDOR _HOSTSNMPVERSION _HOSTMEMFREE_1M_W ARNING_THRESHOLD _HOSTMEMFREE_1M_C RITICAL_THRESHOLD |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
| _MEMFREE_1M_WARNING_THRESHOL D | Memory warning threshold (percentage) | percent |
| _MEMFREE_1M_CRITICAL_THRESHO LD | Memory critical threshold (percentage) | percent |
Networkdevice-mem-snmp3¶
DESCRIPTION
Network device memory checks (only snmp version 3)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Memory | Checks the memory usage using SNMPv3 | wocu-check-mem-snmp3 | _HOSTSNMP3USERNAME _HOSTSNMP3AUTHPASSW ORD _HOSTSNMP3AUTHPROTO COL _HOSTSNMP3PRIVPASSW ORD _HOSTSNMP3PRIVPROTO COL _HOSTMEMFREE_WARNI NG_THRESHOLD _HOSTMEMFREE_CRITI CAL_THRESHOLD |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMP3USERNAME | The securityName for the USM security model, use $SNMP3USERNAME$ for the default username | string |
| _SNMP3AUTHPASSWORD | The authentication password, use $SNMP3AUTHPASSWORD$ for the default auth password | string |
| _SNMP3AUTHPROTOCOL | The authentication protocol (md5, sha), use $SNMP3AUTHPROTOCOL$ for the default auth protocol | string |
| _SNMP3PRIVPASSWORD | The password for authPriv security level, use $SNMP3PRIVPASSWORD$ for the default priv password | string |
| _SNMP3PRIVPROTOCOL | The private protocol (des, aes, aes128, 3des, 3desde), use $SNMP3PRIVPROTOCOL$ for the default priv protocol | string |
| _MEMFREE_WARNING_THRESHOLD | Memory Free warning threshold (percentage) | percent |
| _MEMFREE_CRITICAL_THRESHOLD | Memory Free critical threshold (percentage) | percent |
Networkdevice-mobile-signal¶
DESCRIPTION
Checks mobile signal strength/quality metrics in 3G/4G routers
Checks mobile signal strength/quality metrics in 3G/4G routers via snmp. Also shows info about mobile band and APN (Access Point Name)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Mobile_signal_i nfo_$KEY$ | Shows mobile (3G, 4G) communications information | check_mobile_si gnal_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTDEVICEVEND OR _MOBILE_SIGNAL _LIST |
| Mobile_signal_h ealth_$KEY$ | Checks the health metrics from mobile (3G, 4G) communications | check_mobile_si gnal_health | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTDEVICEVEND OR _MOBILE_SIGNAL _LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_MOBILE_SIGNAL_LIST:
wocu-discover-mobile-signal.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ -V $_DEVICEVENDOR$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The snmp community configured on remote device | string |
| _SNMPVERSION | The snmp version on remote device | string |
| _DEVICEVENDOR | Device vendor. Support for Cisco and Teldat | string |
COMPLEX MACROS
_MOBILE_SIGNAL_LIST
- Description: List of 3G/4G cellular mobile router instances. Apply _VENDOR and _SNMPVERSION changes before discover mobile signals
- Discover: wocu-discover-mobile-signal.py
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| index | Cellular mobile index | integer |
| tech_warn | Technology warning threshold: From 1 (worst) to 13 (best) | integer |
| tech_crit | Technology critical threshold: From 1 (worst) to 13 (best) | integer |
| rssi_warn | RSSI warning threshold (in dBm) | integer |
| rssi_crit | RSSI critical threshold (in dBm) | integer |
| ecio_warn | EC/IO warning threshold | integer |
| ecio_crit | EC/IO critical threshold | integer |
| rsrp_warn | RSRP warning threshold (in dBm) | integer |
| rsrp_crit | RSRP critical threshold (in dBm) | integer |
| rsrq_warn | RSRQ warning threshold (in dB) | integer |
| rsrq_crit | RSRQ critical threshold (in dB) | integer |
| rscp_warn | RSCP warning threshold (in dBm) | integer |
| rscp_crit | RSCP critical threshold (in dBm) | integer |
| sinr_warn | SINR warning threshold (in dB) | integer |
| sinr_crit | SINR critical threshold (in dB) | integer |
Networkdevice-ping¶
DESCRIPTION
Network device ping check
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Ping | Checks connectivity using ICMP protocol | wocu-check-ping | _HOSTRTA_WARNING_THRE SHOLD _HOSTPL_WARNING_THRES HOLD _HOSTRTA_CRITICAL_THR ESHOLD _HOSTPL_CRITICAL_THRE SHOLD _HOSTICMP_PACKETS |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _ICMP_PACKETS | Number of packets to launch | integer |
| _RTA_WARNING_THRESHOLD | Round trip average warning threshold (miliseconds) | integer |
| _RTA_CRITICAL_THRESHOLD | Round trip average critical threshold (miliseconds) | integer |
| _PL_WARNING_THRESHOLD | Packet lost warning threshold (percentage) | percent |
| _PL_CRITICAL_THRESHOLD | Packet lost critical threshold (percentage) | percent |
Networkdevice-ping-1m¶
DESCRIPTION
Network device ping check (forced to 1 minute)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Ping-1m | Checks connectivity using ICMP protocol. 1 minute check interval | wocu-check-ping-1m | _HOSTRTA_WARNING_T HRESHOLD _HOSTPL_WARNING_TH RESHOLD _HOSTRTA_CRITICAL_ THRESHOLD _HOSTPL_CRITICAL_T HRESHOLD _HOSTICMP_PACKETS |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _ICMP_PACKETS | Number of packets to launch | integer |
| _RTA_WARNING_THRESHOLD | Round trip average warning threshold (miliseconds) | integer |
| _RTA_CRITICAL_THRESHOLD | Round trip average critical threshold (miliseconds) | integer |
| _PL_WARNING_THRESHOLD | Packet lost warning threshold (percentage) | percent |
| _PL_CRITICAL_THRESHOLD | Packet lost critical threshold (percentage) | percent |
Networkdevice-route-count¶
DESCRIPTION
Get the number of valid routes using SNMP
The check gets the value from several OID to calculate the amount of current routes configured on the device: inetCidrRouteNumber, inetCidrRouteDiscards and inetCidrRouteTable
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Valid_CIDR_rout es | Checks the number of routes configured in the host | check_networkdev ice_route_count _number | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTROUTES_WA RNING _HOSTROUTES_CR ITICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP Community | string |
| _SNMPVERSION | SNMP version | string |
| _ROUTES_WARNING | Warning threshold for minimum number of valid routes | integer |
| _ROUTES_CRITICAL | Critical threshold for minimum number of valid routes | integer |
Networkdevice-traffic¶
DESCRIPTION
Network device traffic checks
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Traffic_$KEY$ | Checks the input and output traffic from an interface | wocu-check-traffic | _HOSTSNMPCOMMUNI TY _HOSTSNMPVERSION _HOSTTRAFFIC_WA RNING_THRESHOLD _HOSTTRAFFIC_CR ITICAL_THRESHOLD _IFACES |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_IFACES:
wocu-discover-ifaces-ng.py -H $HOSTADDRESS$ -s $_SNMPVERSION$ -C $_SNMPCOMMUNITY$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -A $_SNMPAUTHKEY$ -x $_SNMPPRIVPROTOCOL$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _DEVICEVENDOR | Device vendor | string |
| _TRAFFIC_WARNING_THRESHOLD | Traffic warning threshold (percentage) | percent |
| _TRAFFIC_CRITICAL_THRESHOLD | Traffic critical threshold (percentage) | percent |
COMPLEX MACROS
_IFACES
- Description: List of interfaces to be checked, indexed by ifIndex instead of ifName
- Discover: wocu-discover-ifaces-ng.py
| Fields | Description | Type |
|---|---|---|
| descr | Interface name (ifDescr) to be shown as part of the service description | string |
| index | Interface index (unique) | integer |
| max speed in | Interface maximum speed in {units} per second. Applied to IN traffic. (Values of 0 mean no limit) | integer |
| max speed out | Interface maximum speed in {units} per second. Applied to OUT traffic. (Values of 0 mean no limit) | integer |
| units | Speed units (g=gigabits/s, m=megabits/s, k=kilobits/s ,b=bits/s) | string |
| alias | Interface alias (ifAlias) to be shown as alternative display name | string |
Networkdevice-traffic-1m¶
DESCRIPTION
Network device traffic checks
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Traffic_1m_$KEY $ | Checks the input and output traffic from an interface. 1 minute check interval | wocu-check- traffic-1m | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTTRAFFIC_1 M_WARNING_THRE SHOLD _HOSTTRAFFIC_1 M_CRITICAL_THR ESHOLD _IFACES_1M |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_IFACES_1M:
wocu-discover-ifaces-ng.py -H $HOSTADDRESS$ -s $_SNMPVERSION$ -C $_SNMPCOMMUNITY$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -A $_SNMPAUTHKEY$ -x $_SNMPPRIVPROTOCOL$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _DEVICEVENDOR | Device vendor | string |
| _TRAFFIC_1M_WARNING_THRESHOL D | Traffic warning threshold | percent |
| _TRAFFIC_1M_CRITICAL_THRESHO LD | Traffic critical threshold | percent |
COMPLEX MACROS
_IFACES_1M
- Description: List of interfaces to be checked, indexed by ifIndex instead of ifName
- Discover: wocu-discover-ifaces-ng.py
| Fields | Description | Type |
|---|---|---|
| descr | Interface name (ifDescr) to be shown as part of the service description | string |
| index | Interface index | integer |
| max speed in | Interface maximum speed in {units} per second. Applied to IN traffic. (Values of 0 mean no limit) | integer |
| max speed out | Interface maximum speed in {units} per second. Applied to OUT traffic. (Values of 0 mean no limit) | integer |
| units | Speed units (g=gigabits/s, m=megabits/s, k=kilobits/s ,b=bits/s) | string |
| alias | Interface alias (ifAlias) to be shown as alternative display name | string |
Networkdevice-traffic-all¶
DESCRIPTION
Network device traffic and health checks
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Interface_Errors _$KEY$ | Checks the number of packets with errors from an interface | networkdevice- traffic-all- errors | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTERROR_WAR NING_THRESHOLD _HOSTERROR_CRI TICAL_THRESHOLD _TRAFFIC_ALL_ IFACES |
| Traffic_$KEY$ | Checks the input and output traffic from an interface | networkdevice- traffic-all- traffic | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTTRAFFIC_W ARNING_THRESHOL D _HOSTTRAFFIC_C RITICAL_THRESHO LD _TRAFFIC_ALL_ IFACES |
| Interface_Discar ds_$KEY$ | Checks the discarded packets from an interface | networkdevice- traffic-all- discards | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTDISCARD_W ARNING_THRESHOL D _HOSTDISCARD_C RITICAL_THRESHO LD _TRAFFIC_ALL_ IFACES |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_TRAFFIC_ALL_IFACES:
wocu-discover-ifaces-ng.py -H $HOSTADDRESS$ -s $_SNMPVERSION$ -C $_SNMPCOMMUNITY$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -A $_SNMPAUTHKEY$ -x $_SNMPPRIVPROTOCOL$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _DEVICEVENDOR | Device vendor | string |
| _TRAFFIC_WARNING_THRESHOLD | Traffic warning threshold (percentage) | percent |
| _TRAFFIC_CRITICAL_THRESHOLD | Traffic critical threshold (percentage) | percent |
| _DISCARD_WARNING_THRESHOLD | Interface discards warning threshold (packets/s) | integer |
| _DISCARD_CRITICAL_THRESHOLD | Interface discards critical threshold (packets/s) | integer |
| _ERROR_WARNING_THRESHOLD | Interface errors warning threshold (packets/s) | integer |
| _ERROR_CRITICAL_THRESHOLD | Interface errors critical threshold (packets/s) | integer |
COMPLEX MACROS
_TRAFFIC_ALL_IFACES
- Description: List of interfaces to be checked, indexed by ifIndex instead of ifName
- Discover: wocu-discover-ifaces-ng.py
| Fields | Description | Type |
|---|---|---|
| descr | Interface name (ifDescr) to be shown as part of the service description | string |
| index | Interface index (unique) | integer |
| max speed in | Interface maximum speed in {units} per second. Applied to IN traffic. (Values of 0 mean no limit) | integer |
| max speed out | Interface maximum speed in {units} per second. Applied to OUT traffic. (Values of 0 mean no limit) | integer |
| units | Speed units (g=gigabits/s, m=megabits/s, k=kilobits/s ,b=bits/s) | string |
| alias | Interface alias (ifAlias) to be shown as alternative display name | string |
Networkdevice-traffic-all-1m¶
DESCRIPTION
Network device traffic and health checks. Check interval 1 minute
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Interface_Errors _1m_$KEY$ | Checks the number of packets with errors from an interface. 1 minute check interval | networkdevice- traffic-all- errors-1m | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTERROR_WAR NING_THRESHOLD _HOSTERROR_CRI TICAL_THRESHOLD _TRAFFIC_ALL_ IFACES_1M |
| Traffic_1m_$KEY $ | Checks the input and output traffic from an interface. 1 minute check interval | networkdevice- traffic-all- traffic-1m | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTTRAFFIC_W ARNING_THRESHOL D _HOSTTRAFFIC_C RITICAL_THRESHO LD _TRAFFIC_ALL_ IFACES_1M |
| Interface_Discar ds_1m_$KEY$ | Checks the discarded packets from an interface. 1 minute check interval | networkdevice- traffic-all- discards-1m | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTDISCARD_W ARNING_THRESHOL D _HOSTDISCARD_C RITICAL_THRESHO LD _TRAFFIC_ALL_ IFACES_1M |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_TRAFFIC_ALL_IFACES_1M:
wocu-discover-ifaces-ng.py -H $HOSTADDRESS$ -s $_SNMPVERSION$ -C $_SNMPCOMMUNITY$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -A $_SNMPAUTHKEY$ -x $_SNMPPRIVPROTOCOL$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _DEVICEVENDOR | Device vendor | string |
| _TRAFFIC_WARNING_THRESHOLD | Traffic warning threshold (percentage) | percent |
| _TRAFFIC_CRITICAL_THRESHOLD | Traffic critical threshold (percentage) | percent |
| _DISCARD_WARNING_THRESHOLD | Interface discards warning threshold (packets/s) | integer |
| _DISCARD_CRITICAL_THRESHOLD | Interface discards critical threshold (packets/s) | integer |
| _ERROR_WARNING_THRESHOLD | Interface errors warning threshold (packets/s) | integer |
| _ERROR_CRITICAL_THRESHOLD | Interface errors critical threshold (packets/s) | integer |
COMPLEX MACROS
_TRAFFIC_ALL_IFACES_1M
- Description: List of interfaces to be checked, indexed by ifIndex instead of ifName
- Discover: wocu-discover-ifaces-ng.py
| Fields | Description | Type |
|---|---|---|
| descr | Interface name (ifDescr) to be shown as part of the service description | string |
| index | Interface index (unique) | integer |
| max speed in | Interface maximum speed in {units} per second. Applied to IN traffic. (Values of 0 mean no limit) | integer |
| max speed out | Interface maximum speed in {units} per second. Applied to OUT traffic. (Values of 0 mean no limit) | integer |
| units | Speed units (g=gigabits/s, m=megabits/s, k=kilobits/s ,b=bits/s) | string |
| alias | Interface alias (ifAlias) to be shown as alternative display name | string |
Networkdevice-traffic-byname¶
DESCRIPTION
Network device traffic checks using the interface name
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Traffic_$KEY$_b yname | Checks the input and output traffic from an interface identified by its name | wocu-check- traffic-byname | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTTRAFFIC_W ARNING_THRESHOL D _HOSTTRAFFIC_C RITICAL_THRESHO LD _IFACES_BYNAME |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_IFACES_BYNAME:
wocu-discover-ifaces-ng.py -H $HOSTADDRESS$ -s $_SNMPVERSION$ -C $_SNMPCOMMUNITY$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -A $_SNMPAUTHKEY$ -x $_SNMPPRIVPROTOCOL$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _DEVICEVENDOR | Device vendor | string |
| _TRAFFIC_WARNING_THRESHOLD | Traffic warning threshold (percentage) | percent |
| _TRAFFIC_CRITICAL_THRESHOLD | Traffic critical threshold (percentage) | percent |
COMPLEX MACROS
_IFACES_BYNAME
- Description: List of interfaces to be checked, indexed by ifName instead of by ifIndex
- Discover: wocu-discover-ifaces-ng.py
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| descr | Interface name (unique) | string |
| max speed in | Interface maximum speed in {units} per second. Applied to IN traffic. (Values of 0 mean no limit) | integer |
| max speed out | Interface maximum speed in {units} per second. Applied to OUT traffic. (Values of 0 mean no limit) | integer |
| units | Speed units (g=gigabits/s, m=megabits/s, k=kilobits/s ,b=bits/s) | string |
Networkdevice-traffic-health¶
DESCRIPTION
Network device interfaces health. Subinterfaces not supported in Cisco devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Interface_Errors _$KEY$ | Checks the number of packets with errors from an interface | check_traffic_h ealth_errors | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTERROR_WAR NING_THRESHOLD _HOSTERROR_CRI TICAL_THRESHOLD _IFACES_HEALTH |
| Interface_Discar ds_$KEY$ | Checks the discarded packets from an interface | check_traffic_h ealth_discards | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTDISCARD_W ARNING_THRESHOL D _HOSTDISCARD_C RITICAL_THRESHO LD _IFACES_HEALTH |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_IFACES_HEALTH:
wocu-discover-ifaces-ng.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ -s $_SNMPVERSION$ –short –exclude_nophysical_ifaces –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1, 2c and 3 | string |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _DEVICEVENDOR | Device vendor | string |
| _DISCARD_WARNING_THRESHOLD | Interface discards warning threshold (packets/s) | integer |
| _DISCARD_CRITICAL_THRESHOLD | Interface discards critical threshold (packets/s) | integer |
| _ERROR_WARNING_THRESHOLD | Interface errors warning threshold (packets/s) | integer |
| _ERROR_CRITICAL_THRESHOLD | Interface errors critical threshold (packets/s) | integer |
COMPLEX MACROS
_IFACES_HEALTH
- Description: List of interfaces to be checked (Errors/Discards) (indexed by ifName). Don’t include subinterfaces
- Discover: wocu-discover-ifaces-ng.py
| Fields | Description | Type |
|---|---|---|
| display name | Display name to be shown as part of the service description | string |
| descr | Interface name (Ifdescr) (unique) | string |
| index | Interface index (unique) | integer |
Networkdevice-traffic-snmp3¶
DESCRIPTION
Network device traffic checks (only snmp version 3)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Traffic_$KEY$ | Checks the input and output traffic from an interface using SNMv3 | wocu-check- traffic-snmp3 | _HOSTSNMP3USERNA ME _HOSTSNMP3AUTHPA SSWORD _HOSTSNMP3AUTHPR OTOCOL _HOSTSNMP3PRIVPA SSWORD _HOSTSNMP3PRIVPR OTOCOL _HOSTTRAFFIC_WA RNING_THRESHOLD _HOSTTRAFFIC_CR ITICAL_THRESHOLD _IFACES |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMP3USERNAME | The securityName for the USM security model, use $SNMP3USERNAME$ for the default username | string |
| _SNMP3AUTHPASSWORD | The authentication password, use $SNMP3AUTHPASSWORD$ for the default auth password | string |
| _SNMP3AUTHPROTOCOL | The authentication protocol (md5, sha), use $SNMP3AUTHPROTOCOL$ for the default auth protocol | string |
| _SNMP3PRIVPASSWORD | The password for authPriv security level, use $SNMP3PRIVPASSWORD$ for the default priv password | string |
| _SNMP3PRIVPROTOCOL | The private protocol (des, aes, aes128, 3des, 3desde), use $SNMP3PRIVPROTOCOL$ for the default priv protocol | string |
| _TRAFFIC_WARNING_THRESHOLD | Traffic warning threshold (percentage) | percent |
| _TRAFFIC_CRITICAL_THRESHOLD | Traffic critical threshold (percentage) | percent |
COMPLEX MACROS
_IFACES
- Description: List of interfaces to be checked, indexed by ifIndex instead of ifName
| Fields | Description | Type |
|---|---|---|
| descr | Interface name (ifDescr) to be shown as part of the service description | string |
| index | Interface index (unique) | integer |
| max speed in | Interface maximum speed in {units} per second. Applied to IN traffic. (Values of 0 mean no limit) | integer |
| max speed out | Interface maximum speed in {units} per second. Applied to OUT traffic. (Values of 0 mean no limit) | integer |
| units | Speed units (g=gigabits/s, m=megabits/s, k=kilobits/s ,b=bits/s) | string |
Networkdevice-traffic-sum¶
DESCRIPTION
This pack shows the summarized traffic (in/out) from all (or selected) interfaces
This pack allows you to calculate the addition of traffic from selected interfaces. You can filter interfaces via regexp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Traffic_Interfac es_Sum | Summarized traffic in/out | check_interface_usage_sum | _HOSTSNMPCOMMUN ITY _HOSTTRAFFIC_S UM_IFACES_REGE XP _HOSTTRAFFIC_S UM_WARNING _HOSTTRAFFIC_S UM_CRITICAL _HOSTTRAFFIC_U NIT |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The snmp community read configured on remote device | string |
| _TRAFFIC_SUM_IFACES_REGEXP | Regular expression to match selected interface names, e.g. Ethernet. Leave blank if you want all interfaces. You must double $ characters in your regexp | string |
| _TRAFFIC_SUM_WARNING | Input/Output summarized traffic warning threshold | integer |
| _TRAFFIC_SUM_CRITICAL | Input/Output summarized traffic critical threshold | integer |
| _TRAFFIC_UNIT | Traffic unit (per second) | string |
Nqa-huawei¶
DESCRIPTION
Check for the NQA values (Jitter/RTT/PacketLoss) in Huawei devices
Check for NQA values (Jitter/RTT/Packet Loss) in Huawei devices using SNMP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| NQA_RTT_$KEY$ | Checks the RTT (Round Trip Time) from a Huawei NQA (Network Quality Analysis) | check_huawei_nq a_rtt | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _NQA_LIST |
| NQA_Jitter_$KEY $ | Checks the quality metrics from a Huawei NQA (Network Quality Analysis) | check_huawei_nq a_jitter | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _NQA_LIST |
| NQA_Packet_loss _$KEY$ | Checks the packet loss metric from a Huawei NQA (Network Quality Analysis) | check_huawei_nq a_packet_loss | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _NQA_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_NQA_LIST:
wocu-discover-huawei-nqa.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
COMPLEX MACROS
_NQA_LIST
- Description: List of NQA rules to be checked
- Discover: wocu-discover-huawei-nqa.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| index | Index of NQA Session | integer |
| name | Name of NQA Session | string |
| jitter_warning | Jitter warning threshold for the NQA Session (milliseconds) | integer |
| jitter_critical | Jitter critical threshold for the NQA Session (milliseconds) | integer |
| packet_loss_warning | Packet Loss warning threshold for the NQA Session (percentage) | percent |
| packet_loss_critical | Packet Loss critical threshold for the NQA Session (percentage) | percent |
| rtt_warning | RTT warning threshold for the NQA Session (milliseconds) | integer |
| rtt_critical | RTT critical threshold for the NQA Session (milliseconds) | integer |
Nqa-huawei-1m¶
DESCRIPTION
Check for the NQA values (Jitter/RTT/PacketLoss) in Huawei devices. Check interval: 1 minute
Check for NQA values (Jitter/RTT/Packet Loss) in Huawei devices using SNMP. Check interval: 1 minute
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| NQA_RTT_1m_$KE Y$ | Checks the RTT (Round Trip Time) from a Huawei NQA (Network Quality Analysis). 1 minute check interval | check_huawei_nq a_rtt | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _NQA_LIST_1M |
| NQA_Jitter_1m_ $KEY$ | Checks the quality metrics from a Huawei NQA (Network Quality Analysis). 1 minute check interval | check_huawei_nq a_jitter | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _NQA_LIST_1M |
| NQA_Packet_loss _1m_$KEY$ | Checks the packet loss metric from a Huawei NQA (Network Quality Analysis). 1 minute check interval | check_huawei_nq a_packet_loss | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _NQA_LIST_1M |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_NQA_LIST_1M:
wocu-discover-huawei-nqa.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
COMPLEX MACROS
_NQA_LIST_1M
- Description: List of NQA rules to be checked every minute
- Discover: wocu-discover-huawei-nqa.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| index | Index of NQA Session | integer |
| name | Name of NQA Session | string |
| jitter_warning | Jitter warning threshold for the NQA Session (milliseconds) | integer |
| jitter_critical | Jitter critical threshold for the NQA Session (milliseconds) | integer |
| packet_loss_warning | Packet Loss warning threshold for the NQA Session (percentage) | percent |
| packet_loss_critical | Packet Loss critical threshold for the NQA Session (percentage) | percent |
| rtt_warning | RTT warning threshold for the NQA Session (milliseconds) | integer |
| rtt_critical | RTT critical threshold for the NQA Session (milliseconds) | integer |
Nqa-huawei-icmp¶
DESCRIPTION
Check for NQA ICMP type tests metrics (RTT/PacketLoss) in Huawei devices
Check for NQA ICMP type test stats (RTT/Packet Loss) in Huawei devices using SNMP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| NQA_ICMP_RTT_$ KEY$ | Checks the RTT (Round Trip Time) from an ICMP type Huawei NQA (Network Quality Analysis) | check_huawei_nq a_icmp_rtt | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _NQA_ICMP_LIS T |
| NQA_ICMP_Packet _loss_$KEY$ | Checks the packet loss metric from an ICMP type Huawei NQA (Network Quality Analysis) | check_huawei_nq a_icmp_packet_ loss | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _NQA_ICMP_LIS T |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_NQA_ICMP_LIST:
wocu-discover-huawei-nqa-icmp.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
COMPLEX MACROS
_NQA_ICMP_LIST
- Description: List of NQA ICMP rules to be checked
- Discover: wocu-discover-huawei-nqa-icmp.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| owner | NQA Test Owner name | string |
| name | NQA Test name | string |
| type | NQA Test type | string |
| oid_suffix | NQA Test identification OID suffix | string |
| packet_loss_warning | Packet Loss warning threshold for the NQA Session (percentage) | float.percent |
| packet_loss_critical | Packet Loss critical threshold for the NQA Session (percentage) | float.percent |
| rtt_warning | RTT warning threshold for the NQA Session (milliseconds) | integer |
| rtt_critical | RTT critical threshold for the NQA Session (milliseconds) | integer |
Nsm-teldat¶
DESCRIPTION
Check for the NSM values (Jitter/RTT/PacketLoss) in Teldat devices
Check for the NSM values (Jitter/RTT/PacketLoss) in Teldat devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| NSM_$KEY$ | Checks the quality metrics from a Teldat NSM (Network Service Monitor) | check_nsm_teldat | _HOSTSNMPCOMMUNITY _HOSTSNMPVERSION _NSM_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_NSM_LIST:
wocu-discover-teldat-nsm.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
COMPLEX MACROS
_NSM_LIST
- Description: List of NSM rules to be checked
- Discover: wocu-discover-teldat-nsm.py
| Fields | Description | Type |
|---|---|---|
| display name | Display name to be shown as part of the service description | string |
| index | Index for snmp queries | integer |
| jitter_critical | Critical threshold for the NSM jitter (milliseconds) | integer |
| jitter_warning | Warning threshold for the NSM jitter (milliseconds) | integer |
| percent_loss_critical | Critical threshold for the NSM packet_loss (percentage) | percent |
| name | Name to be shown in the web interface | string |
| percent_loss_warning | Warning threshold for the NSM packet_loss (percentage) | percent |
| rtt_critical | Critical threshold for NSM rtt (milliseconds) | percent |
| rtt_warning | Warning threshold for NSM rtt (milliseconds) | percent |
Ppa-oneaccess¶
DESCRIPTION
Check for the PPA session values (Jitter/RTT/PacketLoss) in OneAccess devices
Check for PPA session stats (Jitter/RTT/Packet Loss) in OneAccess devices using SNMP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| PPA_Jitter_$KEY $ | Checks the quality metrics from a OneAccess PPA session | check_oneaccess_ppa_jitter | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _PPA_LIST |
| PPA_Packet_loss _$KEY$ | Checks the packet loss from a OneAccess PPA session | check_oneaccess_ppa_packet_los s | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _PPA_LIST |
| PPA_RTT_$KEY$ | Checks the RTT from a OneAccess PPA session | check_oneaccess_ppa_rtt | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _PPA_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_PPA_LIST:
wocu-discover-oneaccess-ppa.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
COMPLEX MACROS
_PPA_LIST
- Description: List of PPA sessions to be checked
- Discover: wocu-discover-oneaccess-ppa.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown as Service Description in the web interface | string |
| index | Index of PPA Session (integer) | integer |
| jitter_warning | Jitter warning threshold for the PPA Session (milliseconds) | integer |
| jitter_critical | Jitter critical threshold for the PPA Session (milliseconds) | integer |
| packet_loss_warning | Packet Loss warning threshold for the PPA Session (percentage) | percent |
| packet_loss_critical | Packet Loss critical threshold for the PPA Session (percentage) | percent |
| rtt_warning | RTT warning threshold for the PPA Session (milliseconds) | integer |
| rtt_critical | RTT critical threshold for the PPA Session (milliseconds) | integer |
Qos¶
DESCRIPTION
Checks the QoS classes configured on a network device. Support for Cisco, Juniper, Teldat and OneAccess devices. _DEVICEVENDOR must be configured and applied before discovering QoS classes
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| $KEY$ | Checks the QoS class traffic and drop packets | check_qos | _HOSTSNMPCOMMUNITY _HOSTSNMPVERSION _HOSTDEVICEVENDOR _QOSLIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_QOSLIST:
wocu-discover-qos.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –vendor $_DEVICEVENDOR$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
| _DEVICEVENDOR | Device vendor. Must be configured and applied before discovering QoS classes | string |
COMPLEX MACROS
_QOSLIST
- Description: List of QoS configured on the network devices. _DEVICEVENDOR must be configured and applied before discovering QoS classes
- Discover: wocu-discover-qos.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Display name to be shown as part of the service description | string |
| ifName | ifName for snmp queries | string |
| ifIndex | ifIndex for snmp queries | integer |
| Queue Number | Numeric value of the QoS Queue (ex: 2 instead of Silver) | integer |
| TX Warning | TX Warning Threshold (bps) | integer |
| TX Critical | TX Critical Threshold (bps) | integer |
| Drops Warning | Drops Warning Threshold (bps) | integer |
| Drops Critical | Drops Critical Threshold (bps) | integer |
Qos-cisco¶
DESCRIPTION
Checks for the QOS status configured on Cisco routers
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| QOS_$KEY$ | Checks the QoS class traffic and drop packets for Cisco Devices | check_qos_cisco | _HOSTSNMPCOMMUNITY _HOSTQOS_WARNING_ THRESHOLD _HOSTQOS_CRITICAL_THRESHOLD _QOS_CLASSES |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_QOS_CLASSES:
wocu-discover-qos-cisco.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _QOS_WARNING_THRESHOLD | QOS warning limits | integer |
| _QOS_CRITICAL_THRESHOLD | QOS critical limits | integer |
COMPLEX MACROS
_QOS_CLASSES
- Description: QOS classes(cisco)
- Discover: wocu-discover-qos-cisco.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Custom Name appearing in the service: QOS_<Display Name> | string |
| QOS Name | QOS snmp class name (configured on remote device) | string |
Qos-huawei¶
DESCRIPTION
Checks QoS Classes rates in Huawei devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| QoS - $KEY$ | Checks the traffic, discards and drops rates in Huawei QoS Classes | qos-huawei-rate | _HOSTSNMPCOMMUNITY _HOSTSNMPVERSION _QOS_HUAWEI_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_QOS_HUAWEI_LIST:
wocu-discover-huawei-qos.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
COMPLEX MACROS
_QOS_HUAWEI_LIST
- Description: List of QoS Classes
- Discover: wocu-discover-huawei-qos.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| oid_suffix | OID Suffix used in snmp queries | string |
| qos_index | QoS class index used in snmp queries | string |
| tx_warning | QoS Class TX warning threshold (bps) | integer |
| tx_critical | QoS Class TX rate critical threshold (bps) | integer |
| drops_warning | QoS Class Drops rate warning threshold (bps) | integer |
| drops_critical | QoS Class Drops rate critical threshold (bps) | integer |
| discards_warning | QoS Class enqueue discards rate warning threshold (bps) | integer |
| discards_critical | QoS Class enqueue discards rate critical threshold (bps) | integer |
Rpm-juniper¶
DESCRIPTION
Check for RPM tests metrics (RTT/Jitter/PacketLoss) in Juniper devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| RPM_RTT_$KEY$ | Checks Juniper RPM (Real-Time Performance Monitoring) probe Round Trip Time | check_juniper_r pm_rtt | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _RPM_LIST |
| RPM_Jitter_$KEY $ | Checks Juniper RPM (Real-Time Performance Monitoring) probe jitter | check_juniper_r pm_jitter | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _RPM_LIST |
| RPM_Lost_Percen t_$KEY$ | Checks Juniper RPM (Real-Time Performance Monitoring) probe lost packets percent | check_juniper_r pm_loss_percent | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _RPM_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_RPM_LIST:
wocu-discover-juniper-rpm.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
COMPLEX MACROS
_RPM_LIST
- Description: List of RPM probes to be checked
- Discover: wocu-discover-juniper-rpm.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| owner | RPM Test Owner name | string |
| name | RPM Test name | string |
| oid_suffix | RPM Test identification OID suffix | string |
| loss_percent_warning | Loss warning threshold for the RPM Session (percentage) | percent |
| loss_percent_critical | Loss critical threshold for the RPM Session (percentage) | percent |
| rtt_warning | RTT warning threshold for the RPM Session (milliseconds) | integer |
| rtt_critical | RTT critical threshold for the RPM Session (milliseconds) | integer |
| jitter_warning | Jitter warning threshold for the RPM Session (milliseconds) | integer |
| jitter_critical | Jitter critical threshold for the RPM Session (milliseconds) | integer |
Snmp-generic¶
DESCRIPTION
Nagios official pack to check user defined SNMP oids
Generic pack to check OIDs not included in any other pack. This pack is related to snmp-oid pack
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| SNMP_$KEY$ | Checks the custom configured OID | check_snmp_generi c_oid | _HOSTSNMPCOMMUNIT Y _HOSTSNMPVERSION _SNMP_OIDS |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | SNMP version of the server (allowed 1 and 2c) | string |
COMPLEX MACROS
_SNMP_OIDS
- Description: List of SNMP oids to overwatch
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| oid | SNMP oid to monitor | string |
| warning | SNMP oid warning threshold | string |
| critical | SNMP oid critical threshold | string |
Snmp-generic-1m¶
DESCRIPTION
Nagios official pack to check user defined SNMP oids. Check interval: 1 minute
Generic pack to check OIDs not included in any other pack. This pack is related to snmp-oid-1m pack
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| SNMP_1m_$KEY$ | Checks the custom configured OID with 1 minute check interval | check_snmp_gene ric_1m_oid | _HOSTSNMPCOMMUNI TY _HOSTSNMPVERSION _SNMP_OIDS_1M |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | SNMP version of the server (allowed 1 and 2c) | string |
COMPLEX MACROS
_SNMP_OIDS_1M
- Description: List of SNMP oids to overwatch
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| oid | SNMP oid to monitor | string |
| warning | SNMP oid warning threshold | string |
| critical | SNMP oid critical threshold | string |
Snmp-generic-advanced¶
DESCRIPTION
Improved Nagios pack to check user defined SNMP oids. Supported OID types: counter, rate, string and regex
More info about thresholds and ranges in: https://nagios-plugins.org/doc/guidelines.html#THRESHOLDFORMAT
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| SNMP_Advanced_$ KEY$ | Compare configured snmp OID reply with thresholds, string or regex | check_snmp_gene ric_advanced_oi d | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _SNMP_OIDS_AD VANCED |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ to use default system community | string |
| _SNMPVERSION | SNMP version of the server (allowed 1 and 2c) | string |
COMPLEX MACROS
_SNMP_OIDS_ADVANCED
- Description: List of SNMP oids to check
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| oid | SNMP oid to monitor | string |
| type | OID type | string |
| warning | Warning threshold. Format: [@]start:end. Examples: 10, 10:, :10, 10:20, @10:20 | string |
| critical | Critical threshold. Format: [@]start:end. Examples: 10, 10:, :10, 10:20, @10:20 | string |
| string/regex | String or regex to compare with snmp reply | string |
| unit | Units label for output and perfdata | string |
| label | Label for output and perfdata. Must be unique | string |
Snmp-oid¶
DESCRIPTION
Custom pack to check user defined SNMP oids
Generic pack to check OIDs not included in any other pack. This pack is related to snmp-generic pack
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| SNMP_$KEY$ | Checks the custom configured OID | check_snmp_oid | _HOSTSNMPCOMMUNITY _HOSTSNMPVERSION _SNMP_OID_OIDS |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | SNMP version of the server (allowed 1 and 2c) | string |
COMPLEX MACROS
_SNMP_OID_OIDS
- Description: List of SNMP oids to overwatch
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| oid | SNMP oid to monitor | string |
| min_warning | Bottom warning threshold | integer |
| min_critical | Bottom critical threshold | integer |
| max_warning | Top warning threshold | integer |
| max_critical | Top critical threshold | integer |
Snmp-oid-1m¶
DESCRIPTION
Custom pack to check user defined SNMP oids. Check interval: 1 minute
Generic pack to check OIDs not included in any other pack. This pack is related to snmp-generic-1m pack
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| SNMP_1m_$KEY$ | Checks the custom configured OID with 1 minute check interval | check_snmp_oid_1m | _HOSTSNMPCOMMUNI TY _HOSTSNMPVERSION _SNMP_OID_OIDS _1M |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | SNMP version of the server (allowed 1 and 2c) | string |
COMPLEX MACROS
_SNMP_OID_OIDS_1M
- Description: List of SNMP oids to overwatch
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| oid | SNMP oid to monitor | string |
| min_warning | Bottom warning threshold | integer |
| min_critical | Bottom critical threshold | integer |
| max_warning | Top warning threshold | integer |
| max_critical | Top critical threshold | integer |
Squid¶
DESCRIPTION
Checks metrics from Squid proxy servers. Tested on Squid 3.3
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Squid Cache Stats | Shows Cache stats and checks memory and swap usage | check_squid_cac he | _HOSTSQUID_POR T _HOSTSTORAGE_S WAP_USED_WARNI NG _HOSTSTORAGE_S WAP_USED_CRITI CAL _HOSTSTORAGE_M EM_USED_WARNIN G _HOSTSTORAGE_M EM_USED_CRITIC AL |
| Squid Memory | Checks Squid Memory usage | check_squid_mem | _HOSTSQUID_POR T _HOSTSQUID_MEM _WARNING _HOSTSQUID_MEM _CRITICAL |
| Squid ICP Stats | Shows ICP stats and checks queued messages | check_squid_icp | _HOSTSQUID_POR T _HOSTICP_QUEUE D_WARNING _HOSTICP_QUEUE D_CRITICAL |
| Squid HTTP Stats | Shows HTTP stats and checks failure ratio | check_squid_htt p | _HOSTSQUID_POR T _HOSTHTTP_FAIL URE_RATIO_WARN ING _HOSTHTTP_FAIL URE_RATIO_CRIT ICAL |
| Squid Median service times | Shows median services times | check_squid_med ian | _HOSTSQUID_POR T |
| Squid Uptime | Checks Squid uptime | check_squid_upt ime | _HOSTSQUID_POR T _HOSTSQUID_UPT IME_WARNING _HOSTSQUID_UPT IME_CRITICAL |
| Squid CPU | Checks Squid CPU usage | check_squid_cpu | _HOSTSQUID_POR T _HOSTSQUID_CPU _WARNING _HOSTSQUID_CPU _CRITICAL |
| Squid Clients | Checks connected clients | check_squid_cli ents | _HOSTSQUID_POR T _HOSTCLIENTS_W ARNING _HOSTCLIENTS_C RITICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SQUID_PORT | TCP port where Squid is listening to (default 3128) | integer |
| _CLIENTS_WARNING | Connected clients warning threshold | integer |
| _CLIENTS_CRITICAL | Connected clients critical threshold | integer |
| _HTTP_FAILURE_RATIO_WARNING | Http requests failure ratio warning threshold | integer |
| _HTTP_FAILURE_RATIO_CRITICAL | Http requests failure ratio critical threshold | integer |
| _ICP_QUEUED_WARNING | Queued ICP messages warning threshold | integer |
| _ICP_QUEUED_CRITICAL | Queued ICP messages critical threshold | integer |
| _STORAGE_SWAP_USED_WARNING | Storage SWAP used percent warning threshold (percent) | percent |
| _STORAGE_SWAP_USED_CRITICAL | Storage SWAP used percent critical threshold (percent) | percent |
| _STORAGE_MEM_USED_WARNING | Storage Memory used percent warning threshold (percent) | percent |
| _STORAGE_MEM_USED_CRITICAL | Storage Memory used percent critical threshold (percent) | percent |
| _SQUID_UPTIME_WARNING | Squid Uptime warning threshold (seconds) | integer |
| _SQUID_UPTIME_CRITICAL | Squid uptime critical threshold (seconds) | integer |
| _SQUID_CPU_WARNING | Squid CPU usage warning threshold (percent) | percent |
| _SQUID_CPU_CRITICAL | Squid CPU usage critical threshold (percent) | percent |
| _SQUID_MEM_WARNING | Squid Memory usage warning threshold (percent) | percent |
| _SQUID_MEM_CRITICAL | Squid Memory usage critical threshold (percent) | percent |
Tcp-generic¶
DESCRIPTION
List of TCP ports to check
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| TCP_$KEY$ | Checks TCP port connectivity | check_tcp | _TCP_PORTS |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_TCP_PORTS:
wocu-discover-tcp-ports.py $HOSTADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
COMPLEX MACROS
_TCP_PORTS
- Description: List of TCP ports to overwatch
- Discover: wocu-discover-tcp-ports.py
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| port | TCP port to monitor | integer |
Traps-snmp¶
DESCRIPTION
Checks for the received traps via NSCA module
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| TRAPs | check_dummy_traps |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
Umts-generic¶
DESCRIPTION
Health and info checks for 3G/4G routers. WARNING: Obsoleted by networkdevice-mobile-signal
Health and info checks for 3G/4G routers. WARNING: Obsoleted by networkdevice-mobile-signal. Supported vendors: Cisco and Teldat
Use instructions:
- Fill the macro fields manually for every router instance
- Critical and Warning BAND thresholds must be an integer from 1 to 12: unknown(1),invalid(2),none(3),gsm850(4),gsm900(5),gsm1800(6),gsm1900(7),
- wcdma800(8),wcdma850(9),wcdma1900(10),twcdma2100(11),lteband(12)
- -Critical and Warning RSSI(Coverage Area Quality) thresholds must be an integer from - 65535 to 0 dBm: Excellent(-10 to - 70), Good(-71 to - 80), Fair(-81 to - 85), Weak(-86 to - 95), Very Weak(-96 to - 110),Negligible(-111 and lower), No Signal(-125 or - 65535 or 0) -Critical and Warning EC / IO or RSRQ(Signal Quality) thresholds must be an integer from - 65535 to 0 dB: EC / IO Excellent(0 to - 1), Good(-1 to - 6), Marginal(-6 to - 9),Poor / Unacceptable(-9 + ).RSRQ >= -10 dB(Excellent), -10 dB to - 15 dB(Good), -15 dB to - 20 dB(Fair to poor), <= -20 dB(No signal)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| 3G_info$KEY$ | Shows 3G/4G connection information | 3g-info | _HOSTSNMPCOMMUNITY _HOSTDEVICEVENDOR _HOSTSNMPVERSION _3GLIST |
| 3G_health$KEY$ | Checks the quality metrics from a 3G/4G connection | 3g-health | _HOSTSNMPCOMMUNITY _HOSTDEVICEVENDOR _HOSTSNMPVERSION _3GLIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
COMPLEX MACROS
_3GLIST
- Description: List of parameters and thresholds for router instances
| Fields | Description | Type |
|---|---|---|
| display name | Name to be shown in the web interface | string |
| index | Index for snmp queries | integer |
| critical band | GPRS/UMTS/LTE band to which the modem is attached critical threshold (1 to 12). See pack extended description for details | integer |
| warning band | GPRS/UMTS/LTE band to which the modem is attached warning threshold (1 to 12). See pack extended description for details | integer |
| critical rssi | RSSI (Coverage Area Quality) Critical threshold | integer |
| warning rssi | RSSI (Coverage Area Quality) Warning threshold | integer |
| critical EcIo | EC/IO (3G) or RSRQ (4G) - Signal Quality Critical threshold | integer |
| warning EcIo | EC/IO (3G) or RSRQ (4G) - Signal Quality Warning threshold | integer |
Vrrp-generic¶
DESCRIPTION
Check for the VRRP configured interfaces on Generic routers
VRRP interfaces checks per Device
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| VRRP - $KEY$ | Checks VRRP (Virtual Router Redundancy Protocol) interface state | check_vrrp_inter face | _HOSTSNMPCOMMUNIT Y _HOSTSNMPSECURITY NAME _HOSTSNMPAUTHPROT OCOL _HOSTSNMPAUTHKEY _HOSTSNMPPRIVPROT OCOL _HOSTSNMPPRIVKEY _HOSTSNMPSECURITY LEVEL _HOSTSNMPCONTEXT _HOSTSNMPVERSION _VRRP_INTERFACES |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_VRRP_INTERFACES:
wocu-discover-vrrp-interfaces.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community (only snmp v2) | string |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _SNMPVERSION | Device SNMP version, supported 1 and 2c | string |
COMPLEX MACROS
_VRRP_INTERFACES
- Description: VRRP interfaces (list)
- Discover: wocu-discover-vrrp-interfaces.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Custom Name appearing in the service: VRRP_<Virtual IP> | string |
| Virtual IP | VRRP Virtual IP (configured on remote device) | string |
| ifIndex | VRRP interface index (ifindex configured on remote device) | integer |
| Group | VRRP group (configured on remote device) | integer |
| State | VRRP state (to be checked on remote device) | string |
Storage¶
3par¶
DESCRIPTION
Health checks for HP 3PAR devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| 3par-nl-capacity | Checks 3Par near line capacity information. | check_3par_nl_ capacity | _HOST3PAR_API_PORT _HOSTUSER _HOSTPASSWORD _HOST3PAR_API_PROTOCOL _HOST3PAR_API_VERSION _HOSTCAPACITY_ WARNING _HOSTCAPACITY_ CRITICAL |
| 3PAR - Physical Disks | Checks the Physical Disks state | check_3par_phys ical_disks | _HOSTUSER _HOSTPASSWORD |
| 3par-volume- status-$KEY$ | Checks 3Par volume status information. | check_3par_volu me_status | _HOST3PAR_API_PORT _HOSTUSER _HOSTPASSWORD _HOST3PAR_API_PROTOCOL _HOST3PAR_API_VERSION _VOLUME_LIST |
| 3par-volume- info-$KEY$ | Checks 3Par volume information. | check_3par_volu me_info | _HOST3PAR_API_PORT _HOSTUSER _HOSTPASSWORD _HOST3PAR_API_PROTOCOL _HOST3PAR_API_VERSION _VOLUME_LIST |
| 3par-volume- performance-$KEY$ | Checks 3Par volume performance information. | check_3par_volu me_performance | _HOST3PAR_API_PORT _HOSTUSER _HOSTPASSWORD _HOST3PAR_API_PROTOCOL _HOST3PAR_API_VERSION _HOSTWLAT_CRIT _HOSTWLAT_WARN _HOSTRLAT_CRIT _HOSTRLAT_WARN _HOSTWBW_CRIT _HOSTWBW_WARN _HOSTRBW_CRIT _HOSTRBW_WARN _HOSTWIOPS_CRI T _HOSTWIOPS_WAR N _HOSTRIOPS_CRI T _HOSTRIOPS_WAR N _VOLUME_LIST |
| 3PAR - Virtual Volumes | Checks the Virtual Volumes state | check_3par_virt ual_volumes | _HOSTUSER _HOSTPASSWORD |
| 3par-overall- capacity | Checks 3Par overall capacity information. | check_3par_over all_capacity | _HOST3PAR_API_PORT _HOSTUSER _HOSTPASSWORD _HOST3PAR_API_PROTOCOL _HOST3PAR_API_VERSION _HOSTCAPACITY_ WARNING _HOSTCAPACITY_ CRITICAL |
| 3par-ssd-capacity | Checks 3Par solid state disk capacity information. | check_3par_ssd_capacity | _HOST3PAR_API_PORT _HOSTUSER _HOSTPASSWORD _HOST3PAR_API_PROTOCOL _HOST3PAR_API_VERSION _HOSTCAPACITY_ WARNING _HOSTCAPACITY_ CRITICAL |
| 3par-fc-capacity | Checks 3Par fiber channel capacity information. | check_3par_fc_ capacity | _HOST3PAR_API_PORT _HOSTUSER _HOSTPASSWORD _HOST3PAR_API_PROTOCOL _HOST3PAR_API_VERSION _HOSTCAPACITY_ WARNING _HOSTCAPACITY_ CRITICAL |
| 3PAR - Nodes | Checks the Nodes state | check_3par_node s | _HOSTUSER _HOSTPASSWORD |
| 3par-cpu | Checks 3Par CPU info. | check_3par_cpu | _HOST3PAR_API_PORT _HOSTUSER _HOSTPASSWORD _HOST3PAR_API_PROTOCOL _HOST3PAR_API_VERSION _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| 3PAR - Alerts | Checks the Alerts | check_3par_aler ts | _HOSTUSER _HOSTPASSWORD |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_VOLUME_LIST:
wocu-discover-3par.py -H $HOSTADDRESS$ -P $_3PAR_API_PORT$ -u $_USER$ -p $_PASSWORD$ –protocol $_3PAR_API_PROTOCOL$ –api-version $_3PAR_API_VERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _USER | User to use in the check | string |
| _PASSWORD | Password to use in the check | string |
| _3PAR_API_PORT | 3Par API port | string |
| _3PAR_API_PROTOCOL | 3Par API protocol connection | string |
| _3PAR_API_VERSION | 3Par API version | string |
| _CAPACITY_WARNING | Volume capacity warning threshold | percent |
| _CAPACITY_CRITICAL | Volume capacity critical threshold | percent |
| _CPU_WARNING | CPU usage warning threshold | percent |
| _CPU_CRITICAL | CPU usage critical threshold | percent |
| _WLAT_CRIT | Write Latency critical threshold (in microseconds) | integer |
| _WLAT_WARN | Write Latency warning threshold (in microseconds) | integer |
| _RLAT_CRIT | Read Latency critical threshold (in microseconds) | integer |
| _RLAT_WARN | Read Latency warning threshold (in microseconds) | integer |
| _WBW_CRIT | Write bandwidth critical threshold (in Bps) | integer |
| _WBW_WARN | Write bandwidth warning threshold (in Bps) | integer |
| _RBW_CRIT | Read bandwidth critical threshold (in Bps) | integer |
| _RBW_WARN | Read bandwidth warning threshold (in Bps) | integer |
| _WIOPS_CRIT | Write IOPS critical threshold (in IOPS/s) | integer |
| _WIOPS_WARN | Write IOPS warning threshold (in IOPS/s) | integer |
| _RIOPS_CRIT | Read IOPS critical threshold (in IOPS/s) | integer |
| _RIOPS_WARN | Read IOPS warning threshold (in IOPS/s) | integer |
COMPLEX MACROS
_VOLUME_LIST
- Description: List of interfaces to be checked, indexed by ifIndex instead of ifName
- Discover: wocu-discover-3par.py
| Fields | Description | Type |
|---|---|---|
| display_name | Interface name to be shown as part of the service description | string |
| index | Volume index (unique) | integer |
| capacity_warning_threshold | Capacity warning threshold | percent |
| capacity_critical_threshold | Capacity critical threshold | percent |
Nas-iomega¶
DESCRIPTION
Check Iomega NAS system, disks, raid and storages
Pack for checking the state of Lenovo IOmega NAS devices through snmp v3
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Partition_$KEY$ | check_iomega_parti tion_usage | _HOSTSNMPCOMMUNITY _HOSTSNMPSECURITYNA ME _HOSTSNMPAUTHPROTOC OL _HOSTSNMPAUTHKEY _HOSTSNMPPRIVPROTOC OL _HOSTSNMPPRIVKEY _HOSTSNMPSECURITYLE VEL _HOSTSNMPCONTEXT _HOSTSNMPVERSION _HOSTSTORAGE_USAGE _WARNING _HOSTSTORAGE_USAGE _CRITICAL _PARTITIONS |
|
| Info | check_iomega_info | _HOSTSNMPCOMMUNITY _HOSTSNMPSECURITYNA ME _HOSTSNMPAUTHPROTOC OL _HOSTSNMPAUTHKEY _HOSTSNMPPRIVPROTOC OL _HOSTSNMPPRIVKEY _HOSTSNMPSECURITYLE VEL _HOSTSNMPCONTEXT _HOSTSNMPVERSION |
|
| CPU_usage | check_iomega_cpu_ usage | _HOSTSNMPCOMMUNITY _HOSTSNMPSECURITYNA ME _HOSTSNMPAUTHPROTOC OL _HOSTSNMPAUTHKEY _HOSTSNMPPRIVPROTOC OL _HOSTSNMPPRIVKEY _HOSTSNMPSECURITYLE VEL _HOSTSNMPCONTEXT _HOSTSNMPVERSION _HOSTCPU_USAGE_WA RNING _HOSTCPU_USAGE_CR ITICAL |
|
| Raid_status | check_iomega_raid_status | _HOSTSNMPCOMMUNITY _HOSTSNMPSECURITYNA ME _HOSTSNMPAUTHPROTOC OL _HOSTSNMPAUTHKEY _HOSTSNMPPRIVPROTOC OL _HOSTSNMPPRIVKEY _HOSTSNMPSECURITYLE VEL _HOSTSNMPCONTEXT _HOSTSNMPVERSION |
|
| Disks_status | check_iomega_disks _status | _HOSTSNMPCOMMUNITY _HOSTSNMPSECURITYNA ME _HOSTSNMPAUTHPROTOC OL _HOSTSNMPAUTHKEY _HOSTSNMPPRIVPROTOC OL _HOSTSNMPPRIVKEY _HOSTSNMPSECURITYLE VEL _HOSTSNMPCONTEXT _HOSTSNMPVERSION |
|
| Memory_usage | check_iomega_mem_ usage | _HOSTSNMPCOMMUNITY _HOSTSNMPSECURITYNA ME _HOSTSNMPAUTHPROTOC OL _HOSTSNMPAUTHKEY _HOSTSNMPPRIVPROTOC OL _HOSTSNMPPRIVKEY _HOSTSNMPSECURITYLE VEL _HOSTSNMPCONTEXT _HOSTSNMPVERSION _HOSTMEM_USAGE_WA RNING _HOSTMEM_USAGE_CR ITICAL |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -A $_SNMPAUTHKEY$ -x $_SNMPPRIVPROTOCOL$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ –remote $_POLLER_TAG_ADDRESS$_PARTITIONS:
wocu-discover-os-resources-partitions.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ -s $_SNMPVERSION$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -A $_SNMPAUTHKEY$ -x $_SNMPPRIVPROTOCOL$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _STORAGE_USAGE_WARNING | Warning threshold for each storage usage | percent |
| _STORAGE_USAGE_CRITICAL | Critical threshold for each storage usage | percent |
| _CPU_USAGE_WARNING | Warning threshold for CPU usage as percentage | percent |
| _CPU_USAGE_CRITICAL | Critical threshold for CPU usage as percentage | percent |
| _MEM_USAGE_WARNING | Warning threshold for Memory usage as percentage | percent |
| _MEM_USAGE_CRITICAL | Critical threshold for Memory usage as percentage | percent |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _SNMPCOMMUNITY | SNMP Community | string |
| _SNMPVERSION | Device SNMP version, supported 1, 2c and 3 | string |
COMPLEX MACROS
_PARTITIONS
- Description: Disk partitions
- Discover: wocu-discover-os-resources-partitions.py
| Fields | Description | Type |
|---|---|---|
| index | Partition index | integer |
| label | Partition label | string |
| unit | Letter unit or path | string |
Nas-synology¶
DESCRIPTION
Check Synology NAS system, disks, raid and storages
Checks for NAS Synology devices.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Upgrade Available | Checks if there is an available upgrade | check_synology_ upgrade_availabl e | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| System Fan Status | Checks the status from system fan | check_synology_ system_fan_stat us | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| Info | Shows system information | check_synology_ info | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| Disks Temperatures | Checks the temperature from disks | check_synology_ disks_temperatur es | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTDISK_TEMP ERATURE_WARNING _HOSTDISK_TEMP ERATURE_CRITICA L |
| CPU Usage | Checks the CPU usage | check_synology_ cpu_usage | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTCPU_USAGE _WARNING _HOSTCPU_USAGE _CRITICAL |
| CPU Fan Status | Checks the status of CPU fan | check_synology_ cpu_fan_status | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| PowerSupplies Status | Checks the status from power supplies | check_synology_ power_status | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| Storage Usage | Checks the storage usage | check_synology_ storage_usage | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTSTORAGE_U SAGE_WARNING _HOSTSTORAGE_U SAGE_CRITICAL |
| Raid Status | Checks the raid status | check_synology_ raid_status | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| System Status | Checks the system status | check_synology_ system_status | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| Load Average | Checks the system load average | check_synology_ load | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTLOAD_WARN ING _HOSTLOAD_CRIT ICAL |
| System Temperature | Checks the temperature from system | check_synology_ system_temperatu re | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTSYSTEM_TE MPERATURE_WARNI NG _HOSTSYSTEM_TE MPERATURE_CRITI CAL |
| Disks Status | Checks the disks status | check_synology_ disks_status | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| Memory Usage | Checks the memory usage | check_synology_ mem_usage | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTMEM_USAGE _WARNING _HOSTMEM_USAGE _CRITICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP Community | string |
| _SNMPVERSION | SNMP version | string |
| _SYSTEM_TEMPERATURE_WARNING | Warning threshold for system temperature (in Celsius degrees) | integer |
| _SYSTEM_TEMPERATURE_CRITICAL | Critical threshold for system temperature (in Celsius degrees) | integer |
| _STORAGE_USAGE_WARNING | Global Warning threshold for storage usage | percent |
| _STORAGE_USAGE_CRITICAL | Global Critical threshold for storage usage | percent |
| _DISK_TEMPERATURE_WARNING | Warning threshold for all disks temperatures (in Celsius degrees) | integer |
| _DISK_TEMPERATURE_CRITICAL | Critical threshold for all disks temperatures (in Celsius degrees) | integer |
| _CPU_USAGE_WARNING | Warning threshold for CPU usage (percentage) | percent |
| _CPU_USAGE_CRITICAL | Critical threshold for CPU usage (percentage) | percent |
| _MEM_USAGE_WARNING | Warning threshold for Memory usage as (percentage) | percent |
| _MEM_USAGE_CRITICAL | Critical threshold for Memory usage as (percentage) | percent |
| _LOAD_WARNING | Warning threshold for load average in last 15 minutes | integer |
| _LOAD_CRITICAL | Critical threshold for load average in last 15 minutes | integer |
Purestorage¶
DESCRIPTION
PureStorage specific health and performance checks
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| PureStorage - Info | Checks PureStorage FlashArray model and Purity version info | check_purestorag e_info | _HOSTAPI_TOKEN |
| PureStorage - Occupancy - FA | Checks PureStorage FlashArray occupancy | check_purestorag e_occupancy_fa | _HOSTAPI_TOKEN |
| PureStorage - Load - FA | Checks PureStorage FlashArray load average percent | check_purestorag e_load_fa | _HOSTAPI_TOKEN _HOSTPRIV_KEYP ASS _HOSTPURE1_API _KEY _HOSTLOAD_WARN _HOSTLOAD_CRIT |
| PureStorage - Performance - Volume $KEY$ | Checks PureStorage FlashArray Volume performance | check_purestorag e_perf_volume | _HOSTAPI_TOKEN _HOSTWLAT_CRIT _HOSTWLAT_WARN _HOSTRLAT_CRIT _HOSTRLAT_WARN _HOSTWBW_CRIT _HOSTWBW_WARN _HOSTRBW_CRIT _HOSTRBW_WARN _HOSTWIOPS_CRI T _HOSTWIOPS_WAR N _HOSTRIOPS_CRI T _HOSTRIOPS_WAR N _PURESTORAGE_V OLUME_LIST |
| PureStorage - Open Alerts | Checks Open Alerts in PureStorage FlashArray | check_purestorag e_alerts | _HOSTAPI_TOKEN |
| PureStorage - Occupancy - Volume $KEY$ | Checks PureStorage FlashArray Volume occupancy | check_purestorag e_occupancy_vol ume | _HOSTAPI_TOKEN _PURESTORAGE_V OLUME_LIST |
| PureStorage - Status - $KEY$ | Checks status of PureStorage FlashArray HW components | check_purestorag e_hw_status | _HOSTAPI_TOKEN _PURESTORAGE_H W_LIST |
| PureStorage - Performance - FA | Checks PureStorage FlashArray performance | check_purestorag e_perf_fa | _HOSTAPI_TOKEN _HOSTWLAT_CRIT _HOSTWLAT_WARN _HOSTRLAT_CRIT _HOSTRLAT_WARN _HOSTWBW_CRIT _HOSTWBW_WARN _HOSTRBW_CRIT _HOSTRBW_WARN _HOSTWIOPS_CRI T _HOSTWIOPS_WAR N _HOSTRIOPS_CRI T _HOSTRIOPS_WAR N |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_PURESTORAGE_VOLUME_LIST:
wocu-discover-purestorage-volumes.py -H $HOSTADDRESS$ -at $_API_TOKEN$ –remote $_POLLER_TAG_ADDRESS$_PURESTORAGE_HW_LIST:
wocu-discover-purestorage-hw.py -H $HOSTADDRESS$ -at $_API_TOKEN$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _API_TOKEN | Autentication token for the API REST call session | string |
| _PRIV_KEYPASS | Private key passphrase installed in Pure1 | string |
| _PURE1_API_KEY | API key installed in Pure1. Must start with: pure1:apikey: | string |
| _WLAT_CRIT | Write Latency critical threshold (in milliseconds) | integer |
| _WLAT_WARN | Write Latency warning threshold (in milliseconds) | integer |
| _RLAT_CRIT | Read Latency critical threshold (in milliseconds) | integer |
| _RLAT_WARN | Read Latency warning threshold (in milliseconds) | integer |
| _WBW_CRIT | Write bandwidth critical threshold (in Bps) | integer |
| _WBW_WARN | Write bandwidth warning threshold (in Bps) | integer |
| _RBW_CRIT | Read bandwidth critical threshold (in Bps) | integer |
| _RBW_WARN | Read bandwidth warning threshold (in Bps) | integer |
| _WIOPS_CRIT | Write IOPS critical threshold (in IOPS/s) | integer |
| _WIOPS_WARN | Write IOPS warning threshold (in IOPS/s) | integer |
| _RIOPS_CRIT | Read IOPS critical threshold (in IOPS/s) | integer |
| _RIOPS_WARN | Read IOPS warning threshold (in IOPS/s) | integer |
| _LOAD_CRIT | Array 5 minute avg load percent critical threshold | percent |
| _LOAD_WARN | Array 5 minute avg load percent warning threshold | percent |
COMPLEX MACROS
_PURESTORAGE_VOLUME_LIST
- Description: List of Volumes to be checked
- Discover: wocu-discover-purestorage-volumes.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| name | Volume name | string |
_PURESTORAGE_HW_LIST
- Description: List of Hardware components to be checked
- Discover: wocu-discover-purestorage-hw.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| name | Hardware component name | string |
Qnap¶
DESCRIPTION
Checks for the QNAP NAS devices
Checks for the QNAP NAS devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Qnap_cache_disk _status | Checks the status from cache disk | check_qnap_cach ediskstatus | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Qnap_fans | Checks the fans speed | check_qnap_fans | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTFAN_SPEED _WARNING _HOSTFAN_SPEED _CRITICAL |
| Qnap_info | Shows system information | check_qnap_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Qnap_Temp | Checks the system temperature | check_qnap_temp | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTTEMP_WARN ING _HOSTTEMP_CRIT ICAL |
| Qnap_lunstatus | Checks the LUN (Logical Unit Number) status | check_qnap_luns tatus | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Qnap_power_supp ly | Checks the power supply status | check_qnap_powe rsupply | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Qnap_hdstatus | Checks the hard drive status | check_qnap_hdst atus | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Qnap_CPU | Checks the CPU usage | check_qnap_cpu | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Qnap_volusage | Checks the volumes usage | check_qnap_volu sage | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTVOL_USAGE _WARNING _HOSTVOL_USAGE _CRITICAL |
| Qnap_hdtemp | Checks the hard disk temperature | check_qnap_hdte mp | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTHDTEMP_WA RNING _HOSTHDTEMP_CR ITICAL |
| Qnap_MEM | Checks the memory usage | check_qnap_mem | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
| Qnap_volstatus | Checks the status from volumes | check_qnap_vols tatus | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Qnap_raid_statu s | Checks the status from raid | check_qnap_raid status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _CPU_WARNING | CPU usage warning threshold | percent |
| _CPU_CRITICAL | CPU usage critical threshold | percent |
| _MEM_WARNING | Memory usage warning threshold | percent |
| _MEM_CRITICAL | Memory usage critical threshold | percent |
| _TEMP_WARNING | System temperature warning threshold (in Celsius) | integer |
| _TEMP_CRITICAL | System temperature critical threshold (in Celsius) | integer |
| _HDTEMP_WARNING | HD temperature warning threshold (in Celsius) | integer |
| _HDTEMP_CRITICAL | HD temperature critical threshold (in Celsius) | integer |
| _VOL_USAGE_WARNING | Volume usage warning threshold | percent |
| _VOL_USAGE_CRITICAL | Volume usage critical threshold | percent |
| _FAN_SPEED_WARNING | Fan speed warning threshold (rpm) | integer |
| _FAN_SPEED_CRITICAL | Fan speed critical threshold (rpm) | integer |
Security¶
Alienvault-aio¶
DESCRIPTION
Specific checks for Alienvault All in One devices
Checks Alienvault All in One metrics and processes. NRPE Agent must be installed in Alienvault device
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Alienvault-aio Monit | Checks if monit process is running | check_av_aio_m onit | |
| Alienvault-aio Rsyslog | Checks if rsyslogd is running | check_av_aio_r syslog | |
| Alienvault-aio Framework | Checks if ossim- framework is running | check_av_aio_f ramework | |
| Alienvault-aio Server | Checks if ossim- server is running | check_av_aio_s erver | |
| Alienvault-aio RabbitMQ Server | Checks if rabbitmq-server is running | check_av_aio_r abbitmq_server | |
| Alienvault-aio Sandas | Checks if sandas is running | check_av_aio_s andas | |
| Alienvault-aio Redis Server | Checks if redis- server is running | check_av_aio_r edis_server | |
| Alienvault-aio Mongodb | Checks if mongod is running | check_av_aio_m ongodb | |
| Alienvault-aio Agent | Checks if ossim- agent is running | check_av_aio_a gent | _HOSTAGENT_WAR NING _HOSTAGENT_CRI TICAL |
| Alienvault-aio Size | Checks the logger size | check_av_aio_s ize | |
| Alienvault-aio Procs | Checks the number of processes | check_av_aio_p rocs | _HOSTPROCS_WAR NING _HOSTPROCS_CRI TICAL |
| Alienvault-aio Mysqld | Checks if mysqld is running | check_av_aio_m ysqld | _HOSTMYSQL_WAR NING _HOSTMYSQL_CRI TICAL |
| Alienvault-aio Apache | Checks if apache2 is running | check_av_aio_a pache | _HOSTAPACHE_WA RNING _HOSTAPACHE_CR ITICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _APACHE_WARNING | Running Apache processes warning range threshold (Ex: 1:12) | string |
| _APACHE_CRITICAL | Running Apache processes critical range threshold (Ex: 1:20) | string |
| _AGENT_WARNING | Running Ossim-agent processes warning range threshold (Ex: 1:40) | string |
| _AGENT_CRITICAL | Running Ossim-agent processes critical range threshold (Ex: 1:50) | string |
| _PROCS_WARNING | Number of running processes warning threshold | string |
| _PROCS_CRITICAL | Number of running processes critical threshold | string |
| _MYSQL_WARNING | Number of MySQL running processes warning threshold | string |
| _MYSQL_CRITICAL | Number of MySQL running processes critical threshold | string |
Alienvault-logger¶
DESCRIPTION
Specific checks for Alienvault Logger devices
Checks Alienvault Logger metrics and processes. NRPE Agent must be installed in Alienvault device
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Alienvault-Logger Redis Server | Checks if redis- server is running | check_av_logger _redis_server | |
| Alienvault-Logger Mongodb | Checks if mongod is running | check_av_logger _mongodb | |
| Alienvault-Logger Size | Checks the logger size | check_av_logger _size | |
| Alienvault-Logger RabbitMQ Server | Checks if rabbitmq-server is running | check_av_logger _rabbitmq_serve r | |
| Alienvault-Logger Mysqld | Checks if mysqld is running | check_av_logger _mysqld | _HOSTMYSQL_WAR NING _HOSTMYSQL_CRI TICAL |
| Alienvault-Logger Server | Checks if ossim- server is running | check_av_logger _server | |
| Alienvault-Logger Apache | Checks if apache2 is running | check_av_logger _apache | _HOSTAPACHE_WA RNING _HOSTAPACHE_CR ITICAL |
| Alienvault-Logger Framework | Checks if ossim- framework is running | check_av_logger _framework | |
| Alienvault-Logger Monit | Checks if monit process is running | check_av_logger _monit |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _APACHE_WARNING | Running Apache processes warning range threshold (Ex: 1:12) | string |
| _APACHE_CRITICAL | Running Apache processes critical range threshold (Ex: 1:20) | string |
| _MYSQL_WARNING | Number of MySQL running processes warning threshold | string |
| _MYSQL_CRITICAL | Number of MySQL running processes critical threshold | string |
Alienvault-sensor¶
DESCRIPTION
Specific checks for Alienvault sensor devices
Checks Alienvault Sensor metrics and processes. NRPE Agent must be installed in Alienvault device
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Alienvault-sensor Rsyslog | Checks if rsyslogd is running | check_av_sensor _rsyslog | |
| Alienvault-sensor Agent | Checks if ossim- agent is running | check_av_sensor _agent | _HOSTAGENT_WAR NING _HOSTAGENT_CRI TICAL |
| Alienvault-sensor Procs | Checks the number of processes | check_av_sensor _procs | _HOSTPROCS_WAR NING _HOSTPROCS_CRI TICAL |
| Alienvault-sensor Monit | Checks if monit process is running | check_av_sensor _monit |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _AGENT_WARNING | Running Ossim-agent processes warning range threshold (Ex: 1:40) | string |
| _AGENT_CRITICAL | Running Ossim-agent processes critical range threshold (Ex: 1:50) | string |
| _PROCS_WARNING | Number of running processes warning threshold | string |
| _PROCS_CRITICAL | Number of running processes critical threshold | string |
Alienvault-siem¶
DESCRIPTION
Specific checks for Alienvault siem devices
Checks Alienvault Siem metrics and processes. NRPE Agent must be installed in Alienvault device
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Alienvault-siem Monit | Checks if monit process is running | check_av_siem_ monit | |
| Alienvault-siem Redis Server | Checks if redis- server is running | check_av_siem_ redis_server | |
| Alienvault-siem Mysqld | Checks if mysqld is running | check_av_siem_ mysqld | _HOSTMYSQL_WAR NING _HOSTMYSQL_CRI TICAL |
| Alienvault-siem Framework | Checks if ossim- framework is running | check_av_siem_ framework | |
| Alienvault-siem Sandas | Checks if sandas is running | check_av_siem_ sandas | |
| Alienvault-siem Server | Checks if ossim- server is running | check_av_siem_ server | |
| Alienvault-siem Mongodb | Checks if mongod is running | check_av_siem_ mongodb | |
| Alienvault-siem Apache | Checks if apache2 is running | check_av_siem_ apache | _HOSTAPACHE_WA RNING _HOSTAPACHE_CR ITICAL |
| Alienvault-siem RabbitMQ Server | Checks if rabbitmq-server is running | check_av_siem_ rabbitmq_server |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _APACHE_WARNING | Running Apache processes warning range threshold (Ex: 1:12) | string |
| _APACHE_CRITICAL | Running Apache processes critical range threshold (Ex: 1:20) | string |
| _MYSQL_WARNING | Number of MySQL running processes warning threshold | string |
| _MYSQL_CRITICAL | Number of MySQL running processes critical threshold | string |
Arcsight¶
DESCRIPTION
Generic checks for Arcsight devices
Checks metrics and processes using SNMP and NRPE. NRPE Agent must be installed in Arcsight device
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Partition $KEY$ | Checks the storage usage percent | check_unix_nrpe _disk | _HOSTSTORAGE_W ARNING _HOSTSTORAGE_C RITICAL _PARTITIONS |
| interfaces_statu s | Checks the interfaces status | check_interfaces _status | _HOSTSNMPCOMMUN ITY |
| procs_ssh | Checks if sshd is running | check_procs_ssh | _HOSTSSH_PROCS _WARNING _HOSTSSH_PROCS _CRITICAL |
| zombie_procs | Checks the number of zombie processes | check_unix_zomb ie_procs | _HOSTZOMBIE_PR OCS_WARNING _HOSTZOMBIE_PR OCS_CRITICAL |
| mem | Checks the memory usage | check_unix_nrpe _memory | _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
| procs | Checks the number of processes | check_unix_nrpe _procs | _HOSTPROCS_WAR NING _HOSTPROCS_CRI TICAL |
| load | Checks the system load | check_unix_nrpe _load | _HOSTLOAD_WARN ING _HOSTLOAD_CRIT ICAL |
| uptime_so | Checks the system uptime | check_uptime_so | _HOSTSNMPCOMMUN ITY |
| swap | Checks the swap usage percent | check_unix_nrpe _swap | _HOSTSWAP_WARN ING _HOSTSWAP_CRIT ICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | SNMP version to use in the check | string |
| _PROCS_WARNING | Total processes warning threshold | integer |
| _PROCS_CRITICAL | Total processes critical threshold | integer |
| _SSH_PROCS_WARNING | SSH processes warning threshold. Example 1:20 | string |
| _SSH_PROCS_CRITICAL | SSH processes critical threshold. Example 1:40 | string |
| _LOAD_WARNING | CPU load warning threshold | string |
| _LOAD_CRITICAL | CPU load critical threshold | string |
| _MEM_WARNING | Memory usage warning threshold | percent |
| _MEM_CRITICAL | Memory usage critical threshold | percent |
| _SWAP_WARNING | Swap usage warning threshold | percent |
| _SWAP_CRITICAL | Swap usage critical threshold | percent |
| _STORAGE_WARNING | Storage warning threshold | percent |
| _STORAGE_CRITICAL | Storage critical threshold | percent |
| _PARTITIONS | Filesystem partitions to monitor, for example /,/var | string |
| _ZOMBIE_PROCS_WARNING | Zombie processes warning threshold, for example 1:20 | string |
| _ZOMBIE_PROCS_CRITICAL | Zombie processes critical threshold, for example 1:40 | string |
Arcsight-express¶
DESCRIPTION
Performance and availability checks for Arcsight devices
Checks metrics and processes using SNMP, NRPE and SSH. NRPE Agent must be installed in Arcsight device. SSH credentials are needed
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Procs | Checks the number of processes | check_ssh_procs | _HOSTPROCS_WARNI NG _HOSTPROCS_CRITI CAL |
| Java | Checks if java is running | check_nrpe_java | |
| Uptime | Checks the system uptime | check_ssh_uptime | _HOSTUPTIME_WARN ING _HOSTUPTIME_CRIT ICAL |
| Disk_usage / | Checks the storage usage | check_ssh_disk | _HOSTSTORAGE_WAR NING _HOSTSTORAGE_CRI TICAL |
| Load_average | Checks the system load average | check_ssh_load | _HOSTLOAD_WARNIN G _HOSTLOAD_CRITIC AL |
| Oracle | Checks if Oracle listener is running | check_nrpe_esm_ oracle | |
| Web_service | Checks if Arcsight wrapper is running | check_nrpe_esm_ web | |
| web_access | Checks if port TCP/8443 is listening | check_tcp_web_a ccess | _HOSTRESPONSE_WA RNING _HOSTRESPONSE_CR ITICAL |
| Mem_usage | Checks memory usage | check_ssh_mem | _HOSTMEM_WARNING _HOSTMEM_CRITICA L |
| Swap_usage | Checks the swap usage | check_ssh_swap | _HOSTSWAP_WARNIN G _HOSTSWAP_CRITIC AL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | SNMP version to use in the check | string |
| _RESPONSE_WARNING | Response time warning threshold (in seconds) | integer |
| _RESPONSE_CRITICAL | Response time critical threshold (in seconds) | integer |
| _PROCS_WARNING | Total processes warning threshold | integer |
| _PROCS_CRITICAL | Total processes critical threshold | integer |
| _LOAD_WARNING | CPU load warning threshold | string |
| _LOAD_CRITICAL | CPU load critical threshold | string |
| _MEM_WARNING | Memory usage warning threshold | percent |
| _MEM_CRITICAL | Memory usage critical threshold | percent |
| _SWAP_WARNING | Swap usage warning threshold | percent |
| _SWAP_CRITICAL | Swap usage critical threshold | percent |
| _STORAGE_WARNING | Storage warning threshold | percent |
| _STORAGE_CRITICAL | Storage critical threshold | percent |
| _UPTIME_WARNING | Uptime warning threshold (in seconds) | integer |
| _UPTIME_CRITICAL | Uptime critical threshold (in seconds) | integer |
| _PARTITIONS | Filesystem partions to monitor, for example /,/var | string |
Arcsight-logger¶
DESCRIPTION
Performance and availability checks for Arcsight logger devices
Checks metrics and processes. NRPE Agent must be installed in Arcsight device
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Zombie procs | Checks the number of zombie processes | check_unix_zomb ie_procs | _HOSTZOMBIE_PR OCS_WARNING _HOSTZOMBIE_PR OCS_CRITICAL |
| Partition_logger $KEY$ | Checks the storage usage | check_nrpe_disk | _HOSTSTORAGE_W ARN _HOSTSTORAGE_C RIT _PARTITIONS |
| Raid status | Checks the RAID status | check_nrpe_raid _status | |
| Logger | Checks if arcsight processors is running | check_nrpe_logg er | |
| Receivers | Checks if arcsight receivers is running | check_nrpe_rece ivers | |
| Server | Checks if arcsight servers process is running | check_nrpe_serv er | |
| LinuxWrapper | Checks if linux wrapper process is running | check_nrpe_linu xwrapper | |
| SSH Procs | Checks if sshd process is running | check_nrpe_ssh_procs | _HOSTSSH_PROCS _WARNING _HOSTSSH_PROCS _CRITICAL |
| Swap Usage | Checks swap usage percent | check_unix_nrpe _swap | _HOSTSWAP_WARN ING _HOSTSWAP_CRIT ICAL |
| Load | Checks the system load | check_unix_nrpe _load | _HOSTLOAD_WARN ING _HOSTLOAD_CRIT ICAL |
| Memory Usage | Checks the memory usage | check_unix_nrpe _memory | _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
| PostgreSQL | Checks if PostgreSql postmaster process is running | check_nrpe_post gresql | |
| Mysql Listener | Checks if TCP/3306 port is listening | check_mysql_lis tener | _HOSTRESPONSE_ WARNING _HOSTRESPONSE_ CRITICAL |
| Connectors | Checks if ArcSigh tSmartConnectors is running | check_nrpe_conn ectors | |
| Web | Checks if arcsight web process is running | check_nrpe_web | |
| Procs | Checks the number of processes | check_nrpe_proc s | _HOSTPROCS_WAR NING _HOSTPROCS_CRI TICAL |
| ReportEngine | Checks if arcsight reportengine process is running | check_nrpe_repo rtengine |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | SNMP version to use in the check | string |
| _RESPONSE_WARNING | Response time warning threshold (in seconds) | integer |
| _RESPONSE_CRITICAL | Response time critical threshold (in seconds) | integer |
| _PROCS_WARNING | Total processes warning threshold | integer |
| _PROCS_CRITICAL | Total processes critical threshold | integer |
| _SSH_PROCS_WARNING | SSH processes warning threshold. Example 1:20 | string |
| _SSH_PROCS_CRITICAL | SSH processes critical threshold. Example 1:40 | string |
| _LOAD_WARNING | CPU load warning threshold | string |
| _LOAD_CRITICAL | CPU load critical threshold | string |
| _MEM_WARNING | Memory usage warning threshold | percent |
| _MEM_CRITICAL | Memory usage critical threshold | percent |
| _UPTIME_WARNING | Uptime warning threshold | integer |
| _UPTIME_CRITICAL | Uptime critical threshold | integer |
| _SWAP_WARNING | Swap usage warning threshold | percent |
| _SWAP_CRITICAL | Swap usage critical threshold | percent |
| _STORAGE_WARNING | Storage warning threshold | percent |
| _STORAGE_CRITICAL | Storage critical threshold | percent |
| _PARTITIONS | Filesystem partitions to monitor, for example /,/var | string |
| _ZOMBIE_PROCS_WARNING | Zombie processes warning threshold, for example 1:20 | string |
| _ZOMBIE_PROCS_CRITICAL | Zombie processes critical threshold, for example 1:40 | string |
Bluecoat¶
DESCRIPTION
Health and performance checks for Bluecoat proxy devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| ssh | Checks if TCP/22 port is up and accepting connections | check_bluecoat_s sh | |
| connections | Checks the ammount of connections | check_bluecoat_c onnections | _HOSTSNMPCOMMUNIT Y _HOSTCONN_WARNIN G _HOSTCONN_CRITIC AL |
| proxy_memory | Checks the proxy memory usage | check_bluecoat_p roxy_memory | _HOSTSNMPCOMMUNIT Y _HOSTPROXY_MEM_ WARNING _HOSTPROXY_MEM_ CRITICAL |
| mem_usage | Checks the main memory usage | check_bluecoat_m em_usage | _HOSTSNMPCOMMUNIT Y _HOSTMEM_WARNING _HOSTMEM_CRITICA L |
| gui | Checks if TCP/8082 port is up and accepting connections | check_bluecoat_g ui | |
| disk_usage | Checks the disk usage | check_bluecoat_d isk_usage | _HOSTSNMPCOMMUNIT Y _HOSTSTORAGE_WAR NING _HOSTSTORAGE_CRI TICAL |
| uptime | Checks the device uptime | check_bluecoat_u ptime | _HOSTSNMPCOMMUNIT Y |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _CPU_WARNING | CPU usage warning threshold | percent |
| _CPU_CRITICAL | CPU usage critical threshold | percent |
| _MEM_WARNING | Memory usage warning threshold | percent |
| _MEM_CRITICAL | Memory usage critical threshold | percent |
| _PROXY_MEM_WARNING | Proxy memory usage warning threshold | percent |
| _PROXY_MEM_CRITICAL | Proxy memory usage critical threshold | percent |
| _STORAGE_WARNING | Storage utilization warning threshold | percent |
| _STORAGE_CRITICAL | Storage utilization critical threshold | percent |
| _CONN_WARNING | Established connections warning threshold | integer |
| _CONN_CRITICAL | Established connections critical threshold | integer |
Checkpoint¶
DESCRIPTION
Info and connection checks for Checkpoint devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Info | Shows status info | check_checkpoint_ info | _HOSTSNMPCOMMUNIT Y |
| Connections | Checks the number of connections | check_checkpoint_ connections | _HOSTSNMPCOMMUNIT Y _HOSTCONN_WARNIN G _HOSTCONN_CRITIC AL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _CONN_WARNING | Total connections warning threshold | integer |
| _CONN_CRITICAL | Total connections critical threshold | integer |
Checkpoint-gw-r7720-gaia¶
DESCRIPTION
Checks for Checkpoint GW R77.20 Gaia
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| CKP_Gaia_Swap | Checks the Swap usage | check_checkpoint _gaia_swap | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTSWAP_WARN ING _HOSTSWAP_CRIT ICAL |
| CKP_Gaia_FW_St ate | Shows FW Module status | check_checkpoint _gaia_fw_state | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N |
| CKP_Gaia_Partit ion $KEY$ | Checks the Disk usage | check_checkpoint _gaia_disk | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTSTORAGE_W ARNING _HOSTSTORAGE_C RITICAL _PARTITIONS |
| CKP_Gaia_CPU_U sage | Checks the CPU usage | check_checkpoint _gaia_cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _CPU_WARNING | CPU usage warning threshold | percent |
| _CPU_CRITICAL | CPU Usage critical threshold | percent |
| _PARTITIONS | Partition name to check usage. | string |
| _STORAGE_WARNING | Partition usage percent warning threshold | percent |
| _STORAGE_CRITICAL | Partition usage percent critical threshold | percent |
| _SWAP_WARNING | Swap usage percent warning threshold | percent |
| _SWAP_CRITICAL | Swap usage percent critical threshold | percent |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1, 2c and 3 | string |
Checkpoint-licenses¶
DESCRIPTION
Checks License/Contract expiration on Checkpoint devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Checkpoint_$KEY$ | check_checkpoint_l icenses_exp | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_PASS _CHECKPOINT_LICEN SE_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_CHECKPOINT_LICENSE_LIST:
wocu-discover-checkpoint-licenses.py -H $HOSTADDRESS$ -P $_SSH_PORT$ –ssh_user $_SSH_USER$ –ssh_pass $_SSH_PASS$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SSH_USER | SSH User | string |
| _SSH_PASS | SSH Password | string |
| _SSH_PORT | SSH Port. Default: 22 | integer |
COMPLEX MACROS
_CHECKPOINT_LICENSE_LIST
- Description: List of Licenses/Contracts
- Discover: wocu-discover-checkpoint-licenses.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| type | License or Contract | string |
| id | License/Contract ID | string |
| warning | Time period to expiration date warning threshold (in days) | string |
| critical | Time period to expiration date critical threshold (in days) | string |
| expiration | License/Contract expiration date | string |
| host | Host where license is applied | string |
Checkpoint-mgmt-r7720-gaia¶
DESCRIPTION
Checks for Checkpoint Management R77.20 Gaia
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| CKP_MGMT_Gaia_ Swap | Checks the Swap usage | check_checkpoint _gaia_swap | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTSWAP_WARN ING _HOSTSWAP_CRIT ICAL |
| CKP_MGMT_Gaia_ Partition $KEY$ | Checks the Disk usage | check_checkpoint _gaia_disk | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTSTORAGE_W ARNING _HOSTSTORAGE_C RITICAL _PARTITIONS |
| CKP_MGMT_Gaia_ CPU_Usage | Checks the CPU usage | check_checkpoint _gaia_cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _CPU_WARNING | CPU usage warning threshold | percent |
| _CPU_CRITICAL | CPU Usage critical threshold | percent |
| _PARTITIONS | Partition name to check usage. | string |
| _STORAGE_WARNING | Partition usage percent warning threshold | percent |
| _STORAGE_CRITICAL | Partition usage percent critical threshold | percent |
| _SWAP_WARNING | Swap usage percent warning threshold | percent |
| _SWAP_CRITICAL | Swap usage percent critical threshold | percent |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP version, supported 1, 2c and 3 | string |
Fortianalyzer¶
DESCRIPTION
Checks for Fortianalyzer-Fortimanager devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Fortianalyzer CPU Usage | Checks CPU usage | check_fortianaly zer_cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Fortianalyzer Disk | Checks disk usage | check_fortianaly zer_disk | _HOSTSNMPCOMMUN ITY _HOSTDISK_WARN ING _HOSTDISK_CRIT ICAL |
| Fortianalyzer SSH | Checks SSH availability | check_fortianaly zer_ssh | |
| Fortianalyzer Uptime | Checks uptime | check_fortianaly zer_uptime | _HOSTSNMPCOMMUN ITY _HOSTUPTIME_WA RNING _HOSTUPTIME_CR ITICAL |
| Fortianalyzer HTTPS | Checks GUI availability | check_fortianaly zer_https | |
| Fortianalyzer Memory Usage | check_fortianaly zer_mem | _HOSTSNMPCOMMUN ITY _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _DISK_WARNING | Disk usage warning threshold (percent) | percent |
| _DISK_CRITICAL | Disk usage critical threshold (percent) | percent |
| _CPU_WARNING | CPU usage warning threshold (percent) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | percent |
| _MEM_WARNING | Memory usage warning threshold (percent) | percent |
| _MEM_CRITICAL | Memory usage critical threshold (percent) | percent |
| _UPTIME_WARNING | CPU usage warning threshold (percent) | integer |
| _UPTIME_CRITICAL | CPU usage critical threshold (percent) | integer |
Fortigate¶
DESCRIPTION
Checks for Fortigate devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Fortigate_cpu_n ode2 | Checks Node2 CPU usage | check_fortigate_cpu_node2 | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Fortigate_GUI | Checks GUI availability | check_fortigate_gui | _HOSTGUI_PORT |
| Fortigate_sessio ns_node2 | Checks the number of sessions in Node2 | check_fortigate_sessions_node2 | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTSESSION_W ARNING _HOSTSESSION_C RITICAL |
| Fortigate_cpu_n ode1 | Checks Node1 CPU usage | check_fortigate_cpu_node1 | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Fortigate_sessio ns_node1 | Checks the number of sessions in Node1 | check_fortigate_sessions_node1 | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTSESSION_W ARNING _HOSTSESSION_C RITICAL |
| Fortigate_SSH | Checks SSH availability | check_fortigate_ssh | _HOSTSSH_PORT |
| Fortigate_mem_u sage_node2 | Checks Node2 memory usage | check_fortigate_mem_usage_node 2 | _HOSTSNMPCOMMUN ITY _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
| Fortigate_Uptime | Checks uptime | check_fortigate_uptime | _HOSTSNMPCOMMUN ITY |
| Fortigate_HA | Detects High Availability changes | check_fortigate_ha_load_balanc ing | _HOSTSNMPCOMMUN ITY _HOSTHA_ALARM_PERSISTANCE |
| Fortigate_mem_u sage_node1 | Checks Node1 memory usage | check_fortigate_mem_usage_node 1 | _HOSTSNMPCOMMUN ITY _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _CPU_WARNING | CPU usage warning threshold (percent) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | percent |
| _MEM_WARNING | Memory usage warning threshold (percent) | percent |
| _MEM_CRITICAL | Memory usage critical threshold (percent) | percent |
| _SESSION_WARNING | Session number warning threshold | integer |
| _SESSION_CRITICAL | Session number critical threshold | integer |
| _GUI_PORT | TCP Port number for GUI access (default 443) | integer |
| _SSH_PORT | TCP Port number for SSH access (default 22) | integer |
| _HA_ALARM_PERSISTANCE | High Availability changes alarm persistance time in seconds (default 1 hour) | integer |
Fortigate-standalone¶
DESCRIPTION
Checks for Fortigate devices working in standalone mode
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Fortigate_cpu | Checks CPU usage | check_fortigate_standalone_cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Fortigate_sessio ns | Checks the number of sessions | check_fortigate_standalone_sess ions | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTSESSION_W ARNING _HOSTSESSION_C RITICAL |
| Fortigate Uptime | Checks the uptime | check_fortigate_standalone_upti me | _HOSTSNMPCOMMUN ITY |
| Fortigate_mem_u sage | Checks Memory usage | check_fortigate_standalone_mem_usage | _HOSTSNMPCOMMUN ITY _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
| Fortigate_serial | Shows the serial number | check_fortigate_standalone_seri al | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _CPU_WARNING | CPU usage warning threshold (percent) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | percent |
| _MEM_WARNING | Memory usage warning threshold (percent) | percent |
| _MEM_CRITICAL | Memory usage critical threshold (percent) | percent |
| _SESSION_WARNING | Session number warning threshold | integer |
| _SESSION_CRITICAL | Session number critical threshold | integer |
| _GUI_PORT | TCP Port number for HTTPS access (default 443) | integer |
| _SSH_PORT | TCP Port number for SSH access (default 22) | integer |
Fortimail¶
DESCRIPTION
Checks for Fortimail devices. For non-clustered installations, use fortimail-standalone pack
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Fortimail HA | Detects High Availability changes | fortimail_ha | _HOSTSNMPCOMMUNITY _HOSTHA_ALARM_PERS ISTANCE |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_FORTIMAIL_QUEUE_LIST:
wocu-discover-fortimail-queues.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _CPU_WARNING | CPU usage warning threshold (percent) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | percent |
| _MEM_WARNING | Memory usage warning threshold (percent) | percent |
| _MEM_CRITICAL | Memory usage critical threshold (percent) | percent |
| _DEFERRED_WARNING | Deferred mails number warning threshold | integer |
| _DEFERRED_CRITICAL | Deferred mails number critical threshold | integer |
| _UPTIME_WARNING | Uptime warning threshold (seconds) | integer |
| _UPTIME_CRITICAL | Uptime critical threshold (seconds) | integer |
| _MAIL_DISK_WARNING | Mail disk usage warning threshold (percent) | percent |
| _MAIL_DISK_CRITICAL | Mail disk usage critical threshold (percent) | percent |
| _LOG_DISK_WARNING | Log disk usage warning threshold (percent) | percent |
| _LOG_DISK_CRITICAL | Log disk usage critical threshold (percent) | percent |
| _GUI_PORT | TCP Port number for GUI access (default 443) | integer |
| _SSH_PORT | TCP Port number for SSH access (default 22) | integer |
| _HA_ALARM_PERSISTANCE | High Availability changes alarm persistance time in seconds (default 1 hour) | integer |
COMPLEX MACROS
_FORTIMAIL_QUEUE_LIST
- Description: List of mail queues to check
- Discover: wocu-discover-fortimail-queues.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| index | Queue index | integer |
| warning_threshold | Mail number warning threshold | integer |
| critical_threshold | Mail number critical threshold | integer |
Fortimail-standalone¶
DESCRIPTION
Checks for Fortimail devices. For non-clustered installations, use fortimail-standalone pack
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Fortimail Log Disk | Checks log disk usage | fortimail_log_d isk | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTLOG_DISK_WARNING _HOSTLOG_DISK_CRITICAL |
| Fortimail CPU | Checks Fortimail CPU usage | fortimail_cpu | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Fortimail GUI | Checks GUI availability | fortimail_gui | _HOSTGUI_PORT |
| Fortimail Mem | Checks memory usage | fortimail_mem | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
| Fortimail Queue - $KEY$ | Checks the mail queues | fortimail_queue | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _FORTIMAIL_QUE UE_LIST |
| Fortimail Deferred | Checks deferred queue | fortimail_deferr ed | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTDEFERRED_ WARNING _HOSTDEFERRED_ CRITICAL |
| Fortimail Mail Disk | Checks mail disk usage | fortimail_mail_ disk | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTMAIL_DISK _WARNING _HOSTMAIL_DISK _CRITICAL |
| Fortimail Uptime | Checks uptime | fortimail_uptime | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTUPTIME_WA RNING _HOSTUPTIME_CR ITICAL |
| Fortimail SSH | Checks SSH availability | fortimail_ssh | _HOSTSSH_PORT |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_FORTIMAIL_QUEUE_LIST:
wocu-discover-fortimail-queues.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _CPU_WARNING | CPU usage warning threshold (percent) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | percent |
| _MEM_WARNING | Memory usage warning threshold (percent) | percent |
| _MEM_CRITICAL | Memory usage critical threshold (percent) | percent |
| _DEFERRED_WARNING | Deferred mails number warning threshold | integer |
| _DEFERRED_CRITICAL | Deferred mails number critical threshold | integer |
| _UPTIME_WARNING | Uptime warning threshold (seconds) | integer |
| _UPTIME_CRITICAL | Uptime critical threshold (seconds) | integer |
| _MAIL_DISK_WARNING | Mail disk usage warning threshold (percent) | percent |
| _MAIL_DISK_CRITICAL | Mail disk usage critical threshold (percent) | percent |
| _LOG_DISK_WARNING | Log disk usage warning threshold (percent) | percent |
| _LOG_DISK_CRITICAL | Log disk usage critical threshold (percent) | percent |
| _GUI_PORT | TCP Port number for GUI access (default 443) | integer |
| _SSH_PORT | TCP Port number for SSH access (default 22) | integer |
COMPLEX MACROS
_FORTIMAIL_QUEUE_LIST
- Description: List of mail queues to check
- Discover: wocu-discover-fortimail-queues.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| index | Queue index | integer |
| warning_threshold | Mail number warning threshold | integer |
| critical_threshold | Mail number critical threshold | integer |
Fortinet-licenses¶
DESCRIPTION
Checks License expiration on Fortinet devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Fortinet_license_ $KEY$ | check_fortinet_li censes_exp | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_PASS _FORTINET_LICENS E_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_FORTINET_LICENSE_LIST:
wocu-discover-fortinet-licenses.py -H $HOSTADDRESS$ -P $_SSH_PORT$ –ssh_user $_SSH_USER$ –ssh_pass $_SSH_PASS$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SSH_USER | SSH User | string |
| _SSH_PASS | SSH Password | string |
| _SSH_PORT | SSH Port. Default: 22 | integer |
COMPLEX MACROS
_FORTINET_LICENSE_LIST
- Description: List of Licenses
- Discover: wocu-discover-fortinet-licenses.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| name | License | string |
| warning | Time period to expiration date warning threshold (in days) | string |
| critical | Time period to expiration date critical threshold (in days) | string |
Fortiweb¶
DESCRIPTION
Checks for Fortiweb devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Fortiweb CPU Usage | Checks the CPU usage | check_fortiweb_ cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Fortiweb SSH | Checks SSH availability | check_fortiweb_ ssh | |
| Fortiweb Uptime | Checks the uptime | check_fortiweb_ uptime | _HOSTSNMPCOMMUN ITY |
| Fortiweb HTTPS | Checks the GUI availability | check_fortiweb_ https | |
| Fortiweb Mem | Checks Memory usage | check_fortiweb_ mem | _HOSTSNMPCOMMUN ITY _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _MEM_WARNING | Mem usage warning threshold (percent) | percent |
| _MEM_CRITICAL | Mem usage critical threshold (percent) | percent |
| _CPU_WARNING | CPU usage warning threshold (percent) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | percent |
Ironport-cisco¶
DESCRIPTION
Specific checks for Cisco Ironport devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Ironport Files/Sockets | Checks Ironport open Files/Sockets | check_ironport_ cisco_sockets | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTSOCKETS_W ARNING _HOSTSOCKETS_C RITICAL |
| Ironport Queue count | Checks Ironport mail Queue message count | check_ironport_ cisco_queue_cou nt | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTQUEUE_COU NT_WARNING _HOSTQUEUE_COU NT_CRITICAL |
| Ironport Oldest message | Checks Ironport oldest queued message | check_ironport_ cisco_oldest_me ssage | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTOLDEST_WA RNING _HOSTOLDEST_CR ITICAL |
| Ironport Licenses | Checks Ironport installed Licenses | check_ironport_ cisco_license | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTLICENSE_W ARNING _HOSTLICENSE_C RITICAL |
| Ironport Queue status | Checks Ironport mail Queue status | check_ironport_ cisco_queue_sta tus | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| Ironport Queue usage percent | Checks Ironport mail Queue usage percent | check_ironport_ cisco_queue_per cent | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTQUEUE_PER CENT_WARNING _HOSTQUEUE_PER CENT_CRITICAL |
| Ironport CPU | Checks Ironport CPU usage | check_ironport_ cisco_cpu | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Ironport Power Supply | Checks Ironport Power supply status and redundancy | check_ironport_ cisco_powersuppl y | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| Ironport Memory | Checks Ironport Memory usage | check_ironport_ cisco_mem | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
| Ironport mail related Threads | Checks Ironport mail related threads | check_ironport_ cisco_mail_thre ads | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTTHREADS_W ARNING _HOSTTHREADS_C RITICAL |
| Ironport Conservation reason | Checks Ironport Conservation mode reason | check_ironport_ cisco_conservati on_reason | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| Ironport Memory Status | Checks Ironport Memory status | check_ironport_ cisco_mem_statu s | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| Ironport Temperature | Checks Ironport temperature sensors | check_ironport_ cisco_temp | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTTEMP_WARN ING _HOSTTEMP_CRIT ICAL |
| Ironport Raid Status | Checks Ironport Raid Drives status and errors | check_ironport_ cisco_raid_stat us | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _CPU_WARNING | CPU usage percent warning threshold | percent |
| _CPU_CRITICAL | CPU usage percent critical threshold | percent |
| _MEM_WARNING | Memory usage percent warning threshold | percent |
| _MEM_CRITICAL | Memory usage percent critical threshold | percent |
| _SOCKETS_WARNING | Open Files/Sockets warning threshold | integer |
| _SOCKETS_CRITICAL | Open Files/Sockets critical threshold | integer |
| _TEMP_WARNING | Temperature warning threshold (in celsius) | integer |
| _TEMP_CRITICAL | Temperature critical threshold (in celsius) | integer |
| _LICENSE_WARNING | License expiration warning threshold (in days) | integer |
| _LICENSE_CRITICAL | License expiration critical threshold (in days) | integer |
| _QUEUE_COUNT_WARNING | Message number in work queue warning threshold | integer |
| _QUEUE_COUNT_CRITICAL | Message number in work queue critical threshold | integer |
| _QUEUE_PERCENT_WARNING | Mail queue usage percent warning threshold | percent |
| _QUEUE_PERCENT_CRITICAL | Mail queue usage percent critical threshold | percent |
| _OLDEST_WARNING | Oldest message queued time warning threshold (in seconds) | integer |
| _OLDEST_CRITICAL | Oldest message queued time critical threshold (in seconds) | integer |
| _THREADS_WARNING | Mail related threads number warning threshold | integer |
| _THREADS_CRITICAL | Mail related threads number critical threshold | integer |
Maltiverse¶
DESCRIPTION
Maltiverse Open IOC Search Engine
Maltiverse is an open and collaborative platform for indexing and searching Indicators of Compromise (IoCs) and is easily integrated by other applications like Splunk.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Maltiverse_url_ $KEY$ | Checks url compromise via Maltiverse Open IOC Search Engine | check_maltiverse _url | _HOSTMALTIVERSE _AUTH_TOKEN _MALTIVERSE_UR LS |
| Maltiverse_host | Checks host or address compromise via Maltiverse Open IOC Search Engine | check_maltiverse _host | _HOSTMALTIVERSE _AUTH_TOKEN |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _MALTIVERSE_AUTH_TOKEN | Autentication token for the Maltiverse API REST | string |
COMPLEX MACROS
_MALTIVERSE_URLS
- Description: List of URLs to monitor
| Fields | Description | Type |
|---|---|---|
| name | URL name | string |
| url | URL to monitor | string |
Mcafee-atd¶
DESCRIPTION
Checks for Mcafee ATD via snmp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| McAfee-ATD - Traffic $KEY$ | Checks TX and RX traffic | check_mcafee_at d_traffic | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTTX_WARNIN G _HOSTTX_CRITIC AL _HOSTRX_WARNIN G _HOSTRX_CRITIC AL _IFACES_LIST |
| McAfee-ATD - System Disk Usage | Checks System Disk Usage | check_mcafee_at d_system_disk | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTSYSTEM_DI SK_WARNING _HOSTSYSTEM_DI SK_CRITICAL |
| McAfee-ATD - License Status | Checks License Status (Valid, Invalid, Expired) | check_mcafee_at d_license | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N |
| McAfee-ATD - CPU Usage | Checks CPU Usage | check_mcafee_at d_cpu | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| McAfee-ATD - Memory Usage | Checks Memory Usage | check_mcafee_at d_mem | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
| McAfee-ATD - Data Disk Usage | Checks Data Disk Usage | check_mcafee_at d_data_disk | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTDATA_DISK _WARNING _HOSTDATA_DISK _CRITICAL |
| McAfee-ATD - System Health | Checks System Health (Good, Bad) | check_mcafee_at d_health | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N |
| McAfee-ATD - Temperature | Checks Temperature | check_mcafee_at d_temp | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTTEMP_WARN ING _HOSTTEMP_CRIT ICAL |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_IFACES_LIST:
wocu-discover-mcafee-atd-ifaces.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -A $_SNMPAUTHKEY$ -x $_SNMPPRIVPROTOCOL$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ -v $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _CPU_WARNING | CPU usage warning threshold (percent) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | percent |
| _MEM_WARNING | Memory usage warning threshold (percent) | percent |
| _MEM_CRITICAL | Memory usage critical threshold (percent) | percent |
| _TEMP_WARNING | Temperature warning threshold (Celsius) | integer |
| _TEMP_CRITICAL | Temperature critical threshold (Celsius) | integer |
| _SYSTEM_DISK_WARNING | System Disk usage warning threshold (percent) | percent |
| _SYSTEM_DISK_CRITICAL | System Disk usage critical threshold (percent) | percent |
| _DATA_DISK_WARNING | Data Disk usage warning threshold (percent) | percent |
| _DATA_DISK_CRITICAL | Data Disk usage critical threshold (percent) | percent |
| _TX_WARNING | TX traffic warning threshold (pkt/s) | integer |
| _TX_CRITICAL | TX traffic critical threshold (pkt/s) | integer |
| _RX_WARNING | RX traffic warning threshold (pkt/s) | integer |
| _RX_CRITICAL | RX traffic critical threshold (pkt/s) | integer |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _SNMPCOMMUNITY | SNMP Community | string |
| _SNMPVERSION | Device SNMP version, supported 1, 2c and 3 | string |
COMPLEX MACROS
_IFACES_LIST
- Description: List of interfaces
- Discover: wocu-discover-mcafee-atd-ifaces.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| index | Interface index | integer |
Mcafee-nsp¶
DESCRIPTION
Checks for a McAfee NSP device. Checks are done by SSH.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Mcafee MEM Usage | Checks Memory usage | check_ssh_mem_ usage | _HOSTSSH_USER _HOSTSSH_KEY _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
| Mcafee CPU Usage | Checks CPU usage | check_ssh_cpu_ usage | _HOSTSSH_USER _HOSTSSH_KEY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Mcafee Failover Status | Checks High Availability status | check_ssh_failo ver_status | _HOSTSSH_USER _HOSTSSH_KEY |
| Mcafee Interface Status $KEY$ | Checks Interfaces status | check_ssh_inter face_status | _HOSTSSH_USER _HOSTSSH_KEY _INTERFACES |
| Mcafee Sensor Uptime | Obtain the system uptime | check_ssh_senso r_uptime | _HOSTSSH_USER _HOSTSSH_KEY _HOSTUPTIME_CR ITICAL _HOSTUPTIME_WA RNING |
| Mcafee Traffic IN interface $KEY$ | Obtain the interface input traffic | check_ssh_inter face_traffic_in | _HOSTSSH_USER _HOSTSSH_KEY _HOSTTRAFFIC_I N_WARNING _HOSTTRAFFIC_I N_CRITICAL _INTERFACES |
| Mcafee Traffic OUT interface $KEY$ | Obtain the interface output traffic | check_ssh_inter face_traffic_ou t | _HOSTSSH_USER _HOSTSSH_KEY _HOSTTRAFFIC_O UT_WARNING _HOSTTRAFFIC_O UT_CRITICAL _INTERFACES |
| Mcafee Power Supply Status | Checks Power Supply status | check_ssh_power supply_status | _HOSTSSH_USER _HOSTSSH_KEY |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SSH_USER | Remote user for the SSH service (key interchange with Shinken user must be done ) | string |
| _SSH_KEY | SSH key (Shinken user) | string |
| _CPU_WARNING | CPU usage warning threshold (percentage) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percentage) | percent |
| _MEM_WARNING | Physical memory warning threshold (percentage) | percent |
| _MEM_CRITICAL | Physical memory critical threshold (percentage) | percent |
| _UPTIME_WARNING | Uptime warning threshold | integer |
| _UPTIME_CRITICAL | Uptime critical threshold | integer |
| _TRAFFIC_IN_WARNING | Input traffic packets warning threshold | integer |
| _TRAFFIC_IN_CRITICAL | Input traffic packets critical threshold | integer |
| _TRAFFIC_OUT_WARNING | Output traffic packets warning threshold | integer |
| _TRAFFIC_OUT_CRITICAL | Output traffic packets critical threshold | integer |
| _INTERFACES | List of interfaces to check. Values separated by comma | comma-separated string |
Palo-alto¶
DESCRIPTION
Checks for Palo Alto Devices (Uptime, NTP, Sessions, Info) via snmp
Checks for Palo Alto Devices (Uptime, NTP, HA, Sessions, Info) via snmp. Tested on PA-3020/PA-500
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Palo Alto - HA State | Checks the HA state | check_paloalto_ ha | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTSESSIONS_ WARN _HOSTSESSIONS_ CRIT _HOSTHA_LOCAL_STATE _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Palo Alto - Sessions Info | Checks the number of active sessions (TCP, UDP and ICMP) | check_paloalto_ sessions_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTSESSIONS_ WARN _HOSTSESSIONS_ CRIT _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Palo Alto - Info | Shows system information | check_paloalto_ info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Palo Alto - Uptime | Checks the system uptime | check_paloalto_ uptime | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTUPTIME_WA RN _HOSTUPTIME_CR IT |
| Palo Alto - VPN Active Tunnels | Checks the number of active VPN tunnels | check_paloalto_ active_tunnels | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTACTIVE_TU NNELS_WARNING_ MIN _HOSTACTIVE_TU NNELS_WARNING _HOSTACTIVE_TU NNELS_CRITICAL _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_HA_LOCAL_STATE:
wocu-discover-ha-paloalto.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –snmpversion $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -A $_SNMPAUTHKEY$ -x $_SNMPPRIVPROTOCOL$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The snmp community read configured on remote device | string |
| _SNMPVERSION | Device SNMP versions supported are: 1, 2c or 3 | string |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _SESSIONS_WARN | Current Sessions warning threshold | integer |
| _SESSIONS_CRIT | Current Sessions critical threshold | integer |
| _HA_LOCAL_STATE | Current device status HA State | string |
| _NTP_WARN | NTP timings warning level (in seconds) | integer |
| _NTP_CRIT | NTP timings critical level (in seconds) | integer |
| _ACTIVE_TUNNELS_WARNING_MIN | Minimum number of VPN Active Tunnels warning threshold | integer |
| _ACTIVE_TUNNELS_WARNING | Maximum number of VPN Active Tunnels warning threshold | integer |
| _ACTIVE_TUNNELS_CRITICAL | Maximum number of VPN Active Tunnels critical threshold | integer |
| _UPTIME_WARN | Uptime warning threshold (in seconds) | integer |
| _UPTIME_CRIT | Uptime critical threshold (in seconds) | integer |
Palo-alto-7000-health¶
DESCRIPTION
Hardware checks for Palo Alto 7000 series Devices (Fans, Temperature and Power supply) via snmp
Hardware checks for Palo Alto 7000 series Devices (Fan, temperature and Power Supply) via snmp. This pack inherites fan and temp services from pack palo-alto-health
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Paloalto 7000 Power Supply | Checks the power supply status | check_paloalto_ 7000_health_pow ersupply | _HOSTSNMPCOMMUN ITY |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The snmp community read configured on remote device | string |
| _RPM_WARNING | Fan RPM warning threshold | integer |
| _RPM_CRITICAL | Fan RPM critical threshold | integer |
| _TEMP_WARNING | Temperature warning threshold (in Celsius) | integer |
| _TEMP_CRITICAL | Temperature critical threshold (in Celsius) | integer |
Palo-alto-health¶
DESCRIPTION
Hardware checks for Palo Alto Devices (Fans, Temperature) via snmp
Hardware checks for Palo Alto Devices (Fan and temperature sensors) via snmp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Paloalto temp sensor | Checks the temperature | check_paloalto_ health_temp | _HOSTSNMPCOMMUN ITY _HOSTTEMP_WARN ING _HOSTTEMP_CRIT ICAL |
| Paloalto fan sensor | Checks the fan velocity | check_paloalto_ health_fan | _HOSTSNMPCOMMUN ITY _HOSTRPM_WARNI NG _HOSTRPM_CRITI CAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The snmp community read configured on remote device | string |
| _RPM_WARNING | Fan RPM warning threshold | integer |
| _RPM_CRITICAL | Fan RPM critical threshold | integer |
| _TEMP_WARNING | Temperature warning threshold (in Celsius) | integer |
| _TEMP_CRITICAL | Temperature critical threshold (in Celsius) | integer |
Pulse-secure¶
DESCRIPTION
Specific checks for Pulse Secure devices via snmp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Pulse Secure - Disk Usage | It shows the Disk usage | check_pulse_sec ure_disk | _HOSTSNMPCOMMUN ITY _HOSTDISK_WARN ING _HOSTDISK_CRIT ICAL _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Pulse Secure - Node Concurrent Users | It shows the concurrent users in this node | check_pulse_sec ure_node_users | _HOSTSNMPCOMMUN ITY _HOSTNODE_USER S_WARNING _HOSTNODE_USER S_CRITICAL _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Pulse Secure - CPU Usage | It shows the CPU usage | check_pulse_sec ure_cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Pulse Secure - Concurrent Users | It shows the total number of concurrent user licenses used for the Cluster | check_pulse_sec ure_concurrent_ users | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTCONCURRENT _USERS_WARNING _HOSTCONCURRENT _USERS_CRITICA L |
| Pulse Secure - SWAP Usage | It shows the SWAP usage | check_pulse_sec ure_swap | _HOSTSNMPCOMMUN ITY _HOSTSWAP_WARN ING _HOSTSWAP_CRIT ICAL _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Pulse Secure - Web Users | It shows the concurrent web users | check_pulse_sec ure_web_users | _HOSTSNMPCOMMUN ITY _HOSTWEB_USERS _WARNING _HOSTWEB_USERS _CRITICAL _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Pulse Secure - Memory Usage | It shows the Memory usage | check_pulse_sec ure_mem | _HOSTSNMPCOMMUN ITY _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Pulse Secure - Concurrent Users License | It shows the total licensed concurrent users capacity | check_pulse_sec ure_concurrent_ users_license | _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTCONCURRENT _USERS_LICENSE _WARNING _HOSTCONCURRENT _USERS_LICENSE _CRITICAL |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _CONCURRENT_USERS_WARNING | Concurrent users warning threshold | integer |
| _CONCURRENT_USERS_CRITICAL | Concurrent users critical threshold | integer |
| _CONCURRENT_USERS_LICENSE_WA RNING | Concurrent users license capacity warning threshold | integer |
| _CONCURRENT_USERS_LICENSE_CR ITICAL | Concurrent users license capacity critical threshold | integer |
| _CPU_WARNING | CPU usage warning threshold (percent) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | percent |
| _DISK_WARNING | Disk usage warning threshold (percent) | percent |
| _DISK_CRITICAL | Disk usage critical threshold (percent) | percent |
| _MEM_WARNING | Mem usage warning threshold (percent) | percent |
| _MEM_CRITICAL | Mem usage critical threshold (percent) | percent |
| _SWAP_WARNING | Swap usage warning threshold (percent) | percent |
| _SWAP_CRITICAL | Swap usage critical threshold (percent) | percent |
| _NODE_USERS_WARNING | Node users warning threshold | integer |
| _NODE_USERS_CRITICAL | Node users critical threshold | integer |
| _WEB_USERS_WARNING | Web users warning threshold | integer |
| _WEB_USERS_CRITICAL | Web users critical threshold | integer |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _SNMPCOMMUNITY | SNMP Community | string |
| _SNMPVERSION | Device SNMP version, supported 1, 2c and 3 | string |
Qradar¶
DESCRIPTION
Generic checks for QRadar devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Partition $KEY$ | Checks the partitions storage usage | check_qradar_di sk | _HOSTSNMPCOMMUNI TY _HOSTDISK_WARNI NG _HOSTDISK_CRITI CAL _PARTITIONS |
| CPU Usage | Checks the CPU usage | check_qradar_cp u_usage | _HOSTSNMPCOMMUNI TY _HOSTCPU_WARNIN G _HOSTCPU_CRITIC AL |
| Hostname | Shows system hostname | check_qradar_ho stname | _HOSTSNMPCOMMUNI TY |
| Swap | Checks the swap memory usage | check_qradar_sw ap | _HOSTSNMPCOMMUNI TY _HOSTSWAP_WARNI NG _HOSTSWAP_CRITI CAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | SNMP version (allowed 1 and 2c) | string |
| _CPU_WARNING | CPU usage warning threshold | percent |
| _CPU_CRITICAL | CPU usage critical threshold | percent |
| _DISK_WARNING | Disk usage warning threshold (percent) | percent |
| _DISK_CRITICAL | Disk usage critical threshold (percent) | percent |
| _SWAP_WARNING | Swap usage warning threshold (percent) | percent |
| _SWAP_CRITICAL | Swap usage critical threshold (percent) | percent |
| _PARTITIONS | Filesystem partitions to monitor, for example /,/var | string |
Sourcefire¶
DESCRIPTION
Checks for Sourcefire devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Sourcefire SSH | Checks the SSH port availability | check_sourcefire _ssh | |
| Sourcefire NTP sync | Checks the time difference between monitored server and local server | check_sourcefire _ntp_sync | _HOSTSNMPCOMMUN ITY _HOSTOFFSET_WA RNING _HOSTOFFSET_CR ITICAL |
| Sourcefire Load | Checks the system load | check_sourcefire _load | _HOSTSNMPCOMMUN ITY _HOSTLOAD_WARN ING _HOSTLOAD_CRIT ICAL |
| Sourcefire Storage | Checks the storage usage | check_sourcefire _storage | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTSTORAGE_W ARN _HOSTSTORAGE_C RIT |
| Sourcefire Established TCP sessions | Checks the TCP established connections number | check_sourcefire _tcp_sessions | _HOSTSNMPCOMMUN ITY _HOSTSESSION_W ARNING _HOSTSESSION_C RITICAL |
| Sourcefire HTTPS | Checks the HTTPS port availability | check_sourcefire _https |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _OFFSET_WARNING | Date offset warning threshold (seconds) | integer |
| _OFFSET_CRITICAL | Date offset critical threshold (seconds) | integer |
| _SESSION_WARNING | Session number warning threshold | integer |
| _SESSION_CRITICAL | Session number critical threshold | integer |
| _STORAGE_WARN | Disk usage warning threshold (percent) | percent |
| _STORAGE_CRIT | Disk usage critical threshold (percent) | percent |
| _LOAD_WARNING | Load warning threshold:. Ex: 10,10,10 | string |
| _LOAD_CRITICAL | Load critical threshold. Ex: 7,7,7 | string |
Stonegate¶
DESCRIPTION
Generic checks for Stonegate devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Uptime | Shows the system uptime | check_stonegate_uptime | _HOSTSNMPCOMMUN ITY _HOSTUPTIME_WA RNING _HOSTUPTIME_CR ITICAL |
| CPU_usage | Checks the CPU usage | check_stonegate_cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Stonegate - Interface_status $KEY$ | Checks the interface status | check_stonegate_interface_statu s | _HOSTSNMPCOMMUN ITY _INTERFACES |
| Stonegate - Software version | Shows the software version | check_stonegate_sw_version | _HOSTSNMPCOMMUN ITY |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _CPU_WARNING | CPU usage warning threshold (percent) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | percent |
| _UPTIME_WARNING | Uptime warning threshold | integer |
| _UPTIME_CRITICAL | Uptime critical threshold | integer |
| _INTERFACES | List of interfaces | string |
Stonegate-fw¶
DESCRIPTION
Generic checks for Stonegate firewall devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Stonegate-fw Connections | Shows the actual connections number | check_stonegate_fw_conn | _HOSTSNMPCOMMUN ITY _HOSTCONN_WARN ING _HOSTCONN_CRIT ICAL |
| Stonegate-fw Uptime | Shows the system uptime | check_stonegate_fw_uptime | _HOSTSNMPCOMMUN ITY |
| Stonegate-fw Rejected Packets | Checks the rejected packets number | check_stonegate_rejected_packet s | _HOSTSNMPCOMMUN ITY _HOSTREJECTED_ WARNING _HOSTREJECTED_ CRITICAL |
| Stonegate-fw CPU_usage | Shows the CPU usage | check_stonegate_fw_cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARNI NG _HOSTCPU_CRITI CAL |
| Stonegate-fw Dropped Packets | Checks the dropped packets number | check_stonegate_fw_dropped_pac kets | _HOSTSNMPCOMMUN ITY _HOSTDROPPED_W ARNING _HOSTDROPPED_C RITICAL |
| Stonegate-fw Node state | Checks the node operative (Clustering) state | check_stonegate_fw_node_state | _HOSTSNMPCOMMUN ITY _HOSTNODE_STAT E _HOSTALARM_PER SISTENCE |
| Stonegate-fw Accepted Packets | Shows the accepted packets metrics | check_stonegate_fw_accepted_pa ckets | _HOSTSNMPCOMMUN ITY _HOSTACCEPTED_ WARNING _HOSTACCEPTED_ CRITICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _CPU_WARNING | CPU usage warning threshold (percent) | percent |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | percent |
| _CONN_WARNING | Connections warning threshold | integer |
| _CONN_CRITICAL | Connections critical threshold | integer |
| _ACCEPTED_WARNING | Accepted packets warning threshold | integer |
| _ACCEPTED_CRITICAL | Accepted packets critical threshold | integer |
| _DROPPED_WARNING | Dropped packets warning threshold | integer |
| _DROPPED_CRITICAL | Dropped packets critical threshold | integer |
| _REJECTED_WARNING | Rejected packets warning threshold | integer |
| _REJECTED_CRITICAL | Rejected packets critical threshold | integer |
| _NODE_STATE | Configured cluster oper state in node | string |
| _ALARM_PERSISTENCE | Time for Non-OK service state persistence in minutes. Used in node cluster state service. Default 0 (No persistence) | integer |
Api¶
Kibana-node¶
DESCRIPTION
Custom checks for Kibana services
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| kibana-node- plugins-info | Checks Kibana plugins status information. | check_kibana_no de_plugins_info | _HOSTKIBANA_PO RT _HOSTKIBANA_US ERNAME _HOSTKIBANA_PA SSWORD _HOSTKIBANA_HT TP_PROTOCOL _HOSTKIBANA_AP IURL |
| kibana-node-tcp- port | Checks Kibana host port. | check_kibana_no de_tcp_port | _HOSTKIBANA_PO RT |
| kibana-node- version | Checks Kibana version information. | check_kibana_no de_version | _HOSTKIBANA_PO RT _HOSTKIBANA_US ERNAME _HOSTKIBANA_PA SSWORD _HOSTKIBANA_HT TP_PROTOCOL _HOSTKIBANA_AP IURL |
| kibana-node- uptime | Checks Kibana uptime information. | check_kibana_no de_uptime | _HOSTKIBANA_PO RT _HOSTKIBANA_US ERNAME _HOSTKIBANA_PA SSWORD _HOSTKIBANA_HT TP_PROTOCOL _HOSTKIBANA_UP TIME_WARNING _HOSTKIBANA_UP TIME_CRITICAL _HOSTKIBANA_AP IURL |
| kibana-node- memory-heap | Checks Kibana Heap Memory information. | check_kibana_no de_memory_heap | _HOSTKIBANA_PO RT _HOSTKIBANA_US ERNAME _HOSTKIBANA_PA SSWORD _HOSTKIBANA_HT TP_PROTOCOL _HOSTKIBANA_ME MHEAP_WARNING _HOSTKIBANA_ME MHEAP_CRITICAL _HOSTKIBANA_AP IURL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _KIBANA_USERNAME | Username for API auth | string |
| _KIBANA_PASSWORD | Password for API auth | string |
| _KIBANA_PORT | Api port for HTTP requests | string |
| _KIBANA_APIURL | Api url for HTTP requests, usually starts with a / and ends without a / | string |
| _KIBANA_UPTIME_WARNING | Uptime warning threshold | string |
| _KIBANA_UPTIME_CRITICAL | Uptime critical threshold | string |
| _KIBANA_MEMHEAP_WARNING | Heap memory warning threshold | string |
| _KIBANA_MEMHEAP_CRITICAL | Heap memory critical threshold | string |
| _KIBANA_HTTP_PROTOCOL | HTTP protocol choice with or without ssl | string |
Logstash-node¶
DESCRIPTION
Custom checks for Logstash services
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| logstash-node- tcp-port | Checks Logstash host port. | check_logstash_ node_tcp_port | _HOSTLOGSTASH_ PORT |
| logstash-node- uptime | Checks Logstash uptime information. | check_logstash_ node_uptime | _HOSTLOGSTASH_ PORT _HOSTLOGSTASH_ USERNAME _HOSTLOGSTASH_ PASSWORD _HOSTLOGSTASH_ HTTP_PROTOCOL _HOSTLOGSTASH_ UPTIME_WARNING _HOSTLOGSTASH_ UPTIME_CRITICAL |
| logstash-node- status-info | Checks Logstash node status information. | check_logstash_ node_status_inf o | _HOSTLOGSTASH_ PORT _HOSTLOGSTASH_ USERNAME _HOSTLOGSTASH_ PASSWORD _HOSTLOGSTASH_ HTTP_PROTOCOL |
| logstash-node- version | Checks Logstash version information. | check_logstash_ node_version | _HOSTLOGSTASH_ PORT _HOSTLOGSTASH_ USERNAME _HOSTLOGSTASH_ PASSWORD _HOSTLOGSTASH_ HTTP_PROTOCOL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _LOGSTASH_USERNAME | Username for API auth | string |
| _LOGSTASH_PASSWORD | Password for API auth | string |
| _LOGSTASH_PORT | Api port for HTTP requests | string |
| _LOGSTASH_UPTIME_WARNING | Uptime warning threshold | string |
| _LOGSTASH_UPTIME_CRITICAL | Uptime critical threshold | string |
| _LOGSTASH_HTTP_PROTOCOL | HTTP protocol choice with or without ssl | string |
Printing¶
Generic-printer¶
DESCRIPTION
Checks for the printer status (also consumibles and trays)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| $KEY$ | Checks the consumables state | check_printer_c onsum | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _CONSUMLIST |
| Printer_Pagecoun t | Checks the page count number | check_printer_p agecount | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| $KEY$ | Checks the printer trays status | check_printer_t ray | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _TRAYLIST |
| Printer_Descript ion | Shows the printer description | check_printer_d escription | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_DEVICEVENDOR:
wocu-discover-vendor.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_TRAYLIST:
wocu-discover-printers.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ -t trays –remote $_POLLER_TAG_ADDRESS$_CONSUMLIST:
wocu-discover-printers.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ -t consum –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _DEVICEVENDOR | Device vendor | string |
COMPLEX MACROS
_TRAYLIST
- Description: List of Printer Trays (internal/external/paper)
- Discover: wocu-discover-printers.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Name to be shown in the service (web interface) | string |
| Index | ifIndex for snmp queries (integer) | integer |
| Name | Real name of the Tray (on device) | string |
| Warning | Warning percentage for the printer Tray | percent |
| Critical | Critical percentage for the printer Tray | percent |
_CONSUMLIST
- Description: List of Printer supply list (Drum/Toner/etc)
- Discover: wocu-discover-printers.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Name to be shown in the service (web interface) | string |
| Index | ifName for snmp queries | integer |
| Name | Real name of the Supply (on device) | string |
| Warning | Warning percentage for the printer Consumable | percent |
| Critical | Critical percentage for the printer Consumable | percent |
Operating System¶
Linux-nrpe¶
DESCRIPTION
Linux host monitoring via NRPE (Nagios remote plugin execution)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Zombie procs | Checks the number of Zombie processes | check_nrpe_zomb ie_procs | _HOSTZOMBIEPROCS _WARN _HOSTZOMBIEPROCS _CRIT |
| Total procs | Checks the total number of processes | check_nrpe_tota l_procs | _HOSTTOTALPROCS_WARN _HOSTTOTALPROCS_CRIT |
| Users | Checks the number of users | check_nrpe_user s | _HOSTUSERS_WARN _HOSTUSERS_CRIT |
| Partition $KEY$ | Checks the disk usage | check_nrpe_disk | _HOSTSTORAGE_WA RN _HOSTSTORAGE_CR IT _PARTITIONS |
| Swap | Checks the SWAP usage | check_nrpe_swap | _HOSTSWAP_WARN _HOSTSWAP_CRIT |
| Load | Checks the CPU load | check_nrpe_load | _HOSTLOAD_WARN _HOSTLOAD_CRIT |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _LOAD_WARN | CPU load warning threshold | string |
| _LOAD_CRIT | CPU load critical threshold | string |
| _STORAGE_WARN | Storage warning threshold | string |
| _STORAGE_CRIT | Storage critical threshold | string |
| _PARTITIONS | Filesystem partions to monitor, for example /,/var | string |
| _USERS_WARN | Current users logged warning threshold | integer |
| _USERS_CRIT | Current users logged critical threshold | integer |
| _ZOMBIEPROCS_WARN | Zombie processes warning threshold | integer |
| _ZOMBIEPROCS_CRIT | Zombie processes critical threshold | integer |
| _TOTALPROCS_WARN | Total processes warning threshold | integer |
| _TOTALPROCS_CRIT | Total processes critical threshold | integer |
| _SWAP_WARN | Swap usage warning threshold | string |
| _SWAP_CRIT | Swap usage critical threshold | string |
Linux-snmp¶
DESCRIPTION
Standard linux checks, like CPU, RAM and disk space. Checks are done by SNMP.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Cpu | Detect abnormal CPU usage | check_linux_cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARN _HOSTCPU_CRIT |
| TimeSync | Compare system time with time where shinken operate. Both must be synchronized with a ntp source. | check_linux_tim e | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTNTP_WARN _HOSTNTP_CRIT |
| Memory | Check about physical memory space usage. | check_linux_mem ory | _HOSTMEMORY_WA RN _HOSTMEMORY_CR IT _HOSTSNMPCOMMUN ITY |
| Linux SNMP - Swap | Check about swap space usage. Too many use of swap space means lacks of memory or memory leaks. | check_linux_snm p_swap | _HOSTMEMORY_WA RN _HOSTMEMORY_CR IT _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY |
| Linux SNMP - SysDescr | Shows system description | check_linux_snm p_sysdescr | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Linux SNMP - TCP Connections | Check TCP connections table | check_linux_snm p_tcpconn | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTTCP_CONN_WARN _HOSTTCP_CONN_CRIT |
| Disks | Overall disks usage | check_linux_dis ks | _HOSTSNMPCOMMUN ITY _HOSTSTORAGE_P ATH _HOSTSTORAGE_W ARN _HOSTSTORAGE_C RIT _HOSTSNMP_MSG_MAX_SIZE |
| Load | Detect abnormal CPU usage | check_linux_loa d | _HOSTSNMPCOMMUN ITY _HOSTLOAD_WARN _HOSTLOAD_CRIT |
| Linux SNMP - Uptime | Check about system uptime | check_linux_snm p_uptime | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTUPTIME_WA RN _HOSTUPTIME_CR IT |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The read snmp community allowed on the linux server | string |
| _SNMP_MSG_MAX_SIZE | Maximum size of the snmp messages (in bytes) | integer |
| _LOAD_WARN | Value for starting warning state for the load average at 1m,5m,15m | 3 comma-separated integer |
| _LOAD_CRIT | Value for starting critical state for the load average at 1m,5m,15m | 3 comma-separated integer |
| _STORAGE_WARN | Warning level threshold for used disk space (percentage) | percent |
| _STORAGE_CRIT | Critical level threshold for used disk space (percentage) | percent |
| _CPU_WARN | Warning level for the CPU usage (percentage) | percent |
| _CPU_CRIT | Critical level for the CPU usage (percentage) | percent |
| _MEMORY_WARN | Physical memory and swap warning level (percentage) | percent |
| _MEMORY_CRIT | Physical memory and swap critical level (percentage) | percent |
| _NTP_WARN | NTP timings warning level (in seconds) | integer |
| _NTP_CRIT | NTP timings critical level (in seconds) | integer |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _CHKLOG_CONF | absolute path to checklog conf file. Default: /usr/local/shin ken/libexec/logFiles_li nux.conf | absolute path |
| _STORAGE_PATH | Absolute path to check its storage | absolute path |
| _UPTIME_WARN |
threshold (in seconds) |
integer |
| _UPTIME_CRIT | System uptime critical threshold (in seconds) | integer |
| _TCP_CONN_WARN |
threshold (total number) |
integer |
| _TCP_CONN_CRIT | TCP connections critical threshold (total number) | integer |
Linux-snmp3¶
DESCRIPTION
Standard linux checks, like CPU, RAM and disk space. Checks are done by SNMP3.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Memory | Check about physical memory space usage. | check_linux_mem ory_v3 | _HOSTMEMORY_WA RN _HOSTMEMORY_CR IT _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Disks | Overall disks usage | check_linux_dis ks_v3 | _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTSTORAGE_P ATH _HOSTSTORAGE_W ARN _HOSTSTORAGE_C RIT _HOSTSNMP_MSG_MAX_SIZE _HOSTSNMPCONTEX T |
| TimeSync | Compare system time with time where shinken operate. Both must be synchronized with a ntp source. | check_linux_tim e_v3 | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTNTP_WARN _HOSTNTP_CRIT |
| Cpu | Detect abnormal CPU usage | check_linux_cpu _v3 | _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTCPU_WARN _HOSTCPU_CRIT _HOSTSNMPCONTEX T |
| Load | Detect abnormal CPU usage | check_linux_loa d_v3 | _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTLOAD_WARN _HOSTLOAD_CRIT _HOSTSNMPCONTEX T |
| Linux SNMP3 - Swap | Check about swap space usage. Too many use of swap space means lacks of memory or memory leaks. | check_linux_snm p_swap_v3 | _HOSTMEMORY_WA RN _HOSTMEMORY_CR IT _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Linux SNMP3 - SysDescr | Shows system description | check_linux_snm p_sysdescr_v3 | _HOSTSNMPVERSIO N _HOSTSNMPCONTEX T _HOSTSNMPSECURI TYLEVEL _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y |
| Linux SNMP3 - TCP Connections | Check TCP connections table | check_linux_snm p_tcpconn_v3 | _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTTCP_CONN_WARN _HOSTTCP_CONN_CRIT |
| Linux SNMP3 - Uptime | Check about system uptime | check_linux_snm p_uptime_v3 | _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _HOSTSNMPVERSIO N _HOSTUPTIME_WA RN _HOSTUPTIME_CR IT |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _SNMP_MSG_MAX_SIZE | Maximum size of the snmp messages (in bytes) | integer |
| _LOAD_WARN | Value for starting warning state for the load average at 1m,5m,15m | 3 comma-separated integer |
| _LOAD_CRIT | Value for starting critical state for the load average at 1m,5m,15m | 3 comma-separated integer |
| _STORAGE_WARN | Warning level threshold for used disk space (percentage) | percent |
| _STORAGE_CRIT | Critical level threshold for used disk space (percentage) | percent |
| _CPU_WARN | Warning level for the CPU usage (percentage) | percent |
| _CPU_CRIT | Critical level for the CPU usage (percentage) | percent |
| _MEMORY_WARN | Physical memory and swap warning level (percentage) | percent |
| _MEMORY_CRIT | Physical memory and swap critical level (percentage) | percent |
| _NTP_WARN | NTP timings warning level (in seconds) | integer |
| _NTP_CRIT | NTP timings critical level (in seconds) | integer |
| _SNMPVERSION | Device SNMP versions supported are: 3 | string |
| _CHKLOG_CONF | absolute path to checklog conf file. Default: /usr/local/shin ken/libexec/logFiles_li nux.conf | absolute path |
| _STORAGE_PATH | Absolute path to check its storage | absolute path |
| _UPTIME_WARN |
threshold (in seconds) |
integer |
| _UPTIME_CRIT | System uptime critical threshold (in seconds) | integer |
| _TCP_CONN_WARN |
threshold (total number) |
integer |
| _TCP_CONN_CRIT | TCP connections critical threshold (total number) | integer |
Linux-ssh¶
DESCRIPTION
Standard linux checks, like CPU, RAM and disk space. Checks are done by SSH.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Memory | Checks the memory usage | check_ssh_linux _memory | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE _HOSTMEMORY_WA RN _HOSTMEMORY_CR IT |
| NFS Stats | Checks the NFS (Network File System) statistics | check_ssh_linux _nfs_stats | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| NET Stats | Checks the network statistics | check_ssh_linux _net_stats | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| Load Average | Checks the system load average | check_ssh_linux _load_average | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE _HOSTLOAD_WARN _HOSTLOAD_CRIT |
| Disks | Checks the disk usage | check_ssh_linux _disks | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE _HOSTSTORAGE_U NIT _HOSTSTORAGE_W ARN _HOSTSTORAGE_C RIT _HOSTSTORAGE_M OUNTS |
| Kernel Stats | Checks the Kernel statistics | check_ssh_linux _kernel_stats | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| TCP States | Checks the states from TCP connection table | check_ssh_linux _tcp_states | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| SSH Connexion | Checks the SSH connexion | check_ssh_conne xion | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| Reboot | Checks the system uptime | check_ssh_linux _uptime | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| Read-only Filesystems | Checks if there are Read-only filesystems | check_ssh_ro_f ilesystem | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| CPU Stats | Checks the CPU load statistics | check_ssh_linux _cpu_stats | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| Disks Stats | Checks the disk statistics | check_ssh_linux _disks_stats | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SSH_USER | Remote user for the SSH service (key interchange with Shinken user must be done ) | string |
| _SSH_PORT | Remote port for the SSH service | integer |
| _SSH_KEY | SSH key (Shinken user) | string |
| _SSH_KEY_PASSPHRASE | SSH passphrase (Shinken user) | string |
| _LOAD_WARN | Value for starting warning state for the load average at 1m,5m,15m | 3 comma-separated integer |
| _LOAD_CRIT | Value for starting critical state for the load average at 1m,5m,15m | 3 comma-separated integer |
| _STORAGE_WARN | Warning level for used disk space (percentage) | percent |
| _STORAGE_CRIT | Critical level for used disk space (percentage) | percent |
| _STORAGE_UNIT | Unit of disk space : B, KB, MB, GB or TB | string |
| _STORAGE_MOUNTS | List of mount points to monitor | comma-separated absolute path |
| _CPU_WARN | Warning level for the CPU usage (percentage) | percent |
| _CPU_CRIT | Critical level for the CPU usage (percentage) | percent |
| _MEMORY_WARN | Physical memory warning threshold (percentage) | percent |
| _MEMORY_CRIT | Physical memory critical threshold (percentage) | percent |
Linux-ssh-aggregated¶
DESCRIPTION
Standard linux checks, like CPU, RAM and disk space. Checks are done by SSH.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Memory | Checks the memory usage | check_ssh_linux _memory | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE _HOSTMEMORY_WA RN _HOSTMEMORY_CR IT |
| NFS Stats | Checks the NFS (Network File System) statistics | check_ssh_linux _nfs_stats | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| NET Stats | Checks the network statistics | check_ssh_linux _net_stats | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| Load Average | Checks the system load average | check_ssh_linux _load_average | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE _HOSTLOAD_WARN _HOSTLOAD_CRIT |
| Disks | Checks the disk usage | check_ssh_linux _disks | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE _HOSTSTORAGE_U NIT _HOSTSTORAGE_W ARN _HOSTSTORAGE_C RIT _HOSTSTORAGE_M OUNTS |
| Kernel Stats | Checks the Kernel statistics | check_ssh_linux _kernel_stats | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| TCP States | Checks the states from TCP connection table | check_ssh_linux _tcp_states | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| SSH Connexion | Checks the SSH connexion | check_ssh_conne xion | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| CPU Stats | Checks the CPU load statistics. Returns only aggregated metrics | check_ssh_linux _cpu_stats_agg regated | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| Reboot | Checks the system uptime | check_ssh_linux _uptime | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| Read-only Filesystems | Checks if there are Read-only filesystems | check_ssh_ro_f ilesystem | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
| Disks Stats | Checks the disk statistics | check_ssh_linux _disks_stats | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_KEY _HOSTSSH_KEY_ PASSPHRASE |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SSH_USER | Remote user for the SSH service (key interchange with Shinken user must be done ) | string |
| _SSH_PORT | Remote port for the SSH service | integer |
| _SSH_KEY | SSH key (Shinken user) | string |
| _SSH_KEY_PASSPHRASE | SSH passphrase (Shinken user) | string |
| _LOAD_WARN | Value for starting warning state for the load average at 1m,5m,15m | 3 comma-separated integer |
| _LOAD_CRIT | Value for starting critical state for the load average at 1m,5m,15m | 3 comma-separated integer |
| _STORAGE_WARN | Warning level for used disk space (percentage) | percent |
| _STORAGE_CRIT | Critical level for used disk space (percentage) | percent |
| _STORAGE_UNIT | Unit of disk space : B, KB, MB, GB or TB | string |
| _STORAGE_MOUNTS | List of mount points to monitor | comma-separated absolute path |
| _CPU_WARN | Warning level for the CPU usage (percentage) | percent |
| _CPU_CRIT | Critical level for the CPU usage (percentage) | percent |
| _MEMORY_WARN | Physical memory warning threshold (percentage) | percent |
| _MEMORY_CRIT | Physical memory critical threshold (percentage) | percent |
Nginx-node¶
DESCRIPTION
Custom checks for Nginx services
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| nginx-node-status | Checks nginx status service detailed . | check_nginx_nod e_status | _HOSTNGINX_POR T _HOSTNGINX_PRO TOCOL _HOSTNGINX_DOM AIN _HOSTNGINX_ACT IVE_CONN_WARNI NG _HOSTNGINX_ACT IVE_CONN_CRITI CAL _HOSTSSH_USER _HOSTSSH_KEY_ PASSPHRASE _HOSTSSH_KEY _HOSTSSH_PORT |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _NGINX_PROTOCOL | WEB protocol: HTTP/HTTPS (HTTP by default) | string |
| _NGINX_DOMAIN | Used for Nginx checks if value is not default | string |
| _NGINX_ACTIVE_CONN_WARNING | Active connections warning threshold | integer |
| _NGINX_ACTIVE_CONN_CRITICAL | Active connections critical threshold | integer |
| _NGINX_PORT | NGINX port (default 22). | integer |
| _SSH_USER | SSH user (key interchange with Wocu user must be done). | string |
| _SSH_KEY_PASSPHRASE | SSH passphrase (Wocu user) | string |
| _SSH_KEY | SSH Key File (default ~/.ssh/id_rsa) | string |
| _SSH_PORT | SSH port (default 22). | integer |
Os_resources¶
DESCRIPTION
Monitoring Windows an Linux Servers, via snmp
Script to check the state of Windows an Linux servers, through snmp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Processes_$KEY$ | Checks the state of processes | os_processes | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _PROCESSES |
| Partition_$KEY$ | Checks the partitions storage usage | os_partition_us age | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTSTORAGE_W ARNING_THRESHOL D _HOSTSTORAGE_C RITICAL_THRESHO LD _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T _PARTITIONS |
| Users | Checks the number of users sessions | os_users | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTUSERS_WAR NING_THRESHOLD _HOSTUSERS_CRI TICAL_THRESHOLD _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| CPU usage 1m | Checks the last minute average CPU usage | os_cpu_1m_usag e | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCPU_WARNI NG_THRESHOLD _HOSTCPU_CRITI CAL_THRESHOLD _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Memory buffer usage | Checks the memory buffer usage | os_mem_buffer | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTMEMORY_BU FFER_DEFAULT_W ARNING _HOSTMEMORY_BU FFER_DEFAULT_C RITICAL _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| RAM usage | Checks the memory usage | os_ram_usage | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTRAM_WARNI NG_THRESHOLD _HOSTRAM_CRITI CAL_THRESHOLD _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Number of processes | Checks the number of processes | os_count_proces ses | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCOUNT_PRO CESSES_WARNING_THRESHOLD _HOSTCOUNT_PRO CESSES_CRITICAL _THRESHOLD _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Virtual memory usage | Checks the virtual memory usage | os_vm_usage | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTVM_WARNIN G_THRESHOLD _HOSTVM_CRITIC AL_THRESHOLD _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
| Uptime | Checks the server uptime | os_uptime | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTUPTIME_CR ITICAL_THRESHOL D _HOSTSNMPSECURI TYNAME _HOSTSNMPAUTHPR OTOCOL _HOSTSNMPPRIVPR OTOCOL _HOSTSNMPAUTHKE Y _HOSTSNMPPRIVKE Y _HOSTSNMPSECURI TYLEVEL _HOSTSNMPCONTEX T |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_PARTITIONS:
wocu-discover-os-resources-partitions.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ -s $_SNMPVERSION$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -x $_SNMPPRIVPROTOCOL$ -A $_SNMPAUTHKEY$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ –remote $_POLLER_TAG_ADDRESS$_PROCESSES:
wocu-discover-os-resources-processes.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ -s $_SNMPVERSION$ -u $_SNMPSECURITYNAME$ -a $_SNMPAUTHPROTOCOL$ -x $_SNMPPRIVPROTOCOL$ -A $_SNMPAUTHKEY$ -X $_SNMPPRIVKEY$ -l $_SNMPSECURITYLEVEL$ -n $_SNMPCONTEXT$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Device SNMP Community, use $SNMPCOMMUNITYREAD$ for the default system community | string |
| _SNMPVERSION | Device SNMP versions supported are: 1, 2c and 3 | string |
| _SNMPSECURITYNAME | SNMP security name (only snmp v3) | string |
| _SNMPAUTHPROTOCOL | SNMP authentication type, can be either MD5 or SHA (only snmp v3) | string |
| _SNMPAUTHKEY | SNMP authentication key (only snmp v3) | string |
| _SNMPPRIVPROTOCOL | SNMP privacy type, can be either AES or DES (only snmp v3) | string |
| _SNMPPRIVKEY | SNMP privacy key (only snmp v3)’ | string |
| _SNMPSECURITYLEVEL | SNMP Security level, noAuthNoPriv or authNoPriv or authPriv (only snmp v3) | string |
| _SNMPCONTEXT | SNMP context name (only snmp v3). Write $SNMPCONTEXT$ to use Shinken resource | string |
| _CPU_WARNING_THRESHOLD | CPU warning threshold | percent |
| _CPU_CRITICAL_THRESHOLD | CPU critical threshold | percent |
| _RAM_WARNING_THRESHOLD | RAM warning threshold | percent |
| _RAM_CRITICAL_THRESHOLD | RAM critical threshold | percent |
| _VM_WARNING_THRESHOLD | Virtual memory warning threshold | percent |
| _VM_CRITICAL_THRESHOLD | Virtual memory critical threshold | percent |
| _STORAGE_WARNING_THRESHOLD | Storage warning threshold | percent |
| _STORAGE_CRITICAL_THRESHOLD | Storage critical threshold | percent |
| _UPTIME_CRITICAL_THRESHOLD | Uptime critical threshold | integer |
| _USERS_WARNING_THRESHOLD | Users warning threshold | integer |
| _USERS_CRITICAL_THRESHOLD | Users critical threshold | integer |
| _COUNT_PROCESSES_WARNING_THR ESHOLD | Number of processes running warning threshold | integer |
| _COUNT_PROCESSES_CRITICAL_TH RESHOLD | Number of processes running critical threshold | integer |
| _MEMORY_BUFFER_DEFAULT_WARNI NG | Percent of memory buffer used warning threshold | integer |
| _MEMORY_BUFFER_DEFAULT_CRITI CAL | Percent of memory buffer used critical threshold | integer |
COMPLEX MACROS
_PARTITIONS
- Description: Disk partitions
- Discover: wocu-discover-os-resources-partitions.py
| Fields | Description | Type |
|---|---|---|
| index | Partition index | integer |
| label | Partition label | string |
| unit | Letter unit or path | string |
_PROCESSES
- Description: Processes
- Discover: wocu-discover-os-resources-processes.py
| Fields | Description | Type |
|---|---|---|
| ProcName | Process label | string |
| ProcParameters | Process parameters | string |
Unix-files-ssh¶
DESCRIPTION
Checks last modification day for a file via ssh protocol
Checks last modification day for a file via ssh protocol
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| File $KEY$ | Connects to a server via SSH and checks if a file exists | check_unix-files- ssh | _HOSTSSH_PORT _HOSTSSH_USER _HOSTSSH_PASSWORD _HOSTSSH_KEY_FIL E _FILES |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SSH_PORT | SSH port (default 22) | integer |
| _SSH_USER | SSH User | string |
| _SSH_PASSWORD | SSH Password. If default (SSH_PASSWORD), SSH_KEY_FILE will be used | string |
| _SSH_KEY_FILE | SSH Key File (default ~/.ssh/id_rsa) | string |
COMPLEX MACROS
_FILES
- Description: File details
| Fields | Description | Type |
|---|---|---|
| Display name | File id (unique) | string |
| File name prefix | File name without date suffix. Wildcards (*, ?, etc.) are supported | string |
| Path | File path | string |
| Time period | If Time Period Unit is days, 1 means today, 2 means yesterday and today, etc. | integer |
| Time period Unit | Time period unit | string |
Windows¶
DESCRIPTION
Standard windows checks, like CPU, RAM and disk space. Checks are done by WMI.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Reboot | Checks last reboot | check_windows_r eboot | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_R EBOOT_WARN _HOSTWINDOWS_R EBOOT_CRIT |
| InactiveSessions | Detect inactive sessions | check_windows_i nactive_ts_sess ions | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_M IN_INACTIVE_SE SSIONS _HOSTWINDOWS_M AX_INACTIVE_SE SSIONS |
| ShareSpace-$KEY$ | Checks windows share free space. | check_windows_s hare | _HOSTDOMAINUSER SHORT _HOSTDOMAINPASS WORD _HOSTDOMAIN _HOSTWINDOWS_S HARE_WARN _HOSTWINDOWS_S HARE_CRIT _shares |
| Windows - BigProcesses | Obtain processes using high CPU resources | check_windows_b ig_processes | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_B IG_PROCESSES_W ARN |
| Services | Check the services running in the server | check_windows_a uto_services | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_E XCLUDED_AUTO_S ERVICES _HOSTWINDOWS_A UTO_SERVICES_W ARN _HOSTWINDOWS_A UTO_SERVICES_C RIT |
| EventLogSystem | Detect abnormal system events | check_windows_e ventlogs | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_E VENT_LOG_WARN _HOSTWINDOWS_E VENT_LOG_CRIT |
| LoadAverage | Detect abnormal CPU usage | check_windows_l oadaverage | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_L OAD_WARN _HOSTWINDOWS_L OAD_CRIT |
| Network Interface | Detect abnormal Network usage | check_windows_n etwork | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_N ET_WARN _HOSTWINDOWS_N ET_CRIT _HOSTWINDOWS_N ET_WARN _HOSTWINDOWS_N ET_CRIT |
| Memory | Check about memory usage. | check_windows_p hysical_memory | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_M EM_WARN _HOSTWINDOWS_M EM_CRIT |
| Disks | Overall disks usage | check_windows_d isks | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_D ISK_WARN _HOSTWINDOWS_D ISK_CRIT |
| EventLogApplicati on | Detect abnormal application events | check_windows_e ventlogs | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_E VENT_LOG_WARN _HOSTWINDOWS_E VENT_LOG_CRIT |
| EachCpu | Detect abnormal CPU usage | check_windows_e ach_cpu | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_C PU_WARN _HOSTWINDOWS_C PU_CRIT |
| Swap | Check swap space usage. Too many use of swap space means lacks of memory or memory leaks. | check_windows_s wap | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD |
| DisksIO | Overall disks IO usage | check_windows_d isks_io | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD |
| Cpu | Detect abnormal CPU usage | check_windows_o verall_cpu | _HOSTDOMAINUSER _HOSTDOMAINPASS WORD _HOSTWINDOWS_A LL_CPU_WARN _HOSTWINDOWS_A LL_CPU_CRIT |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _DOMAIN | Windows Domain of the server | string |
| _DOMAINUSERSHORT | Short name (without the domain) of the user to query the server. Should have rights on the WMI tables for reading. | string |
| _DOMAINUSER | Full name of the user launching the query (default DOMAINUSERSHORT). | string |
| _DOMAINPASSWORD | Password for the user launching the query. | string |
| _WINDOWS_SHARE_WARN | Warning level for the share disk space (percentage). | percent |
| _WINDOWS_SHARE_CRIT | Critical level for the share disk space (percentage). | percent |
| _WINDOWS_DISK_WARN | Warning threshold for disk space (percentage). | percent |
| _WINDOWS_DISK_CRIT | Critical threshold for disk space (percentage). | percent |
| _WINDOWS_EVENT_LOG_WARN | Level for event log detection | string |
| _WINDOWS_EVENT_LOG_CRIT | Level for event log detection | string |
| _WINDOWS_REBOOT_WARN | Warning Uptime of the host (expressed as 5min: / 15m:) | string |
| _WINDOWS_REBOOT_CRIT | Critical Uptime of the host (expressed as 5min: / 15m:) | string |
| _WINDOWS_MEM_WARN | Warning threshold for Windows RAM usage (percentage) | percent |
| _WINDOWS_MEM_CRIT | Critical threshold for Windows RAM usage (percentage) | percent |
| _WINDOWS_ALL_CPU_WARN | Warning threshold for Windows combined CPU usage (percentage) | percent |
| _WINDOWS_ALL_CPU_CRIT | Critical threshold for Windows combined CPU usage (percentage) | percent |
| _WINDOWS_CPU_WARN | Warning threshold for each CPU usage (percentage) | percent |
| _WINDOWS_CPU_CRIT | Critical threshold for each CPU usage (percentage) | percent |
| _WINDOWS_LOAD_WARN | Warning threshold for CPU load (absolute, single value) | string |
| _WINDOWS_LOAD_CRIT | Critical threshold for CPU load (absolute, single value) | string |
| _WINDOWS_EXCLUDED_AUTO_SERVI CES | Regex to match Services to be excluded from check | string |
| _WINDOWS_AUTO_SERVICES_WARN | Level for auto-services not running | string |
| _WINDOWS_AUTO_SERVICES_CRIT | Level for auto-services not running | string |
| _WINDOWS_BIG_PROCESSES_WARN | Level for Big processes (percentage) | percent |
| _WINDOWS_NET_WARN | Warning threshold for NET usage (percentage) | percent |
| _WINDOWS_NET_CRIT | Critical threshold for NET usage (percentage) | percent |
| _WINDOWS_MIN_INACTIVE_SESSIO NS | Windows min Inactive Sessions | integer |
| _WINDOWS_MAX_INACTIVE_SESSIO NS | Windows max Inactive Sessions | integer |
| _WINDOWS_NETWORK_INTERFACE | Default network interface (for checking usage thresholds) | string |
Windows-drive-size¶
DESCRIPTION
Get drive size on windows servers by WMI interface
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| DRIVE_$KEY$_STA TUS | Checks the drive size and status | check_drive_siz e | _HOSTUSER_WMI _HOSTPASSWORD_ WMI _DRIVES_LIST |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _USER_WMI | Server WMI User | string |
| _PASSWORD_WMI | Server WMI Password | string |
COMPLEX MACROS
_DRIVES_LIST
- Description: List of drives to overwatch
| Fields | Description | Type |
|---|---|---|
| Drive | Drive: | string |
| Warning | % warning value | string |
| Critical | % critical value | string |
Windows-events¶
DESCRIPTION
Check event viewer id by WMI interface
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| EVENTS_$KEY$_ST ATUS | Looks for events in remote event viewer | check_events_wi ndows_status | _HOSTUSER_WMI _HOSTPASSWORD_ WMI _EVENTS_LIST |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _USER_WMI | Server WMI User | string |
| _PASSWORD_WMI | Server WMI Password | string |
COMPLEX MACROS
_EVENTS_LIST
- Description: List of Events to overwatch
| Fields | Description | Type |
|---|---|---|
| name | Name of sample Event Viewer | string |
| service | Name of the log eg System or Application or any other Event log as shown in the Windows Event Viewer | string |
| type | Eventtype: # 1=error , 2=warning , 3=Information,4=Security Audit Success,5=Security Audit Failure Multiple Eventypes possible with coma separation | string |
| id | Eventid Multiple Eventids possible with coma separation | integer |
| minutes | Number of past min to check for events | integer |
| warning | Set warning if past min to check for events | integer |
| critical | Set critical if past min to check for events | integer |
Windows-process¶
DESCRIPTION
Gets data usage of processes running on windows servers per WMI interface
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| PROCESS_$KEY$_C PU | Checks the CPU used by a process | check_process_w indows_cpu | _HOSTUSER_WMI _HOSTPASSWORD_ WMI _PROCESSES_LIS T |
| PROCESS_$KEY$_M EM | Checks the Memory used by a process | check_process_w indows_mem | _HOSTUSER_WMI _HOSTPASSWORD_ WMI _PROCESSES_LIS T |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _USER_WMI | Server WMI User | string |
| _PASSWORD_WMI | Server WMI Password | string |
COMPLEX MACROS
_PROCESSES_LIST
- Description: List of Process to overwatch
| Fields | Description | Type |
|---|---|---|
| name | Custom Service Name | string |
| Process | Name of the Process to be displayed without extension | string |
| warning Memory | warning threshold use Memory | string |
| critical Memory | critical threshold use Memory | string |
| warning CPU | warning threshold use CPU | string |
| critical CPU | critical threshold use CPU | string |
Windows-services¶
DESCRIPTION
Get service status on windows servers by WMI interface
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| SERVICES_$KEY$_ STATUS | Checks the status of a service | check_services_ windows_status | _HOSTUSER_WMI _HOSTPASSWORD_ WMI _SERVICES_LIST |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _USER_WMI | Server WMI User | string |
| _PASSWORD_WMI | Server WMI Password | string |
COMPLEX MACROS
_SERVICES_LIST
- Description: List of Services to overwatch
| Fields | Description | Type |
|---|---|---|
| name | Custom Service Name | string |
| Service | Name real of the service | string |
| Status | Service status Running/Stopped | string |
Wocu-health-aggregator¶
DESCRIPTION
Checks Wocu Aggregator daemons running on a server. Netcat must be installed in monitored server
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| WOCU Health - Aggregator - $KEY$ | Checks Wocu Aggregator daemons status and consumption metrics | check-wocu- aggregator-daemon | _HOSTWEB_PROTO COL _HOSTDOMAIN _HOSTACTIVE_CO NN_WARNING _HOSTACTIVE_CO NN_CRITICAL _HOSTSSH_USER _HOSTSSH_KEY_ PASSPHRASE _HOSTSSH_KEY _HOSTSSH_PORT _HOSTAPI_AGGRE GATOR_ENDPOINT _HOSTAPI_AGGRE GATOR_USER _HOSTAPI_AGGRE GATOR_PASSWORD _HOSTAPI_TIMEO UT _WOCU_DAEMONS |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_WOCU_DAEMONS:
wocu-discover-wocu-daemons.py -H $HOSTADDRESS$ -f Aggregator -p $_WEB_PROTOCOL$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _WEB_PROTOCOL | WEB protocol: HTTP/HTTPS (HTTP by default) | string |
| _DOMAIN | Used for Nginx checks if value is not default | string |
| _ACTIVE_CONN_WARNING | Active connections warning threshold | integer |
| _ACTIVE_CONN_CRITICAL | Active connections critical threshold | integer |
| _SSH_USER | SSH user (key interchange with Wocu user must be done). | string |
| _SSH_PORT | SSH port (default 22). | integer |
| _SSH_KEY_PASSPHRASE | SSH passphrase (Wocu user) | string |
| _SSH_KEY | SSH Key File (default ~/.ssh/id_rsa) | string |
| _API_AGGREGATOR_USER | Aggregtor API User | string |
| _API_AGGREGATOR_PASSWORD | Aggregtor API Password | string |
| _API_AGGREGATOR_ENDPOINT | Aggregtor API Query endpoint | string |
| _API_TIMEOUT | API Query timeout in seconds, default 10s | integer |
COMPLEX MACROS
_WOCU_DAEMONS
- Description: Wocu daemons and ports to monitorize.
- Discover: wocu-discover-wocu-daemons.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Display name to be shown as part of the service description. | string |
| Daemon | Daemon (process name) to monitor. | string |
| Port | Daemon TCP Port to be checked. | integer |
Wocu-health-generic¶
DESCRIPTION
Checks Wocu daemons running on a server. Netcat must be installed in monitored server
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| WOCU Health - $KEY$ | Checks Wocu daemons status and consumption metrics | check-wocu-daemon | _HOSTWEB_PROTO COL _HOSTDOMAIN _HOSTACTIVE_CO NN_WARNING _HOSTACTIVE_CO NN_CRITICAL _HOSTSSH_USER _HOSTSSH_KEY_ PASSPHRASE _HOSTSSH_KEY _HOSTSSH_PORT _HOSTAPI_AGGRE GATOR_ENDPOINT _HOSTAPI_AGGRE GATOR_USER _HOSTAPI_AGGRE GATOR_PASSWORD _HOSTAPI_IMPOR T_TOOL_ENDPOIN T _HOSTAPI_IMPOR T_TOOL_USER _HOSTAPI_IMPOR T_TOOL_PASSWOR D _HOSTAPI_TIMEO UT _WOCU_DAEMONS |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_WOCU_DAEMONS:
wocu-discover-wocu-daemons.py -H $HOSTADDRESS$ -f $_WOCU_FLAVOUR$ -p $_WEB_PROTOCOL$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _WOCU_FLAVOUR | Choose Wocu Flavour | string |
| _WEB_PROTOCOL | WEB protocol: HTTP/HTTPS (HTTP by default) | string |
| _DOMAIN | Used for Nginx checks if value is not default | string |
| _ACTIVE_CONN_WARNING | Active connections warning threshold | integer |
| _ACTIVE_CONN_CRITICAL | Active connections critical threshold | integer |
| _SSH_USER | SSH user (key interchange with Wocu user must be done). | string |
| _SSH_PORT | SSH port (default 22). | integer |
| _SSH_KEY_PASSPHRASE | SSH passphrase (Wocu user) | string |
| _SSH_KEY | SSH Key File (default ~/.ssh/id_rsa) | string |
| _API_AGGREGATOR_USER | Aggregtor API User | string |
| _API_AGGREGATOR_PASSWORD | Aggregtor API Password | string |
| _API_AGGREGATOR_ENDPOINT | Aggregtor API Query endpoint | string |
| _API_IMPORT_TOOL_USER | Import-tool API User | string |
| _API_IMPORT_TOOL_PASSWORD | Import-tool API Password | string |
| _API_IMPORT_TOOL_ENDPOINT | Import-tool API Query endpoint | string |
| _API_TIMEOUT | API Query timeout in seconds, default 10s | integer |
COMPLEX MACROS
_WOCU_DAEMONS
- Description: Wocu daemons and ports to monitorize.
- Discover: wocu-discover-wocu-daemons.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Display name to be shown as part of the service description. | string |
| Daemon | Daemon (process name) to monitor. | string |
| Port | Daemon TCP Port to be checked. | integer |
Wocu-health-monitoring¶
DESCRIPTION
Checks Wocu Monitoring daemons running on a server. Netcat must be installed in monitored server
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| WOCU Health - Monitoring - $KEY$ | Checks Wocu Monitoring daemons status and consumption metrics | check-wocu- monitoring-daemon | _HOSTWEB_PROTO COL _HOSTDOMAIN _HOSTACTIVE_CO NN_WARNING _HOSTACTIVE_CO NN_CRITICAL _HOSTSSH_USER _HOSTSSH_KEY_ PASSPHRASE _HOSTSSH_KEY _HOSTSSH_PORT _HOSTAPI_IMPOR T_TOOL_ENDPOIN T _HOSTAPI_IMPOR T_TOOL_USER _HOSTAPI_IMPOR T_TOOL_PASSWOR D _HOSTAPI_TIMEO UT _WOCU_DAEMONS |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_WOCU_DAEMONS:
wocu-discover-wocu-daemons.py -H $HOSTADDRESS$ -f Monitoring -p $_WEB_PROTOCOL$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _WEB_PROTOCOL | WEB protocol: HTTP/HTTPS (HTTP by default) | string |
| _DOMAIN | Used for Nginx checks if value is not default | string |
| _ACTIVE_CONN_WARNING | Active connections warning threshold | integer |
| _ACTIVE_CONN_CRITICAL | Active connections critical threshold | integer |
| _SSH_USER | SSH user (key interchange with Wocu user must be done). | string |
| _SSH_PORT | SSH port (default 22). | integer |
| _SSH_KEY_PASSPHRASE | SSH passphrase (Wocu user) | string |
| _SSH_KEY | SSH Key File (default ~/.ssh/id_rsa) | string |
| _API_IMPORT_TOOL_USER | Import-tool API User | string |
| _API_IMPORT_TOOL_PASSWORD | Import-tool API Password | string |
| _API_IMPORT_TOOL_ENDPOINT | Import-tool API Query endpoint | string |
| _API_TIMEOUT | API Query timeout in seconds, default 10s | integer |
COMPLEX MACROS
_WOCU_DAEMONS
- Description: Wocu daemons and ports to monitorize.
- Discover: wocu-discover-wocu-daemons.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Display name to be shown as part of the service description. | string |
| Daemon | Daemon (process name) to monitor. | string |
| Port | Daemon TCP Port to be checked. | integer |
Wocu-health-monitoring-visor¶
DESCRIPTION
Checks Wocu Monitoring Visor daemons running on a server. Netcat must be installed in monitored server
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| WOCU Health - Monitoring Visor - $KEY$ | Checks Wocu Monitoring Visor daemons status and consumption metrics | check-wocu- monitoring-visor- daemon | _HOSTWEB_PROTO COL _HOSTDOMAIN _HOSTACTIVE_CO NN_WARNING _HOSTACTIVE_CO NN_CRITICAL _HOSTSSH_USER _HOSTSSH_KEY_ PASSPHRASE _HOSTSSH_KEY _HOSTSSH_PORT _HOSTAPI_IMPOR T_TOOL_ENDPOIN T _HOSTAPI_IMPOR T_TOOL_USER _HOSTAPI_IMPOR T_TOOL_PASSWOR D _HOSTAPI_TIMEO UT _WOCU_DAEMONS |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_WOCU_DAEMONS:
wocu-discover-wocu-daemons.py -H $HOSTADDRESS$ -f Monitoring-Visor -p $_WEB_PROTOCOL$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _WEB_PROTOCOL | WEB protocol: HTTP/HTTPS (HTTP by default) | string |
| _DOMAIN | Used for Nginx checks if value is not default | string |
| _ACTIVE_CONN_WARNING | Active connections warning threshold | integer |
| _ACTIVE_CONN_CRITICAL | Active connections critical threshold | integer |
| _SSH_USER | SSH user (key interchange with Wocu user must be done). | string |
| _SSH_PORT | SSH port (default 22). | integer |
| _SSH_KEY_PASSPHRASE | SSH passphrase (Wocu user) | string |
| _SSH_KEY | SSH Key File (default ~/.ssh/id_rsa) | string |
| _API_IMPORT_TOOL_USER | Import-tool API User | string |
| _API_IMPORT_TOOL_PASSWORD | Import-tool API Password | string |
| _API_IMPORT_TOOL_ENDPOINT | Import-tool API Query endpoint | string |
| _API_TIMEOUT | API Query timeout in seconds, default 10s | integer |
COMPLEX MACROS
_WOCU_DAEMONS
- Description: Wocu daemons and ports to monitorize.
- Discover: wocu-discover-wocu-daemons.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Display name to be shown as part of the service description. | string |
| Daemon | Daemon (process name) to monitor. | string |
| Port | Daemon TCP Port to be checked. | integer |
Wocu-health-satellite¶
DESCRIPTION
Checks Wocu Satellite daemons running on a server
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| WOCU Health - Satellite - $KEY$ | Checks Wocu Satellite daemons status and consumption metrics | check-wocu- satellite-daemon | _HOSTWEB_PROTO COL _HOSTSSH_USER _HOSTSSH_KEY_ PASSPHRASE _HOSTSSH_KEY _HOSTSSH_PORT _WOCU_DAEMONS |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _WEB_PROTOCOL | WEB protocol: HTTP/HTTPS (HTTP by default) | string |
| _SSH_USER | SSH user (key interchange with Wocu user must be done). | string |
| _SSH_PORT | SSH port (default 22). | integer |
| _SSH_KEY_PASSPHRASE | SSH passphrase (Wocu user) | string |
| _SSH_KEY | SSH Key File (default ~/.ssh/id_rsa) | string |
COMPLEX MACROS
_WOCU_DAEMONS
- Description: Wocu daemons and ports to monitorize.
| Fields | Description | Type |
|---|---|---|
| Display Name | Display name to be shown as part of the service description. | string |
| Daemon | Daemon (process name) to monitor. | string |
| Port | Daemon TCP Port to be checked. | integer |
Wocu-realm¶
DESCRIPTION
Checks to obtain host/services stats per realm from Wocu-aggregator servers
This pack should be applied only to wocu-aggregator
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| WOCU Realm - $KEY$ - Stats | Checks hosts/serv ices/bphost/bpser vices statistics from realms | check-realm- status | _HOSTAPI_PROTO COL _HOSTAPI_ENDPO INT _HOSTAPI_USER _HOSTAPI_PASSW ORD _HOSTAPI_TIMEO UT _HOSTDOMAIN _HOSTHOST_WARN _HOSTHOST_CRIT _HOSTSERVICE_W ARN _HOSTSERVICE_C RIT _HOSTBPHOST_WA RN _HOSTBPHOST_CR IT _HOSTBPSERVICE_WARN _HOSTBPSERVICE_CRIT _WOCU_REALMS |
| WOCU Realm - $KEY$ - LMD Status | Checks LMD status from every realm | check-realm-lmd- status | _WOCU_REALMS |
| WOCU Realm - $KEY$ - Last Check | Checks the time from last check command executed | check-realm-last- check | _HOSTLAST_CHEC K_WARN _HOSTLAST_CHEC K_CRIT _WOCU_REALMS |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_WOCU_REALMS:
wocu-discover-wocu-realms.py -H $HOSTADDRESS$ -P $_API_PROTOCOL$ -u $_API_USER$ -p $_API_PASSWORD$ -d $_DOMAIN$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _API_USER | Aggregator API user | string |
| _API_PASSWORD | Aggregator API password | string |
| _API_PROTOCOL | Aggregator API protocol: HTTP/HTTPS (HTTP by default) | string |
| _API_ENDPOINT | API Query endpoint | string |
| _API_TIMEOUT | API Query timeout in seconds, default 10s | integer |
| _HOST_WARN | Not OK Hosts warning threshold (percentage) | percent |
| _HOST_CRIT | Not OK Hosts critical threshold (percentage) | percent |
| _SERVICE_WARN | Not OK Services warning threshold (percentage) | percent |
| _SERVICE_CRIT | Not OK Services critical threshold (percentage) | percent |
| _BPHOST_WARN | Not OK BPHosts warning threshold (percentage) | percent |
| _BPHOST_CRIT | Not OK BPHosts critical threshold (percentage) | percent |
| _BPSERVICE_WARN | Not OK BPServices warning threshold (percentage) | percent |
| _BPSERVICE_CRIT | Not OK BPServices critical threshold (percentage) | percent |
| _LAST_CHECK_WARN | Minutes from last executed check warning threshold | integer |
| _LAST_CHECK_CRIT | Minutes from last executed check critical threshold | integer |
| _DOMAIN | Domain hostname | string |
COMPLEX MACROS
_WOCU_REALMS
- Description: Wocu realms
- Discover: wocu-discover-wocu-realms.py
| Fields | Description | Type |
|---|---|---|
| display_name | Display name to be shown as part of the service description. | string |
| name | Realm name to monitor. | string |
| monitoring_ip | IP address to query. | string |
| monitoring_port | Port to query. | integer |
Database¶
Elastic-node¶
DESCRIPTION
Checks the status of a single Elastic node
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Elastic_software _indexing | Checks the indexing time | check_node_inde xing | _HOSTELASTIC_P ORT _HOSTELASTIC_N ODENAME _HOSTINDEXING_ WARNING_THRESHO LD _HOSTINDEXING_ CRITICAL_THRESH OLD _HOSTELASTIC_U SERNAME _HOSTELASTIC_P ASSWORD |
| Elastic_cluster_shards_status | Checks Shards status | check_shards_st atus | _HOSTELASTIC_P ORT _HOSTELASTIC_N ODENAME _HOSTUNASSIGNED _SHARD_WARNING _THRESHOLD _HOSTUNASSIGNED _SHARD_CRITICA L_THRESHOLD _HOSTELASTIC_U SERNAME _HOSTELASTIC_P ASSWORD |
| Elastic_disk_us ed | Checks Disk usage | check_elastic_d isk_space_used | _HOSTELASTIC_P ORT _HOSTELASTIC_N ODENAME _HOSTDISK_SPAC E_USED_WARNING _THRESHOLD _HOSTDISK_SPAC E_USED_CRITICA L_THRESHOLD _HOSTELASTIC_U SERNAME _HOSTELASTIC_P ASSWORD |
| Elastic_jvm_mem ory | Checks used memory percentage of JVM | check_elastic_m emory_jvm | _HOSTELASTIC_P ORT _HOSTELASTIC_N ODENAME _HOSTJVM_WARNI NG_THRESHOLD _HOSTJVM_CRITI CAL_THRESHOLD _HOSTELASTIC_U SERNAME _HOSTELASTIC_P ASSWORD |
| Elastic_document s | Checks the number of documents | check_elastic_d ocuments | _HOSTELASTIC_P ORT _HOSTELASTIC_N ODENAME _HOSTELASTIC_U SERNAME _HOSTELASTIC_P ASSWORD |
| Elastic_cluster_status | Checks Cluster status | check_cluster_h ealth | _HOSTELASTIC_P ORT _HOSTELASTIC_N ODENAME _HOSTELASTIC_U SERNAME _HOSTELASTIC_P ASSWORD |
| Elastic_software _uptime | Checks the Elastic node uptime | check_elastic_u ptime | _HOSTELASTIC_P ORT _HOSTELASTIC_N ODENAME _HOSTNODE_UPTI ME_WARNING_THR ESHOLD _HOSTNODE_UPTI ME_WARNING_THR ESHOLD _HOSTELASTIC_U SERNAME _HOSTELASTIC_P ASSWORD |
| Elastic_software _version | Shows Elastic node version | check_elastic_v ersion | _HOSTELASTIC_P ORT _HOSTELASTIC_N ODENAME _HOSTELASTIC_U SERNAME _HOSTELASTIC_P ASSWORD |
| Elastic_cluster_shards_count | Shows Shards info | check_shards_co unt | _HOSTELASTIC_P ORT _HOSTELASTIC_N ODENAME _HOSTELASTIC_U SERNAME _HOSTELASTIC_P ASSWORD |
| Elastic_software _search_query | Checks the index search query time | check_node_sear ch_query | _HOSTELASTIC_P ORT _HOSTELASTIC_N ODENAME _HOSTSEARCH_QU ERY_WARNING_TH RESHOLD _HOSTSEARCH_QU ERY_CRITICAL_T HRESHOLD _HOSTELASTIC_U SERNAME _HOSTELASTIC_P ASSWORD |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_ELASTIC_NODENAME:
wocu-discover-elastic-node.py -H $HOSTADDRESS$ -P $_ELASTIC_PORT$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _ELASTIC_PORT | Elastic port for the queries (default 9200) | integer |
| _ELASTIC_NODENAME | Name of the Elastic node (as registered in the service) | string |
| _ELASTIC_USERNAME | Username for API auth. Leave it blank if authentication is not needed | string |
| _ELASTIC_PASSWORD | Password for API auth. Leave it blank if authentication is not needed | string |
| _JVM_WARNING_THRESHOLD | Warning threshold for the JVM Memory used by Elastic (percentage) | percent |
| _JVM_CRITICAL_THRESHOLD | Critical threshold for the JVM Memory used by Elastic (percentage) | percent |
| _DISK_SPACE_USED_WARNING_TH RESHOLD | Warning threshold for the disk space used by Elastic (percentage) | percent |
| _DISK_SPACE_USED_CRITICAL_T HRESHOLD | Critical threshold for the disk space used by Elastic (percentage) | percent |
| _INDEXING_WARNING_THRESHOLD | Warning threshold for the indexing time by Elastic (in milliseconds) | integer |
| _INDEXING_CRITICAL_THRESHOLD | Critical threshold for the indexing time by Elastic (in milliseconds) | integer |
| _SEARCH_QUERY_WARNING_THRESH OLD | Warning threshold for the search query time by Elastic (in milliseconds) | integer |
| _SEARCH_QUERY_CRITICAL_THRES HOLD | Critical threshold for the search query time by Elastic (in milliseconds) | integer |
| _UNASSIGNED_SHARD_WARNING_TH RESHOLD | Warning threshold for unassigned shards | integer |
| _UNASSIGNED_SHARD_CRITICAL_T HRESHOLD | Critical threshold for unassigned shards | integer |
| _NODE_UPTIME_WARNING_THRESHO LD | Warning threshold for software uptime (in seconds) | integer |
| _NODE_UPTIME_CRITICAL_THRESH OLD | Critical threshold for software uptime (in seconds) | integer |
Influxdb-node¶
DESCRIPTION
Health and performance checks of a InfluxDB node
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| API ping | Checks the response time of http API | check_influxdb_ api | _HOSTINFLUXDB_ PORT _HOSTINFLUXDB_ USER _HOSTINFLUXDB_ PASS _HOSTINFLUXDB_ NODENAME _HOSTAPI_WARNI NG_THRESHOLD _HOSTAPI_CRITI CAL_THRESHOLD |
| Collectd Plugin | Shows all Collectd info | check_influxdb_ collectd | _HOSTINFLUXDB_ PORT _HOSTINFLUXDB_ USER _HOSTINFLUXDB_ PASS _HOSTINFLUXDB_ NODENAME |
| InfluxDB Points | Checks diff of writing ok/fail/total points of Influx Node | check_influxdb_ points | _HOSTINFLUXDB_ PORT _HOSTINFLUXDB_ USER _HOSTINFLUXDB_ PASS _HOSTINFLUXDB_ NODENAME |
| InfluxDB Diagnosis | Checks the behaviour of Influx Create/Ins ert/Delete | check_influxdb_ operation | _HOSTINFLUXDB_ PORT _HOSTINFLUXDB_ USER _HOSTINFLUXDB_ PASS _HOSTINFLUXDB_ NODENAME _HOSTOPERATION_WARNING_THRESH OLD _HOSTOPERATION_CRITICAL_THRES HOLD |
| InfluxDB Versions | Shows all InfluxDB info | check_influxdb_ info | _HOSTINFLUXDB_ PORT _HOSTINFLUXDB_ USER _HOSTINFLUXDB_ PASS _HOSTINFLUXDB_ NODENAME |
| InfluxDB Requests | Checks diff of Http api resquests (ping/r ad/write/total) | check_influxdb_ requests | _HOSTINFLUXDB_ PORT _HOSTINFLUXDB_ USER _HOSTINFLUXDB_ PASS _HOSTINFLUXDB_ NODENAME _HOSTREQUEST_W ARNING_THRESHOL D _HOSTREQUEST_C RITICAL_THRESHO LD |
| InfluxDB Heap | Shows all Go heap info | check_influxdb_ heap | _HOSTINFLUXDB_ PORT _HOSTINFLUXDB_ USER _HOSTINFLUXDB_ PASS _HOSTINFLUXDB_ NODENAME _HOSTNODE_TOTA L_MEMORY _HOSTHEAP_WARN ING_THRESHOLD _HOSTHEAP_CRIT ICAL_THRESHOLD |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _INFLUXDB_USER | User to launch the DB queries | string |
| _INFLUXDB_PASS | Password of user to launch the DB queries | string |
| _INFLUXDB_PORT | InfluxDB port for the queries | integer |
| _INFLUXDB_NODENAME | Name of the InfluxDB node (as registered in the service) | string |
| _HEAP_WARNING_THRESHOLD | Memory used by InfluxDB Warning threshold (percentage) | percent |
| _HEAP_CRITICAL_THRESHOLD | Memory used by InfluxDB Critical threshold (percentage) | percent |
| _NODE_TOTAL_MEMORY | Amount of total Memory of the node (in MegaBytes) | integer |
| _OPERATION_WARNING_THRESHOLD | Warning threshold (in miliseconds) for completing a basic diagnosis (Create/Insert/Delete) | integer |
| _OPERATION_CRITICAL_THRESHOLD | Critical threshold (in miliseconds) for completing a basic diagnosis (Create/Insert/Delete) | integer |
| _API_WARNING_THRESHOLD | Warning threshold (in miliseconds) for pinging the http api | integer |
| _API_CRITICAL_THRESHOLD | Critical threshold (in miliseconds) for pinging the http api | integer |
| _REQUEST_WARNING_THRESHOLD | Warning threshold (absolute) for the http api read-requests | integer |
| _REQUEST_CRITICAL_THRESHOLD | Critical threshold (absolute) for the http api read-requests | integer |
Log-occurrences¶
DESCRIPTION
Check log occurrences in docs into logger indices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Search $KEY$ | Looks for events in ElasticSearch logger databases | check_log_occurr ences | _HOSTELASTICSEARC H_CLUSTER_IP _HOSTELASTICSEARC H_CLUSTER_PORT _HOSTELASTICSEARC H_PREFIX_INDEX _HOSTIDENTIFIER _HOSTIDENTIFIER_ FIELD _HOSTTIME_RANGE _SEARCH_CRITERIA |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _ELASTICSEARCH_CLUSTER_IP | IP of Elasticsearch cluster | string |
| _ELASTICSEARCH_CLUSTER_PORT | Port of Elasticsearch cluster | integer |
| _ELASTICSEARCH_PREFIX_INDEX | Elasticsearch index prefix | string |
| _IDENTIFIER | Choose host identifier to build the query (ip/hostname) | string |
| _IDENTIFIER_FIELD | Host identifier field name as appears in logs (source, ip, ap_address, etc.) | string |
| _TIME_RANGE | The time range (in minutes) we are looking back. Limited to 24 hours | integer |
COMPLEX MACROS
_SEARCH_CRITERIA
- Description: Search criteria and threshold for alerts
| Fields | Description | Type |
|---|---|---|
| Display name | Name id of criteria (unique) | string |
| Elasticsearch index | Index name of Elasticsearch (realm name) | string |
| Search field for the criteria | Main search field for the criteria | string |
| Regular expression | Main regular expression to match in log message. Strings must be lowercase | string |
| Warning | Occurrences warning threshold | integer |
| Critical | Occurrences critical threshold | integer |
| Secondary search field for the criteria | Secondary search field for the criteria (optional) | string |
| Secondary regular expression | Secondary regular expression to match in log message (optional). Strings must be lowercase | string |
| Disable pattern | Main regular expression to disable alerts (optional). Strings must be lowercase | string |
| Secondary disable pattern | Secondary regular expression to disable alerts (optional). Strings must be lowercase | string |
| Third search field | Third search field for the criteria (optional) | string |
| Third regular expression | Third regular expression to match in log message (optional). Strings must be lowercase | string |
| Third disable pattern | Third regular expression to disable alerts (optional). Strings must be lowercase | string |
Mongodb-node¶
DESCRIPTION
Checks for the status of a single MongoDB node
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| MongoDB_total_d elete_queries | Checks the total number of delete queries | check_total_del ete_queries | _HOSTMONGODB_P ORT |
| MongoDB_node_me mory | Checks the memory usage | check_mongo_mem ory | _HOSTMONGODB_P ORT _HOSTMONGODB_M EMORY_WARNING_ THRESHOLD _HOSTMONGODB_M EMORY_CRITICAL_THRESHOLD |
| MongoDB_total_i nsert_queries | Checks the total number of insert queries | check_total_ins ert_queries | _HOSTMONGODB_P ORT |
| MongoDB_reader_ clients | Checks the number of reader clients | check_reader_cl ients | _HOSTMONGODB_P ORT |
| MongoDB_current_connections | Checks the current connections | check_current_c onnections | _HOSTMONGODB_P ORT |
| MongoDB_version | Shows the mongodb version | check_mongo_ver sion | _HOSTMONGODB_P ORT |
| MongoDB_software _uptime | Shows the mongodb software uptime | check_server_up time | _HOSTMONGODB_P ORT |
| MongoDB_writer_ clients | Checks the number of writer cients | check_writer_cl ients | _HOSTMONGODB_P ORT |
| MongoDB_total_u pdate_queries | Checks the total number of update queries | check_total_upd ate_queries | _HOSTMONGODB_P ORT |
| MongoDB_total_q ueries | Checks the total number of queries | check_total_que ries | _HOSTMONGODB_P ORT |
| MongoDB_active_ clients | Checks the active clients | check_active_cl ients | _HOSTMONGODB_P ORT |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_MONGODB_STORAGE_ENGINE:
wocu-discover-mongo-engine.py -H $HOSTADDRESS$ -P $_MONGODB_PORT$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _MONGODB_PORT | MongoDB port for the queries (default 27017) | integer |
| _MONGODB_STORAGE_ENGINE | Name of the MongoDB storage engine (as registered in the service) | string |
| _MONGODB_MEMORY_WARNING_THRE SHOLD | Threshold of memory warning to MongoDB in Bytes | integer |
| _MONGODB_MEMORY_CRITICAL_THR ESHOLD | Threshold of memory critical to MongoDB in Bytes | integer |
Mssql¶
DESCRIPTION
Checks for Microsoft SQL Server
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| MSSQL - Version | Shows MSSQL server version | check_mssql_ver sion | _HOSTSQL_USER _HOSTSQL_PASSW ORD |
| MSSQL - Memory pressure | Checks MSSQL database memory pressure | check_mssql_mem ory_pressure | _HOSTSQL_USER _HOSTSQL_PASSW ORD |
| MSSQL - Time to connect | Checks MSSQL database time to connect | check_mssql_tim e2connect | _HOSTSQL_USER _HOSTSQL_PASSW ORD _HOSTSQL_TIME_WARNING _HOSTSQL_TIME_CRITICAL |
| MSSQL - Active Transactions $KEY$ | Checks active transactions in a database table | check_mssql_act ive_transactions | _HOSTSQL_USER _HOSTSQL_PASSW ORD _HOSTSQL_ACT_ TRANS_WARNING _HOSTSQL_ACT_ TRANS_CRITICAL _SQL_TABLE_LI ST |
| MSSQL - Status | Checks MSSQL server process status | check_mssql_sta tus | _HOSTSQL_USER _HOSTSQL_PASSW ORD |
| MSSQL - Memory in use | Checks MSSQL database memory in use | check_mssql_mem ory_in_use | _HOSTSQL_USER _HOSTSQL_PASSW ORD _HOSTSQL_MEM_ USE_WARNING _HOSTSQL_MEM_ USE_CRITICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SQL_TIME_WARNING | Time to connect warning threshold (seconds) | integer |
| _SQL_TIME_CRITICAL | Time to connect critical threshold (seconds) | integer |
| _SQL_ACT_TRANS_WARNING | Table active transactions warning threshold | integer |
| _SQL_ACT_TRANS_CRITICAL | Table active transactions critical threshold | integer |
| _SQL_MEM_USE_WARNING | Memory in use warning threshold (megabytes) | integer |
| _SQL_MEM_USE_CRITICAL | Memory in use critical threshold (megabytes) | integer |
| _SQL_USER | Microsoft SQL server user | string |
| _SQL_PASSWORD | Microsoft SQL server password | string |
COMPLEX MACROS
_SQL_TABLE_LIST
- Description: List of Tables
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| table | Database table name | string |
Mysql-server¶
DESCRIPTION
Mysql Database Plugin Monitoring. Uptime, Connection Time, InnoDB Hit Rates, etc
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Mysql Temporary Tables created on disk -percent- | Checks the percentage of temporary tables created on disk | mysql_check_tmp _dsk_tbl | _HOSTMYSQLPORT _HOSTMYSQLDATAB ASE _HOSTMYSQLUSER _HOSTMYSQLPASS _HOSTTMP_DISK_TBL_WARNING _HOSTTMP_DISK_TBL_CRITICAL |
| Mysql Amount of Slow Processes -now- | Checks the actual number of slow processes | mysql_check_slo w_process | _HOSTMYSQLPORT _HOSTMYSQLDATAB ASE _HOSTMYSQLUSER _HOSTMYSQLPASS _HOSTSLOW_PROC S_WARNING _HOSTSLOW_PROC S_CRITICAL |
| Mysql Connection Time | Checks the connection time | mysql_check_con nection_time | _HOSTMYSQLPORT _HOSTMYSQLDATAB ASE _HOSTMYSQLUSER _HOSTMYSQLPASS _HOSTCONNECTION _TIME_WARNING _HOSTCONNECTION _TIME_CRITICAL |
| Mysql InnoDB Buffer Hit Rate | Checks the buffer hit rate | mysql_check_inn odb_bufferpool_ hitrate | _HOSTMYSQLPORT _HOSTMYSQLDATAB ASE _HOSTMYSQLUSER _HOSTMYSQLPASS _HOSTBPHITRATE_WARNING _HOSTBPHITRATE_CRITICAL |
| Mysql Threads Connected | Checks the actual number of connected threads | mysql_check_thr ead_connected | _HOSTMYSQLPORT _HOSTMYSQLDATAB ASE _HOSTMYSQLUSER _HOSTMYSQLPASS _HOSTTHREAD_WA RNING _HOSTTHREAD_CR ITICAL |
| Mysql Amount of Slow Queries | Checks the actual number of slow queries | mysql_check_slo w_queries | _HOSTMYSQLPORT _HOSTMYSQLDATAB ASE _HOSTMYSQLUSER _HOSTMYSQLPASS _HOSTSLOW_Q_W ARNING _HOSTSLOW_Q_C RITICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _MYSQLUSER | Mysql user login | string |
| _MYSQLPASS | Mysql password for the login user | string |
| _MYSQLDATABASE | Mysql database | string |
| _MYSQLPORT | Mysql port | integer |
| _THREAD_WARNING | The amount of thread connections to reach a WARNING state. Reference from the max_connections variables from mysql | integer |
| _THREAD_CRITICAL | The amount of thread connections to reach a CRITICAL state. Reference from the max_connections variables from mysql | integer |
| _CONNECTION_TIME_WARNING | The amount of time it takes to connect to the Mysql Database reaching a WARNING state. | integer |
| _CONNECTION_TIME_CRITICAL | The amount of time it takes to connect to the Mysql Database reaching a CRITICAL state. | integer |
| _BPHITRATE_WARNING | The percentage of hitrate from the InnoDB Buffer Pool to reach a WARNING state. | string |
| _BPHITRATE_CRITICAL | The percentage of hitrate from the InnoDB Buffer Pool to reach a CRITICAL state. | string |
| _TMP_DISK_TBL_WARNING | The percentage of temporary tables created in disk instead of memory to reach a WARNING state. | percent |
| _TMP_DISK_TBL_CRITICAL | The percentage of temporary tables created in disk instead of memory to reach a CRITICAL state. | percent |
| _SLOW_PROCS_WARNING | The amount of slow process running NOW to reach a WARNING state. | integer |
| _SLOW_PROCS_CRITICAL | The amount of slow process running NOW to reach a CRITICAL state. | integer |
| _SLOW_Q_WARNING | The amount of slow queries running to reach a WARNING state. | integer |
| _SLOW_Q_CRITICAL | The amount of slow queries running to reach a CRITICAL state. | integer |
Oracle-resources¶
DESCRIPTION
Resource checks for Oracle databases (tablespace usage, users, sessions, etc.)
Resource checks for Oracle databases such as Tablespaces usage, FRA usage, sessions and processes. The Oracle Install Client is not installed by default in WOCU. You need to install it manually in both WOCU monitoring and satellite devices.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Oracle sessions | Checks the number of sessions | check_oracle_re sources_sessions | _HOSTUSER _HOSTPASSWD _HOSTDDBB _HOSTSESSIONS_ WARN _HOSTSESSIONS_ CRIT |
| Oracle FRA usage | Checks the FRA (Fast Recovery Area) usage | check_oracle_re sources_fra | _HOSTUSER _HOSTPASSWD _HOSTDDBB _HOSTFRA_WARNI NG _HOSTFRA_CRITI CAL |
| Oracle Tablespace usage | Checks the tablespace usage | check_oracle_re sources_tablespa ce | _HOSTUSER _HOSTPASSWD _HOSTDDBB _HOSTTABLESPACE _WARNING _HOSTTABLESPACE _CRITICAL |
| Oracle processes | Checks the actual number of processes | check_oracle_re sources_procs | _HOSTUSER _HOSTPASSWD _HOSTDDBB _HOSTPROCS_WAR N _HOSTPROCS_CRI T |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _USER | Oracle user | string |
| _PASSWD | Oracle user password | string |
| _DDBB | Oracle database name | string |
| _TABLESPACE_WARNING | Tablespace usage warning threshold (percent) | integer |
| _TABLESPACE_CRITICAL | Tablespace usage critical threshold (percent) | integer |
| _FRA_WARNING | Flash Recovery Area usage warning threshold (percent) | integer |
| _FRA_CRITICAL | Flash recovery Area usage critical threshold (percent) | integer |
| _SESSIONS_WARN | Current Sessions warning threshold | integer |
| _SESSIONS_CRIT | Current Sessions critical threshold | integer |
| _PROCS_WARN | Current processes warning threshold | integer |
| _PROCS_CRIT | Current processes critical threshold | integer |
Postgresql¶
DESCRIPTION
PostgreSQL database checks, like connected users, locks or data size
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| PostgreSQL-bloat | Check for table and index bloat | check_postgresql _bloat | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD |
| PostgreSQL- hitratio | Report if the hit ratio of a database is too low | check_postgresql _hitratio | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD _HOSTHITRATIO_ WARN _HOSTHITRATIO_ CRIT |
| PostgreSQL- connection | Simple connection check | check_postgresql _connection | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD |
| PostgreSQL- database_size | Report if a database is too big | check_postgresql _database_size | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD _HOSTDBSIZE_WA RN _HOSTDBSIZE_CR IT |
| PostgreSQL-Locks | Checks the number of locks | check_postgresql _locks | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD _HOSTLOCKS_WAR N _HOSTLOCKS_CRI T |
| PostgreSQL- index_size | Checks the size of indexes only | check_postgresql _index_size | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD _HOSTINDEXSIZE_WARN _HOSTINDEXSIZE_CRIT |
| PostgreSQL- table_size | Checks the size of tables only | check_postgresql _table_size | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD _HOSTTABLESIZE_WARN _HOSTTABLESIZE_CRIT |
| PostgreSQL- Txn_time | Checks the maximum open transaction time | check_postgresql _txn_time | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD _HOSTTXNTIME_W ARN _HOSTTXNTIME_C RIT |
| PostgreSQL- Query_Time | Checks the maximum running time of current queries | check_postgresql _query_time | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD _HOSTQUERYTIME_WARN _HOSTQUERYTIME_CRIT |
| PostgreSQL- backends | Checks the number of connections | check_postgresql _backends | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD _HOSTBACKENDS_ WARN _HOSTBACKENDS_ CRIT |
| PostgreSQL-disabl ed_triggers | Check if any triggers are disabled | check_postgresql _disabled_trigg ers | _HOSTPOSTGRESQL PORT _HOSTPOSTGRESQL USER _HOSTPOSTGRESQL PASSWORD |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _POSTGRESQLUSER | PostgreSQL user login. | string |
| _POSTGRESQLPASSWORD | PostgreSQL user password. | string |
| _POSTGRESQLPORT | PostgreSQL port access. | integer |
| _DBSIZE_WARN | Database size warning (must include unit G/M character). | string |
| _DBSIZE_CRIT | Database size critical (must include unit G/M character). | string |
| _BACKENDS_WARN | Backends warning threshold (must include percentage character). | string |
| _BACKENDS_CRIT | Backends critical threshold (must include percentage character). | string |
| _HITRATIO_WARN | Hit ratio warning threshold (must include percentage character). | string |
| _HITRATIO_CRIT | Hit ratio critical threshold (must include percentage character). | string |
| _INDEXSIZE_WARN | Index size warning threshold (must include unit G/M character). | string |
| _INDEXSIZE_CRIT | Index size critical threshold (must include unit G/M character). | string |
| _TABLESIZE_WARN | Table size warning threshold (must include percentage character). | string |
| _TABLESIZE_CRIT | Table size critical threshold (must include percentage character). | string |
| _LOCKS_WARN | Locks warnings threshold. | integer |
| _LOCKS_CRIT | Locks critical threshold. | integer |
| _QUERYTIME_WARN | Query time warning threshold (must include min expression, ex: 1min / 5min). | string |
| _QUERYTIME_CRIT | Query time critical threshold (must include min expression, ex: 1min / 5min). | string |
| _TXNTIME_WARN | Transaction time warning threshold (must include min expression, ex: 1min / 5min). | string |
| _TXNTIME_CRIT | Transaction time critical threshold (must include min expression, ex: 1min / 5min). | string |
Network Protocol¶
Bgp¶
DESCRIPTION
Checks BGP peer state
Tested on Cisco, Juniper, Huawei, OneAccess and Teldat
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| BGP - Peer State - $KEY$ | Checks the BGP Peer state | check_bgp_gener ic | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _BGP_PEER_LIS T |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_BGP_PEER_LIST:
wocu-discover-bgp.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
COMPLEX MACROS
_BGP_PEER_LIST
- Description: List of BGP peers list
- Discover: wocu-discover-bgp.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown in the web interface | string |
| peer_ip | Peer IP Address | string |
| peer_state | Peer State | string |
Dns¶
DESCRIPTION
This plugin uses the nslookup program to obtain the IP address for the given host/domain query
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Dns | Obtain the IP address for the given host/domain | check_dns | _HOSTDNSSERVER _HOSTDNSHOSTNAME _HOSTDNSEXPECTEDRESULT |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _DNSSERVER | Dns server to query | string |
| _DNSHOSTNAME | Dns host to check | string |
| _DNSEXPECTEDRESULT | Dns address expected to be returned | string |
Dns-advanced¶
DESCRIPTION
Dnslookup search to obtain the IP address for the given host/domain query. This pack deprecates the dns pack
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| DNS_$KEY$ | Checks if DNS query reply is what it’s expected | check_dns_advanced | _DNS_LIST |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
COMPLEX MACROS
_DNS_LIST
- Description: List of DNS names to be queried
| Fields | Description | Type |
|---|---|---|
| descr | Query name. It will be used in the service name | string |
| dns_server | DNS server you want to use for the lookup | string |
| dns_hostname | The name or address you want to query | string |
| dns_expected_result | IP-ADDRESS you expect the DNS server to return | string |
Http¶
DESCRIPTION
Monitors HTTP response
This plugin will attempt to open an HTTP connection with the host.
Successful connects return STATE_OK, refusals and timeouts return STATE_CRITICAL other errors return STATE_UNKNOWN.
Successful connects, but incorrect reponse messages from the host result in STATE_WARNING return values.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| HttpsCertificate | Checks the SSL Certificate validity | check_https_cer tificate | _HOSTCHECK_HTTP S_DOMAIN_NAME _HOSTCHECK_HTTP S_MINIMUM_DAYS _HOSTCHECK_HTTP S_PORT _HOSTCHECK_HTTP S_AUTH |
| Http | Checks the HTTP web site response time | check_http | _HOSTCHECK_HTTP _DOMAIN_NAME _HOSTCHECK_HTTP _URI _HOSTCHECK_HTTP _PORT _HOSTCHECK_HTTP _AUTH _HOSTWARNING_TI ME_RESPONSE _HOSTCRITICAL_T IME_RESPONSE |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _CHECK_HTTP_DOMAIN_NAME | Domain name or ip address for HTTP | string |
| _CHECK_HTTP_PORT | HTTP port | integer |
| _CHECK_HTTP_URI | HTTP URI | string |
| _CHECK_HTTP_AUTH | Credentials for HTTP access. Format user:password | string |
| _CHECK_HTTPS_DOMAIN_NAME | Domain name or ip address for HTTPS | string |
| _CHECK_HTTPS_PORT | HTTPS port | integer |
| _CHECK_HTTPS_URI | HTTPS URI | string |
| _CHECK_HTTPS_AUTH | Credentials for HTTPS access. Format user:password | string |
| _CHECK_HTTPS_MINIMUM_DAYS | Minimum number of days a certificate has to be valid | integer |
| _WARNING_TIME_RESPONSE | Response time to result in warning status (seconds) | float |
| _CRITICAL_TIME_RESPONSE | Response time to result in critical status (seconds) | float |
Http-proxy¶
DESCRIPTION
Http checks through a proxy
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| https- proxy_$KEY$ | Checks the https web site status through a proxy | check_https_pro xy | _HOSTHTTP_PROX Y _HOSTHTTP_TIME OUT _HOSTHTTP_NTRI ES _HTTPS_LIST |
| http-proxy_$KEY$ | Checks the http web site status through a proxy | check_http_prox y | _HOSTHTTP_PROX Y _HOSTHTTP_TIME OUT _HOSTHTTP_NTRI ES _HTTP_LIST |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _HTTP_PROXY | Preconfigured Proxy for the check (Default: $DEFAULT_PROXY$) | string |
| _HTTP_TIMEOUT | Amount of time to wait for a connection in seconds (default: 30) | integer |
| _HTTP_NTRIES | Number of times to try (default: 1) | integer |
COMPLEX MACROS
_HTTP_LIST
- Description: HTTP sites (list)
| Fields | Description | Type |
|---|---|---|
| Display Name | Custom Name appearing in the service: HTTP_<Display Name> | string |
| Host | Host to check (IP or name) | string |
| Port | Port to check (default: 80) | integer |
| Url | url path with leading / (default: /) | string |
_HTTPS_LIST
- Description: HTTPS sites (list)
| Fields | Description | Type |
|---|---|---|
| Display Name | Custom Name appearing in the service: HTTPS_<Display Name> | string |
| Host | Host to check (IP or name) | string |
| Url | url path with leading / (default: /) | string |
Ntp-snmp¶
DESCRIPTION
Check the current time of a Host against the local time of Wocu probe via SNMP
Check the current time of the selected host and compares it against the local time of the Wocu probe via SNMP.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| NTP_diff_by_sn mp | Checks the time difference as received via SNMP compared to the local time | check_ntp_by_s nmp | _HOSTSNMPCOMMUN ITY _HOSTTIME_WARN ING _HOSTTIME_CRIT ICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _TIME_WARNING | Warning threshold for time difference (secs) against NTP server | integer |
| _TIME_CRITICAL | Critical threshold for time difference (secs) against NTP server | integer |
Voip¶
Call-manager-cisco¶
DESCRIPTION
Generic and specific checks for Cisco Call Manager devices
Supported CUCM v10 and olders
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Devices_Gateways | Checks the number and status of Gateway devices | check-cisco-ccm- devices-gateways | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTPROBLEM_G ATEWAYS_WARNING _HOSTPROBLEM_G ATEWAYS_CRITICA L |
| CCM-Info | Shows info about the Cisco Call Manager device | check-cisco-ccm- info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Disks | Overall disks usage | check-cisco-ccm- disks | _HOSTSNMPCOMMUN ITY _HOSTSTORAGE_P ATH _HOSTSTORAGE_W ARN _HOSTSTORAGE_C RIT _HOSTSNMP_MSG_MAX_SIZE |
| Devices_Phones | Checks the number and status of Phone devices | check-cisco-ccm- devices-phones | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTPROBLEM_P HONES_WARNING _HOSTPROBLEM_P HONES_CRITICAL |
| Devices_VoiceMai ls | Checks the number and status of Voicemail devices | check-cisco-ccm- devices- voicemails | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTPROBLEM_V OICEMAIL_WARNIN G _HOSTPROBLEM_V OICEMAIL_CRITIC AL |
| MGCP_ActiveCalls _$KEY$ | Checks the number Active calls per MGCP | check-cisco-ccm- mgcp-activecalls | _HOSTCUCM_USER _HOSTCUCM_PASS WORD _HOSTACTIVECALL S_WARNING _HOSTACTIVECALL S_CRITICAL _MGCP_DEVICES |
| TimeSync | Checks the difference between device and Wocu UTC time | check-cisco-ccm- time | _HOSTSNMPCOMMUN ITY _HOSTNTP_WARN _HOSTNTP_CRIT |
| Devices_Media | Checks the number and status of Media devices | check-cisco-ccm- devices-media | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTPROBLEM_M EDIA_WARNING _HOSTPROBLEM_M EDIA_CRITICAL |
| Devices_CTI | Checks the number and status of CTI devices | check-cisco-ccm- devices-cti | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTPROBLEM_C TI_WARNING _HOSTPROBLEM_C TI_CRITICAL |
| SIP_ActiveCalls_$KEY$ | Checks the number of active and in- progress calls per SIP | check-cisco-ccm- sip-activecalls | _HOSTCUCM_USER _HOSTCUCM_PASS WORD _HOSTACTIVECALL S_WARNING _HOSTACTIVECALL S_CRITICAL _SIP_DEVICES |
| CPU | Checks the CPU usage | check-cisco-ccm- cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARN _HOSTCPU_CRIT |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_SIP_DEVICES:
wocu-discover-cucm.py –server $HOSTADDRESS$ -t sip -u $_CUCM_USER$ -p $_CUCM_PASSWORD$ –remote $_POLLER_TAG_ADDRESS$_MGCP_DEVICES:
wocu-discover-cucm.py –server $HOSTADDRESS$ -t mgcp -u $_CUCM_USER$ -p $_CUCM_PASSWORD$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _PROBLEM_PHONES_WARNI NG | Unregistered + Rejected Phones warning threshold | integer |
| _PROBLEM_PHONES_CRITI CAL | Unregistered + Rejected Phones critical threshold | integer |
| _PROBLEM_GATEWAYS_WAR NING | Unregistered + Rejected Gateways warning threshold | integer |
| _PROBLEM_GATEWAYS_CRI TICAL | Unregistered + Rejected Gateways critical threshold | integer |
| _PROBLEM_MEDIA_WARNIN G | Unregistered + Rejected Media warning threshold | integer |
| _PROBLEM_MEDIA_CRITIC AL | Unregistered + Rejected Media critical threshold | integer |
| _PROBLEM_CTI_WARNING | Unregistered + Rejected Cti warning threshold | integer |
| _PROBLEM_CTI_CRITICAL | Unregistered + Rejected Cti critical threshold | integer |
| _PROBLEM_VOICEMAIL_WA RNING | Unregistered + Rejected Voicemails warning threshold | integer |
| _PROBLEM_VOICEMAIL_CR ITICAL | Unregistered + Rejected Voicemails critical threshold | integer |
| _LOAD_WARN | Value for starting warning state for the load average at 1m,5m,15m | 3 comma-separated integer |
| _LOAD_CRIT | Value for starting critical state for the load average at 1m,5m,15m | 3 comma-separated integer |
| _CPU_WARN | Warning level for the CPU usage | percent |
| _CPU_CRIT | Critical level for the CPU usage | percent |
| _MEMORY_WARN | Physical memory and swap warning level | percent |
| _MEMORY_CRIT | Physical memory and swap critical level | percent |
| _STORAGE_PATH | Absolute path to check its storage | absolute path |
| _STORAGE_WARN | Warning level for used disk space | percent |
| _STORAGE_CRIT | Critical level for used disk space | percent |
| _SNMP_MSG_MAX_SIZE | Maximum size of the snmp messages | integer |
| _NTP_WARN | NTP timings warning level (in seconds) | integer |
| _NTP_CRIT | NTP timings critical level (in seconds) | integer |
| _CUCM_USER | Call Manager connecting user (SOAP checks) | string |
| _CUCM_PASSWORD | Password of the Call Manager connecting user(SOAP checks) | string |
| _ACTIVECALLS_WARNING | Warning threshold for ActiveCalls in the Call Manager | integer |
| _ACTIVECALLS_CRITICAL | Critical threshold for ActiveCalls in the Call Manager | integer |
COMPLEX MACROS
_SIP_DEVICES
- Description: SIP Devices from Call Manager
- Discover: wocu-discover-cucm.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Custom Name appearing in the service: SIP_<Display Name> | string |
| Device Name | SIP Device name (configured on remote device) | string |
_MGCP_DEVICES
- Description: MGCP Devices from Call Manager
- Discover: wocu-discover-cucm.py
| Fields | Description | Type |
|---|---|---|
| Display Name | Custom Name appearing in the service: MGCP_<Display Name> | string |
| Device Name | MGCP Device name (configured on remote device) | string |
Call-manager-cisco-snmp¶
DESCRIPTION
Generic and specific checks for Cisco Call Manager devices using only SNMP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Call Manager Devices - Gateways | Checks the number and status of Gateway devices | call-manager- cisco-snmp- gateways | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTREGISTERED _GATEWAYS_WARN ING _HOSTREGISTERED _GATEWAYS_CRIT ICAL |
| Call Manager Devices - Media | Checks the number and status of Media devices | call-manager- cisco-snmp-media | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTREGISTERED _MEDIA_WARNING _HOSTREGISTERED _MEDIA_CRITICA L |
| Call Manager CPU Usage | Checks the CPU usage | call-manager- cisco-snmp-cpu | _HOSTSNMPCOMMUN ITY _HOSTCPU_WARN _HOSTCPU_CRIT |
| Call Manager Memory Usage | Checks the memory usage | call-manager- cisco-snmp-memory | _HOSTSNMPCOMMUN ITY _HOSTMEMORY_WA RN _HOSTMEMORY_CR IT |
| CUCM_Process_$K EY$ | Checks process status | call-manager- cisco-snmp- processes | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _PROCESSES |
| Call Manager Devices - CTI | Checks the number and status of CTI devices | call-manager- cisco-snmp-cti | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTREGISTERED _CTI_WARNING _HOSTREGISTERED _CTI_CRITICAL |
| Call Manager Devices - VoiceMails | Checks the number and status of Voicemail devices | call-manager- cisco-snmp- voicemails | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTREGISTERED _VOICEMAIL_WAR NING _HOSTREGISTERED _VOICEMAIL_CRI TICAL |
| Call Manager Status - local | Checks status from local Cisco Call Manager | call-manager- cisco-snmp-status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Call Manager Devices - Phones | Checks the number and status of Phone devices | call-manager- cisco-snmp-phones | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTREGISTERED _PHONES_WARNIN G _HOSTREGISTERED _PHONES_CRITIC AL |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_SNMPVERSION:
wocu-discover-snmpversion.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ –remote $_POLLER_TAG_ADDRESS$_PROCESSES:
wocu-discover-os-resources-processes.py -H $HOSTADDRESS$ -C $_SNMPCOMMUNITY$ -s $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | Device SNMP versions supported are: 1 and 2c | string |
| _REGISTERED_PHONES_WARNING | Registered Phones warning threshold | integer |
| _REGISTERED_PHONES_CRITICAL | Registered Phones critical threshold | integer |
| _REGISTERED_GATEWAYS_WARNING | Registered Gateways warning threshold | integer |
| _REGISTERED_GATEWAYS_CRITICAL | Registered Gateways critical threshold | integer |
| _REGISTERED_MEDIA_WARNING | Registered Media warning threshold | integer |
| _REGISTERED_MEDIA_CRITICAL | Registered Media critical threshold | integer |
| _REGISTERED_CTI_WARNING | Registered Cti warning threshold | integer |
| _REGISTERED_CTI_CRITICAL | Registered Cti critical threshold | integer |
| _REGISTERED_VOICEMAIL_WARNING | Registered Voicemails warning threshold | integer |
| _REGISTERED_VOICEMAIL_CRITICA L | Registered Voicemails critical threshold | integer |
| _CPU_WARN | CPU usage percent critical threshold | percent |
| _CPU_CRIT | CPU usage percent critical threshold | percent |
| _MEMORY_WARN | Physical memory usage percent warning threshold | percent |
| _MEMORY_CRIT | Physical memory usage percent critical threshold | percent |
COMPLEX MACROS
_PROCESSES
- Description: Processes
- Discover: wocu-discover-os-resources-processes.py
| Fields | Description | Type |
|---|---|---|
| ProcName | Process label | string |
| ProcIndex | Process index | integer |
Mxone-advanced¶
DESCRIPTION
Additional Pack for Advanced Licensed devices
Get the operational backup status and traffic status of service nodes (LIMs) using SNMP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| LIM_Backup_stat us_$KEY$ | Gets the LIM backup operation status | check_mxone_adv anced_backup_st atus | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _LIM_LIST |
| LIM_Oper_status _$KEY$ | Gets the LIM traffic state | check_mxone_adv anced_oper_stat us | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _LIM_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_LIM_LIST:
wocu-discover-mxone-advanced.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP Community | string |
| _SNMPVERSION | SNMP version | string |
COMPLEX MACROS
_LIM_LIST
- Description: List of node services (LIMs) to be checked
- Discover: wocu-discover-mxone-advanced.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown as Service Description in the web interface | string |
| index | Index of node service (LIM) (integer) | integer |
| ip_address | Management IP Address of node service (LIM). If discovered IP is not accessible from Wocu, configure it manually | string |
| name | Name of node service (LIM) | string |
Mxone-basic¶
DESCRIPTION
Pack for Basic Licensed devices
Get the number of active (unhandled) alarms and status of every LIM using SNMP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| MX-ONE_Active_a larms_$KEY$ | Shows the total number of active (unhandled) alarms on the node service (LIM) | check_mxone_bas ic_alarms | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTALARM_WAR NING _HOSTALARM_CRI TICAL _LIM_LIST |
| MX-ONE_Alarms_m ax_level_$KEY$ | Shows the current alarm status in the node service (LIM). | check_mxone_bas ic_status | _HOSTSNMPVERSIO N _HOSTSNMPCOMMUN ITY _HOSTSTATUS_CR ITICAL _LIM_LIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_LIM_LIST:
wocu-discover-mxone-advanced.py -H $HOSTADDRESS$ -c $_SNMPCOMMUNITY$ -S $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP Community | string |
| _SNMPVERSION | SNMP version | string |
| _ALARM_WARNING | Warning threshold for number of active (unhandled) alarms | integer |
| _ALARM_CRITICAL | Critical threshold for number of active (unhandled) alarms | integer |
| _STATUS_CRITICAL | Critical threshold for maximum severity level of active (unhandled) alarms. Must be in the 0-5 range | integer |
COMPLEX MACROS
_LIM_LIST
- Description: List of node services (LIMs) to be checked
- Discover: wocu-discover-mxone-advanced.py
| Fields | Description | Type |
|---|---|---|
| display_name | Name to be shown as Service Description in the web interface | string |
| index | Index of node service (LIM) (integer) | integer |
| ip_address | Management IP Address of node service (LIM) | string |
| name | Name of node service (LIM) | string |
Sbc-acme-packet¶
DESCRIPTION
Checks for AcmePacket SBC gateways via snmp
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| SBC Redundancy State | Checks the redundancy state of the SBC node | sbc_acme_redund ancy | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| SBC AcmePacket Info | Shows system information | sbc_acme_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| SBC System Health | Check the system health expressed as percentage | sbc_acme_system _health | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTSYSTEM_HE ALTH_WARNING _HOSTSYSTEM_HE ALTH_CRITICAL |
| Call Rate $KEY$ | Checks the inbound and outbound sessions increment | sbc_acme_call_ rate | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _REALMLIST |
| SBC CPU Usage | Checks the CPU usage | sbc_acme_cpu_u sage | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCPU_USAGE _WARNING _HOSTCPU_USAGE _CRITICAL |
| SBC Call Statistics | Checks the global call statistics (concurrent sessions and call per second) | sbc_acme_call_ stats | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCONCURRENT _SESSIONS_WARN ING _HOSTCONCURRENT _SESSIONS_CRIT ICAL |
| System state | Check the snmp sytem state of the SBC device | sbc_system_stat e | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| SBC Memory Usage | sbc_acme_memory _usage | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTMEMORY_US AGE_WARNING _HOSTMEMORY_US AGE_CRITICAL |
|
| Outbound Sessions $KEY$ | Checks the actual outbound sessions number | sbc_acme_outbou nd_sessions | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _REALMLIST |
| SBC License Usage | Checks the percentage of SBC license in use | sbc_acme_licens e_usage | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTLICENSE_U SAGE_WARNING _HOSTLICENSE_U SAGE_CRITICAL |
| Inbound Sessions $KEY$ | Checks the actual inbound sessions number | sbc_acme_inboun d_sessions | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _REALMLIST |
DISCOVER SCRIPTS
A monitoring pack can provide discover scripts to automatically gather some macros.
Note
A discover script has the following format:
<_MACRO> : Macro discovered
<script.py> <arguments>: Script and arguments to discover _MACRO
The discover scripts provided by this pack can discover the next macros:
_REALMLIST:
wocu-discover-sbc-realms.py -H $HOSTADDRESS$ –community $_SNMPCOMMUNITY$ –snmpversion $_SNMPVERSION$ –remote $_POLLER_TAG_ADDRESS$
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The read snmp community allowed on the SBC server | string |
| _SNMPVERSION | SNMP version of the SBC server (allowed 1 and 2c) | string |
| _INBOUND_SESSIONS_WARNING | Inbound sessions warning threshold | integer |
| _INBOUND_SESSIONS_CRITICAL | Inbound sessions critical threshold | integer |
| _OUTBOUND_SESSIONS_WARNING | Outbound sessions warning threshold | integer |
| _OUTBOUND_SESSIONS_CRITICAL | Outbound sessions critical threshold | integer |
| _CPU_USAGE_WARNING | CPU usage Warning threshold | integer |
| _CPU_USAGE_CRITICAL | CPU usage Critical threshold | integer |
| _MEMORY_USAGE_WARNING | Memory usage Warning threshold | integer |
| _MEMORY_USAGE_CRITICAL | Memory usage Critical threshold | integer |
| _SYSTEM_HEALTH_WARNING | System health Warning threshold | integer |
| _SYSTEM_HEALTH_CRITICAL | System health Critical threshold | integer |
| _CONCURRENT_SESSIONS_WARNING | Concurrent sessions Warning threshold | integer |
| _CONCURRENT_SESSIONS_CRITICAL | Concurrent sessions Critical threshold | integer |
| _LICENSE_USAGE_WARNING | License usage Warning threshold | integer |
| _LICENSE_USAGE_CRITICAL | License usage Critical threshold | integer |
COMPLEX MACROS
_REALMLIST
- Description: List of Realms
- Discover: wocu-discover-sbc-realms.py
| Fields | Description | Type |
|---|---|---|
| display_name | Realm name | string |
| index | snmp realm index | integer |
| inbound_rejected_warning | Inbound rejected sessions warning threshold | integer |
| inbound_rejected_critical | Inbound rejected sessions critical threshold | integer |
| outbound_rejected_warning | Outbound rejected sessions warning threshold | integer |
| outbound_rejected_critical | Outbound rejected sessions critical threshold | integer |
| inbound_call_rate_warning | Inbound sessions increment warning threshold | integer |
| outbound_call_rate_critical | Outbound sessions increment critical threshold | integer |
| inbound_active_warning | Inbound active sessions warning threshold | integer |
| inbound_active_critical | Inbound active sessions critical threshold | integer |
| outbound_active_warning | Outbound active sessions warning threshold | integer |
| outbound_active_critical | Outbound active sessions critical threshold | integer |
Sbc-audiocodes¶
DESCRIPTION
Checks for Audiocodes SBC gateways via snmp
Pack for checking SBC Audiocodes VoIP Gateway devices. This pack checks Audiocodes gateway devices, polled via snmp.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| SBC PSTN channels | Check the PSTN channels utilization | sbc_audiocodes_ pstn_channels | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTTRUNK_CHA NNELS_IN_SERVI CE_WARNING _HOSTTRUNK_CHA NNELS_IN_SERVI CE_CRITICAL |
| SBC Audiocodes Info | Shows system information | sbc_audiocodes_ info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| SBC OffHook channels | Checks the Off Hook channels | sbc_audiocodes_ offhook_channels | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTOFFHOOK_C HANNELS_WARNING _HOSTOFFHOOK_C HANNELS_CRITICA L |
| SBC DSP utilization | Checks the DSP (Digital Signal Processing) utilization | sbc_audiocodes_ dsp_utilization | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTACTIVE_DS P_CHANNELS_WAR NING _HOSTACTIVE_DS P_CHANNELS_CRI TICAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | The read snmp community allowed on the SBC server | string |
| _SNMPVERSION | SNMP version of the SBC server | string |
| _ACTIVE_DSP_CHANNELS_WARNING | Active DSP channels warning threshold | integer |
| _ACTIVE_DSP_CHANNELS_CRITICA L | Active DSP channels critical threshold | integer |
| _TRUNK_CHANNELS_IN_SERVICE_ WARNING | Trunk channels in service warning threshold | integer |
| _TRUNK_CHANNELS_IN_SERVICE_ CRITICAL | Trunk channels in service critical threshold | integer |
| _OFFHOOK_CHANNELS_WARNING | Off Hook channels Warning threshold | integer |
| _OFFHOOK_CHANNELS_CRITICAL | Off Hook channels Critical threshold | integer |
Skype-for-business¶
DESCRIPTION
Skype For Business health and performance checks via nsclient
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Skype_Memory | check_skype_for_ business_mem | _HOSTMEM_WARNING _HOSTMEM_CRITICA L |
|
| Skype_Drivesize | check_skype_for_ business_drivesize | _HOSTDRIVESIZE_W ARNING _HOSTDRIVESIZE_C RITICAL |
|
| Skype_CPU | check_skype_for_ business_cpu | _HOSTCPU_WARNING _HOSTCPU_CRITICA L |
|
| Skype_service_$KE Y$ | check_skype_for_ business_service | _SKYPE_SERVICES_LIST |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _CPU_WARNING | CPU usage warning threshold (percent) | integer |
| _CPU_CRITICAL | CPU usage critical threshold (percent) | integer |
| _MEM_WARNING | Memory usage warning threshold (percent) | integer |
| _MEM_CRITICAL | Memory usage critical threshold (percent) | integer |
| _DRIVESIZE_WARNING | Drive usage warning threshold (percent) | integer |
| _DRIVESIZE_CRITICAL | Drive usage critical threshold (percent) | integer |
COMPLEX MACROS
_SKYPE_SERVICES_LIST
- Description: List of Skype services to overwatch
| Fields | Description | Type |
|---|---|---|
| name | Display name to be shown as part of the service description | string |
| service | Service name to monitor. Ex: RTCCLSAGT | string |
Hardware¶
Cisco-ucs-server-hwinfo¶
DESCRIPTION
Hardware health checks for Cisco UCS Rack Servers, via CICM (snmp)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| FANs | Checks fans status | check_ucs_fans | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPUs_temperature s | Checks the CPU temperature | check_ucs_cpu_ temps | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCPUTEMPWR _HOSTCPUTEMPCR |
| Disks_info | Shows disk info | check_ucs_disks _info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Memory_info | Shows memory info | check_ucs_mem_ info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPUs_info | Shows CPU info | check_ucs_cpus_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Raid_status | Checks the Raid status | check_ucs_raids _status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| PSUs | Checks the Powersupply status | check_ucs_psus | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Disks_states | Checks the Disk status | check_ucs_local disks | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Storage_controll er | Checks the Storage Controller status | check_ucs_stora ge_controller | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| PSUs_voltage | Checks the Powersupply voltage | check_ucs_psus_voltage | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTPSUVOLTWR _HOSTPSUVOLTCR |
| Server_info | Shows server info | check_ucs_serve r_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Memory_status | Checks the memory status | check_ucs_mem_ status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPUs_status | Checks the CPU status | check_ucs_cpus_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Raid_info | Shows Raid info | check_ucs_raids _info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Snmp community | string |
| _SNMPVERSION | Snmp version | string |
| _CPUTEMPWR | CPU temperature warning (Celsius degrees) | integer |
| _CPUTEMPCR | CPU temperature critical (Celsius degrees) | integer |
| _PSUVOLTWR | PSU voltage warning | float |
| _PSUVOLTCR | PSU voltage critical | float |
Crossbeam¶
DESCRIPTION
Generic checks for Crossbeam devices
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| XBEAM CPU Temp | Checks the CPU temperature | check_cpu_temp | _HOSTSNMPCOMMUN ITY _HOSTCPU_TEMP_WARNING _HOSTCPU_TEMP_CRITICAL |
| XBEAM Failover_g roup_status $KEY$ | Checks the failover group status | check_failover_ group_status | _HOSTSNMPCOMMUN ITY _CROSSBEAM_FAI LOVER_GR_STATU S |
| XBEAM CPU_Load $KEY$ | Checks the CPU instant load | check_cpu_load | _HOSTSNMPCOMMUN ITY _HOSTCPU_LOAD_WARNING _HOSTCPU_LOAD_CRITICAL _CROSSBEAM_CPU _LOAD_LIST |
| XBEAM CPU_Idle $KEY$ | Checks the CPU Idle time | check_cpu_idle | _HOSTSNMPCOMMUN ITY _HOSTCPU_IDLE_WARNING _HOSTCPU_IDLE_CRITICAL _CROSSBEAM_CPU _IDLE_LIST |
| XBEAM CPU_Util $KEY$ | Checks the CPU utilization percent | check_cpu_util | _HOSTSNMPCOMMUN ITY _HOSTCPU_UTIL_WARNING _HOSTCPU_UTIL_CRITICAL _CROSSBEAM_CPU _UTIL_LIST |
| XBEAM CPU_LoadAvg15 $KEY$ | Checks the CPU 15 minute load average | check_cpu_loada vg15 | _HOSTSNMPCOMMUN ITY _HOSTCPU_LOADA VG15_WARNING _HOSTCPU_LOADA VG15_CRITICAL _CROSSBEAM_CPU _LOADAVG15_LIS T |
| XBEAM Memory Usage | Checks the memory usage | check_mem_usage | _HOSTSNMPCOMMUN ITY _HOSTMEM_USAGE _WARNING _HOSTMEM_USAGE _CRITICAL |
| XBEAM CPU_Iowait $KEY$ | Checks the CPU I/O wait time | check_cpu_iowai t | _HOSTSNMPCOMMUN ITY _HOSTCPU_IOWAI T_WARNING _HOSTCPU_IOWAI T_CRITICAL _CROSSBEAM_CPU _IOWAIT_LIST |
| XBEAM CPU_System $KEY$ | Checks the System CPU | check_cpu_syste m | _HOSTSNMPCOMMUN ITY _HOSTCPU_SYSTE M_WARNING _HOSTCPU_SYSTE M_CRITICAL _CROSSBEAM_CPU _SYSTEM_LIST |
| XBEAM Interface_ in_octets $KEY$ | Checks the interface traffic in bytes | check_interface_in_octets | _HOSTSNMPCOMMUN ITY _HOSTIN_OCTETS _WARNING _HOSTIN_OCTETS _CRITICAL _CROSSBEAM_IN_OCTETS_LIST |
| XBEAM Uptime | Checks the system uptime | check_uptime | _HOSTSNMPCOMMUN ITY |
| XBEAM Memory Free | Checks the free memory | check_mem_free | _HOSTSNMPCOMMUN ITY _HOSTMEM_FREE_WARNING _HOSTMEM_FREE_CRITICAL |
| XBEAM Chassis Temperature | Checks XBEAM Chassis temperature | check_chassis_t emp | _HOSTSNMPCOMMUN ITY _HOSTCHASSIS_T EMP_WARNING _HOSTCHASSIS_T EMP_CRITICAL |
| XBEAM Swap Usage | Checks the SWAP usage | check_swap_usag e | _HOSTSNMPCOMMUN ITY _HOSTSWAP_USAG E_WARNING _HOSTSWAP_USAG E_CRITICAL |
| XBEAM CPU_LoadAvg5 $KEY$ | Checks the CPU 5 minute load average | check_cpu_loada vg5 | _HOSTSNMPCOMMUN ITY _HOSTCPU_LOADA VG5_WARNING _HOSTCPU_LOADA VG5_CRITICAL _CROSSBEAM_CPU _LOADAVG5_LIST |
| XBEAM HA Status | Checks the HA Status | check_ha_status | _HOSTSNMPCOMMUN ITY |
| XBEAM Vap_Status $KEY$ | Checks the VAP status | check_vap_statu s | _HOSTSNMPCOMMUN ITY _CROSSBEAM_VAP _STATUS_LIST |
| XBEAM CPU_LoadAvg1 $KEY$ | Checks the CPU 1 minute load average | check_cpu_loada vg1 | _HOSTSNMPCOMMUN ITY _HOSTCPU_LOADA VG1_WARNING _HOSTCPU_LOADA VG1_CRITICAL _CROSSBEAM_CPU _LOADAVG1_LIST |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | SNMP version to use in the check | string |
| _CPU_IDLE_WARNING | CPU Idle warning threshold | percent |
| _CPU_IDLE_CRITICAL | CPU Idle critical threshold | percent |
| _CPU_IOWAIT_WARNING | CPU IOWAIT warning threshold | percent |
| _CPU_IOWAIT_CRITICAL | CPU IOWAIT critical threshold | percent |
| _CPU_LOAD_WARNING | CPU Load warning threshold | integer |
| _CPU_LOAD_CRITICAL | CPU Load critical threshold | integer |
| _CPU_LOADAVG1_WARNING | CPU Load average 1 minute warning threshold | integer |
| _CPU_LOADAVG1_CRITICAL | CPU Load average 1 minute critical threshold | integer |
| _CPU_LOADAVG5_WARNING | CPU Load average 5 minute warning threshold | integer |
| _CPU_LOADAVG5_CRITICAL | CPU Load average 5 minute critical threshold | integer |
| _CPU_LOADAVG15_WARNING | CPU Load average 15 minute warning threshold | integer |
| _CPU_LOADAVG15_CRITICAL | CPU Load average 15 minute critical threshold | integer |
| _CPU_SYSTEM_WARNING | CPU System warning threshold | percent |
| _CPU_SYSTEM_CRITICAL | CPU System critical threshold | percent |
| _CPU_UTIL_WARNING | CPU Utilization warning threshold | percent |
| _CPU_UTIL_CRITICAL | CPU Utilization critical threshold | percent |
| _IN_OCTETS_WARNING | In octets warning threshold | integer |
| _IN_OCTETS_CRITICAL | In octets critical threshold | integer |
| _MEM_FREE_WARNING | Free memory warning threshold | percent |
| _MEM_FREE_CRITICAL | Free memory critical threshold | percent |
| _MEM_USAGE_WARNING | Memory usage warning threshold | percent |
| _MEM_USAGE_CRITICAL | Memory usage critical threshold | percent |
| _SWAP_USAGE_WARNING | Swap usage warning threshold | percent |
| _SWAP_USAGE_CRITICAL | Swap usage critical threshold | percent |
| _CPU_TEMP_WARNING | CPU temperature warning threshold | integer |
| _CPU_TEMP_CRITICAL | CPU temperature critical threshold | integer |
| _CHASSIS_TEMP_WARNING | Chassis temperature warning threshold | integer |
| _CHASSIS_TEMP_CRITICAL | Chassis temperature critical threshold | integer |
COMPLEX MACROS
_CROSSBEAM_CPU_IDLE_LIST
- Description: OIDs to check Core CPU idle
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check CPU idle | string |
_CROSSBEAM_CPU_IOWAIT_LIST
- Description: OIDs to check Core CPU iowait
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check CPU iowait | string |
_CROSSBEAM_CPU_LOAD_LIST
- Description: OIDs to check CPU load
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check CPU load | string |
_CROSSBEAM_CPU_LOADAVG1_LIST
- Description: OIDs to check CPU load average 1 minute
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check CPU load average 1 minute | string |
_CROSSBEAM_CPU_LOADAVG5_LIST
- Description: OIDs to check CPU load average 5 minutes
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check CPU load average 5 minutes | string |
_CROSSBEAM_CPU_LOADAVG15_LIST
- Description: OIDs to check CPU load average 15 minutes
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check CPU load average 15 minutes | string |
_CROSSBEAM_CPU_SYSTEM_LIST
- Description: OIDs to check Core CPU system
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check Core CPU system | string |
_CROSSBEAM_CPU_UTIL_LIST
- Description: OIDs to check CPU utilization
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check CPU utilization | string |
_CROSSBEAM_IN_OCTETS_LIST
- Description: OIDs to check interface IN octets
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check interface IN octets | string |
_CROSSBEAM_VAP_STATUS_LIST
- Description: OIDs to check crossbeam vap status
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check vap status | string |
_CROSSBEAM_FAILOVER_GR_STATUS_LIST
- Description: OIDs to check crossbeam failover group status
| Fields | Description | Type |
|---|---|---|
| display name | Custom Name appearing in the services | string |
| oid | OID to check failover group status | string |
Crossbeam-apm¶
DESCRIPTION
Specific checks for Crossbeam APM (Application Processor Module)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Log send | Checks the Log send service | check_xbeam_log _send | _HOSTSNMPCOMMUN ITY |
| Checkpoint total memory | Checks the Checkpoint memory | check_checkpoint _total_memory | _HOSTSNMPCOMMUN ITY _HOSTMEM_WARNI NG _HOSTMEM_CRITI CAL |
| Log server connection | Checks the Log Server connection | check_xbeam_log server_conn | _HOSTSNMPCOMMUN ITY |
| Cluster State | Shows the Cluster state | check_xbeam_clu ster_state | _HOSTSNMPCOMMUN ITY |
| Checkpoint connections and CPU | Checks the Checkpoint connections and CPU | check_checkpoint _connections_cp u | _HOSTSNMPCOMMUN ITY _HOSTCONN_CRIT ICAL _HOSTCPU_CRITI CAL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | SNMP community to use in the check | string |
| _SNMPVERSION | SNMP version to use in the check | string |
| _MEM_WARNING | Memory usage warning threshold | percent |
| _MEM_CRITICAL | Memory usage critical threshold | percent |
| _CONN_CRITICAL | Connections number critical threshold | integer |
| _CPU_CRITICAL | CPU usage critical threshold | percent |
Dell-server-hwinfo¶
DESCRIPTION
Hardware checks for Dell servers via snmp using iDRAC. Support for iDRAC7 and higher
iDRAC7 and iDRAC8 supported
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| CPUs temperature | Overall check for CPU(s) temperature | check_dell_cpus _temps | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTTEMPWARNIN G _HOSTTEMPCRITIC AL |
| FANs state | Checks the Fan(s) state | check_dell_fans _state | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Memory information | Shows memory info | check_dell_mem_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Server_status | Checks Dell server status | check_dell_serv er_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPUs_info | Shows info about CPU(s) | check_dell_cpus _info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Chassis_intrusio n | Shows overall status of Dell PowerEdge | check_dell_over all_chassis_int rusion | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| RAID_info | Shows RAID info | check_dell_raid _info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| PSUs | Overall check for PowerSupply(s) status | check_dell_psus | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Disks_states | Overall check for Disk(s) state | check_dell_loca ldisks | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| FANs_rpm | Checks the Fan(s) speed (rpm) | check_dell_fans _rpm | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTRPMDEFAULT WARNING _HOSTRPMDEFAULT CRITICAL |
| PSUs_voltage | Overall check for PowerSupply(s) voltage | check_dell_psus _volt | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTPSUVOLTWAR NING _HOSTPSUVOLTCRI TICAL |
| Server_info | Shows Dell server info | check_dell_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Disks_info | Shows overall Disk(s) state | check_dell_loca ldisks_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Memory status | Check memory status | check_dell_mem_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CMOS_battery | Shows overall status of Dell PowerEdge CMOS battery | check_dell_over all_battery | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| RAID_status | Checks the RAID status | check_dell_raid _status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPUs_status | Overall check for CPU(s) status | check_dell_cpus _status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Temperatures | Overall check for temperature sensor(s) | check_dell_temp s | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTTEMPWARNIN G _HOSTTEMPCRITIC AL |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Snmp community | string |
| _SNMPVERSION | Snmp version | string |
| _TEMPWARNING | Temperature warning threshold (Celsius degrees) | integer |
| _TEMPCRITICAL | Temperature critical threshold (Celsius degrees) | integer |
| _RPMDEFAULTWARNING | Minimum fan’s rpms warning threshold | integer |
| _RPMDEFAULTCRITICAL | Minimum fan’s rpms critical threshold | integer |
| _PSUVOLTWARNING | PSU’s voltage warning | integer |
| _PSUVOLTCRITICAL | PSU’s voltage critical | integer |
Hp-blade-hwinfo¶
DESCRIPTION
Plugin for monitoring HP Blades, via iLO (snmp)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Mem_info | Shows the Memory info | check_hp_ilo_m em_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPUs_info | Shows CPUs info | check_hp_ilo_c pus_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| System_info | Shows system info | check_hp_ilo_s ys_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| FANs_status | Checks the Fans status | check_hp_ilo_f ans_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPUs_temperature s | Checks the CPUs temperature | check_hp_ilo_c pus_temp | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCPUTEMPWAR NING _HOSTCPUTEMPCRI TICAL |
| Mem_status | Checks the Memory status | check_hp_ilo_m em_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Snmp community | string |
| _SNMPVERSION | Snmp version | string |
| _CPUTEMPWARNING | CPU temperature warning threshold (Celsius degrees) | integer |
| _CPUTEMPCRITICAL | CPU temperature critical threshold (Celsius degrees) | integer |
Hp-server-hwinfo¶
DESCRIPTION
Plugin for monitoring HP Servers, via iLO (snmp)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Disks_info | Shows the disks info | check_hp_ilo_d isks_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Mem_info | Shows the Memory info | check_hp_ilo_m em_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPUs_info | Shows CPUs info | check_hp_ilo_c pus_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| System_info | Shows system info | check_hp_ilo_s ys_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| FANs_status | Checks the Fans status | check_hp_ilo_f ans_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPUs_temperature s | Checks the CPUs temperature | check_hp_ilo_c pus_temp | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCPUTEMPWAR NING _HOSTCPUTEMPCRI TICAL |
| RAID_info | Shows the Raid info | check_hp_ilo_r aids_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| PSUs_voltage | Checks the Power Supply voltage | check_hp_ilo_p sus_volt | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTPSUVOLTAGE WARNING _HOSTPSUVOLTAGE CRITICAL |
| Mem_status | Checks the Memory status | check_hp_ilo_m em_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| RAID_status | Checks the Raid status | check_hp_ilo_r aids_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Disks_status | Checks the Disks status | check_hp_ilo_d isks_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| PSUs_state | Checks the Power Supply status | check_hp_ilo_p sus_state | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Snmp community | string |
| _SNMPVERSION | Snmp version | string |
| _CPUTEMPWARNING | CPU temperature warning threshold (Celsius degrees) | integer |
| _CPUTEMPCRITICAL | CPU temperature critical threshold (Celsius degrees) | integer |
| _PSUVOLTAGEWARNING | PSU voltage warning threshold (in Volts) | float |
| _PSUVOLTAGECRITICAL | PSU voltage critical threshold (in Volts) | float |
Ibm-server-hwinfo¶
DESCRIPTION
Pack for monitoring physical IBM Servers via IMM (using snmp)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| FANs | Checks Fans speed | check_ibm_imm_ fans | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTFAN_SPEED _PCT_WARNING _HOSTFAN_SPEED _PCT_CRITICAL |
| Disks info | Shows disks info | check_ibm_disks _info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Memory_info | Shows Memory info | check_ibm_mem_ info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPU_temperatures | Checks the CPUs temperature | check_ibm_imm_ cpus_temp | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N _HOSTCPU_TEMP_WARNING _HOSTCPU_TEMP_CRITICAL |
| CPU_info | Shows CPU info | check_ibm_cpus_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| FANs_status | Checks Fans status | check_ibm_fans_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| RAID_info | Shows Raid info | check_ibm_raid_info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Health_status | Checks system health status or level | check_ibm_imm_ health | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| PSUs | Checks Power Supply status | check_ibm_psus | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Disks_status | Checks disks status | check_ibm_disks | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Memory_status | Checks Memory status | check_ibm_mem_ status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| RAID_status | Checks the Raid status | check_ibm_raid_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| Server_info | Shows server info | check_ibm_srv_ info | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
| CPUs_status | Checks the CPUs status | check_ibm_cpus_status | _HOSTSNMPCOMMUN ITY _HOSTSNMPVERSIO N |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _SNMPCOMMUNITY | Snmp community | string |
| _SNMPVERSION | Snmp version | string |
| _CPU_TEMP_WARNING | CPU Temperature warning threshold (Celsius degrees) | integer |
| _CPU_TEMP_CRITICAL | CPU Temperature critical threshold (Celsius degrees) | integer |
| _FAN_SPEED_PCT_WARNING | Fan speed warning threshold (% of maximum rpms) | percent |
| _FAN_SPEED_PCT_CRITICAL | Fan speed critical threshold (% of maximum rpms) | percent |
Others¶
Mailbox-query¶
DESCRIPTION
Check alert messages in a mailbox via IMAP
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Mailbox - Search $KEY$ | Looks for alert messages in a mailbox via IMAP | check_mailbox- query | _HOSTMAILBOX_S ERVER _HOSTMAILBOX_A DDRESS _HOSTMAILBOX_P ASSWORD _ALERT_MESSAGE _LIST |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _MAILBOX_SERVER | IMAP Mail server address | string |
| _MAILBOX_ADDRESS | Mailbox address. Ex: mailbox@bussiness.com | string |
| _MAILBOX_PASSWORD | Mailbox password | string |
COMPLEX MACROS
_ALERT_MESSAGE_LIST
- Description: Alert message conditions
| Fields | Description | Type |
|---|---|---|
| Display name | Name/ID of alert message (unique) | string |
| Alert type | String included in message Subject to identify the alert | string |
| Disable String | String included in message Subject to identify the alert disable message. Ex: return to nomal | string |
Test-pack-random-states¶
DESCRIPTION
Test pack to generate random states service
This is a test purpose pack. Just to generate services with random states
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Test pack random states | Generates random state (OK, WARNING, CRITICAL, UNKNOWN). Test purpose | check_test_pack_r andom_states |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
Virtualization¶
Esx¶
DESCRIPTION
This pack checks VMware ESX virtual machines (guests)
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| ESX Io | Checks Virtual Machine disk I/O info | check_esx_host_io | _HOSTVCENTER _HOSTVCENTER_LOGIN _HOSTVCENTER_PASSW ORD _HOSTVCENTER_SESSI ON |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _VCENTER | VCenter address | string |
| _VCENTER_LOGIN | VCenter User login | string |
| _VCENTER_PASSWORD | VCenter User password | string |
| _VCENTER_SESSION | VCenter temporal session file (complete path) | absolute path |
| _ESX_CPU_CRIT | Critical threshold for CPU USAGE (absolute) | integer |
| _ESX_CPU_WARN | Warning threshold for CPU USAGE (absolute) | integer |
| _ESX_MEM_CRIT | Critical threshold for MEMORY USAGE (percentage) | percent |
| _ESX_MEM_WARN | Warning threshold for MEMORY USAGE (percentage) | percent |
Esx-host¶
DESCRIPTION
This pack checks ESX hosts
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| ESX VMFS | Shows Datastore info | check_esx_vmfs | _HOSTHOST_LOGIN _HOSTHOST_PASSWO RD _HOSTHOST_WARN_ VMFS _HOSTHOST_CRIT_ VMFS |
| ESX NTP | Shows NTP info (drift and peers) | check_esx_ntp | _HOSTHOST_LOGIN _HOSTHOST_PASSWO RD _HOSTHOST_WARN_ NTP_SECONDS _HOSTHOST_CRIT_ NTP_SECONDS _HOSTHOST_WARN_ NTP_PEERS _HOSTHOST_CRIT_ NTP_PEERS |
| ESX MEM | Checks ESX Host memory usage | check_esx_mem | _HOSTHOST_LOGIN _HOSTHOST_PASSWO RD _HOSTHOST_WARN_ MEM _HOSTHOST_CRIT_ MEM |
| ESX NET | Shows ESX Host net info | check_esx_net | _HOSTHOST_LOGIN _HOSTHOST_PASSWO RD _HOSTHOST_WARN_ NET _HOSTHOST_CRIT_ NET |
| ESX IO READ | Checks ESX Host I/O read info | check_esx_io_re ad | _HOSTHOST_LOGIN _HOSTHOST_PASSWO RD _HOSTHOST_WARN_ IO_READ _HOSTHOST_CRIT_ IO_READ |
| ESX IO WRITE | Checks ESX Host I/O write info | check_esx_io_wr ite | _HOSTHOST_LOGIN _HOSTHOST_PASSWO RD _HOSTHOST_WARN_ IO_WRITE _HOSTHOST_CRIT_ IO_WRITE |
| ESX CPU | Checks ESX Host CPU usage | check_esx_cpu | _HOSTHOST_LOGIN _HOSTHOST_PASSWO RD _HOSTHOST_WARN_ CPU _HOSTHOST_CRIT_ CPU |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _HOST_LOGIN | Host user | string |
| _HOST_PASSWORD | Host password | string |
| _HOST_WARN_CPU | Warning value percentage for CPU (ESX) | integer |
| _HOST_CRIT_CPU | Critical value percentage for CPU (ESX) | integer |
| _HOST_WARN_MEM | Warning value percentage for MEM usage (ESX) | integer |
| _HOST_CRIT_MEM | Critical value percentage for MEM usage (ESX) | integer |
| _HOST_WARN_NET | Warning Overall network usage in KBps(Kilobytes per Second) | integer |
| _HOST_CRIT_NET | Critical overall network usage in KBps(Kilobytes per Second) | integer |
| _HOST_WARN_IO_READ | Warning value for status disks IO in ms(ESX) | integer |
| _HOST_CRIT_IO_READ | Critical value for status disks IO in ms (ESX) | integer |
| _HOST_WARN_IO_WRITE | Warning value for status disks IO in ms (ESX) | integer |
| _HOST_CRIT_IO_WRITE | Critical value for status disks IO in ms (ESX) | integer |
| _HOST_WARN_VMFS | Warning value for space DATASTORE (ESX) | string |
| _HOST_CRIT_VMFS | Critical value for space DATASTORE (ESX) | string |
| _HOST_WARN_NTP_SECONDS | Warning value for NTP drift (seconds) | integer |
| _HOST_CRIT_NTP_SECONDS | Critical value for NTP drift (seconds) | integer |
| _HOST_WARN_NTP_PEERS | Warning value for NTP peer servers | integer |
| _HOST_CRIT_NTP_PEERS | Critical value for NTP peer servers | integer |
Proxmox¶
DESCRIPTION
proxmox checks, returns performance values for proxmox server.
Returns performance values for proxmox server via request: Cluster Health, CPU, Memory, Storage, Subscription, VM Status, Replication Status.
Important
The terms and concepts used in this section are explained in the Terminology section.
SERVICES
The following table shows the services that this pack will manage. Each row contains information about the managed service, such as its description, check_command and macros.
| Name | Description | Check Command | Macros |
|---|---|---|---|
| Proxmox Memory | check_pve_memory | _HOSTAPI_USER _HOSTAPI_PASSWD _HOSTAPI_ENDPOIN T _HOSTAPI_NODE |
|
| Proxmox Services | check_pve_service s | _HOSTAPI_USER _HOSTAPI_PASSWD _HOSTAPI_ENDPOIN T _HOSTAPI_NODE _HOST_IGNORE_SE RVICES |
|
| Proxmox Storage | check_pve_storage | _HOSTAPI_USER _HOSTAPI_PASSWD _HOSTAPI_ENDPOIN T _HOSTAPI_NODE _HOSTAPI_STORAGE |
|
| Proxmox Cluster Health | check_pve_cluster _health | _HOSTAPI_USER _HOSTAPI_PASSWD _HOSTAPI_ENDPOIN T |
|
| Proxmox IO Wait | check_pve_io_wai t | _HOSTAPI_USER _HOSTAPI_PASSWD _HOSTAPI_ENDPOIN T _HOSTAPI_NODE |
|
| Proxmox CPU Load | check_pve_cpu | _HOSTAPI_USER _HOSTAPI_PASSWD _HOSTAPI_ENDPOIN T _HOSTAPI_NODE |
MACROS
The following macros can be configured in order to modify the pack behaviour for each host that uses it:
SIMPLE MACROS
| Name | Description | Type |
|---|---|---|
| _API_USER | Remote user for the API calls | string |
| _API_PASSWD | Remote password for the API calls | string |
| _API_ENDPOINT | API Endpoing (Proxmox Server) | string |
| _API_NODE | Proxmox node name | string |
| _API_STORAGE | Proxmox storage Name | string |
| _IGNORE_SERVICE | Ignore check services names | string |