.. _packs-terminology: ----------- 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**. .. image:: ../images/packs/wocupacks.png :align: center :scale: 90% 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. .. _packs-categories: --------------- Pack categories --------------- Network ------- Allot_nms ^^^^^^^^^ **DESCRIPTION** ---------------------- Gets metrics in Allot Network Management System devices using SNMP .. image:: ../images/packs/pack_icons/allot-nms.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | Connection | Checks the | connection\_est | | | establishment | connection | | \_HOSTSNMPCOMMUN | | rate | establishment | | ITY | | | rate | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTCONNECTION | | | | | \_WARNING | | | | | | | | | | \_HOSTCONNECTION | | | | | \_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | allot\_uptime | Checks the device | uptime | | | | uptime | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTUPTIME\_WA | | | | | RNING | | | | | | | | | | \_HOSTUPTIME\_CR | | | | | ITICAL | +-------------------+-------------------+-------------------+------------------+ | CPU Average | Checks the | cpu\_avg | | | | average use of | | \_HOSTSNMPCOMMUN | | | CPU | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Active lines | Checks the number | active\_lines | | | | of active lines | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTLINES\_WAR | | | | | NING | | | | | | | | | | \_HOSTLINES\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | PowerSupply | Checks the status | powersupply\_stat | | | status | of power supplies | us | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Protocol update | Checks the | protocol\_update | | | licence | expiration date | | \_HOSTSNMPCOMMUN | | | of Allot protocol | | ITY | | | update | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTPROTOCOL\_ | | | | | UPDATE\_WARNING | +-------------------+-------------------+-------------------+------------------+ | FANs status | Checks the status | fans\_status | | | | of fans | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Pipes | Checks the number | pipes | | | | of pipes | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTPIPES\_WAR | | | | | NING | | | | | | | | | | \_HOSTPIPES\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | Board Temperature | Checks the board | board\_temperatur | | | Range | temperature | e\_range | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | RAM Usage | Checks the main | mem\_usage | | | | memory usage | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTRAM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTRAM\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Sensors | Checks the | sensor\_temperatu | | | Temperature | temperature | re | \_HOSTSNMPCOMMUN | | | obtained from | | ITY | | | sensors | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTSENSOR\_TE | | | | | MP\_WARNING | | | | | | | | | | \_HOSTSENSOR\_TE | | | | | MP\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Software status | Checks the | software\_status | | | | software status | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Virtual channels | Checks the number | virtual\_channels | | | | of virtual | | \_HOSTSNMPCOMMUN | | | channels | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTVIRTUAL\_C | | | | | HANNELS\_DEFAULT | | | | | \_WARNING | | | | | | | | | | \_HOSTVIRTUAL\_C | | | | | HANNELS\_DEFAULT | | | | | \_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Disk Usage | Checks the | disk\_usage | | | | storage usage | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTDISK\_WARN | | | | | ING | | | | | | | | | | \_HOSTDISK\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | Hardware status | Checks the | hardware\_status | | | | hardware status | | \_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 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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | Device SNMP version, supported | string | | | 1 and 2c | | +----------------------------------+---------------------------------+---------+ | \_CPU\_WARNING | CPU warning threshold | percent | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_CPU\_CRITICAL | CPU critical threshold | percent | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_RAM\_WARNING | RAM warning threshold | percent | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_RAM\_CRITICAL | RAM critical threshold | percent | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_DISK\_WARNING | Disk warning threshold | percent | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_DISK\_CRITICAL | Disk critical threshold | percent | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_SENSOR\_TEMP\_WARNING | Temperature(celsius) warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_SENSOR\_TEMP\_CRITICAL | Temperature(celsius) critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_UPTIME\_WARNING | Time (seconds) warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_UPTIME\_CRITICAL | Time (seconds) critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_CONNECTION\_WARNING | Connection establishment rate | integer | | | warning threshold | | +----------------------------------+---------------------------------+---------+ | \_CONNECTION\_CRITICAL | Connection establishment rate | integer | | | critical threshold | | +----------------------------------+---------------------------------+---------+ | \_LINES\_WARNING | Active lines warning threshold | integer | +----------------------------------+---------------------------------+---------+ | \_LINES\_CRITICAL | Active lines critical threshold | integer | +----------------------------------+---------------------------------+---------+ | \_PIPES\_WARNING | Total number of pipes warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_PIPES\_CRITICAL | Total number of pipes critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_VIRTUAL\_CHANNELS\_DEFAULT\_WA | Total number of vc's warning | integer | | RNING | threshold | | +----------------------------------+---------------------------------+---------+ | \_VIRTUAL\_CHANNELS\_DEFAULT\_CR | Total number of vc's critical | integer | | ITICAL | threshold | | +----------------------------------+---------------------------------+---------+ | \_PROTOCOL\_UPDATE\_WARNING | Days to expire the license of | integer | | | Allot protocol update | | +----------------------------------+---------------------------------+---------+ Aruba-alcatel-wifi-controller ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for Aruba/Alcatel Controllers and its associated APs .. image:: ../images/packs/pack_icons/aruba-alcatel-wifi-controller.png :align: center :scale: 50% Supported devices: Aruba Mobility Controllers (7000 Series) .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | Radio\_TX\_Bytes | Checks the TX | check\_aruba\_alc | | | $KEY$ | bytes per radio | atel\_controller\ | \_HOSTSNMPCOMMUN | | | channel | _radio\_bytes\_tx | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Radio\_RX\_Throug | Checks the RX | check\_aruba\_alc | | | hput $KEY$ | throughput per | atel\_controller\ | \_HOSTSNMPCOMMUN | | | radio channel | _radio\_rx | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTRADIO\_RX\ | | | | | _WARNING | | | | | | | | | | \_HOSTRADIO\_RX\ | | | | | _CRITICAL | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Channel\_utilizat | Checks the | check\_aruba\_alc | | | ion $KEY$ | channel | atel\_channel\_ut | \_HOSTSNMPCOMMUN | | | utilization | ilization | ITY | | | | | | | | | | \_HOSTCHANNEL\_U | | | | | TIL\_WARNING\_TH | | | | | RESHOLD | | | | | | | | | | \_HOSTCHANNEL\_U | | | | | TIL\_CRITICAL\_T | | | | | HRESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Channel\_intefere | Checks the radio | check\_aruba\_alc | | | nce $KEY$ | channel | atel\_channel\_in | \_HOSTSNMPCOMMUN | | | inteference | terference | ITY | | | | | | | | | | \_HOSTCHANNEL\_I | | | | | NTERF\_WARNING\_ | | | | | THRESHOLD | | | | | | | | | | \_HOSTCHANNEL\_I | | | | | NTERF\_CRITICAL\ | | | | | _THRESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Controller\_Power | Checks the status | check\_aruba\_alc | | | \_Supply | of controller | atel\_controller\ | \_HOSTSNMPCOMMUN | | | power supplies | _power\_supply | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Radio\_TX\_Throug | Checks the TX | check\_aruba\_alc | | | hput $KEY$ | throughput per | atel\_controller\ | \_HOSTSNMPCOMMUN | | | radio channel | _radio\_tx | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTRADIO\_TX\ | | | | | _WARNING | | | | | | | | | | \_HOSTRADIO\_TX\ | | | | | _CRITICAL | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Radio\_Bytes | Checks the bytes | check\_aruba\_alc | | | $KEY$ | per radio channel | atel\_controller\ | \_HOSTSNMPCOMMUN | | | | _radio\_bytes | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Controller\_Temp | Checks the | check\_aruba\_alc | | | | controller | atel\_controller\ | \_HOSTSNMPCOMMUN | | | temperature | _temp | ITY | | | | | | | | | | \_HOSTTEMP\_WARN | | | | | ING\_THRESHOLD | | | | | | | | | | \_HOSTTEMP\_CRIT | | | | | ICAL\_THRESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Controller\_ap\_c | Checks the number | check\_ap\_count\ | | | ount | of Access Points | _aruba\_alcatel\_ | \_HOSTSNMPCOMMUN | | | connected to the | controller | ITY | | | controller | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | AP\_Info $KEY$ | Shows Access | check\_aruba\_alc | | | | Point info | atel\_ap\_info | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_APLIST | +-------------------+-------------------+-------------------+------------------+ | Channel\_bandwidt | Checks the | check\_aruba\_alc | | | h $KEY$ | bandwidth per | atel\_channel\_ba | \_HOSTSNMPCOMMUN | | | radio channel | ndwidth | ITY | | | | | | | | | | \_HOSTCHANNEL\_B | | | | | W\_WARNING\_THRE | | | | | SHOLD | | | | | | | | | | \_HOSTCHANNEL\_B | | | | | W\_CRITICAL\_THR | | | | | ESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Controller\_cpu | Checks the | check\_cpu\_aruba | | | | controller cpu | \_alcatel\_contro | \_HOSTSNMPCOMMUN | | | usage | ller | ITY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL\_THRESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Channel\_clients | Checks the number | check\_aruba\_alc | | | $KEY$ | of clients per | atel\_channel\_cl | \_HOSTSNMPCOMMUN | | | radio channel | ients | ITY | | | | | | | | | | \_HOSTCHANNEL\_C | | | | | LIENTS\_WARNING\ | | | | | _THRESHOLD | | | | | | | | | | \_HOSTCHANNEL\_C | | | | | LIENTS\_CRITICAL | | | | | \_THRESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Radio\_Info $KEY$ | Shows radio | check\_aruba\_alc | | | | channel info | atel\_ap\_radio\_ | \_HOSTSNMPCOMMUN | | | | info | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Controller\_Fans | Checks the fans | check\_aruba\_alc | | | | status from the | atel\_controller\ | \_HOSTSNMPCOMMUN | | | controller | _fans | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | WLAN\_Throughput | Checks the | check\_aruba\_alc | | | | throughput per | atel\_controller\ | \_HOSTSNMPCOMMUN | | | WLAN | _wlan\_throughput | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTWLAN\_THRO | | | | | UGHPUT\_WARNING | | | | | | | | | | \_HOSTWLAN\_THRO | | | | | UGHPUT\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | WLAN\_Clients | Checks the | check\_aruba\_alc | | | | clients connected | atel\_controller\ | \_HOSTSNMPCOMMUN | | | per WLAN | _wlan\_clients | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTWLAN\_CLIE | | | | | NTS\_WARNING | | | | | | | | | | \_HOSTWLAN\_CLIE | | | | | NTS\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | AP\_status $KEY$ | Checks the Access | check\_aruba\_alc | | | | Point status | atel\_ap\_status | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_APLIST | +-------------------+-------------------+-------------------+------------------+ | AP\_uptime $KEY$ | Checks the Access | check\_aruba\_alc | | | | Point uptime | atel\_ap\_uptime | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTAP\_MIN\_U | | | | | PTIME | | | | | | | | | | \_APLIST | +-------------------+-------------------+-------------------+------------------+ | AP\_Clients $KEY$ | Checks the number | check\_aruba\_alc | | | | of clients per | atel\_ap\_clients | \_HOSTSNMPCOMMUN | | | Access Point | | ITY | | | | | | | | | | \_HOSTAP\_CLIENT | | | | | S\_WARNING\_THRE | | | | | SHOLD | | | | | | | | | | \_HOSTAP\_CLIENT | | | | | S\_CRITICAL\_THR | | | | | ESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_APLIST | +-------------------+-------------------+-------------------+------------------+ | WLAN\_ESSIDs | Shows the WLAN | check\_aruba\_alc | | | | essids running in | atel\_essid | \_HOSTSNMPCOMMUN | | | the controller | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Radio\_RX\_Bytes | Checks the RX | check\_aruba\_alc | | | $KEY$ | bytes per radio | atel\_controller\ | \_HOSTSNMPCOMMUN | | | channel | _radio\_bytes\_rx | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Controller\_memor | Checks the | check\_aruba\_alc | | | y | controller memory | atel\_controller\ | \_HOSTSNMPCOMMUN | | | usage | _mem | ITY | | | | | | | | | | \_HOSTMEM\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL\_THRESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Controller\_disks | Checks the | check\_disks\_aru | | | | controller | ba\_alcatel\_cont | \_HOSTSNMPCOMMUN | | | storage usage | roller | ITY | | | | | | | | | | \_HOSTDISKS\_WAR | | | | | NING\_THRESHOLD | | | | | | | | | | \_HOSTDISKS\_CRI | | | | | TICAL\_THRESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Client\_SNR\_avg | Checks the | check\_aruba\_alc | | | | average of client | atel\_client\_snr | \_HOSTSNMPCOMMUN | | | Signal to Noise | \_average | ITY | | | Ratio (SNR) | | | | | | | \_HOSTCLIENT\_SN | | | | | R\_WARNING\_THRE | | | | | SHOLD | | | | | | | | | | \_HOSTCLIENT\_SN | | | | | R\_CRITICAL\_THR | | | | | ESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | AP\_bandwidth | Checks the | check\_aruba\_alc | | | $KEY$ | bandwidth per | atel\_ap\_bandwid | \_HOSTSNMPCOMMUN | | | Access Point | th | ITY | | | | | | | | | | \_HOSTAP\_BW\_WA | | | | | RNING\_THRESHOLD | | | | | | | | | | \_HOSTAP\_BW\_CR | | | | | ITICAL\_THRESHOL | | | | | D | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_APLIST | +-------------------+-------------------+-------------------+------------------+ | Radio\_non\_unica | Checks the non | check\_aruba\_alc | | | st $KEY$ | unicast packets | atel\_controller\ | \_HOSTSNMPCOMMUN | | | per radio channel | _radio\_non\_unic | ITY | | | | ast | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTNON\_UNICA | | | | | ST\_WARNING | | | | | | | | | | \_HOSTNON\_UNICA | | | | | ST\_CRITICAL | | | | | | | | | | \_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 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 | string | | | check | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | SNMP version to use in the | string | | | check | | +----------------------------------+---------------------------------+---------+ | \_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 | percent | | | threshold (percent) | | +----------------------------------+---------------------------------+---------+ | \_DISKS\_CRITICAL\_THRESHOLD | Disks ocupation critical | percent | | | threshold (percent) | | +----------------------------------+---------------------------------+---------+ | \_AP\_MIN\_UPTIME | AP Critical below this number | integer | | | of second after boot time | | +----------------------------------+---------------------------------+---------+ | \_CHANNEL\_UTIL\_WARNING\_THRESH | Channel utilization warning | percent | | OLD | threshold (percent) | | +----------------------------------+---------------------------------+---------+ | \_CHANNEL\_UTIL\_CRITICAL\_THRES | Channel utilization critical | percent | | HOLD | threshold (percent) | | +----------------------------------+---------------------------------+---------+ | \_CHANNEL\_INTERF\_WARNING\_THRE | Channel interference warning | integer | | SHOLD | threshold | | +----------------------------------+---------------------------------+---------+ | \_CHANNEL\_INTERF\_CRITICAL\_THR | Channel interference critical | integer | | ESHOLD | threshold | | +----------------------------------+---------------------------------+---------+ | \_CHANNEL\_CLIENTS\_WARNING\_THR | Channel clients warning | integer | | ESHOLD | threshold | | +----------------------------------+---------------------------------+---------+ | \_CHANNEL\_CLIENTS\_CRITICAL\_TH | Channel clients critical | integer | | RESHOLD | threshold | | +----------------------------------+---------------------------------+---------+ | \_AP\_CLIENTS\_WARNING\_THRESHOL | AP clients warning threshold | integer | | D | | | +----------------------------------+---------------------------------+---------+ | \_AP\_CLIENTS\_CRITICAL\_THRESHO | AP clients critical threshold | integer | | LD | | | +----------------------------------+---------------------------------+---------+ | \_CHANNEL\_BW\_WARNING\_THRESHOL | Channel bandwidth warning | integer | | D | threshold (in kbps) | | +----------------------------------+---------------------------------+---------+ | \_CHANNEL\_BW\_CRITICAL\_THRESHO | Channel bandwidth critical | integer | | LD | threshold (in kbps) | | +----------------------------------+---------------------------------+---------+ | \_AP\_BW\_WARNING\_THRESHOLD | AP bandwidth warning threshold | integer | | | (in kbps) | | +----------------------------------+---------------------------------+---------+ | \_AP\_BW\_CRITICAL\_THRESHOLD | AP bandwidth critical threshold | integer | | | (in kbps) | | +----------------------------------+---------------------------------+---------+ | \_CLIENT\_SNR\_WARNING\_THRESHOL | Client average SNR warning | integer | | D | threshold | | +----------------------------------+---------------------------------+---------+ | \_CLIENT\_SNR\_CRITICAL\_THRESHO | Client average SNR critical | integer | | LD | threshold | | +----------------------------------+---------------------------------+---------+ | \_TEMP\_WARNING\_THRESHOLD | Controller Temp warning | integer | | | threshold in Celsius | | +----------------------------------+---------------------------------+---------+ | \_TEMP\_CRITICAL\_THRESHOLD | Controller Temp critical | integer | | | threshold in Celsius | | +----------------------------------+---------------------------------+---------+ | \_WLAN\_CLIENTS\_WARNING | Client count warning threshold | integer | | | per WLAN | | +----------------------------------+---------------------------------+---------+ | \_WLAN\_CLIENTS\_CRITICAL | Client count critical threshold | integer | | | per WLAN | | +----------------------------------+---------------------------------+---------+ | \_WLAN\_THROUGHPUT\_WARNING | WLAN throughput warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_WLAN\_THROUGHPUT\_CRITICAL | WLAN throughput critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_NON\_UNICAST\_WARNING | Non unicast packets percent | percent | | | warning threshold | | +----------------------------------+---------------------------------+---------+ | \_NON\_UNICAST\_CRITICAL | Non unicast packets percent | percent | | | critical threshold | | +----------------------------------+---------------------------------+---------+ | \_RADIO\_RX\_WARNING | Radio RX throughput warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_RADIO\_RX\_CRITICAL | Radio RX throughput critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_RADIO\_TX\_WARNING | Radio TX throughput warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_RADIO\_TX\_CRITICAL | Radio TX throughput critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ **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 .. image:: ../images/packs/pack_icons/aruba-alcatel-wifi-iap.png :align: center :scale: 50% 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 :ref:`packs-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\_ap\_count | Checks the number | check\_aruba\_alc | | | | of connected | atel\_iap\_ap\_co | \_HOSTSNMPCOMMUN | | | Access Points | unt | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTAP\_COUNT\ | | | | | _WARNING | | | | | | | | | | \_HOSTAP\_COUNT\ | | | | | _CRITICAL | +-------------------+-------------------+-------------------+------------------+ | AP\_Uptime $KEY$ | Checks Access | check\_aruba\_alc | | | | Point uptime | atel\_iap\_ap\_up | \_HOSTSNMPCOMMUN | | | | time | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTAP\_UPTIME | | | | | \_WARNING | | | | | | | | | | \_HOSTAP\_UPTIME | | | | | \_CRITICAL | | | | | | | | | | \_APLIST | +-------------------+-------------------+-------------------+------------------+ | WLAN\_Clients | Checks the number | check\_aruba\_alc | | | | of clients per | atel\_iap\_wlan\_ | \_HOSTSNMPCOMMUN | | | WLAN | clients | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTWLAN\_CLIE | | | | | NTS\_WARNING | | | | | | | | | | \_HOSTWLAN\_CLIE | | | | | NTS\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Channel\_status | Checks the radio | check\_aruba\_alc | | | $KEY$ | channel status | atel\_iap\_channe | \_HOSTSNMPCOMMUN | | | | l\_status | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | AP\_Status $KEY$ | Checks the Access | check\_aruba\_alc | | | | Point status | atel\_iap\_ap\_st | \_HOSTSNMPCOMMUN | | | | atus | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_APLIST | +-------------------+-------------------+-------------------+------------------+ | Channel\_util | Checks the radio | check\_aruba\_alc | | | $KEY$ | channel | atel\_iap\_channe | \_HOSTSNMPCOMMUN | | | utilization | l\_util | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTCHANNEL\_U | | | | | TIL\_WARNING | | | | | | | | | | \_HOSTCHANNEL\_U | | | | | TIL\_CRITICAL | | | | | | | | | | \_CHLIST | +-------------------+-------------------+-------------------+------------------+ | WLAN\_RX\_Through | Checks the RX | check\_aruba\_alc | | | put | throughput per | atel\_iap\_wlan\_ | \_HOSTSNMPCOMMUN | | | WLAN | rx\_throughput | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTRX\_THROUG | | | | | HPUT\_WARNING | | | | | | | | | | \_HOSTRX\_THROUG | | | | | HPUT\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | WLAN\_TX\_Through | Checks the TX | check\_aruba\_alc | | | put | throughput per | atel\_iap\_wlan\_ | \_HOSTSNMPCOMMUN | | | WLAN | tx\_throughput | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTTX\_THROUG | | | | | HPUT\_WARNING | | | | | | | | | | \_HOSTTX\_THROUG | | | | | HPUT\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | AP\_CPU $KEY$ | Checks the Access | check\_aruba\_alc | | | | Point CPU usage | atel\_iap\_cpu | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL | | | | | | | | | | \_APLIST | +-------------------+-------------------+-------------------+------------------+ | AP\_MEM $KEY$ | Checks the Access | check\_aruba\_alc | | | | Point memory | atel\_iap\_mem | \_HOSTSNMPCOMMUN | | | usage | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTMEM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL | | | | | | | | | | \_APLIST | +-------------------+-------------------+-------------------+------------------+ | AP\_ap\_count\_up | Checks the number | check\_aruba\_alc | | | | of connected | atel\_iap\_ap\_co | \_HOSTSNMPCOMMUN | | | Access Points | unt\_up | ITY | | | with status UP | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTAP\_COUNT\ | | | | | _UP\_WARNING | | | | | | | | | | \_HOSTAP\_COUNT\ | | | | | _UP\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | WLAN\_ESSIDs | Shows the WLAN | check\_aruba\_alc | | | | essids published | atel\_iap\_essid | \_HOSTSNMPCOMMUN | | | by the controller | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Client\_count | Checks the number | check\_aruba\_alc | | | | of clients | atel\_iap\_client | \_HOSTSNMPCOMMUN | | | | \_count | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTCLIENT\_CO | | | | | UNT\_WARNING | | | | | | | | | | \_HOSTCLIENT\_CO | | | | | UNT\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | AP\_Channel\_snr\ | Checks the | check\_aruba\_alc | | | _avg | average client | atel\_iap\_client | \_HOSTSNMPCOMMUN | | | Signal to Noise | \_snr\_avg | ITY | | | Ratio (SNR) | | | | | | | \_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 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 | string | | | $SNMPCOMMUNITYREAD$ for the default | | | | system community | | +----------------------------+---------------------------------------+---------+ | \_SNMPVERSION | Device SNMP versions supported are: 1 | string | | | and 2c | | +----------------------------+---------------------------------------+---------+ | \_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 | integer | | | connected to the virtual controller | | +----------------------------+---------------------------------------+---------+ | \_AP\_COUNT\_CRITICAL | Critical counter for the number of | integer | | | aps connected to the virtual | | | | controller | | +----------------------------+---------------------------------------+---------+ | \_AP\_COUNT\_UP\_WARNING | Warning counter for the number of aps | integer | | | connected to the virtual controller | | | | and with status UP | | +----------------------------+---------------------------------------+---------+ | \_AP\_COUNT\_UP\_CRITICAL | Critical counter for the number of | integer | | | aps connected to the virtual | | | | controller and with status UP | | +----------------------------+---------------------------------------+---------+ | \_CHANNEL\_UTIL\_WARNING | Channel utilization warning threshold | percent | +----------------------------+---------------------------------------+---------+ | \_CHANNEL\_UTIL\_CRITICAL | Channel utilization critical | percent | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_CLIENT\_SNR\_WARNING | Average client Signal to Noise Ratio | integer | | | warning threshold | | +----------------------------+---------------------------------------+---------+ | \_CLIENT\_SNR\_CRITICAL | Average client Signal to Noise Ratio | integer | | | critical threshold | | +----------------------------+---------------------------------------+---------+ | \_CLIENT\_COUNT\_WARNING | Total connected client number warning | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_CLIENT\_COUNT\_CRITICAL | Total connected client number | integer | | | critical threshold | | +----------------------------+---------------------------------------+---------+ | \_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 | integer | | | (in bps) | | +----------------------------+---------------------------------------+---------+ | \_TX\_THROUGHPUT\_CRITICAL | WLAN TX throughput critical threshold | integer | | | (in bps) | | +----------------------------+---------------------------------------+---------+ | \_RX\_THROUGHPUT\_WARNING | WLAN RX throughput warning threshold | integer | | | (in bps) | | +----------------------------+---------------------------------------+---------+ | \_RX\_THROUGHPUT\_CRITICAL | WLAN RX throughput critical threshold | integer | | | (in bps) | | +----------------------------+---------------------------------------+---------+ | \_AP\_UPTIME\_WARNING | AP Uptime warning threshold (in | integer | | | seconds) | | +----------------------------+---------------------------------------+---------+ | \_AP\_UPTIME\_CRITICAL | AP Uptime critical threshold (in | integer | | | seconds) | | +----------------------------+---------------------------------------+---------+ **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 .. image:: ../images/packs/pack_icons/bchannel-cisco.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | It shows the | check\_bchannels\ | | | Active\_Calls | number of used, | _cisco | \_HOSTSNMPCOMMUN | | | free and total | | ITY | | | ISDN B-channels | | | | | | | \_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 | string | | | check | | +---------------------------------+----------------------------------+---------+ | \_BCHANNEL\_WARNING\_THRESHOLD | : | integer | | | Below this number, raise a | | | | Warning status | | +---------------------------------+----------------------------------+---------+ | \_BCHANNEL\_CRITICAL\_THRESHOLD | : | integer | | | Below this number, raise a | | | | Critical status | | +---------------------------------+----------------------------------+---------+ Bgp-cisco ^^^^^^^^^ **DESCRIPTION** ---------------------- Checks BGP peer availability and session state in Cisco devices .. image:: ../images/packs/pack_icons/bgp-cisco.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | check\_bgp | | | | sessions state | | \_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 .. image:: ../images/packs/pack_icons/bgp-juniper.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 - | Checks the | check\_bgp\_junip | | | $KEY$ | Juniper BGP Peer | er | \_HOSTSNMPCOMMUN | | | state | | 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 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 | +---------------+---------------------------------------+----------+ Call-manager-cisco ^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Generic and specific checks for Cisco Call Manager devices .. image:: ../images/packs/pack_icons/call-manager-cisco.png :align: center :scale: 50% Supported CUCM v10 and olders .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | SIP\_ActiveCalls\ | Checks the number | check-cisco-ccm- | | | _$KEY$ | of active and in- | sip-activecalls | \_HOSTCUCM\_USER | | | progress calls | | | | | per SIP | | \_HOSTCUCM\_PASS | | | | | WORD | | | | | | | | | | \_HOSTACTIVECALL | | | | | S\_WARNING | | | | | | | | | | \_HOSTACTIVECALL | | | | | S\_CRITICAL | | | | | | | | | | \_SIP\_DEVICES | +-------------------+-------------------+-------------------+------------------+ | Devices\_CTI | Checks the number | check-cisco-ccm- | | | | and status of CTI | devices-cti | \_HOSTSNMPCOMMUN | | | devices | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTPROBLEM\_C | | | | | TI\_WARNING | | | | | | | | | | \_HOSTPROBLEM\_C | | | | | TI\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Devices\_Phones | Checks the number | check-cisco-ccm- | | | | and status of | devices-phones | \_HOSTSNMPCOMMUN | | | Phone devices | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTPROBLEM\_P | | | | | HONES\_WARNING | | | | | | | | | | \_HOSTPROBLEM\_P | | | | | HONES\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Devices\_Media | Checks the number | check-cisco-ccm- | | | | and status of | devices-media | \_HOSTSNMPCOMMUN | | | Media devices | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTPROBLEM\_M | | | | | EDIA\_WARNING | | | | | | | | | | \_HOSTPROBLEM\_M | | | | | EDIA\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Devices\_VoiceMai | Checks the number | check-cisco-ccm- | | | ls | and status of | devices- | \_HOSTSNMPCOMMUN | | | Voicemail devices | voicemails | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTPROBLEM\_V | | | | | OICEMAIL\_WARNIN | | | | | G | | | | | | | | | | \_HOSTPROBLEM\_V | | | | | OICEMAIL\_CRITIC | | | | | AL | +-------------------+-------------------+-------------------+------------------+ | Devices\_Gateways | Checks the number | check-cisco-ccm- | | | | and status of | devices-gateways | \_HOSTSNMPCOMMUN | | | Gateway devices | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTPROBLEM\_G | | | | | ATEWAYS\_WARNING | | | | | | | | | | \_HOSTPROBLEM\_G | | | | | ATEWAYS\_CRITICA | | | | | L | +-------------------+-------------------+-------------------+------------------+ | CPU | Checks the CPU | check-cisco-ccm- | | | | usage | cpu | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARN | | | | | | | | | | \_HOSTCPU\_CRIT | +-------------------+-------------------+-------------------+------------------+ | MGCP\_ActiveCalls | Checks the number | check-cisco-ccm- | | | \_$KEY$ | Active calls per | mgcp-activecalls | \_HOSTCUCM\_USER | | | MGCP | | | | | | | \_HOSTCUCM\_PASS | | | | | WORD | | | | | | | | | | \_HOSTACTIVECALL | | | | | S\_WARNING | | | | | | | | | | \_HOSTACTIVECALL | | | | | S\_CRITICAL | | | | | | | | | | \_MGCP\_DEVICES | +-------------------+-------------------+-------------------+------------------+ | TimeSync | Checks the | check-cisco-ccm- | | | | difference | time | \_HOSTSNMPCOMMUN | | | between device | | ITY | | | and Wocu UTC time | | | | | | | \_HOSTNTP\_WARN | | | | | | | | | | \_HOSTNTP\_CRIT | +-------------------+-------------------+-------------------+------------------+ | Disks | Overall disks | check-cisco-ccm- | | | | usage | disks | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSTORAGE\_P | | | | | ATH | | | | | | | | | | \_HOSTSTORAGE\_W | | | | | ARN | | | | | | | | | | \_HOSTSTORAGE\_C | | | | | RIT | | | | | | | | | | \_HOSTSNMP\_MSG\ | | | | | _MAX\_SIZE | +-------------------+-------------------+-------------------+------------------+ | CCM-Info | Shows info about | check-cisco-ccm- | | | | the Cisco Call | info | \_HOSTSNMPCOMMUN | | | Manager device | | 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 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 | string | | | in the check | | +--------------------------+-------------------------+-------------------------+ | \_SNMPVERSION | Device SNMP versions | string | | | supported are: 1 and 2c | | +--------------------------+-------------------------+-------------------------+ | \_PROBLEM\_PHONES\_WARNI | Unregistered + Rejected | integer | | NG | Phones warning | | | | threshold | | +--------------------------+-------------------------+-------------------------+ | \_PROBLEM\_PHONES\_CRITI | Unregistered + Rejected | integer | | CAL | Phones critical | | | | threshold | | +--------------------------+-------------------------+-------------------------+ | \_PROBLEM\_GATEWAYS\_WAR | Unregistered + Rejected | integer | | NING | Gateways warning | | | | threshold | | +--------------------------+-------------------------+-------------------------+ | \_PROBLEM\_GATEWAYS\_CRI | Unregistered + Rejected | integer | | TICAL | Gateways critical | | | | threshold | | +--------------------------+-------------------------+-------------------------+ | \_PROBLEM\_MEDIA\_WARNIN | Unregistered + Rejected | integer | | G | Media warning threshold | | +--------------------------+-------------------------+-------------------------+ | \_PROBLEM\_MEDIA\_CRITIC | Unregistered + Rejected | integer | | AL | Media critical | | | | threshold | | +--------------------------+-------------------------+-------------------------+ | \_PROBLEM\_CTI\_WARNING | Unregistered + Rejected | integer | | | Cti warning threshold | | +--------------------------+-------------------------+-------------------------+ | \_PROBLEM\_CTI\_CRITICAL | Unregistered + Rejected | integer | | | Cti critical threshold | | +--------------------------+-------------------------+-------------------------+ | \_PROBLEM\_VOICEMAIL\_WA | Unregistered + Rejected | integer | | RNING | Voicemails warning | | | | threshold | | +--------------------------+-------------------------+-------------------------+ | \_PROBLEM\_VOICEMAIL\_CR | Unregistered + Rejected | integer | | ITICAL | Voicemails critical | | | | threshold | | +--------------------------+-------------------------+-------------------------+ | \_LOAD\_WARN | Value for starting | 3 comma-separated | | | warning state for the | integer | | | load average at | | | | 1m,5m,15m | | +--------------------------+-------------------------+-------------------------+ | \_LOAD\_CRIT | Value for starting | 3 comma-separated | | | critical state for the | integer | | | load average at | | | | 1m,5m,15m | | +--------------------------+-------------------------+-------------------------+ | \_CPU\_WARN | Warning level for the | percent | | | CPU usage | | +--------------------------+-------------------------+-------------------------+ | \_CPU\_CRIT | Critical level for the | percent | | | CPU usage | | +--------------------------+-------------------------+-------------------------+ | \_MEMORY\_WARN | Physical memory and | percent | | | swap warning level | | +--------------------------+-------------------------+-------------------------+ | \_MEMORY\_CRIT | Physical memory and | percent | | | swap critical level | | +--------------------------+-------------------------+-------------------------+ | \_STORAGE\_PATH | Absolute path to check | absolute path | | | its storage | | +--------------------------+-------------------------+-------------------------+ | \_STORAGE\_WARN | Warning level for used | percent | | | disk space | | +--------------------------+-------------------------+-------------------------+ | \_STORAGE\_CRIT | Critical level for used | percent | | | disk space | | +--------------------------+-------------------------+-------------------------+ | \_SNMP\_MSG\_MAX\_SIZE | Maximum size of the | integer | | | snmp messages | | +--------------------------+-------------------------+-------------------------+ | \_NTP\_WARN | NTP timings warning | integer | | | level (in seconds) | | +--------------------------+-------------------------+-------------------------+ | \_NTP\_CRIT | NTP timings critical | integer | | | level (in seconds) | | +--------------------------+-------------------------+-------------------------+ | \_CUCM\_USER | Call Manager connecting | string | | | user (SOAP checks) | | +--------------------------+-------------------------+-------------------------+ | \_CUCM\_PASSWORD | Password of the Call | string | | | Manager connecting | | | | user(SOAP checks) | | +--------------------------+-------------------------+-------------------------+ | \_ACTIVECALLS\_WARNING | Warning threshold for | integer | | | ActiveCalls in the Call | | | | Manager | | +--------------------------+-------------------------+-------------------------+ | \_ACTIVECALLS\_CRITICAL | Critical threshold for | integer | | | ActiveCalls in the Call | | | | Manager | | +--------------------------+-------------------------+-------------------------+ **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: | string | | | SIP\_ | | +--------------+----------------------------------------------------+----------+ | 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: | string | | | MGCP\_ | | +--------------+----------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/call-manager-cisco-snmp.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | Checks the number | call-manager- | | | Devices - Media | and status of | cisco-snmp-media | \_HOSTSNMPCOMMUN | | | Media devices | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTREGISTERED | | | | | \_MEDIA\_WARNING | | | | | | | | | | \_HOSTREGISTERED | | | | | \_MEDIA\_CRITICA | | | | | L | +-------------------+-------------------+-------------------+------------------+ | Call Manager | Checks the number | call-manager- | | | Devices - | and status of | cisco-snmp- | \_HOSTSNMPCOMMUN | | VoiceMails | Voicemail devices | voicemails | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTREGISTERED | | | | | \_VOICEMAIL\_WAR | | | | | NING | | | | | | | | | | \_HOSTREGISTERED | | | | | \_VOICEMAIL\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | Call Manager | Checks the number | call-manager- | | | Devices - CTI | and status of CTI | cisco-snmp-cti | \_HOSTSNMPCOMMUN | | | devices | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTREGISTERED | | | | | \_CTI\_WARNING | | | | | | | | | | \_HOSTREGISTERED | | | | | \_CTI\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Call Manager | Checks the memory | call-manager- | | | Memory Usage | usage | cisco-snmp-memory | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTMEMORY\_WA | | | | | RN | | | | | | | | | | \_HOSTMEMORY\_CR | | | | | IT | +-------------------+-------------------+-------------------+------------------+ | Call Manager | Checks status | call-manager- | | | Status - local | from local Cisco | cisco-snmp-status | \_HOSTSNMPCOMMUN | | | Call Manager | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Call Manager CPU | Checks the CPU | call-manager- | | | Usage | usage | cisco-snmp-cpu | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARN | | | | | | | | | | \_HOSTCPU\_CRIT | +-------------------+-------------------+-------------------+------------------+ | Call Manager | Checks the number | call-manager- | | | Devices - | and status of | cisco-snmp- | \_HOSTSNMPCOMMUN | | Gateways | Gateway devices | gateways | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTREGISTERED | | | | | \_GATEWAYS\_WARN | | | | | ING | | | | | | | | | | \_HOSTREGISTERED | | | | | \_GATEWAYS\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | Call Manager | Checks the number | call-manager- | | | Devices - Phones | and status of | cisco-snmp-phones | \_HOSTSNMPCOMMUN | | | Phone devices | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTREGISTERED | | | | | \_PHONES\_WARNIN | | | | | G | | | | | | | | | | \_HOSTREGISTERED | | | | | \_PHONES\_CRITIC | | | | | AL | +-------------------+-------------------+-------------------+------------------+ | CUCM\_Process\_$K | Checks process | call-manager- | | | EY$ | status | cisco-snmp- | \_HOSTSNMPCOMMUN | | | | processes | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_PROCESSES | +-------------------+-------------------+-------------------+------------------+ **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 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 | string | | | check | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | Device SNMP versions supported | string | | | are: 1 and 2c | | +----------------------------------+---------------------------------+---------+ | \_REGISTERED\_PHONES\_WARNING | Registered Phones warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_REGISTERED\_PHONES\_CRITICAL | Registered Phones critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_REGISTERED\_GATEWAYS\_WARNING | Registered Gateways warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_REGISTERED\_GATEWAYS\_CRITICAL | Registered Gateways critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_REGISTERED\_MEDIA\_WARNING | Registered Media warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_REGISTERED\_MEDIA\_CRITICAL | Registered Media critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_REGISTERED\_CTI\_WARNING | Registered Cti warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_REGISTERED\_CTI\_CRITICAL | Registered Cti critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_REGISTERED\_VOICEMAIL\_WARNING | Registered Voicemails warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_REGISTERED\_VOICEMAIL\_CRITICA | Registered Voicemails critical | integer | | L | threshold | | +----------------------------------+---------------------------------+---------+ | \_CPU\_WARN | CPU usage percent critical | percent | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_CPU\_CRIT | CPU usage percent critical | percent | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_MEMORY\_WARN | Physical memory usage percent | percent | | | warning threshold | | +----------------------------------+---------------------------------+---------+ | \_MEMORY\_CRIT | Physical memory usage percent | percent | | | critical threshold | | +----------------------------------+---------------------------------+---------+ **COMPLEX MACROS** - **_PROCESSES** - **Description:** Processes - **Discover:** wocu-discover-os-resources-processes.py | +------------+-----------------+----------+ | **Fields** | **Description** | **Type** | +============+=================+==========+ | ProcName | Process label | string | +------------+-----------------+----------+ | ProcIndex | Process index | integer | +------------+-----------------+----------+ Cisco-asr-health ^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Hardware checks for Cisco ASR Devices (Fans, Temperature and Powersupply) via snmp .. image:: ../images/packs/pack_icons/cisco-asr-health.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | Checks the | check\_cisco\_asr | | | powersupply | Powersupply | \_health\_powersu | \_HOSTSNMPCOMMUN | | | status | pply | ITY | +-------------------+-------------------+-------------------+------------------+ | Cisco ASR Temp | Checks the temp | check\_cisco\_asr | | | sensors | sensors | \_health\_temp | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTDEVICEVEND | | | | | OR | | | | | | | | | | \_HOSTTEMP\_WARN | | | | | ING | | | | | | | | | | \_HOSTTEMP\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | Cisco ASR fan | Checks the Fans | check\_cisco\_asr | | | sensors | health | \_health\_fan | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTDEVICEVEND | | | | | OR | | | | | | | | | | \_HOSTRPM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTRPM\_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 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 | string | | | device | | +------------------+-------------------------------------------------+---------+ | \_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) .. image:: ../images/packs/pack_icons/cisco-interfaces-advanced-health.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | Checks the | check\_cisco\_int | | | EY$ | interface health | erfaces\_health | \_HOSTSNMPCOMMUN | | | parameters | | 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 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$ -C $_SNMPCOMMUNITY$ -s $_SNMPVERSION$ --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 | string | | | check | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | SNMP version to use in the | string | | | check | | +----------------------------------+---------------------------------+---------+ | \_OVERRUN\_IN\_WARNING\_THRESHOL | Overrun input packets warning | integer | | D | threshold value | | +----------------------------------+---------------------------------+---------+ | \_OVERRUN\_IN\_CRITICAL\_THRESHO | Overrun input packets critical | integer | | LD | threshold value | | +----------------------------------+---------------------------------+---------+ | \_CRC\_IN\_WARNING\_THRESHOLD | CRC error input packets warning | integer | | | threshold value | | +----------------------------------+---------------------------------+---------+ | \_CRC\_IN\_CRITICAL\_THRESHOLD | CRC error input packets | integer | | | critical threshold value | | +----------------------------------+---------------------------------+---------+ | \_GIANTS\_IN\_WARNING\_THRESHOLD | Giant input packets warning | integer | | | threshold value | | +----------------------------------+---------------------------------+---------+ | \_GIANTS\_IN\_CRITICAL\_THRESHOL | Giant input packets critical | integer | | D | threshold value | | +----------------------------------+---------------------------------+---------+ | \_COLLISIONS\_OUT\_WARNING\_THRE | Output collisions warning | integer | | SHOLD | threshold value | | +----------------------------------+---------------------------------+---------+ | \_COLLISIONS\_OUT\_CRITICAL\_THR | Output collisions critical | integer | | ESHOLD | threshold value | | +----------------------------------+---------------------------------+---------+ | \_DROPS\_IN\_WARNING\_THRESHOLD | Input dropped packets warning | integer | | | threshold value | | +----------------------------------+---------------------------------+---------+ | \_DROPS\_IN\_CRITICAL\_THRESHOLD | Input dropped packets critical | integer | | | threshold value | | +----------------------------------+---------------------------------+---------+ | \_DROPS\_OUT\_WARNING\_THRESHOLD | Output dropped packets warning | integer | | | threshold value | | +----------------------------------+---------------------------------+---------+ | \_DROPS\_OUT\_CRITICAL\_THRESHOL | Output dropped packets critical | integer | | D | threshold value | | +----------------------------------+---------------------------------+---------+ **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 | string | | | ifDescr) | | +------------+------------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/cisco-wifi-controller.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_cpu | Checks the | check\_cpu\_cisco | | | | controller CPU | \_wifi\_controlle | \_HOSTSNMPCOMMUN | | | usage | r | ITY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL\_THRESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | AP\_count | Checks the number | check\_ap\_count\ | | | | of connected | _cisco\_wifi\_con | \_HOSTSNMPCOMMUN | | | Access Points | troller | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTAPS\_CONNE | | | | | CTED\_WARNING\_T | | | | | HRESHOLD | | | | | | | | | | \_HOSTAPS\_CONNE | | | | | CTED\_CRITICAL\_ | | | | | THRESHOLD | +-------------------+-------------------+-------------------+------------------+ | AP\_status $KEY$ | Checks the Access | check\_ap\_status | | | | Point status | \_cisco\_wifi\_co | \_HOSTSNMPCOMMUN | | | | ntroller | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CISCO\_APLIST | +-------------------+-------------------+-------------------+------------------+ | Controller\_temp | Checks the | check\_temp\_cisc | | | | controller | o\_wifi\_controll | \_HOSTSNMPCOMMUN | | | temperature | er | ITY | | | | | | | | | | \_HOSTTEMP\_DEFA | | | | | ULT\_HIGH | | | | | | | | | | \_HOSTTEMP\_DEFA | | | | | ULT\_LOW | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Channel\_utilizat | Checks the Radio | check\_channel\_u | | | ion $KEY$ | Channel | til\_cisco\_wifi\ | \_HOSTSNMPCOMMUN | | | utilization | _controller | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTCHANNEL\_U | | | | | TIL\_WARNING\_TH | | | | | RESHOLD | | | | | | | | | | \_HOSTCHANNEL\_U | | | | | TIL\_CRITICAL\_T | | | | | HRESHOLD | | | | | | | | | | \_CISCO\_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Controller\_info | Shows controller | check\_info\_cisc | | | | info | o\_wifi\_controll | \_HOSTSNMPCOMMUN | | | | er | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | AP\_radio\_client | Checks the | check\_ap\_radio\ | | | s $KEY$ | clients per Radio | _clients\_cisco\_ | \_HOSTSNMPCOMMUN | | | Channel | wifi\_controller | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTAP\_RADIO\ | | | | | _CLIENTS\_DEFAUL | | | | | T\_WARNING | | | | | | | | | | \_HOSTAP\_RADIO\ | | | | | _CLIENTS\_DEFAUL | | | | | T\_CRITICAL | | | | | | | | | | \_CISCO\_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Controller\_essid | Shows the WLAN | check\_essid\_cis | | | | ESSIDs published | co\_wifi\_control | \_HOSTSNMPCOMMUN | | | in the controller | ler | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Channel\_interfer | Checks the Radio | check\_channel\_i | | | ence $KEY$ | Channel | nterf\_cisco\_wif | \_HOSTSNMPCOMMUN | | | interference | i\_controller | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTAPS\_CHANN | | | | | EL\_INTERFERENCE | | | | | \_WARNING\_THRES | | | | | HOLD | | | | | | | | | | \_HOSTAPS\_CHANN | | | | | EL\_INTERFERENCE | | | | | \_CRITICAL\_THRE | | | | | SHOLD | | | | | | | | | | \_CISCO\_CHLIST | +-------------------+-------------------+-------------------+------------------+ | Controller\_power | Checks the | check\_power\_sup | | | \_supply | controller | ply\_cisco\_wifi\ | \_HOSTSNMPCOMMUN | | | powersupply | _controller | ITY | | | status | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | AP\_info $KEY$ | Shows info from | check\_ap\_info\_ | | | | Access Point | cisco\_wifi\_cont | \_HOSTSNMPCOMMUN | | | | roller | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CISCO\_APLIST | +-------------------+-------------------+-------------------+------------------+ | WLAN\_Clients | Checks the number | check\_wlan\_clie | | | | of clients per | nts\_cisco\_wifi\ | \_HOSTSNMPCOMMUN | | | WLAN | _controller | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTWLAN\_CLIE | | | | | NTS\_DEFAULT\_WA | | | | | RNING | | | | | | | | | | \_HOSTWLAN\_CLIE | | | | | NTS\_DEFAULT\_CR | | | | | ITICAL | +-------------------+-------------------+-------------------+------------------+ | AP\_clients $KEY$ | Checks the | check\_ap\_client | | | | clients per | s\_cisco\_wifi\_c | \_HOSTSNMPCOMMUN | | | Access Point | ontroller | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTAP\_CLIENT | | | | | S\_WARNING\_THRE | | | | | SHOLD | | | | | | | | | | \_HOSTAP\_CLIENT | | | | | S\_CRITICAL\_THR | | | | | ESHOLD | | | | | | | | | | \_CISCO\_APLIST | +-------------------+-------------------+-------------------+------------------+ | Client\_count | Checks the total | check\_client\_co | | | | number of clients | unt\_cisco\_wifi\ | \_HOSTSNMPCOMMUN | | | | _controller | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTCLIENT\_CO | | | | | UNT\_DEFAULT\_WA | | | | | RNING | | | | | | | | | | \_HOSTCLIENT\_CO | | | | | UNT\_DEFAULT\_CR | | | | | ITICAL | +-------------------+-------------------+-------------------+------------------+ | Controller\_memor | Checks the | check\_mem\_cisco | | | y | controller memory | \_wifi\_controlle | \_HOSTSNMPCOMMUN | | | usage | r | ITY | | | | | | | | | | \_HOSTMEM\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL\_THRESHOLD | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Client\_SNR\_avg | Checks the | check\_client\_sn | | | $KEY$ | average Signal to | r\_avg\_cisco\_wi | \_HOSTSNMPCOMMUN | | | Noise Ratio per | fi\_controller | ITY | | | Radio Channel | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTCLIENT\_SN | | | | | R\_AVG\_WARNING\ | | | | | _THRESHOLD | | | | | | | | | | \_HOSTCLIENT\_SN | | | | | R\_AVG\_CRITICAL | | | | | \_THRESHOLD | | | | | | | | | | \_CISCO\_CHLIST | +-------------------+-------------------+-------------------+------------------+ | AP\_radio\_info | Shows info of the | check\_ap\_radio\ | | | $KEY$ | Radio Channels | _info\_cisco\_wif | \_HOSTSNMPCOMMUN | | | | i\_controller | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CISCO\_CHLIST | +-------------------+-------------------+-------------------+------------------+ | AP\_noise\_power | Checks the | check\_ap\_noise\ | | | $KEY$ | average noise | _power\_cisco\_wi | \_HOSTSNMPCOMMUN | | | power in dBm on | fi\_controller | ITY | | | each channel per | | | | | AP | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTAPS\_CHANN | | | | | EL\_NOISE\_POWER | | | | | \_WARNING\_THRES | | | | | HOLD | | | | | | | | | | \_HOSTAPS\_CHANN | | | | | EL\_NOISE\_POWER | | | | | \_CRITICAL\_THRE | | | | | SHOLD | | | | | | | | | | \_CISCO\_APLIST | +-------------------+-------------------+-------------------+------------------+ **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 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 | string | | | check | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | SNMP version to use in the | string | | | check | | +----------------------------------+---------------------------------+---------+ | \_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 | APs connected warning threshold | integer | | HOLD | | | +----------------------------------+---------------------------------+---------+ | \_APS\_CONNECTED\_CRITICAL\_THRE | APs connected critical | integer | | SHOLD | threshold | | +----------------------------------+---------------------------------+---------+ | \_AP\_CLIENTS\_WARNING\_THRESHOL | Connected clients warning | integer | | D | threshold | | +----------------------------------+---------------------------------+---------+ | \_AP\_CLIENTS\_CRITICAL\_THRESHO | Connected clients critical | integer | | LD | threshold | | +----------------------------------+---------------------------------+---------+ | \_CHANNEL\_UTIL\_WARNING\_THRESH | Channel utilization warning | percent | | OLD | threshold | | +----------------------------------+---------------------------------+---------+ | \_CHANNEL\_UTIL\_CRITICAL\_THRES | Channel utilization critical | percent | | HOLD | threshold | | +----------------------------------+---------------------------------+---------+ | \_CLIENT\_SNR\_AVG\_WARNING\_THR | Average client SNR warning | integer | | ESHOLD | threshold | | +----------------------------------+---------------------------------+---------+ | \_CLIENT\_SNR\_AVG\_CRITICAL\_TH | Average client SNR critical | integer | | RESHOLD | threshold | | +----------------------------------+---------------------------------+---------+ | \_APS\_CHANNEL\_NOISE\_POWER\_CR | APs channel noise power | integer | | ITICAL\_THRESHOLD | | | +----------------------------------+---------------------------------+---------+ | \_APS\_CHANNEL\_NOISE\_POWER\_WA | APs channel interference | integer | | RNING\_THRESHOLD | | | +----------------------------------+---------------------------------+---------+ | \_APS\_CHANNEL\_INTERFERENCE\_WA | APs channel interference | integer | | RNING\_THRESHOLD | | | +----------------------------------+---------------------------------+---------+ | \_APS\_CHANNEL\_INTERFERENCE\_CR | APs channel interference | integer | | ITICAL\_THRESHOLD | | | +----------------------------------+---------------------------------+---------+ | \_TEMP\_DEFAULT\_HIGH | Controller temperature high | integer | | | threshold (Celsius) | | +----------------------------------+---------------------------------+---------+ | \_TEMP\_DEFAULT\_LOW | Controller temperature low | integer | | | threshold (Celsius) | | +----------------------------------+---------------------------------+---------+ | \_CLIENT\_COUNT\_DEFAULT\_WARNIN | Controller client count warning | integer | | G | threshold | | +----------------------------------+---------------------------------+---------+ | \_CLIENT\_COUNT\_DEFAULT\_CRITIC | Controller client count | integer | | AL | critical threshold | | +----------------------------------+---------------------------------+---------+ | \_WLAN\_CLIENTS\_DEFAULT\_WARNIN | WLAN client count warning | integer | | G | threshold | | +----------------------------------+---------------------------------+---------+ | \_WLAN\_CLIENTS\_DEFAULT\_CRITIC | WLAN client count critical | integer | | AL | threshold | | +----------------------------------+---------------------------------+---------+ | \_AP\_RADIO\_CLIENTS\_DEFAULT\_W | WLAN client count warning | integer | | ARNING | threshold | | +----------------------------------+---------------------------------+---------+ | \_AP\_RADIO\_CLIENTS\_DEFAULT\_C | WLAN client count critical | integer | | RITICAL | threshold | | +----------------------------------+---------------------------------+---------+ **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 | string | | | Slot1. Used for snmp queries | | +--------------+----------------------------------------------------+----------+ F5-health ^^^^^^^^^ **DESCRIPTION** ---------------------- Hardware checks for F5 BIGIP Devices (Fans, Temperature and PowerSupply) via snmp .. image:: ../images/packs/pack_icons/f5-health.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 Temp | Checks hardware | check\_f5\_health\ | | | | temperature(s) | _temp | \_HOSTSNMPCOMMUNI | | | | | TY | | | | | | | | | | \_HOSTTEMP\_WARNI | | | | | NG | | | | | | | | | | \_HOSTTEMP\_CRITI | | | | | CAL | +----------------+--------------------+--------------------+-------------------+ | F5 Fan | Checks Fan(s) | check\_f5\_health\ | | | | status | _fan | \_HOSTSNMPCOMMUNI | | | | | TY | | | | | | | | | | \_HOSTRPM\_WARNIN | | | | | G | | | | | | | | | | \_HOSTRPM\_CRITIC | | | | | AL | +----------------+--------------------+--------------------+-------------------+ | F5 PowerSupply | Checks | check\_f5\_health\ | | | | PowerSupply(s) | _powersupply | \_HOSTSNMPCOMMUNI | | | status | | 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 | string | | | device | | +------------------+-------------------------------------------------+---------+ | \_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 | +------------------+-------------------------------------------------+---------+ Health-cisco ^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Check hardware health status of cisco devices .. image:: ../images/packs/pack_icons/health-cisco.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | check-cisco-health | | | | of hardware | | \_HOSTSNMPCOMMUNIT | | | sensors | | 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$ | string | | | for the default system community | | +-----------------+---------------------------------------------------+--------+ **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 .. image:: ../images/packs/pack_icons/hsrp-cisco.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | check\_hsrp\_stat | | | $ | status | 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 | string | | | clustering : number of members, max % assigned to | | | | nodes. Other : check HSRP interface to be master | | | | or backup | | +-----------------+---------------------------------------------------+--------+ Infinera-edu ^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for Infinera EDU devices using SNMP .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | Infinera-edu temp | Checks hardware | check\_infinera\_ | | | | temperature | edu\_temp | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTTEMP\_WARN | | | | | ING | | | | | | | | | | \_HOSTTEMP\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | Port\_drops\_$KEY | Checks dropped | check\_infinera\_ | | | $ | packets | edu\_port\_drops | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTDROPS\_WAR | | | | | NING | | | | | | | | | | \_HOSTDROPS\_CRI | | | | | TICAL | | | | | | | | | | \_INFINERA\_PORT | | | | | S\_LIST | +-------------------+-------------------+-------------------+------------------+ | Layer1\_rate\_$KE | Checks the Layer | check\_infinera\_ | | | Y$ | 1 traffic rate | edu\_l1\_rate | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTLAYER1\_RA | | | | | TE\_WARNING | | | | | | | | | | \_HOSTLAYER1\_RA | | | | | TE\_CRITICAL | | | | | | | | | | \_INFINERA\_PORT | | | | | S\_LIST | +-------------------+-------------------+-------------------+------------------+ | Layer2\_rate\_$KE | Checks the Layer | check\_infinera\_ | | | Y$ | 2 traffic rate | edu\_l2\_rate | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTLAYER2\_RA | | | | | TE\_WARNING | | | | | | | | | | \_HOSTLAYER2\_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 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 | integer | | | Celsius) | | +--------------------------+-----------------------------------------+---------+ | \_TEMP\_CRITICAL | Temperature critical threshold (in | integer | | | Celsius) | | +--------------------------+-----------------------------------------+---------+ | \_DROPS\_WARNING | Packet drops increase warning threshold | integer | +--------------------------+-----------------------------------------+---------+ | \_DROPS\_CRITICAL | Packet drops increase critical | integer | | | threshold | | +--------------------------+-----------------------------------------+---------+ | \_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 | string | | | web interface | | +---------------+---------------------------------------------------+----------+ | 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 :ref:`packs-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\ | Checks dropped | check\_infinera\_ | | | _$KEY$ | packets | xtm\_ifaces\_drop | \_HOSTSNMPCOMMUN | | | | s | 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 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 | integer | | | threshold | | +-----------------------------+--------------------------------------+---------+ | \_DROPPED\_BYTES\_CRITICAL | Dropped byte increase critical | integer | | | threshold | | +-----------------------------+--------------------------------------+---------+ | \_DROPPED\_FRAMES\_WARNING | Dropped frame increase warning | integer | | | threshold | | +-----------------------------+--------------------------------------+---------+ | \_DROPPED\_FRAMES\_CRITICAL | Dropped frame increase critical | integer | | | threshold | | +-----------------------------+--------------------------------------+---------+ **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 | string | | | web interface | | +---------------+---------------------------------------------------+----------+ | index | Index of Infinera interface (integer) | integer | +---------------+---------------------------------------------------+----------+ | name | Name of interface | string | +---------------+---------------------------------------------------+----------+ Infoblox ^^^^^^^^ **DESCRIPTION** ---------------------- Health and performance checks for Infoblox devices via snmp .. image:: ../images/packs/pack_icons/infoblox.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | check\_infoblox\_ip | | | | addresses of this | | \_HOSTSNMPCOMMUNIT | | | appliance | | Y | | | | | | | | | | \_HOSTCPU\_WARNING | | | | | \_THRESHOLD | | | | | | | | | | \_HOSTCPU\_CRITICA | | | | | L\_THRESHOLD | +-------------+---------------------+---------------------+--------------------+ | dns\_stat | Shows DNS | check\_infoblox\_dn | | | | statistics | 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 | +-------------+---------------------+---------------------+--------------------+ | memory | Checks memory usage | check\_infoblox\_me | | | | | m | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTMEM\_WARNING | | | | | \_THRESHOLD | | | | | | | | | | \_HOSTMEM\_CRITICA | | | | | L\_THRESHOLD | +-------------+---------------------+---------------------+--------------------+ | temperature | Checks the | check\_infoblox\_te | | | | temperature of the | mp | \_HOSTSNMPCOMMUNIT | | | appliance | | Y | | | | | | | | | | \_HOSTTEMP\_WARNIN | | | | | G\_THRESHOLD | | | | | | | | | | \_HOSTTEMP\_CRITIC | | | | | AL\_THRESHOLD | +-------------+---------------------+---------------------+--------------------+ | ha\_state | Checks High | check\_infoblox\_ha | | | | Availability (HA) | | \_HOSTSNMPCOMMUNIT | | | status | | Y | | | | | | | | | | \_HOSTCPU\_WARNING | | | | | \_THRESHOLD | | | | | | | | | | \_HOSTCPU\_CRITICA | | | | | L\_THRESHOLD | | | | | | | | | | \_HOSTHA\_LOCAL\_S | | | | | TATE | +-------------+---------------------+---------------------+--------------------+ | Info | Shows general | check\_infoblox\_in | | | | information about | fo | \_HOSTSNMPCOMMUNIT | | | this appliance | | Y | | | | | | | | | | \_HOSTCPU\_WARNING | | | | | \_THRESHOLD | | | | | | | | | | \_HOSTCPU\_CRITICA | | | | | L\_THRESHOLD | +-------------+---------------------+---------------------+--------------------+ | replication | Checks if | check\_infoblox\_re | | | | replication between | plication | \_HOSTSNMPCOMMUNIT | | | Infoblox appliances | | Y | | | is working | | | | | | | \_HOSTMEM\_WARNING | | | | | \_THRESHOLD | | | | | | | | | | \_HOSTMEM\_CRITICA | | | | | L\_THRESHOLD | +-------------+---------------------+---------------------+--------------------+ | dhcp\_stat | Shows DHCP | check\_infoblox\_dh | | | | statistics | cp | \_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 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 | string | | | the linux server | | +-----------------------------+--------------------------------------+---------+ | \_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 | percent | | | (percentage) | | +-----------------------------+--------------------------------------+---------+ | \_MEM\_CRITICAL\_THRESHOLD | Memory critical threshold | percent | | | (percentage) | | +-----------------------------+--------------------------------------+---------+ | \_TEMP\_WARNING\_THRESHOLD | Temperature warning threshold | integer | | | (Celsius degrees) | | +-----------------------------+--------------------------------------+---------+ | \_TEMP\_CRITICAL\_THRESHOLD | Temperature critical threshold | integer | | | (Celsius degrees) | | +-----------------------------+--------------------------------------+---------+ | \_CHECK\_DOMAIN | Check Domain | string | +-----------------------------+--------------------------------------+---------+ Ipsla-cisco ^^^^^^^^^^^ **DESCRIPTION** ---------------------- Check IPSLA rules (Jitter/RTT/Packets) in Cisco devices .. image:: ../images/packs/pack_icons/ipsla-cisco.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | check\_cisco\_ipsl | | | | and metrics of | a | \_HOSTSNMPCOMMUNIT | | | IPSLA sessions | | 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 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 | string | | | interface | | +-------------------------+------------------------------------+---------------+ | index | Index for snmp queries | integer | +-------------------------+------------------------------------+---------------+ | jitter\_critical | Critical threshold for the average | integer | | | of positive and negative jitter | | | | values in SD and DS direction for | | | | latest operation | | +-------------------------+------------------------------------+---------------+ | jitter\_warning | Warning threshold for the average | integer | | | of positive and negative jitter | | | | values in SD and DS direction for | | | | latest operation | | +-------------------------+------------------------------------+---------------+ | percent\_loss\_critical | Critical threshold for percent | float.percent | | | packet loss (SD + DS) | | +-------------------------+------------------------------------+---------------+ | name | Name to be shown in the web | string | | | interface | | +-------------------------+------------------------------------+---------------+ | percent\_loss\_warning | Warning threshold for percent | float.percent | | | packet loss (SD + DS) | | +-------------------------+------------------------------------+---------------+ | rtt\_critical | Critical threshold for completion | integer | | | time of the latest RTT operation | | | | successfully completed | | +-------------------------+------------------------------------+---------------+ | rtt\_warning | Warning threshold for completion | integer | | | time of the latest RTT operation | | | | successfully completed | | +-------------------------+------------------------------------+---------------+ | mos\_critical | Critical threshold for Mean | integer | | | Opinion Scores (MOS) | | +-------------------------+------------------------------------+---------------+ | mos\_warning | Warning threshold for Mean Opinion | integer | | | Scores (MOS) | | +-------------------------+------------------------------------+---------------+ Meraki-device ^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Pack for checking Meraki devices using Dashboard API .. image:: ../images/packs/pack_icons/meraki-device.png :align: center :scale: 50% 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 :ref:`packs-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\_C | Checks the CPU | check\_meraki\_de | | | PU | usage | vice\_cpu | \_HOSTAPIKEY | | | | | | | | | | \_HOSTORGID | | | | | | | | | | \_HOSTNETWORKID | | | | | | | | | | \_HOSTSERIAL | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL\_THRESHOLD | +-------------------+-------------------+-------------------+------------------+ | Meraki\_device\_U | Checks the USB | check\_meraki\_de | | | SB\_Status | port status | vice\_usb\_status | \_HOSTAPIKEY | | | | | | | | | | \_HOSTORGID | | | | | | | | | | \_HOSTNETWORKID | | | | | | | | | | \_HOSTSERIAL | +-------------------+-------------------+-------------------+------------------+ **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 | string | | | device | | +----------------------------+---------------------------------------+---------+ | \_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 :ref:`packs-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 | Checks hardware | check\_mikrotik\_ | | | temperature | temperature | temp | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTTEMP\_WARN | | | | | ING | | | | | | | | | | \_HOSTTEMP\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | Mikrotik mem | Checks Memory | check\_mikrotik\_ | | | usage | usage percent | mem | \_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 | The snmp community read configured on | string | | | remote device | | +------------------------+-------------------------------------------+---------+ | \_TEMP\_WARNING | Temperature warning threshold (in | integer | | | Celsius) | | +------------------------+-------------------------------------------+---------+ | \_TEMP\_CRITICAL | Temperature critical threshold (in | integer | | | Celsius) | | +------------------------+-------------------------------------------+---------+ | \_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 .. image:: ../images/packs/pack_icons/networkdevice-adsl-metrics.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_Traffic\_$K | Checks Line usage | check\_adsl\_metr | | | EY$ | percent in ADSL | ics\_traffic | \_HOSTSNMPCOMMUN | | | associated | | ITY | | | interfaces | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTADSL\_TRAF | | | | | FIC\_WARNING | | | | | | | | | | \_HOSTADSL\_TRAF | | | | | FIC\_CRITICAL | | | | | | | | | | \_ADSL\_METRICS\ | | | | | _LIST | +-------------------+-------------------+-------------------+------------------+ | ADSL\_Channels\_T | Checks ATU-C and | check\_adsl\_metr | | | X\_Rates\_$KEY$ | ATU-R TX rates in | ics\_rates | \_HOSTSNMPCOMMUN | | | ADSL interfaces | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_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 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 | string | | | remote device | | +---------------------------+----------------------------------------+---------+ | \_SNMPVERSION | The snmp version on remote device | string | +---------------------------+----------------------------------------+---------+ | \_ADSL\_TRAFFIC\_WARNING | Traffic warning threshold (percentage) | percent | +---------------------------+----------------------------------------+---------+ | \_ADSL\_TRAFFIC\_CRITICAL | Traffic critical threshold | percent | | | (percentage) | | +---------------------------+----------------------------------------+---------+ **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 | string | | | service description | | +------------------+------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/networkdevice-available-ports.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | wocu-check-available- | | | | | ports | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTAVAILABLE\_POR | | | | | TS\_WARNING\_THRESHO | | | | | LD | | | | | | | | | | \_HOSTAVAILABLE\_POR | | | | | TS\_CRITICAL\_THRESH | | | | | OLD | +-----------------+-------------+-----------------------+----------------------+ **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 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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | Device SNMP, versions supported | string | | | are: 1 and 2c | | +----------------------------------+---------------------------------+---------+ | \_AVAILABLE\_PORTS\_WARNING\_THR | warning threshold of available | percent | | ESHOLD | ports in the device | | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_AVAILABLE\_PORTS\_CRITICAL\_TH | critical threshold of available | percent | | RESHOLD | ports in the device | | | | (percentage) | | +----------------------------------+---------------------------------+---------+ Networkdevice-cpu ^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device cpu checks .. image:: ../images/packs/pack_icons/networkdevice-cpu.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | wocu-check-cpu | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTDEVICEVENDOR | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTCPU\_WARNING\_THRESHOLD | | | | | | | | | | \_HOSTCPU\_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 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 | string | | | $SNMPCOMMUNITYREAD$ for the default | | | | system community | | +----------------------------+---------------------------------------+---------+ | \_SNMPVERSION | Device SNMP version, supported 1 and | string | | | 2c | | +----------------------------+---------------------------------------+---------+ | \_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) .. image:: ../images/packs/pack_icons/networkdevice-cpu-1m.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | wocu-check-cpu-1m | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTDEVICEVENDOR | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTCPU\_1M\_WARNING\_THRESHOL | | | | | D | | | | | | | | | | \_HOSTCPU\_1M\_CRITICAL\_THRESHO | | | | | LD | +---------+-------------+-------------------+----------------------------------+ **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 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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +--------------------------------+-----------------------------------+---------+ | \_SNMPVERSION | Device SNMP version, supported 1 | string | | | and 2c | | +--------------------------------+-----------------------------------+---------+ | \_DEVICEVENDOR | Device vendor | string | +--------------------------------+-----------------------------------+---------+ | \_CPU\_1M\_WARNING\_THRESHOLD | CPU warning threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_CPU\_1M\_CRITICAL\_THRESHOLD | CPU critical threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ Networkdevice-cpu-snmp3 ^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device cpu checks (only snmp version 3) .. image:: ../images/packs/pack_icons/networkdevice-cpu-snmp3.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | wocu-check-cpu-snmp3 | | | | | | \_HOSTSNMP3USERNAME | | | | | | | | | | \_HOSTSNMP3AUTHPASSWORD | | | | | | | | | | \_HOSTSNMP3AUTHPROTOCOL | | | | | | | | | | \_HOSTSNMP3PRIVPASSWORD | | | | | | | | | | \_HOSTSNMP3PRIVPROTOCOL | | | | | | | | | | \_HOSTCPU\_WARNING\_THRESHOLD | | | | | | | | | | \_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 | string | | | model, use $SNMP3USERNAME$ for the | | | | default username | | +----------------------------+---------------------------------------+---------+ | \_SNMP3AUTHPASSWORD | The authentication password, use | string | | | $SNMP3AUTHPASSWORD$ for the default | | | | auth password | | +----------------------------+---------------------------------------+---------+ | \_SNMP3AUTHPROTOCOL | The authentication protocol (md5, | string | | | sha), use $SNMP3AUTHPROTOCOL$ for the | | | | default auth protocol | | +----------------------------+---------------------------------------+---------+ | \_SNMP3PRIVPASSWORD | The password for authPriv security | string | | | level, use $SNMP3PRIVPASSWORD$ for | | | | the default priv password | | +----------------------------+---------------------------------------+---------+ | \_SNMP3PRIVPROTOCOL | The private protocol (des, aes, | string | | | aes128, 3des, 3desde), use | | | | $SNMP3PRIVPROTOCOL$ for the default | | | | priv protocol | | +----------------------------+---------------------------------------+---------+ | \_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 :ref:`packs-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 | check\_networkdev | | | | of all sensors | ice\_hardware\_he | \_HOSTSNMPCOMMUNI | | | detected in the | alth | TY | | | hardware (temp, | | | | | fan, powersupply, | | | | | etc.) | | | +-----------------+--------------------+-------------------+-------------------+ **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 | string | | | device | | +-----------------+---------------------------------------------------+--------+ | \_SNMPVERSION | SNMP version | string | +-----------------+---------------------------------------------------+--------+ Networkdevice-mem ^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device memory checks .. image:: ../images/packs/pack_icons/networkdevice-mem.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | 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 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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +--------------------------------+-----------------------------------+---------+ | \_SNMPVERSION | Device SNMP version, supported 1 | string | | | and 2c | | +--------------------------------+-----------------------------------+---------+ | \_DEVICEVENDOR | Device vendor | string | +--------------------------------+-----------------------------------+---------+ | \_MEMFREE\_WARNING\_THRESHOLD | Memory Free warning threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_MEMFREE\_CRITICAL\_THRESHOLD | Memory Free critical threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ Networkdevice-mem-1m ^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device memory checks (forced to 1m) .. image:: ../images/packs/pack_icons/networkdevice-mem-1m.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | wocu-check-mem-1m | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTDEVICEVENDOR | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTMEMFREE\_1M\_WARNING\_T | | | | | HRESHOLD | | | | | | | | | | \_HOSTMEMFREE\_1M\_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 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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | Device SNMP version, supported | string | | | 1 and 2c | | +----------------------------------+---------------------------------+---------+ | \_DEVICEVENDOR | Device vendor | string | +----------------------------------+---------------------------------+---------+ | \_MEMFREE\_1M\_WARNING\_THRESHOL | Memory warning threshold | percent | | D | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_MEMFREE\_1M\_CRITICAL\_THRESHO | Memory critical threshold | percent | | LD | (percentage) | | +----------------------------------+---------------------------------+---------+ Networkdevice-mem-snmp3 ^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device memory checks (only snmp version 3) .. image:: ../images/packs/pack_icons/networkdevice-mem-snmp3.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | wocu-check-mem-snmp3 | | | | | | \_HOSTSNMP3USERNAME | | | | | | | | | | \_HOSTSNMP3AUTHPASSWORD | | | | | | | | | | \_HOSTSNMP3AUTHPROTOCOL | | | | | | | | | | \_HOSTSNMP3PRIVPASSWORD | | | | | | | | | | \_HOSTSNMP3PRIVPROTOCOL | | | | | | | | | | \_HOSTMEMFREE\_WARNING\_THRESH | | | | | OLD | | | | | | | | | | \_HOSTMEMFREE\_CRITICAL\_THRES | | | | | HOLD | +--------+-------------+----------------------+--------------------------------+ **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 | string | | | security model, use | | | | $SNMP3USERNAME$ for the default | | | | username | | +--------------------------------+-----------------------------------+---------+ | \_SNMP3AUTHPASSWORD | The authentication password, use | string | | | $SNMP3AUTHPASSWORD$ for the | | | | default auth password | | +--------------------------------+-----------------------------------+---------+ | \_SNMP3AUTHPROTOCOL | The authentication protocol (md5, | string | | | sha), use $SNMP3AUTHPROTOCOL$ for | | | | the default auth protocol | | +--------------------------------+-----------------------------------+---------+ | \_SNMP3PRIVPASSWORD | The password for authPriv | string | | | security level, use | | | | $SNMP3PRIVPASSWORD$ for the | | | | default priv password | | +--------------------------------+-----------------------------------+---------+ | \_SNMP3PRIVPROTOCOL | The private protocol (des, aes, | string | | | aes128, 3des, 3desde), use | | | | $SNMP3PRIVPROTOCOL$ for the | | | | default priv protocol | | +--------------------------------+-----------------------------------+---------+ | \_MEMFREE\_WARNING\_THRESHOLD | Memory Free warning threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_MEMFREE\_CRITICAL\_THRESHOLD | Memory Free critical threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ Networkdevice-mobile-signal ^^^^^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks mobile signal strength/quality metrics in 3G/4G routers .. image:: ../images/packs/pack_icons/networkdevice-mobile-signal.png :align: center :scale: 50% 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 :ref:`packs-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\_hea | | check\_mobile\_sign | | | lth\_$KEY$ | | al\_health | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTDEVICEVENDOR | | | | | | | | | | \_MOBILE\_SIGNAL\_ | | | | | LIST | +---------------------+-------------+---------------------+--------------------+ | Mobile\_signal\_inf | | check\_mobile\_sign | | | o\_$KEY$ | | al\_info | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTDEVICEVENDOR | | | | | | | | | | \_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 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 | string | | | description | | +------------+------------------------------------------------------+----------+ | index | Cellular mobile index | integer | +------------+------------------------------------------------------+----------+ | tech\_warn | Technology warning threshold: From 1 (worst) to 13 | integer | | | (best) | | +------------+------------------------------------------------------+----------+ | tech\_crit | Technology critical threshold: From 1 (worst) to 13 | integer | | | (best) | | +------------+------------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/networkdevice-ping.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | wocu-check-ping | | | | | | \_HOSTRTA\_WARNING\_THRESHOLD | | | | | | | | | | \_HOSTPL\_WARNING\_THRESHOLD | | | | | | | | | | \_HOSTRTA\_CRITICAL\_THRESHOLD | | | | | | | | | | \_HOSTPL\_CRITICAL\_THRESHOLD | | | | | | | | | | \_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 | integer | | | (miliseconds) | | +----------------------------+---------------------------------------+---------+ | \_RTA\_CRITICAL\_THRESHOLD | Round trip average critical threshold | integer | | | (miliseconds) | | +----------------------------+---------------------------------------+---------+ | \_PL\_WARNING\_THRESHOLD | Packet lost warning threshold | percent | | | (percentage) | | +----------------------------+---------------------------------------+---------+ | \_PL\_CRITICAL\_THRESHOLD | Packet lost critical threshold | percent | | | (percentage) | | +----------------------------+---------------------------------------+---------+ Networkdevice-ping-1m ^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device ping check (forced to 1 minute) .. image:: ../images/packs/pack_icons/networkdevice-ping-1m.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | wocu-check-ping-1m | | | | | | \_HOSTRTA\_WARNING\_THRESHOLD | | | | | | | | | | \_HOSTPL\_WARNING\_THRESHOLD | | | | | | | | | | \_HOSTRTA\_CRITICAL\_THRESHOLD | | | | | | | | | | \_HOSTPL\_CRITICAL\_THRESHOLD | | | | | | | | | | \_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 | integer | | | (miliseconds) | | +----------------------------+---------------------------------------+---------+ | \_RTA\_CRITICAL\_THRESHOLD | Round trip average critical threshold | integer | | | (miliseconds) | | +----------------------------+---------------------------------------+---------+ | \_PL\_WARNING\_THRESHOLD | Packet lost warning threshold | percent | | | (percentage) | | +----------------------------+---------------------------------------+---------+ | \_PL\_CRITICAL\_THRESHOLD | Packet lost critical threshold | percent | | | (percentage) | | +----------------------------+---------------------------------------+---------+ Networkdevice-route-count ^^^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Get the number of valid routes using SNMP .. image:: ../images/packs/pack_icons/networkdevice-route-count.png :align: center :scale: 50% 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 :ref:`packs-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\_routes | | check\_networkdevic | | | | | e\_route\_count\_nu | \_HOSTSNMPVERSION | | | | mber | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTROUTES\_WARN | | | | | ING | | | | | | | | | | \_HOSTROUTES\_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 | string | +--------------------+-----------------------------------------------+---------+ | \_SNMPVERSION | SNMP version | string | +--------------------+-----------------------------------------------+---------+ | \_ROUTES\_WARNING | Warning threshold for minimum number of valid | integer | | | routes | | +--------------------+-----------------------------------------------+---------+ | \_ROUTES\_CRITICAL | Critical threshold for minimum number of | integer | | | valid routes | | +--------------------+-----------------------------------------------+---------+ Networkdevice-traffic ^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device traffic checks .. image:: ../images/packs/pack_icons/networkdevice-traffic.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | wocu-check-traffic | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTTRAFFIC\_WARNING\_ | | | | | THRESHOLD | | | | | | | | | | \_HOSTTRAFFIC\_CRITICAL\ | | | | | _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 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$ -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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +--------------------------------+-----------------------------------+---------+ | \_SNMPVERSION | Device SNMP version, supported 1 | string | | | and 2c | | +--------------------------------+-----------------------------------+---------+ | \_DEVICEVENDOR | Device vendor | string | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_WARNING\_THRESHOLD | Traffic warning threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_CRITICAL\_THRESHOLD | Traffic critical threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ **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 | string | | | the service description | | +---------------+---------------------------------------------------+----------+ | index | Interface index (unique) | integer | +---------------+---------------------------------------------------+----------+ | max speed in | Interface maximum speed in {units} per second. | integer | | | Applied to IN traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | max speed out | Interface maximum speed in {units} per second. | integer | | | Applied to OUT traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | units | Speed units (g=gigabits/s, m=megabits/s, | string | | | k=kilobits/s ,b=bits/s) | | +---------------+---------------------------------------------------+----------+ | alias | Interface alias (ifAlias) to be shown as | string | | | alternative display name | | +---------------+---------------------------------------------------+----------+ Networkdevice-traffic-1m ^^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device traffic checks .. image:: ../images/packs/pack_icons/networkdevice-traffic-1m.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | wocu-check- | | | | | traffic-1m | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTTRAFFIC\_1M\_ | | | | | WARNING\_THRESHOLD | | | | | | | | | | \_HOSTTRAFFIC\_1M\_ | | | | | CRITICAL\_THRESHOLD | | | | | | | | | | \_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 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$ -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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | Device SNMP versions supported | string | | | are: 1 and 2c | | +----------------------------------+---------------------------------+---------+ | \_DEVICEVENDOR | Device vendor | string | +----------------------------------+---------------------------------+---------+ | \_TRAFFIC\_1M\_WARNING\_THRESHOL | Traffic warning threshold | percent | | D | | | +----------------------------------+---------------------------------+---------+ | \_TRAFFIC\_1M\_CRITICAL\_THRESHO | Traffic critical threshold | percent | | LD | | | +----------------------------------+---------------------------------+---------+ **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 | string | | | the service description | | +---------------+---------------------------------------------------+----------+ | index | Interface index | integer | +---------------+---------------------------------------------------+----------+ | max speed in | Interface maximum speed in {units} per second. | integer | | | Applied to IN traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | max speed out | Interface maximum speed in {units} per second. | integer | | | Applied to OUT traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | units | Speed units (g=gigabits/s, m=megabits/s, | string | | | k=kilobits/s ,b=bits/s) | | +---------------+---------------------------------------------------+----------+ | alias | Interface alias (ifAlias) to be shown as | string | | | alternative display name | | +---------------+---------------------------------------------------+----------+ Networkdevice-traffic-all ^^^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device traffic and health checks .. image:: ../images/packs/pack_icons/networkdevice-traffic-all.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | networkdevice- | | | | | traffic-all-traffic | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTTRAFFIC\_WAR | | | | | NING\_THRESHOLD | | | | | | | | | | \_HOSTTRAFFIC\_CRI | | | | | TICAL\_THRESHOLD | | | | | | | | | | \_TRAFFIC\_ALL\_IF | | | | | ACES | +---------------------+-------------+---------------------+--------------------+ | Interface\_Errors\_ | | networkdevice- | | | $KEY$ | | traffic-all-errors | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTERROR\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTERROR\_CRITI | | | | | CAL\_THRESHOLD | | | | | | | | | | \_TRAFFIC\_ALL\_IF | | | | | ACES | +---------------------+-------------+---------------------+--------------------+ | Interface\_Discards | | networkdevice- | | | \_$KEY$ | | traffic-all- | \_HOSTSNMPCOMMUNIT | | | | discards | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTDISCARD\_WAR | | | | | NING\_THRESHOLD | | | | | | | | | | \_HOSTDISCARD\_CRI | | | | | TICAL\_THRESHOLD | | | | | | | | | | \_TRAFFIC\_ALL\_IF | | | | | ACES | +---------------------+-------------+---------------------+--------------------+ **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 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$ -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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +--------------------------------+-----------------------------------+---------+ | \_SNMPVERSION | Device SNMP version, supported 1 | string | | | and 2c | | +--------------------------------+-----------------------------------+---------+ | \_DEVICEVENDOR | Device vendor | string | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_WARNING\_THRESHOLD | Traffic warning threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_CRITICAL\_THRESHOLD | Traffic critical threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_DISCARD\_WARNING\_THRESHOLD | Interface discards warning | integer | | | threshold (packets/s) | | +--------------------------------+-----------------------------------+---------+ | \_DISCARD\_CRITICAL\_THRESHOLD | Interface discards critical | integer | | | threshold (packets/s) | | +--------------------------------+-----------------------------------+---------+ | \_ERROR\_WARNING\_THRESHOLD | Interface errors warning | integer | | | threshold (packets/s) | | +--------------------------------+-----------------------------------+---------+ | \_ERROR\_CRITICAL\_THRESHOLD | Interface errors critical | integer | | | threshold (packets/s) | | +--------------------------------+-----------------------------------+---------+ **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 | string | | | the service description | | +---------------+---------------------------------------------------+----------+ | index | Interface index (unique) | integer | +---------------+---------------------------------------------------+----------+ | max speed in | Interface maximum speed in {units} per second. | integer | | | Applied to IN traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | max speed out | Interface maximum speed in {units} per second. | integer | | | Applied to OUT traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | units | Speed units (g=gigabits/s, m=megabits/s, | string | | | k=kilobits/s ,b=bits/s) | | +---------------+---------------------------------------------------+----------+ | alias | Interface alias (ifAlias) to be shown as | string | | | alternative display name | | +---------------+---------------------------------------------------+----------+ Networkdevice-traffic-all-1m ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device traffic and health checks. Check interval 1 minute .. image:: ../images/packs/pack_icons/networkdevice-traffic-all-1m.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | networkdevice- | | | | | traffic-all- | \_HOSTSNMPCOMMUNIT | | | | traffic-1m | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTTRAFFIC\_WAR | | | | | NING\_THRESHOLD | | | | | | | | | | \_HOSTTRAFFIC\_CRI | | | | | TICAL\_THRESHOLD | | | | | | | | | | \_TRAFFIC\_ALL\_IF | | | | | ACES\_1M | +---------------------+-------------+---------------------+--------------------+ | Interface\_Errors\_ | | networkdevice- | | | 1m\_$KEY$ | | traffic-all- | \_HOSTSNMPCOMMUNIT | | | | errors-1m | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTERROR\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTERROR\_CRITI | | | | | CAL\_THRESHOLD | | | | | | | | | | \_TRAFFIC\_ALL\_IF | | | | | ACES\_1M | +---------------------+-------------+---------------------+--------------------+ | Interface\_Discards | | networkdevice- | | | \_1m\_$KEY$ | | traffic-all- | \_HOSTSNMPCOMMUNIT | | | | discards-1m | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTDISCARD\_WAR | | | | | NING\_THRESHOLD | | | | | | | | | | \_HOSTDISCARD\_CRI | | | | | TICAL\_THRESHOLD | | | | | | | | | | \_TRAFFIC\_ALL\_IF | | | | | ACES\_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 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$ -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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +--------------------------------+-----------------------------------+---------+ | \_SNMPVERSION | Device SNMP version, supported 1 | string | | | and 2c | | +--------------------------------+-----------------------------------+---------+ | \_DEVICEVENDOR | Device vendor | string | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_WARNING\_THRESHOLD | Traffic warning threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_CRITICAL\_THRESHOLD | Traffic critical threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_DISCARD\_WARNING\_THRESHOLD | Interface discards warning | integer | | | threshold (packets/s) | | +--------------------------------+-----------------------------------+---------+ | \_DISCARD\_CRITICAL\_THRESHOLD | Interface discards critical | integer | | | threshold (packets/s) | | +--------------------------------+-----------------------------------+---------+ | \_ERROR\_WARNING\_THRESHOLD | Interface errors warning | integer | | | threshold (packets/s) | | +--------------------------------+-----------------------------------+---------+ | \_ERROR\_CRITICAL\_THRESHOLD | Interface errors critical | integer | | | threshold (packets/s) | | +--------------------------------+-----------------------------------+---------+ **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 | string | | | the service description | | +---------------+---------------------------------------------------+----------+ | index | Interface index (unique) | integer | +---------------+---------------------------------------------------+----------+ | max speed in | Interface maximum speed in {units} per second. | integer | | | Applied to IN traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | max speed out | Interface maximum speed in {units} per second. | integer | | | Applied to OUT traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | units | Speed units (g=gigabits/s, m=megabits/s, | string | | | k=kilobits/s ,b=bits/s) | | +---------------+---------------------------------------------------+----------+ | alias | Interface alias (ifAlias) to be shown as | string | | | alternative display name | | +---------------+---------------------------------------------------+----------+ Networkdevice-traffic-byname ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device traffic checks using the interface name .. image:: ../images/packs/pack_icons/networkdevice-traffic-byname.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$\_byn | | wocu-check-traffic- | | | ame | | byname | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTTRAFFIC\_WAR | | | | | NING\_THRESHOLD | | | | | | | | | | \_HOSTTRAFFIC\_CRI | | | | | TICAL\_THRESHOLD | | | | | | | | | | \_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 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$ -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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +--------------------------------+-----------------------------------+---------+ | \_SNMPVERSION | Device SNMP version, supported 1 | string | | | and 2c | | +--------------------------------+-----------------------------------+---------+ | \_DEVICEVENDOR | Device vendor | string | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_WARNING\_THRESHOLD | Traffic warning threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_CRITICAL\_THRESHOLD | Traffic critical threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ **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 | string | | | description | | +---------------+---------------------------------------------------+----------+ | descr | Interface name (unique) | string | +---------------+---------------------------------------------------+----------+ | max speed in | Interface maximum speed in {units} per second. | integer | | | Applied to IN traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | max speed out | Interface maximum speed in {units} per second. | integer | | | Applied to OUT traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | units | Speed units (g=gigabits/s, m=megabits/s, | string | | | k=kilobits/s ,b=bits/s) | | +---------------+---------------------------------------------------+----------+ Networkdevice-traffic-health ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device Health traffic checks (by name) .. image:: ../images/packs/pack_icons/networkdevice-traffic-health.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_Discards | | check\_traffic\_hea | | | \_$KEY$ | | lth\_discards | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTDISCARD\_WAR | | | | | NING\_THRESHOLD | | | | | | | | | | \_HOSTDISCARD\_CRI | | | | | TICAL\_THRESHOLD | | | | | | | | | | \_IFACES\_HEALTH | +---------------------+-------------+---------------------+--------------------+ | Interface\_Errors\_ | | check\_traffic\_hea | | | $KEY$ | | lth\_errors | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTDISCARD\_WAR | | | | | NING\_THRESHOLD | | | | | | | | | | \_HOSTDISCARD\_CRI | | | | | TICAL\_THRESHOLD | | | | | | | | | | \_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 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 | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +--------------------------------+-----------------------------------+---------+ | \_SNMPVERSION | Device SNMP version, supported 1 | string | | | and 2c | | +--------------------------------+-----------------------------------+---------+ | \_DEVICEVENDOR | Device vendor | string | +--------------------------------+-----------------------------------+---------+ | \_DISCARD\_WARNING\_THRESHOLD | Interface discards warning | percent | | | threshold (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_DISCARD\_CRITICAL\_THRESHOLD | Interface discards critical | percent | | | threshold (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_ERROR\_WARNING\_THRESHOLD | Interface errors warning | percent | | | threshold | | +--------------------------------+-----------------------------------+---------+ | \_ERROR\_CRITICAL\_THRESHOLD | Interface erorrs critical | percent | | | threshold | | +--------------------------------+-----------------------------------+---------+ **COMPLEX MACROS** - **_IFACES_HEALTH** - **Description:** List of interfaces to be checked (Errors/Discards) (indexed by ifName) - **Discover:** wocu-discover-ifaces-ng.py | +--------------+----------------------------------------------------+----------+ | **Fields** | **Description** | **Type** | +==============+====================================================+==========+ | display name | Display name to be shown as part of the service | string | | | description | | +--------------+----------------------------------------------------+----------+ | descr | Interface name (Ifdescr) (unique) | string | +--------------+----------------------------------------------------+----------+ Networkdevice-traffic-snmp3 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Network device traffic checks (only snmp version 3) .. image:: ../images/packs/pack_icons/networkdevice-traffic-snmp3.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | wocu-check-traffic- | | | | | snmp3 | \_HOSTSNMP3USERNAME | | | | | | | | | | \_HOSTSNMP3AUTHPASSWO | | | | | RD | | | | | | | | | | \_HOSTSNMP3AUTHPROTOC | | | | | OL | | | | | | | | | | \_HOSTSNMP3PRIVPASSWO | | | | | RD | | | | | | | | | | \_HOSTSNMP3PRIVPROTOC | | | | | OL | | | | | | | | | | \_HOSTTRAFFIC\_WARNIN | | | | | G\_THRESHOLD | | | | | | | | | | \_HOSTTRAFFIC\_CRITIC | | | | | AL\_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 | string | | | security model, use | | | | $SNMP3USERNAME$ for the default | | | | username | | +--------------------------------+-----------------------------------+---------+ | \_SNMP3AUTHPASSWORD | The authentication password, use | string | | | $SNMP3AUTHPASSWORD$ for the | | | | default auth password | | +--------------------------------+-----------------------------------+---------+ | \_SNMP3AUTHPROTOCOL | The authentication protocol (md5, | string | | | sha), use $SNMP3AUTHPROTOCOL$ for | | | | the default auth protocol | | +--------------------------------+-----------------------------------+---------+ | \_SNMP3PRIVPASSWORD | The password for authPriv | string | | | security level, use | | | | $SNMP3PRIVPASSWORD$ for the | | | | default priv password | | +--------------------------------+-----------------------------------+---------+ | \_SNMP3PRIVPROTOCOL | The private protocol (des, aes, | string | | | aes128, 3des, 3desde), use | | | | $SNMP3PRIVPROTOCOL$ for the | | | | default priv protocol | | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_WARNING\_THRESHOLD | Traffic warning threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_CRITICAL\_THRESHOLD | Traffic critical threshold | percent | | | (percentage) | | +--------------------------------+-----------------------------------+---------+ **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 | string | | | the service description | | +---------------+---------------------------------------------------+----------+ | index | Interface index (unique) | integer | +---------------+---------------------------------------------------+----------+ | max speed in | Interface maximum speed in {units} per second. | integer | | | Applied to IN traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | max speed out | Interface maximum speed in {units} per second. | integer | | | Applied to OUT traffic. (Values of 0 mean no | | | | limit) | | +---------------+---------------------------------------------------+----------+ | units | Speed units (g=gigabits/s, m=megabits/s, | string | | | k=kilobits/s ,b=bits/s) | | +---------------+---------------------------------------------------+----------+ Networkdevice-traffic-sum ^^^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- This pack shows the summarized traffic (in/out) from all (or selected) interfaces .. image:: ../images/packs/pack_icons/networkdevice-traffic-sum.png :align: center :scale: 50% 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 :ref:`packs-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 | Summarized | check\_interface\ | | | es\_Sum | traffic in/out | _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 | string | | | configured on remote device | | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_SUM\_IFACES\_REGEXP | Regular expression to match | string | | | selected interface names, e.g. | | | | Ethernet. Leave blank if you want | | | | all interfaces. You must double $ | | | | characters in your regexp | | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_SUM\_WARNING | Input/Output summarized traffic | integer | | | warning threshold | | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_SUM\_CRITICAL | Input/Output summarized traffic | integer | | | critical threshold | | +--------------------------------+-----------------------------------+---------+ | \_TRAFFIC\_UNIT | Traffic unit (per second) | string | +--------------------------------+-----------------------------------+---------+ Nqa-huawei ^^^^^^^^^^ **DESCRIPTION** ---------------------- Check for the NQA values (Jitter/RTT/PacketLoss) in Huawei devices .. image:: ../images/packs/pack_icons/nqa-huawei.png :align: center :scale: 50% 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 :ref:`packs-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\_Packet\_loss\_ | | check\_huawei\_nqa\ | | | $KEY$ | | _packet\_loss | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_NQA\_LIST | +---------------------+-------------+---------------------+--------------------+ | NQA\_RTT\_$KEY$ | | check\_huawei\_nqa\ | | | | | _rtt | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_NQA\_LIST | +---------------------+-------------+---------------------+--------------------+ | NQA\_Jitter\_$KEY$ | | check\_huawei\_nqa\ | | | | | _jitter | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_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 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 | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ | jitter\_critical | Jitter critical threshold for the NQA | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ | packet\_loss\_warning | Packet Loss warning threshold for the | percent | | | NQA Session (percentage) | | +------------------------+------------------------------------------+----------+ | packet\_loss\_critical | Packet Loss critical threshold for the | percent | | | NQA Session (percentage) | | +------------------------+------------------------------------------+----------+ | rtt\_warning | RTT warning threshold for the NQA | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ | rtt\_critical | RTT critical threshold for the NQA | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ Nqa-huawei-1m ^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Check for the NQA values (Jitter/RTT/PacketLoss) in Huawei devices. Check interval: 1 minute .. image:: ../images/packs/pack_icons/nqa-huawei-1m.png :align: center :scale: 50% 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 :ref:`packs-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\_Packet\_loss\_ | | check\_huawei\_nqa\ | | | 1m\_$KEY$ | | _packet\_loss | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_NQA\_LIST\_1M | +---------------------+-------------+---------------------+--------------------+ | NQA\_RTT\_1m\_$KEY$ | | check\_huawei\_nqa\ | | | | | _rtt | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_NQA\_LIST\_1M | +---------------------+-------------+---------------------+--------------------+ | NQA\_Jitter\_1m\_$K | | check\_huawei\_nqa\ | | | EY$ | | _jitter | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_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 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 | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ | jitter\_critical | Jitter critical threshold for the NQA | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ | packet\_loss\_warning | Packet Loss warning threshold for the | percent | | | NQA Session (percentage) | | +------------------------+------------------------------------------+----------+ | packet\_loss\_critical | Packet Loss critical threshold for the | percent | | | NQA Session (percentage) | | +------------------------+------------------------------------------+----------+ | rtt\_warning | RTT warning threshold for the NQA | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ | rtt\_critical | RTT critical threshold for the NQA | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ Nqa-huawei-icmp ^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Check for NQA ICMP type tests metrics (RTT/PacketLoss) in Huawei devices .. image:: ../images/packs/pack_icons/nqa-huawei-icmp.png :align: center :scale: 50% 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 :ref:`packs-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\_Packet\_ | | check\_huawei\_nqa\ | | | loss\_$KEY$ | | _icmp\_packet\_loss | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_NQA\_ICMP\_LIST | +---------------------+-------------+---------------------+--------------------+ | NQA\_ICMP\_RTT\_$KE | | check\_huawei\_nqa\ | | | Y$ | | _icmp\_rtt | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_NQA\_ICMP\_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 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 | string | | | interface | | +------------------------+-------------------------------------+---------------+ | 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 | float.percent | | | the NQA Session (percentage) | | +------------------------+-------------------------------------+---------------+ | packet\_loss\_critical | Packet Loss critical threshold for | float.percent | | | the NQA Session (percentage) | | +------------------------+-------------------------------------+---------------+ | rtt\_warning | RTT warning threshold for the NQA | integer | | | Session (milliseconds) | | +------------------------+-------------------------------------+---------------+ | rtt\_critical | RTT critical threshold for the NQA | integer | | | Session (milliseconds) | | +------------------------+-------------------------------------+---------------+ Nsm-teldat ^^^^^^^^^^ **DESCRIPTION** ---------------------- Check for the NSM values (Jitter/RTT/PacketLoss) in Teldat devices .. image:: ../images/packs/pack_icons/nsm-teldat.png :align: center :scale: 50% Check for the NSM values (Jitter/RTT/PacketLoss) in Teldat devices .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | 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 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 | string | | | service description | | +-------------------------+-----------------------------------------+----------+ | index | Index for snmp queries | integer | +-------------------------+-----------------------------------------+----------+ | jitter\_critical | Critical threshold for the NSM jitter | integer | | | (milliseconds) | | +-------------------------+-----------------------------------------+----------+ | jitter\_warning | Warning threshold for the NSM jitter | integer | | | (milliseconds) | | +-------------------------+-----------------------------------------+----------+ | percent\_loss\_critical | Critical threshold for the NSM | percent | | | packet\_loss (percentage) | | +-------------------------+-----------------------------------------+----------+ | name | Name to be shown in the web interface | string | +-------------------------+-----------------------------------------+----------+ | percent\_loss\_warning | Warning threshold for the NSM | percent | | | packet\_loss (percentage) | | +-------------------------+-----------------------------------------+----------+ | rtt\_critical | Critical threshold for NSM rtt | percent | | | (milliseconds) | | +-------------------------+-----------------------------------------+----------+ | rtt\_warning | Warning threshold for NSM rtt | percent | | | (milliseconds) | | +-------------------------+-----------------------------------------+----------+ Ppa-oneaccess ^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Check for the PPA session values (Jitter/RTT/PacketLoss) in OneAccess devices .. image:: ../images/packs/pack_icons/ppa-oneaccess.png :align: center :scale: 50% 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 :ref:`packs-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$ | | check\_oneaccess\_p | | | | | pa\_jitter | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_PPA\_LIST | +---------------------+-------------+---------------------+--------------------+ | PPA\_Packet\_loss\_ | | check\_oneaccess\_p | | | $KEY$ | | pa\_packet\_loss | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_PPA\_LIST | +---------------------+-------------+---------------------+--------------------+ | PPA\_RTT\_$KEY$ | | check\_oneaccess\_p | | | | | pa\_rtt | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_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 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 | string | | | in the web interface | | +------------------------+------------------------------------------+----------+ | index | Index of PPA Session (integer) | integer | +------------------------+------------------------------------------+----------+ | jitter\_warning | Jitter warning threshold for the PPA | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ | jitter\_critical | Jitter critical threshold for the PPA | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ | packet\_loss\_warning | Packet Loss warning threshold for the | percent | | | PPA Session (percentage) | | +------------------------+------------------------------------------+----------+ | packet\_loss\_critical | Packet Loss critical threshold for the | percent | | | PPA Session (percentage) | | +------------------------+------------------------------------------+----------+ | rtt\_warning | RTT warning threshold for the PPA | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ | rtt\_critical | RTT critical threshold for the PPA | integer | | | Session (milliseconds) | | +------------------------+------------------------------------------+----------+ Qos ^^^ **DESCRIPTION** ---------------------- Checks for the QoS status configured on a network device .. image:: ../images/packs/pack_icons/qos.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | 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 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 | string | +-----------------+-----------------------------------------+--------+ **COMPLEX MACROS** - **_QOSLIST** - **Description:** List of QoS configured on the network devices - **Discover:** wocu-discover-qos.py | +----------------+--------------------------------------------------+----------+ | **Fields** | **Description** | **Type** | +================+==================================================+==========+ | Display Name | Display name to be shown as part of the service | string | | | description | | +----------------+--------------------------------------------------+----------+ | ifName | ifName for snmp queries | string | +----------------+--------------------------------------------------+----------+ | ifIndex | ifIndex for snmp queries | integer | +----------------+--------------------------------------------------+----------+ | Queue Number | Numeric value of the QoS Queue (ex: 2 instead of | integer | | | Silver) | | +----------------+--------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/qos-cisco.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | check\_qos\_cisco | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTQOS\_WARNING\_THRESHOLD | | | | | | | | | | \_HOSTQOS\_CRITICAL\_THRESHOL | | | | | D | | | | | | | | | | \_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 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: | string | | | QOS\_ | | +--------------+----------------------------------------------------+----------+ | 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 :ref:`packs-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, | qos-huawei-rate | | | | discards and drops | | \_HOSTSNMPCOMMUNITY | | | rates in Huawei QoS | | | | | Classes | | \_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 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 | integer | | | (bps) | | +--------------------+----------------------------------------------+----------+ | discards\_warning | QoS Class enqueue discards rate warning | integer | | | threshold (bps) | | +--------------------+----------------------------------------------+----------+ | discards\_critical | QoS Class enqueue discards rate critical | integer | | | threshold (bps) | | +--------------------+----------------------------------------------+----------+ Rpm-juniper ^^^^^^^^^^^ **DESCRIPTION** ---------------------- Check for RPM tests metrics (RTT/Jitter/PacketLoss) in Juniper devices .. image:: ../images/packs/pack_icons/rpm-juniper.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_Lost\_Percen | Checks Juniper | check\_juniper\_r | | | t\_$KEY$ | RPM probe Lost | pm\_loss\_percent | \_HOSTSNMPVERSIO | | | Percent | | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_RPM\_LIST | +-------------------+-------------------+-------------------+------------------+ | RPM\_RTT\_$KEY$ | Checks Juniper | check\_juniper\_r | | | | RPM probe Round | pm\_rtt | \_HOSTSNMPVERSIO | | | Trip Time | | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_RPM\_LIST | +-------------------+-------------------+-------------------+------------------+ | RPM\_Jitter\_$KEY | Checks Juniper | check\_juniper\_r | | | $ | RPM probe Jitter | pm\_jitter | \_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 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 | percent | | | Session (percentage) | | +-------------------------+-----------------------------------------+----------+ | loss\_percent\_critical | Loss critical threshold for the RPM | percent | | | Session (percentage) | | +-------------------------+-----------------------------------------+----------+ | rtt\_warning | RTT warning threshold for the RPM | integer | | | Session (milliseconds) | | +-------------------------+-----------------------------------------+----------+ | rtt\_critical | RTT critical threshold for the RPM | integer | | | Session (milliseconds) | | +-------------------------+-----------------------------------------+----------+ | jitter\_warning | Jitter warning threshold for the RPM | integer | | | Session (milliseconds) | | +-------------------------+-----------------------------------------+----------+ | jitter\_critical | Jitter critical threshold for the RPM | integer | | | Session (milliseconds) | | +-------------------------+-----------------------------------------+----------+ Snmp-generic ^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Nagios official pack to check user defined SNMP oids .. image:: ../images/packs/pack_icons/snmp-generic.png :align: center :scale: 50% 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 :ref:`packs-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$ | | check\_snmp\_generic\_oid | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_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$ | string | | | for the default system community | | +-----------------+---------------------------------------------------+--------+ | \_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 | string | | | description | | +------------+------------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/snmp-generic-1m.png :align: center :scale: 50% 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 :ref:`packs-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$ | | check\_snmp\_generic\_ | | | | | 1m\_oid | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_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$ | string | | | for the default system community | | +-----------------+---------------------------------------------------+--------+ | \_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 | string | | | description | | +------------+------------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/snmp-generic-advanced.png :align: center :scale: 50% 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 :ref:`packs-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\_$ | Compare snmp OID | check\_snmp\_gene | | | KEY$ | reply with | ric\_advanced\_oi | \_HOSTSNMPCOMMUN | | | thresholds, | d | ITY | | | string or regex | | | | | | | \_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 | string | | | use default system community | | +-----------------+---------------------------------------------------+--------+ | \_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 | string | | | description | | +--------------+----------------------------------------------------+----------+ | oid | SNMP oid to monitor | string | +--------------+----------------------------------------------------+----------+ | type | OID type | string | +--------------+----------------------------------------------------+----------+ | warning | Warning threshold. Format: [@]start:end. Examples: | string | | | 10, 10:, :10, 10:20, @10:20 | | +--------------+----------------------------------------------------+----------+ | critical | Critical threshold. Format: [@]start:end. | string | | | Examples: 10, 10:, :10, 10:20, @10:20 | | +--------------+----------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/snmp-oid.png :align: center :scale: 50% 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 :ref:`packs-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$ | | 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$ | string | | | for the default system community | | +-----------------+---------------------------------------------------+--------+ | \_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 | string | | | description | | +---------------+---------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/snmp-oid-1m.png :align: center :scale: 50% 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 :ref:`packs-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$ | | check\_snmp\_oid\_1m | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_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$ | string | | | for the default system community | | +-----------------+---------------------------------------------------+--------+ | \_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 | string | | | description | | +---------------+---------------------------------------------------+----------+ | 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 | +---------------+---------------------------------------------------+----------+ Tcp-generic ^^^^^^^^^^^ **DESCRIPTION** ---------------------- List of TCP ports to check .. image:: ../images/packs/pack_icons/tcp-generic.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | 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 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 | string | | | description | | +------------+------------------------------------------------------+----------+ | port | TCP port to monitor | integer | +------------+------------------------------------------------------+----------+ Traps-snmp ^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for the received traps via NSCA module .. image:: ../images/packs/pack_icons/traps-snmp.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 .. image:: ../images/packs/pack_icons/umts-generic.png :align: center :scale: 50% 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 :ref:`packs-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\_health$KEY$ | | 3g-health | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTDEVICEVENDOR | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_3GLIST | +-----------------+-------------+---------------+---------------------+ | 3G\_info$KEY$ | | 3g-info | | | | | | \_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 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 | integer | | | critical threshold (1 to 12). See pack extended | | | | description for details | | +---------------+---------------------------------------------------+----------+ | warning band | GPRS/UMTS/LTE band to which the modem is attached | integer | | | warning threshold (1 to 12). See pack extended | | | | description for details | | +---------------+---------------------------------------------------+----------+ | 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 | integer | | | threshold | | +---------------+---------------------------------------------------+----------+ | warning EcIo | EC/IO (3G) or RSRQ (4G) - Signal Quality Warning | integer | | | threshold | | +---------------+---------------------------------------------------+----------+ Vrrp-generic ^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Check for the VRRP configured interfaces on Generic routers .. image:: ../images/packs/pack_icons/vrrp-generic.png :align: center :scale: 50% VRRP interfaces checks per Device .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | check\_vrrp\_interface | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_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 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 to use in the check | 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: | string | | | VRRP\_ | | +--------------+----------------------------------------------------+----------+ | Virtual IP | VRRP Virtual IP (configured on remote device) | string | +--------------+----------------------------------------------------+----------+ | ifIndex | VRRP interface index (ifindex configured on remote | integer | | | device) | | +--------------+----------------------------------------------------+----------+ | Group | VRRP group (configured on remote device) | integer | +--------------+----------------------------------------------------+----------+ | State | VRRP state (to be checked on remote device) | string | +--------------+----------------------------------------------------+----------+ Storage ------- Nas-iomega ^^^^^^^^^^ **DESCRIPTION** ---------------------- Check Iomega NAS system, disks, raid and storages .. image:: ../images/packs/pack_icons/nas-iomega.png :align: center :scale: 50% 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 :ref:`packs-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\_usage | | check\_iomega\_cpu\_u | | | | | sage | \_HOSTSNMP\_USER | | | | | | | | | | \_HOSTSNMP\_PASSWORD | | | | | | | | | | \_HOSTCPU\_USAGE\_WAR | | | | | NING | | | | | | | | | | \_HOSTCPU\_USAGE\_CRI | | | | | TICAL | +----------------+-------------+-----------------------+-----------------------+ | Disks\_status | | check\_iomega\_disks\ | | | | | _status | \_HOSTSNMP\_USER | | | | | | | | | | \_HOSTSNMP\_PASSWORD | +----------------+-------------+-----------------------+-----------------------+ | Memory\_usage | | check\_iomega\_mem\_u | | | | | sage | \_HOSTSNMP\_USER | | | | | | | | | | \_HOSTSNMP\_PASSWORD | | | | | | | | | | \_HOSTMEM\_USAGE\_WAR | | | | | NING | | | | | | | | | | \_HOSTMEM\_USAGE\_CRI | | | | | TICAL | +----------------+-------------+-----------------------+-----------------------+ | Storage\_usage | | check\_iomega\_storag | | | | | e\_usage | \_HOSTSNMP\_USER | | | | | | | | | | \_HOSTSNMP\_PASSWORD | | | | | | | | | | \_HOSTSTORAGE\_USAGE\ | | | | | _WARNING | | | | | | | | | | \_HOSTSTORAGE\_USAGE\ | | | | | _CRITICAL | +----------------+-------------+-----------------------+-----------------------+ | Info | | check\_iomega\_info | | | | | | \_HOSTSNMP\_USER | | | | | | | | | | \_HOSTSNMP\_PASSWORD | +----------------+-------------+-----------------------+-----------------------+ | Raid\_status | | check\_iomega\_raid\_ | | | | | status | \_HOSTSNMP\_USER | | | | | | | | | | \_HOSTSNMP\_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 | +============================+=======================================+=========+ | \_STORAGE\_USAGE\_WARNING | Warning threshold for each storage | percent | | | usage | | +----------------------------+---------------------------------------+---------+ | \_STORAGE\_USAGE\_CRITICAL | Critical threshold for each storage | percent | | | usage | | +----------------------------+---------------------------------------+---------+ | \_CPU\_USAGE\_WARNING | Warning threshold for CPU usage as | percent | | | percentage | | +----------------------------+---------------------------------------+---------+ | \_CPU\_USAGE\_CRITICAL | Critical threshold for CPU usage as | percent | | | percentage | | +----------------------------+---------------------------------------+---------+ | \_MEM\_USAGE\_WARNING | Warning threshold for Memory usage as | percent | | | percentage | | +----------------------------+---------------------------------------+---------+ | \_MEM\_USAGE\_CRITICAL | Critical threshold for Memory usage | percent | | | as percentage | | +----------------------------+---------------------------------------+---------+ | \_SNMP\_USER | SNMP V3 User | string | +----------------------------+---------------------------------------+---------+ | \_SNMP\_PASSWORD | SNMP V3 Password | string | +----------------------------+---------------------------------------+---------+ Nas-synology ^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Check Synology NAS system, disks, raid and storages .. image:: ../images/packs/pack_icons/nas-synology.png :align: center :scale: 50% Checks for NAS Synology devices. .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 Fan Status | | check\_synology\_cp | | | | | u\_fan\_status | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | +---------------------+-------------+---------------------+--------------------+ | PowerSupplies | | check\_synology\_po | | | Status | | wer\_status | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | +---------------------+-------------+---------------------+--------------------+ | System Status | | check\_synology\_sy | | | | | stem\_status | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | +---------------------+-------------+---------------------+--------------------+ | CPU Usage | | check\_synology\_cp | | | | | u\_usage | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTCPU\_USAGE\_ | | | | | WARNING | | | | | | | | | | \_HOSTCPU\_USAGE\_ | | | | | CRITICAL | +---------------------+-------------+---------------------+--------------------+ | Load Average | | check\_synology\_lo | | | | | ad | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTLOAD\_WARNIN | | | | | G | | | | | | | | | | \_HOSTLOAD\_CRITIC | | | | | AL | +---------------------+-------------+---------------------+--------------------+ | Upgrade Available | | check\_synology\_up | | | | | grade\_available | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | +---------------------+-------------+---------------------+--------------------+ | System Temperature | | check\_synology\_sy | | | | | stem\_temperature | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSYSTEM\_TEMP | | | | | ERATURE\_WARNING | | | | | | | | | | \_HOSTSYSTEM\_TEMP | | | | | ERATURE\_CRITICAL | +---------------------+-------------+---------------------+--------------------+ | Disks Status | | check\_synology\_di | | | | | sks\_status | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | +---------------------+-------------+---------------------+--------------------+ | System Fan Status | | check\_synology\_sy | | | | | stem\_fan\_status | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | +---------------------+-------------+---------------------+--------------------+ | Memory Usage | | check\_synology\_me | | | | | m\_usage | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTMEM\_USAGE\_ | | | | | WARNING | | | | | | | | | | \_HOSTMEM\_USAGE\_ | | | | | CRITICAL | +---------------------+-------------+---------------------+--------------------+ | Storage Usage | | check\_synology\_st | | | | | orage\_usage | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSTORAGE\_USA | | | | | GE\_WARNING | | | | | | | | | | \_HOSTSTORAGE\_USA | | | | | GE\_CRITICAL | +---------------------+-------------+---------------------+--------------------+ | Info | | check\_synology\_in | | | | | fo | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | +---------------------+-------------+---------------------+--------------------+ | Disks Temperatures | | check\_synology\_di | | | | | sks\_temperatures | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTDISK\_TEMPER | | | | | ATURE\_WARNING | | | | | | | | | | \_HOSTDISK\_TEMPER | | | | | ATURE\_CRITICAL | +---------------------+-------------+---------------------+--------------------+ | Raid Status | | check\_synology\_ra | | | | | id\_status | \_HOSTSNMPVERSION | | | | | | | | | | \_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 | SNMP Community | string | +---------------------------------+----------------------------------+---------+ | \_SNMPVERSION | SNMP version | string | +---------------------------------+----------------------------------+---------+ | \_SYSTEM\_TEMPERATURE\_WARNING | Warning threshold for system | integer | | | temperature (in Celsius degrees) | | +---------------------------------+----------------------------------+---------+ | \_SYSTEM\_TEMPERATURE\_CRITICAL | Critical threshold for system | integer | | | temperature (in Celsius degrees) | | +---------------------------------+----------------------------------+---------+ | \_STORAGE\_USAGE\_WARNING | Global Warning threshold for | percent | | | storage usage | | +---------------------------------+----------------------------------+---------+ | \_STORAGE\_USAGE\_CRITICAL | Global Critical threshold for | percent | | | storage usage | | +---------------------------------+----------------------------------+---------+ | \_DISK\_TEMPERATURE\_WARNING | Warning threshold for all disks | integer | | | temperatures (in Celsius | | | | degrees) | | +---------------------------------+----------------------------------+---------+ | \_DISK\_TEMPERATURE\_CRITICAL | Critical threshold for all disks | integer | | | temperatures (in Celsius | | | | degrees) | | +---------------------------------+----------------------------------+---------+ | \_CPU\_USAGE\_WARNING | Warning threshold for CPU usage | percent | | | (percentage) | | +---------------------------------+----------------------------------+---------+ | \_CPU\_USAGE\_CRITICAL | Critical threshold for CPU usage | percent | | | (percentage) | | +---------------------------------+----------------------------------+---------+ | \_MEM\_USAGE\_WARNING | Warning threshold for Memory | percent | | | usage as (percentage) | | +---------------------------------+----------------------------------+---------+ | \_MEM\_USAGE\_CRITICAL | Critical threshold for Memory | percent | | | usage as (percentage) | | +---------------------------------+----------------------------------+---------+ | \_LOAD\_WARNING | Warning threshold for load | integer | | | average in last 15 minutes | | +---------------------------------+----------------------------------+---------+ | \_LOAD\_CRITICAL | Critical threshold for load | integer | | | average in last 15 minutes | | +---------------------------------+----------------------------------+---------+ Purestorage ^^^^^^^^^^^ **DESCRIPTION** ---------------------- PureStorage specific health and performance checks .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 - | Checks status of | check\_purestorag | | | Status - $KEY$ | PureStorage | e\_hw\_status | \_HOSTAPI\_TOKEN | | | FlashArray HW | | | | | components | | \_PURESTORAGE\_H | | | | | W\_LIST | +-------------------+-------------------+-------------------+------------------+ | PureStorage - | Checks | check\_purestorag | | | Performance - | PureStorage | e\_perf\_volume | \_HOSTAPI\_TOKEN | | Volume $KEY$ | FlashArray Volume | | | | | performance | | \_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 - | Checks Open | check\_purestorag | | | Open Alerts | Alerts in | e\_alerts | \_HOSTAPI\_TOKEN | | | PureStorage | | | | | FlashArray | | | +-------------------+-------------------+-------------------+------------------+ | PureStorage - | Checks | check\_purestorag | | | Occupancy - FA | PureStorage | e\_occupancy\_fa | \_HOSTAPI\_TOKEN | | | FlashArray | | | | | occupancy | | | +-------------------+-------------------+-------------------+------------------+ | PureStorage - | Checks | check\_purestorag | | | Occupancy - | PureStorage | e\_occupancy\_vol | \_HOSTAPI\_TOKEN | | Volume $KEY$ | FlashArray Volume | ume | | | | occupancy | | \_PURESTORAGE\_V | | | | | OLUME\_LIST | +-------------------+-------------------+-------------------+------------------+ | PureStorage - | Checks | check\_purestorag | | | Performance - FA | PureStorage | e\_perf\_fa | \_HOSTAPI\_TOKEN | | | FlashArray | | | | | performance | | \_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 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 | +---------------+----------------------------------------------------+---------+ | \_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** - **_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 .. image:: ../images/packs/pack_icons/qnap.png :align: center :scale: 50% Checks for the QNAP NAS devices .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_volstatus | | check\_qnap\_volsta | | | | | tus | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ | Qnap\_lunstatus | | check\_qnap\_lunsta | | | | | tus | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ | Qnap\_info | | check\_qnap\_info | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ | Qnap\_MEM | | check\_qnap\_mem | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTMEM\_WARNING | | | | | | | | | | \_HOSTMEM\_CRITICA | | | | | L | +---------------------+-------------+---------------------+--------------------+ | Qnap\_power\_supply | | check\_qnap\_powers | | | | | upply | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ | Qnap\_volusage | | check\_qnap\_volusa | | | | | ge | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTVOL\_USAGE\_ | | | | | WARNING | | | | | | | | | | \_HOSTVOL\_USAGE\_ | | | | | CRITICAL | +---------------------+-------------+---------------------+--------------------+ | Qnap\_cache\_disk\_ | | check\_qnap\_cached | | | status | | iskstatus | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ | Qnap\_fans | | check\_qnap\_fans | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTFAN\_SPEED\_ | | | | | WARNING | | | | | | | | | | \_HOSTFAN\_SPEED\_ | | | | | CRITICAL | +---------------------+-------------+---------------------+--------------------+ | Qnap\_CPU | | check\_qnap\_cpu | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTCPU\_WARNING | | | | | | | | | | \_HOSTCPU\_CRITICA | | | | | L | +---------------------+-------------+---------------------+--------------------+ | Qnap\_Temp | | check\_qnap\_temp | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTTEMP\_WARNIN | | | | | G | | | | | | | | | | \_HOSTTEMP\_CRITIC | | | | | AL | +---------------------+-------------+---------------------+--------------------+ | Qnap\_hdtemp | | check\_qnap\_hdtemp | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTHDTEMP\_WARN | | | | | ING | | | | | | | | | | \_HOSTHDTEMP\_CRIT | | | | | ICAL | +---------------------+-------------+---------------------+--------------------+ | Qnap\_raid\_status | | check\_qnap\_raidst | | | | | atus | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ | Qnap\_hdstatus | | check\_qnap\_hdstat | | | | | us | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ **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 | string | | | $SNMPCOMMUNITYREAD$ for the default | | | | system community | | +------------------------+-------------------------------------------+---------+ | \_SNMPVERSION | Device SNMP versions supported are: 1 and | string | | | 2c | | +------------------------+-------------------------------------------+---------+ | \_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 | integer | | | Celsius) | | +------------------------+-------------------------------------------+---------+ | \_TEMP\_CRITICAL | System temperature critical threshold (in | integer | | | Celsius) | | +------------------------+-------------------------------------------+---------+ | \_HDTEMP\_WARNING | HD temperature warning threshold (in | integer | | | Celsius) | | +------------------------+-------------------------------------------+---------+ | \_HDTEMP\_CRITICAL | HD temperature critical threshold (in | integer | | | Celsius) | | +------------------------+-------------------------------------------+---------+ | \_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 .. image:: ../images/packs/pack_icons/alienvault-aio.png :align: center :scale: 50% 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 :ref:`packs-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 | Checks if monit | check\_av\_aio\_m | | | Monit | process is | onit | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks if ossim- | check\_av\_aio\_a | | | Agent | agent is running | gent | \_HOSTAGENT\_WAR | | | | | NING | | | | | | | | | | \_HOSTAGENT\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks if redis- | check\_av\_aio\_r | | | Redis Server | server is running | edis\_server | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks if ossim- | check\_av\_aio\_s | | | Server | server is running | erver | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks if apache2 | check\_av\_aio\_a | | | Apache | is running | pache | \_HOSTAPACHE\_WA | | | | | RNING | | | | | | | | | | \_HOSTAPACHE\_CR | | | | | ITICAL | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks if | check\_av\_aio\_r | | | RabbitMQ Server | rabbitmq-server | abbitmq\_server | | | | is running | | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks if ossim- | check\_av\_aio\_f | | | Framework | framework is | ramework | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks if mongod | check\_av\_aio\_m | | | Mongodb | is running | ongodb | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks if mysqld | check\_av\_aio\_m | | | Mysqld | is running | ysqld | \_HOSTMYSQL\_WAR | | | | | NING | | | | | | | | | | \_HOSTMYSQL\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks if | check\_av\_aio\_r | | | Rsyslog | rsyslogd is | syslog | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks the logger | check\_av\_aio\_s | | | Size | size | ize | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks the number | check\_av\_aio\_p | | | Procs | of processes | rocs | \_HOSTPROCS\_WAR | | | | | NING | | | | | | | | | | \_HOSTPROCS\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | Alienvault-aio | Checks if sandas | check\_av\_aio\_s | | | Sandas | is running | andas | | +-------------------+-------------------+-------------------+------------------+ **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 | string | | | threshold (Ex: 1:12) | | +--------------------+------------------------------------------------+--------+ | \_APACHE\_CRITICAL | Running Apache processes critical range | string | | | threshold (Ex: 1:20) | | +--------------------+------------------------------------------------+--------+ | \_AGENT\_WARNING | Running Ossim-agent processes warning range | string | | | threshold (Ex: 1:40) | | +--------------------+------------------------------------------------+--------+ | \_AGENT\_CRITICAL | Running Ossim-agent processes critical range | string | | | threshold (Ex: 1:50) | | +--------------------+------------------------------------------------+--------+ | \_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 | string | | | threshold | | +--------------------+------------------------------------------------+--------+ | \_MYSQL\_CRITICAL | Number of MySQL running processes critical | string | | | threshold | | +--------------------+------------------------------------------------+--------+ Alienvault-logger ^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Specific checks for Alienvault Logger devices .. image:: ../images/packs/pack_icons/alienvault-logger.png :align: center :scale: 50% 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 :ref:`packs-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 | Checks if apache2 | check\_av\_logger | | | Apache | is running | \_apache | \_HOSTAPACHE\_WA | | | | | RNING | | | | | | | | | | \_HOSTAPACHE\_CR | | | | | ITICAL | +-------------------+-------------------+-------------------+------------------+ | Alienvault-Logger | Checks if | check\_av\_logger | | | RabbitMQ Server | rabbitmq-server | \_rabbitmq\_serve | | | | is running | r | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-Logger | Checks if ossim- | check\_av\_logger | | | Framework | framework is | \_framework | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-Logger | Checks if ossim- | check\_av\_logger | | | Server | server is running | \_server | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-Logger | Checks if mongod | check\_av\_logger | | | Mongodb | is running | \_mongodb | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-Logger | Checks if redis- | check\_av\_logger | | | Redis Server | server is running | \_redis\_server | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-Logger | Checks if mysqld | check\_av\_logger | | | Mysqld | is running | \_mysqld | \_HOSTMYSQL\_WAR | | | | | NING | | | | | | | | | | \_HOSTMYSQL\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | Alienvault-Logger | Checks the logger | check\_av\_logger | | | Size | size | \_size | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-Logger | Checks if monit | check\_av\_logger | | | Monit | process is | \_monit | | | | running | | | +-------------------+-------------------+-------------------+------------------+ **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 | string | | | threshold (Ex: 1:12) | | +--------------------+------------------------------------------------+--------+ | \_APACHE\_CRITICAL | Running Apache processes critical range | string | | | threshold (Ex: 1:20) | | +--------------------+------------------------------------------------+--------+ | \_MYSQL\_WARNING | Number of MySQL running processes warning | string | | | threshold | | +--------------------+------------------------------------------------+--------+ | \_MYSQL\_CRITICAL | Number of MySQL running processes critical | string | | | threshold | | +--------------------+------------------------------------------------+--------+ Alienvault-sensor ^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Specific checks for Alienvault sensor devices .. image:: ../images/packs/pack_icons/alienvault-sensor.png :align: center :scale: 50% 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 :ref:`packs-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 | Checks if | check\_av\_sensor | | | Rsyslog | rsyslogd is | \_rsyslog | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-sensor | Checks if monit | check\_av\_sensor | | | Monit | process is | \_monit | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-sensor | Checks if ossim- | check\_av\_sensor | | | Agent | agent is running | \_agent | \_HOSTAGENT\_WAR | | | | | NING | | | | | | | | | | \_HOSTAGENT\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | Alienvault-sensor | Checks the number | check\_av\_sensor | | | Procs | of processes | \_procs | \_HOSTPROCS\_WAR | | | | | NING | | | | | | | | | | \_HOSTPROCS\_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 | +===================+=================================================+========+ | \_AGENT\_WARNING | Running Ossim-agent processes warning range | string | | | threshold (Ex: 1:40) | | +-------------------+-------------------------------------------------+--------+ | \_AGENT\_CRITICAL | Running Ossim-agent processes critical range | string | | | threshold (Ex: 1:50) | | +-------------------+-------------------------------------------------+--------+ | \_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 .. image:: ../images/packs/pack_icons/alienvault-siem.png :align: center :scale: 50% 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 :ref:`packs-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 | Checks if ossim- | check\_av\_siem\_ | | | Server | server is running | server | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-siem | Checks if sandas | check\_av\_siem\_ | | | Sandas | is running | sandas | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-siem | Checks if mysqld | check\_av\_siem\_ | | | Mysqld | is running | mysqld | \_HOSTMYSQL\_WAR | | | | | NING | | | | | | | | | | \_HOSTMYSQL\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | Alienvault-siem | Checks if apache2 | check\_av\_siem\_ | | | Apache | is running | apache | \_HOSTAPACHE\_WA | | | | | RNING | | | | | | | | | | \_HOSTAPACHE\_CR | | | | | ITICAL | +-------------------+-------------------+-------------------+------------------+ | Alienvault-siem | Checks if | check\_av\_siem\_ | | | RabbitMQ Server | rabbitmq-server | rabbitmq\_server | | | | is running | | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-siem | Checks if mongod | check\_av\_siem\_ | | | Mongodb | is running | mongodb | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-siem | Checks if ossim- | check\_av\_siem\_ | | | Framework | framework is | framework | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-siem | Checks if monit | check\_av\_siem\_ | | | Monit | process is | monit | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | Alienvault-siem | Checks if redis- | check\_av\_siem\_ | | | Redis Server | server is running | redis\_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 | string | | | threshold (Ex: 1:12) | | +--------------------+------------------------------------------------+--------+ | \_APACHE\_CRITICAL | Running Apache processes critical range | string | | | threshold (Ex: 1:20) | | +--------------------+------------------------------------------------+--------+ | \_MYSQL\_WARNING | Number of MySQL running processes warning | string | | | threshold | | +--------------------+------------------------------------------------+--------+ | \_MYSQL\_CRITICAL | Number of MySQL running processes critical | string | | | threshold | | +--------------------+------------------------------------------------+--------+ Arcsight ^^^^^^^^ **DESCRIPTION** ---------------------- Generic checks for Arcsight devices .. image:: ../images/packs/pack_icons/arcsight.png :align: center :scale: 50% 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 :ref:`packs-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 | +===================+===================+===================+==================+ | interfaces\_statu | Checks the | check\_interfaces | | | s | interfaces status | \_status | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | uptime\_so | Checks the system | check\_uptime\_so | | | | uptime | | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | zombie\_procs | Checks the number | check\_unix\_zomb | | | | of zombie | ie\_procs | \_HOSTZOMBIE\_PR | | | processes | | OCS\_WARNING | | | | | | | | | | \_HOSTZOMBIE\_PR | | | | | OCS\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | procs | Checks the number | check\_unix\_nrpe | | | | of processes | \_procs | \_HOSTPROCS\_WAR | | | | | NING | | | | | | | | | | \_HOSTPROCS\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | procs\_ssh | Checks if sshd is | check\_procs\_ssh | | | | running | | \_HOSTSSH\_PROCS | | | | | \_WARNING | | | | | | | | | | \_HOSTSSH\_PROCS | | | | | \_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | load | Checks the system | check\_unix\_nrpe | | | | load | \_load | \_HOSTLOAD\_WARN | | | | | ING | | | | | | | | | | \_HOSTLOAD\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | mem | Checks the memory | check\_unix\_nrpe | | | | usage | \_memory | \_HOSTMEM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | swap | Checks the swap | check\_unix\_nrpe | | | | usage percent | \_swap | \_HOSTSWAP\_WARN | | | | | ING | | | | | | | | | | \_HOSTSWAP\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | Partition $KEY$ | Checks the | check\_unix\_nrpe | | | | storage usage | \_disk | \_HOSTSTORAGE\_W | | | percent | | ARNING | | | | | | | | | | \_HOSTSTORAGE\_C | | | | | RITICAL | | | | | | | | | | \_PARTITIONS | +-------------------+-------------------+-------------------+------------------+ **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. | string | | | Example 1:20 | | +---------------------------+----------------------------------------+---------+ | \_SSH\_PROCS\_CRITICAL | SSH processes critical threshold. | string | | | Example 1:40 | | +---------------------------+----------------------------------------+---------+ | \_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 | string | | | example /,/var | | +---------------------------+----------------------------------------+---------+ | \_ZOMBIE\_PROCS\_WARNING | Zombie processes warning threshold, | string | | | for example 1:20 | | +---------------------------+----------------------------------------+---------+ | \_ZOMBIE\_PROCS\_CRITICAL | Zombie processes critical threshold, | string | | | for example 1:40 | | +---------------------------+----------------------------------------+---------+ Arcsight-express ^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Performance and availability checks for Arcsight devices .. image:: ../images/packs/pack_icons/arcsight-express.png :align: center :scale: 50% 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 :ref:`packs-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 | +===============+====================+====================+====================+ | Swap\_usage | Checks the swap | check\_ssh\_swap | | | | usage | | \_HOSTSWAP\_WARNIN | | | | | G | | | | | | | | | | \_HOSTSWAP\_CRITIC | | | | | AL | +---------------+--------------------+--------------------+--------------------+ | Java | Checks if java is | check\_nrpe\_java | | | | running | | | +---------------+--------------------+--------------------+--------------------+ | Disk\_usage / | Checks the storage | check\_ssh\_disk | | | | usage | | \_HOSTSTORAGE\_WAR | | | | | NING | | | | | | | | | | \_HOSTSTORAGE\_CRI | | | | | TICAL | +---------------+--------------------+--------------------+--------------------+ | Load\_average | Checks the system | check\_ssh\_load | | | | load average | | \_HOSTLOAD\_WARNIN | | | | | G | | | | | | | | | | \_HOSTLOAD\_CRITIC | | | | | AL | +---------------+--------------------+--------------------+--------------------+ | Uptime | Checks the system | check\_ssh\_uptime | | | | uptime | | \_HOSTUPTIME\_WARN | | | | | ING | | | | | | | | | | \_HOSTUPTIME\_CRIT | | | | | ICAL | +---------------+--------------------+--------------------+--------------------+ | Web\_service | Checks if Arcsight | check\_nrpe\_esm\_ | | | | wrapper is running | web | | +---------------+--------------------+--------------------+--------------------+ | Procs | Checks the number | check\_ssh\_procs | | | | of processes | | \_HOSTPROCS\_WARNI | | | | | NG | | | | | | | | | | \_HOSTPROCS\_CRITI | | | | | CAL | +---------------+--------------------+--------------------+--------------------+ | web\_access | Checks if port | check\_tcp\_web\_a | | | | TCP/8443 is | ccess | \_HOSTRESPONSE\_WA | | | listening | | RNING | | | | | | | | | | \_HOSTRESPONSE\_CR | | | | | ITICAL | +---------------+--------------------+--------------------+--------------------+ | Mem\_usage | Checks memory | check\_ssh\_mem | | | | usage | | \_HOSTMEM\_WARNING | | | | | | | | | | \_HOSTMEM\_CRITICA | | | | | L | +---------------+--------------------+--------------------+--------------------+ | Oracle | Checks if Oracle | check\_nrpe\_esm\_ | | | | listener is | oracle | | | | running | | | +---------------+--------------------+--------------------+--------------------+ **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 | integer | | | seconds) | | +----------------------+---------------------------------------------+---------+ | \_RESPONSE\_CRITICAL | Response time critical threshold (in | integer | | | seconds) | | +----------------------+---------------------------------------------+---------+ | \_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 | string | | | /,/var | | +----------------------+---------------------------------------------+---------+ Arcsight-logger ^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Performance and availability checks for Arcsight logger devices .. image:: ../images/packs/pack_icons/arcsight-logger.png :align: center :scale: 50% 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 :ref:`packs-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 Listener | Checks if | check\_mysql\_lis | | | | TCP/3306 port is | tener | \_HOSTRESPONSE\_ | | | listening | | WARNING | | | | | | | | | | \_HOSTRESPONSE\_ | | | | | CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Raid status | Checks the RAID | check\_nrpe\_raid | | | | status | \_status | | +-------------------+-------------------+-------------------+------------------+ | Partition\_logger | Checks the | check\_nrpe\_disk | | | $KEY$ | storage usage | | \_HOSTSTORAGE\_W | | | | | ARN | | | | | | | | | | \_HOSTSTORAGE\_C | | | | | RIT | | | | | | | | | | \_PARTITIONS | +-------------------+-------------------+-------------------+------------------+ | LinuxWrapper | Checks if linux | check\_nrpe\_linu | | | | wrapper process | xwrapper | | | | is running | | | +-------------------+-------------------+-------------------+------------------+ | Load | Checks the system | check\_unix\_nrpe | | | | load | \_load | \_HOSTLOAD\_WARN | | | | | ING | | | | | | | | | | \_HOSTLOAD\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | Web | Checks if | check\_nrpe\_web | | | | arcsight web | | | | | process is | | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | ReportEngine | Checks if | check\_nrpe\_repo | | | | arcsight | rtengine | | | | reportengine | | | | | process is | | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | PostgreSQL | Checks if | check\_nrpe\_post | | | | PostgreSql | gresql | | | | postmaster | | | | | process is | | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | Zombie procs | Checks the number | check\_unix\_zomb | | | | of zombie | ie\_procs | \_HOSTZOMBIE\_PR | | | processes | | OCS\_WARNING | | | | | | | | | | \_HOSTZOMBIE\_PR | | | | | OCS\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Receivers | Checks if | check\_nrpe\_rece | | | | arcsight | ivers | | | | receivers is | | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | Procs | Checks the number | check\_nrpe\_proc | | | | of processes | s | \_HOSTPROCS\_WAR | | | | | NING | | | | | | | | | | \_HOSTPROCS\_CRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | Swap Usage | Checks swap usage | check\_unix\_nrpe | | | | percent | \_swap | \_HOSTSWAP\_WARN | | | | | ING | | | | | | | | | | \_HOSTSWAP\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | Connectors | Checks if ArcSigh | check\_nrpe\_conn | | | | tSmartConnectors | ectors | | | | is running | | | +-------------------+-------------------+-------------------+------------------+ | Memory Usage | Checks the memory | check\_unix\_nrpe | | | | usage | \_memory | \_HOSTMEM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Server | Checks if | check\_nrpe\_serv | | | | arcsight servers | er | | | | process is | | | | | running | | | +-------------------+-------------------+-------------------+------------------+ | SSH Procs | Checks if sshd | check\_nrpe\_ssh\ | | | | process is | _procs | \_HOSTSSH\_PROCS | | | running | | \_WARNING | | | | | | | | | | \_HOSTSSH\_PROCS | | | | | \_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Logger | Checks if | check\_nrpe\_logg | | | | arcsight | er | | | | processors is | | | | | running | | | +-------------------+-------------------+-------------------+------------------+ **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 | integer | | | seconds) | | +---------------------------+----------------------------------------+---------+ | \_RESPONSE\_CRITICAL | Response time critical threshold (in | integer | | | seconds) | | +---------------------------+----------------------------------------+---------+ | \_PROCS\_WARNING | Total processes warning threshold | integer | +---------------------------+----------------------------------------+---------+ | \_PROCS\_CRITICAL | Total processes critical threshold | integer | +---------------------------+----------------------------------------+---------+ | \_SSH\_PROCS\_WARNING | SSH processes warning threshold. | string | | | Example 1:20 | | +---------------------------+----------------------------------------+---------+ | \_SSH\_PROCS\_CRITICAL | SSH processes critical threshold. | string | | | Example 1:40 | | +---------------------------+----------------------------------------+---------+ | \_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 | string | | | example /,/var | | +---------------------------+----------------------------------------+---------+ | \_ZOMBIE\_PROCS\_WARNING | Zombie processes warning threshold, | string | | | for example 1:20 | | +---------------------------+----------------------------------------+---------+ | \_ZOMBIE\_PROCS\_CRITICAL | Zombie processes critical threshold, | string | | | for example 1:40 | | +---------------------------+----------------------------------------+---------+ Bluecoat ^^^^^^^^ **DESCRIPTION** ---------------------- Health and performance checks for Bluecoat proxy devices .. image:: ../images/packs/pack_icons/bluecoat.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===============+====================+====================+====================+ | gui | Checks if TCP/8082 | check\_bluecoat\_g | | | | port is up and | ui | | | | accepting | | | | | connections | | | +---------------+--------------------+--------------------+--------------------+ | ssh | Checks if TCP/22 | check\_bluecoat\_s | | | | port is up and | sh | | | | accepting | | | | | connections | | | +---------------+--------------------+--------------------+--------------------+ | mem\_usage | Checks the main | check\_bluecoat\_m | | | | memory usage | em\_usage | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTMEM\_WARNING | | | | | | | | | | \_HOSTMEM\_CRITICA | | | | | L | +---------------+--------------------+--------------------+--------------------+ | connections | Checks the ammount | check\_bluecoat\_c | | | | of connections | onnections | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTCONN\_WARNIN | | | | | G | | | | | | | | | | \_HOSTCONN\_CRITIC | | | | | AL | +---------------+--------------------+--------------------+--------------------+ | disk\_usage | Checks the disk | check\_bluecoat\_d | | | | usage | isk\_usage | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSTORAGE\_WAR | | | | | NING | | | | | | | | | | \_HOSTSTORAGE\_CRI | | | | | TICAL | +---------------+--------------------+--------------------+--------------------+ | proxy\_memory | Checks the proxy | check\_bluecoat\_p | | | | memory usage | roxy\_memory | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTPROXY\_MEM\_ | | | | | WARNING | | | | | | | | | | \_HOSTPROXY\_MEM\_ | | | | | CRITICAL | +---------------+--------------------+--------------------+--------------------+ | uptime | Checks the device | check\_bluecoat\_u | | | | uptime | 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 | string | | | $SNMPCOMMUNITYREAD$ for the default | | | | system community | | +------------------------+-------------------------------------------+---------+ | \_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 | integer | | | threshold | | +------------------------+-------------------------------------------+---------+ Checkpoint ^^^^^^^^^^ **DESCRIPTION** ---------------------- Info and connection checks for Checkpoint devices .. image:: ../images/packs/pack_icons/checkpoint.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +=============+=====================+=====================+====================+ | Connections | Checks the number | check\_checkpoint\_ | | | | of connections | connections | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTCONN\_WARNIN | | | | | G | | | | | | | | | | \_HOSTCONN\_CRITIC | | | | | AL | +-------------+---------------------+---------------------+--------------------+ | Info | Shows status info | check\_checkpoint\_ | | | | | info | \_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$ | string | | | for the default system community | | +------------------+-------------------------------------------------+---------+ | \_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 .. image:: ../images/packs/pack_icons/checkpoint-gw-r7720-gaia.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_Partit | Checks the Disk | check\_checkpoint | | | ion $KEY$ | usage | \_gaia\_disk | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSTORAGE\_W | | | | | ARNING | | | | | | | | | | \_HOSTSTORAGE\_C | | | | | RITICAL | | | | | | | | | | \_PARTITIONS | +-------------------+-------------------+-------------------+------------------+ | CKP\_Gaia\_Swap | Checks the Swap | check\_checkpoint | | | | usage | \_gaia\_swap | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSWAP\_WARN | | | | | ING | | | | | | | | | | \_HOSTSWAP\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | CKP\_Gaia\_CPU\_U | Checks the CPU | check\_checkpoint | | | sage | usage | \_gaia\_cpu | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | CKP\_Gaia\_Info | Shows status info | check\_checkpoint | | | | | \_gaia\_info | \_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 | string | | | $SNMPCOMMUNITYREAD$ for the default system | | | | community | | +---------------------+----------------------------------------------+---------+ | \_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 | +---------------------+----------------------------------------------+---------+ Checkpoint-licenses ^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks License/Contract expiration on Checkpoint devices .. image:: ../images/packs/pack_icons/checkpoint-licenses.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 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 | string | | | (in days) | | +---------------+---------------------------------------------------+----------+ | critical | Time period to expiration date critical threshold | string | | | (in days) | | +---------------+---------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/checkpoint-mgmt-r7720-gaia.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_ | Checks the Disk | check\_checkpoint | | | Partition $KEY$ | usage | \_mgmt\_gaia\_dis | \_HOSTSNMPCOMMUN | | | | k | ITY | | | | | | | | | | \_HOSTSTORAGE\_W | | | | | ARNING | | | | | | | | | | \_HOSTSTORAGE\_C | | | | | RITICAL | | | | | | | | | | \_PARTITIONS | +-------------------+-------------------+-------------------+------------------+ | CKP\_MGMT\_Gaia\_ | Checks the Swap | check\_checkpoint | | | Swap | usage | \_mgmt\_gaia\_swa | \_HOSTSNMPCOMMUN | | | | p | ITY | | | | | | | | | | \_HOSTSWAP\_WARN | | | | | ING | | | | | | | | | | \_HOSTSWAP\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | CKP\_MGMT\_Gaia\_ | Checks the CPU | check\_checkpoint | | | CPU\_Usage | usage | \_mgmt\_gaia\_cpu | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_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 | Device SNMP Community, use | string | | | $SNMPCOMMUNITYREAD$ for the default system | | | | community | | +---------------------+----------------------------------------------+---------+ | \_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 | +---------------------+----------------------------------------------+---------+ Fortianalyzer ^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for Fortianalyzer-Fortimanager devices .. image:: ../images/packs/pack_icons/fortianalyzer.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | check\_fortianaly | | | Memory Usage | | zer\_mem | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTMEM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Fortianalyzer | Checks disk usage | check\_fortianaly | | | Disk | | zer\_disk | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTDISK\_WARN | | | | | ING | | | | | | | | | | \_HOSTDISK\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | Fortianalyzer | Checks uptime | check\_fortianaly | | | Uptime | | zer\_uptime | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTUPTIME\_WA | | | | | RNING | | | | | | | | | | \_HOSTUPTIME\_CR | | | | | ITICAL | +-------------------+-------------------+-------------------+------------------+ | Fortianalyzer SSH | Checks SSH | check\_fortianaly | | | | availability | zer\_ssh | | +-------------------+-------------------+-------------------+------------------+ | Fortianalyzer | Checks GUI | check\_fortianaly | | | HTTPS | availability | zer\_https | | +-------------------+-------------------+-------------------+------------------+ | Fortianalyzer CPU | Checks CPU usage | check\_fortianaly | | | Usage | | zer\_cpu | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_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 | +--------------------+-------------------------------------------+---------+ | \_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 .. image:: ../images/packs/pack_icons/fortigate.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_sessio | Checks the number | check\_fortigate\ | | | ns\_node1 | of sessions in | _sessions\_node1 | \_HOSTSNMPCOMMUN | | | Node1 | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTSESSION\_W | | | | | ARNING | | | | | | | | | | \_HOSTSESSION\_C | | | | | RITICAL | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_HA | Detects High | check\_fortigate\ | | | | Availability | _ha\_load\_balanc | \_HOSTSNMPCOMMUN | | | changes | ing | ITY | | | | | | | | | | \_HOSTHA\_ALARM\ | | | | | _PERSISTANCE | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_SSH | Checks SSH | check\_fortigate\ | | | | availability | _ssh | \_HOSTSSH\_PORT | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_cpu\_n | Checks Node2 CPU | check\_fortigate\ | | | ode2 | usage | _cpu\_node2 | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_cpu\_n | Checks Node1 CPU | check\_fortigate\ | | | ode1 | usage | _cpu\_node1 | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_GUI | Checks GUI | check\_fortigate\ | | | | availability | _gui | \_HOSTGUI\_PORT | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_sessio | Checks the number | check\_fortigate\ | | | ns\_node2 | of sessions in | _sessions\_node2 | \_HOSTSNMPCOMMUN | | | Node2 | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTSESSION\_W | | | | | ARNING | | | | | | | | | | \_HOSTSESSION\_C | | | | | RITICAL | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_mem\_u | Checks Node2 | check\_fortigate\ | | | sage\_node2 | memory usage | _mem\_usage\_node | \_HOSTSNMPCOMMUN | | | | 2 | ITY | | | | | | | | | | \_HOSTMEM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_Uptime | Checks uptime | check\_fortigate\ | | | | | _uptime | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_mem\_u | Checks Node1 | check\_fortigate\ | | | sage\_node1 | memory usage | _mem\_usage\_node | \_HOSTSNMPCOMMUN | | | | 1 | 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 | string | | | $SNMPCOMMUNITYREAD$ for the default | | | | system community | | +--------------------------+-----------------------------------------+---------+ | \_SNMPVERSION | Device SNMP versions supported are: 1 | string | | | and 2c | | +--------------------------+-----------------------------------------+---------+ | \_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 | integer | | | 443) | | +--------------------------+-----------------------------------------+---------+ | \_SSH\_PORT | TCP Port number for SSH access (default | integer | | | 22) | | +--------------------------+-----------------------------------------+---------+ | \_HA\_ALARM\_PERSISTANCE | High Availability changes alarm | integer | | | persistance time in seconds (default 1 | | | | hour) | | +--------------------------+-----------------------------------------+---------+ Fortigate-standalone ^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for Fortigate devices working in standalone mode .. image:: ../images/packs/pack_icons/fortigate-standalone.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_sessio | Checks the number | check\_fortigate\ | | | ns | of sessions | _standalone\_sess | \_HOSTSNMPCOMMUN | | | | ions | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTSESSION\_W | | | | | ARNING | | | | | | | | | | \_HOSTSESSION\_C | | | | | RITICAL | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_serial | Shows the serial | check\_fortigate\ | | | | number | _standalone\_seri | \_HOSTSNMPCOMMUN | | | | al | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_cpu | Checks CPU usage | check\_fortigate\ | | | | | _standalone\_cpu | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Fortigate Uptime | Checks the uptime | check\_fortigate\ | | | | | _standalone\_upti | \_HOSTSNMPCOMMUN | | | | me | ITY | +-------------------+-------------------+-------------------+------------------+ | Fortigate\_mem\_u | Checks Memory | check\_fortigate\ | | | sage | usage | _standalone\_mem\ | \_HOSTSNMPCOMMUN | | | | _usage | 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 | string | | | $SNMPCOMMUNITYREAD$ for the default system | | | | community | | +---------------------+----------------------------------------------+---------+ | \_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 | integer | | | 443) | | +---------------------+----------------------------------------------+---------+ | \_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 .. image:: ../images/packs/pack_icons/fortimail.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | fortimail\_ha | | | | Availability changes | | \_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 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 | string | | | $SNMPCOMMUNITYREAD$ for the default | | | | system community | | +--------------------------+-----------------------------------------+---------+ | \_SNMPVERSION | Device SNMP versions supported are: 1 | string | | | and 2c | | +--------------------------+-----------------------------------------+---------+ | \_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 | integer | | | threshold | | +--------------------------+-----------------------------------------+---------+ | \_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 | integer | | | 443) | | +--------------------------+-----------------------------------------+---------+ | \_SSH\_PORT | TCP Port number for SSH access (default | integer | | | 22) | | +--------------------------+-----------------------------------------+---------+ | \_HA\_ALARM\_PERSISTANCE | High Availability changes alarm | integer | | | persistance time in seconds (default 1 | | | | hour) | | +--------------------------+-----------------------------------------+---------+ **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 .. image:: ../images/packs/pack_icons/fortimail-standalone.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 Uptime | Checks uptime | fortimail\_uptime | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTUPTIME\_WA | | | | | RNING | | | | | | | | | | \_HOSTUPTIME\_CR | | | | | ITICAL | +-------------------+-------------------+-------------------+------------------+ | Fortimail CPU | Checks Fortimail | fortimail\_cpu | | | | CPU usage | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Fortimail SSH | Checks SSH | fortimail\_ssh | | | | availability | | \_HOSTSSH\_PORT | +-------------------+-------------------+-------------------+------------------+ | Fortimail | Checks deferred | fortimail\_deferr | | | Deferred | queue | ed | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTDEFERRED\_ | | | | | WARNING | | | | | | | | | | \_HOSTDEFERRED\_ | | | | | CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Fortimail Mail | Checks mail disk | fortimail\_mail\_ | | | Disk | usage | disk | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTMAIL\_DISK | | | | | \_WARNING | | | | | | | | | | \_HOSTMAIL\_DISK | | | | | \_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Fortimail Queue - | Checks the mail | fortimail\_queue | | | $KEY$ | queues | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_FORTIMAIL\_QUE | | | | | UE\_LIST | +-------------------+-------------------+-------------------+------------------+ | Fortimail GUI | Checks GUI | fortimail\_gui | | | | availability | | \_HOSTGUI\_PORT | +-------------------+-------------------+-------------------+------------------+ | Fortimail Mem | Checks memory | fortimail\_mem | | | | usage | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTMEM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Fortimail Log | Checks log disk | fortimail\_log\_d | | | Disk | usage | isk | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTLOG\_DISK\ | | | | | _WARNING | | | | | | | | | | \_HOSTLOG\_DISK\ | | | | | _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 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 | string | | | $SNMPCOMMUNITYREAD$ for the default | | | | system community | | +------------------------+-------------------------------------------+---------+ | \_SNMPVERSION | Device SNMP versions supported are: 1 and | string | | | 2c | | +------------------------+-------------------------------------------+---------+ | \_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 | integer | | | 443) | | +------------------------+-------------------------------------------+---------+ | \_SSH\_PORT | TCP Port number for SSH access (default | integer | | | 22) | | +------------------------+-------------------------------------------+---------+ **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 .. image:: ../images/packs/pack_icons/fortinet-licenses.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_ | | check\_fortinet\_li | | | $KEY$ | | 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 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 | string | | | (in days) | | +---------------+---------------------------------------------------+----------+ | critical | Time period to expiration date critical threshold | string | | | (in days) | | +---------------+---------------------------------------------------+----------+ Fortiweb ^^^^^^^^ **DESCRIPTION** ---------------------- Checks for Fortiweb devices .. image:: ../images/packs/pack_icons/fortiweb.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 SSH | Checks SSH | check\_fortiweb\_ | | | | availability | ssh | | +-------------------+-------------------+-------------------+------------------+ | Fortiweb HTTPS | Checks the GUI | check\_fortiweb\_ | | | | availability | https | | +-------------------+-------------------+-------------------+------------------+ | Fortiweb Uptime | Checks the uptime | check\_fortiweb\_ | | | | | uptime | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Fortiweb Mem | Checks Memory | check\_fortiweb\_ | | | | usage | mem | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTMEM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Fortiweb CPU | Checks the CPU | check\_fortiweb\_ | | | Usage | usage | cpu | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_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 | +-----------------+----------------------------------------+---------+ | \_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 .. image:: ../images/packs/pack_icons/ironport-cisco.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 CPU | Checks Ironport | check\_ironport\_ | | | | CPU usage | cisco\_cpu | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Ironport Raid | Checks Ironport | check\_ironport\_ | | | Status | Raid Drives | cisco\_raid\_stat | \_HOSTSNMPVERSIO | | | status and errors | us | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Ironport Queue | Checks Ironport | check\_ironport\_ | | | usage percent | mail Queue usage | cisco\_queue\_per | \_HOSTSNMPVERSIO | | | percent | cent | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTQUEUE\_PER | | | | | CENT\_WARNING | | | | | | | | | | \_HOSTQUEUE\_PER | | | | | CENT\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Ironport | Checks Ironport | check\_ironport\_ | | | Temperature | temperature | cisco\_temp | \_HOSTSNMPVERSIO | | | sensors | | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTTEMP\_WARN | | | | | ING | | | | | | | | | | \_HOSTTEMP\_CRIT | | | | | ICAL | +-------------------+-------------------+-------------------+------------------+ | Ironport Memory | Checks Ironport | check\_ironport\_ | | | | Memory usage | cisco\_mem | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTMEM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Ironport Licenses | Checks Ironport | check\_ironport\_ | | | | installed | cisco\_license | \_HOSTSNMPVERSIO | | | Licenses | | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTLICENSE\_W | | | | | ARNING | | | | | | | | | | \_HOSTLICENSE\_C | | | | | RITICAL | +-------------------+-------------------+-------------------+------------------+ | Ironport Oldest | Checks Ironport | check\_ironport\_ | | | message | oldest queued | cisco\_oldest\_me | \_HOSTSNMPVERSIO | | | message | ssage | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTOLDEST\_WA | | | | | RNING | | | | | | | | | | \_HOSTOLDEST\_CR | | | | | ITICAL | +-------------------+-------------------+-------------------+------------------+ | Ironport | Checks Ironport | check\_ironport\_ | | | Files/Sockets | open | cisco\_sockets | \_HOSTSNMPVERSIO | | | Files/Sockets | | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSOCKETS\_W | | | | | ARNING | | | | | | | | | | \_HOSTSOCKETS\_C | | | | | RITICAL | +-------------------+-------------------+-------------------+------------------+ | Ironport Power | Checks Ironport | check\_ironport\_ | | | Supply | Power supply | cisco\_powersuppl | \_HOSTSNMPVERSIO | | | status and | y | N | | | redundancy | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Ironport Memory | Checks Ironport | check\_ironport\_ | | | Status | Memory status | cisco\_mem\_statu | \_HOSTSNMPVERSIO | | | | s | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Ironport mail | Checks Ironport | check\_ironport\_ | | | related Threads | mail related | cisco\_mail\_thre | \_HOSTSNMPVERSIO | | | threads | ads | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTTHREADS\_W | | | | | ARNING | | | | | | | | | | \_HOSTTHREADS\_C | | | | | RITICAL | +-------------------+-------------------+-------------------+------------------+ | Ironport | Checks Ironport | check\_ironport\_ | | | Conservation | Conservation mode | cisco\_conservati | \_HOSTSNMPVERSIO | | reason | reason | on\_reason | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Ironport Queue | Checks Ironport | check\_ironport\_ | | | count | mail Queue | cisco\_queue\_cou | \_HOSTSNMPVERSIO | | | message count | nt | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTQUEUE\_COU | | | | | NT\_WARNING | | | | | | | | | | \_HOSTQUEUE\_COU | | | | | NT\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Ironport Queue | Checks Ironport | check\_ironport\_ | | | status | mail Queue status | cisco\_queue\_sta | \_HOSTSNMPVERSIO | | | | tus | 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 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 | string | | | and 2c | | +----------------------------+---------------------------------------+---------+ | \_CPU\_WARNING | CPU usage percent warning threshold | percent | +----------------------------+---------------------------------------+---------+ | \_CPU\_CRITICAL | CPU usage percent critical threshold | percent | +----------------------------+---------------------------------------+---------+ | \_MEM\_WARNING | Memory usage percent warning | percent | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_MEM\_CRITICAL | Memory usage percent critical | percent | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_SOCKETS\_WARNING | Open Files/Sockets warning threshold | integer | +----------------------------+---------------------------------------+---------+ | \_SOCKETS\_CRITICAL | Open Files/Sockets critical threshold | integer | +----------------------------+---------------------------------------+---------+ | \_TEMP\_WARNING | Temperature warning threshold (in | integer | | | celsius) | | +----------------------------+---------------------------------------+---------+ | \_TEMP\_CRITICAL | Temperature critical threshold (in | integer | | | celsius) | | +----------------------------+---------------------------------------+---------+ | \_LICENSE\_WARNING | License expiration warning threshold | integer | | | (in days) | | +----------------------------+---------------------------------------+---------+ | \_LICENSE\_CRITICAL | License expiration critical threshold | integer | | | (in days) | | +----------------------------+---------------------------------------+---------+ | \_QUEUE\_COUNT\_WARNING | Message number in work queue warning | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_QUEUE\_COUNT\_CRITICAL | Message number in work queue critical | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_QUEUE\_PERCENT\_WARNING | Mail queue usage percent warning | percent | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_QUEUE\_PERCENT\_CRITICAL | Mail queue usage percent critical | percent | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_OLDEST\_WARNING | Oldest message queued time warning | integer | | | threshold (in seconds) | | +----------------------------+---------------------------------------+---------+ | \_OLDEST\_CRITICAL | Oldest message queued time critical | integer | | | threshold (in seconds) | | +----------------------------+---------------------------------------+---------+ | \_THREADS\_WARNING | Mail related threads number warning | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_THREADS\_CRITICAL | Mail related threads number critical | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ Juniper-pulse-secure ^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for Juniper Pulse Secure VPN devices using SNMP .. image:: ../images/packs/pack_icons/juniper-pulse-secure.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 Node | Checks the number | check\_pulse\_nod | | | Users | of users from | e\_users | \_HOSTSNMPCOMMUN | | | node | | ITY | | | | | | | | | | \_HOSTNODE\_USER | | | | | S\_WARNING | | | | | | | | | | \_HOSTNODE\_USER | | | | | S\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Pulse Secure Mem | Checks the memory | check\_pulse\_mem | | | | usage | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTMEM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEMCRITICA | | | | | L | +-------------------+-------------------+-------------------+------------------+ | Pulse Secure | Checks the number | check\_pulse\_clu | | | Cluster Users | of users from | ster\_users | \_HOSTSNMPCOMMUN | | | cluster | | ITY | | | | | | | | | | \_HOSTCLUSTER\_U | | | | | SERS\_WARNING | | | | | | | | | | \_HOSTCLUSTER\_U | | | | | SERS\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Pulse Secure Web | Checks the number | check\_pulse\_web | | | Users | of web users | \_users | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTWEB\_USERS | | | | | \_WARNING | | | | | | | | | | \_HOSTWEB\_USERS | | | | | \_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Pulse Secure Disk | Checks the disk | check\_pulse\_dis | | | | usage | k | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTDISK\_WARN | | | | | ING | | | | | | | | | | \_HOSTDISKCRITIC | | | | | AL | +-------------------+-------------------+-------------------+------------------+ | Pulse Secure Swap | Checks the SWAP | check\_pulse\_swa | | | | usage | p | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSWAP\_WARN | | | | | ING | | | | | | | | | | \_HOSTSWAPCRITIC | | | | | 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 | +============================+=======================================+=========+ | \_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) | | +----------------------------+---------------------------------------+---------+ | \_CLUSTER\_USERS\_WARNING | Cluster users warning threshold | integer | +----------------------------+---------------------------------------+---------+ | \_CLUSTER\_USERS\_CRITICAL | Cluster users critical threshold | integer | +----------------------------+---------------------------------------+---------+ | \_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 | +----------------------------+---------------------------------------+---------+ | \_SNMPCOMMUNITY | Device SNMP Community, use | string | | | $SNMPCOMMUNITYREAD$ for the default | | | | system community | | +----------------------------+---------------------------------------+---------+ Mcafee-nsp ^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for a McAfee NSP device. Checks are done by SSH. .. image:: ../images/packs/pack_icons/mcafee-nsp.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 Traffic | Obtain the | check\_ssh\_inter | | | OUT interface | interface output | face\_traffic\_ou | \_HOSTSSH\_USER | | $KEY$ | traffic | t | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTTRAFFIC\_O | | | | | UT\_WARNING | | | | | | | | | | \_HOSTTRAFFIC\_O | | | | | UT\_CRITICAL | | | | | | | | | | \_INTERFACES | +-------------------+-------------------+-------------------+------------------+ | Mcafee Sensor | Obtain the system | check\_ssh\_senso | | | Uptime | uptime | r\_uptime | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTUPTIME\_CR | | | | | ITICAL | | | | | | | | | | \_HOSTUPTIME\_WA | | | | | RNING | +-------------------+-------------------+-------------------+------------------+ | Mcafee Power | Checks Power | check\_ssh\_power | | | Supply Status | Supply status | supply\_status | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | +-------------------+-------------------+-------------------+------------------+ | Mcafee Traffic IN | Obtain the | check\_ssh\_inter | | | interface $KEY$ | interface input | face\_traffic\_in | \_HOSTSSH\_USER | | | traffic | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTTRAFFIC\_I | | | | | N\_WARNING | | | | | | | | | | \_HOSTTRAFFIC\_I | | | | | N\_CRITICAL | | | | | | | | | | \_INTERFACES | +-------------------+-------------------+-------------------+------------------+ | Mcafee CPU Usage | Checks CPU usage | check\_ssh\_cpu\_ | | | | | usage | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Mcafee Interface | Checks Interfaces | check\_ssh\_inter | | | Status $KEY$ | status | face\_status | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_INTERFACES | +-------------------+-------------------+-------------------+------------------+ | Mcafee Failover | Checks High | check\_ssh\_failo | | | Status | Availability | ver\_status | \_HOSTSSH\_USER | | | status | | | | | | | \_HOSTSSH\_KEY | +-------------------+-------------------+-------------------+------------------+ | Mcafee MEM Usage | Checks Memory | check\_ssh\_mem\_ | | | | usage | usage | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_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 | +==========================+==========================+========================+ | \_SSH\_USER | Remote user for the SSH | string | | | service (key interchange | | | | with Shinken user must | | | | be done ) | | +--------------------------+--------------------------+------------------------+ | \_SSH\_KEY | SSH key (Shinken user) | string | +--------------------------+--------------------------+------------------------+ | \_CPU\_WARNING | CPU usage warning | percent | | | threshold (percentage) | | +--------------------------+--------------------------+------------------------+ | \_CPU\_CRITICAL | CPU usage critical | percent | | | threshold (percentage) | | +--------------------------+--------------------------+------------------------+ | \_MEM\_WARNING | Physical memory warning | percent | | | threshold (percentage) | | +--------------------------+--------------------------+------------------------+ | \_MEM\_CRITICAL | Physical memory critical | percent | | | threshold (percentage) | | +--------------------------+--------------------------+------------------------+ | \_UPTIME\_WARNING | Uptime warning threshold | integer | +--------------------------+--------------------------+------------------------+ | \_UPTIME\_CRITICAL | Uptime critical | integer | | | threshold | | +--------------------------+--------------------------+------------------------+ | \_TRAFFIC\_IN\_WARNING | Input traffic packets | integer | | | warning threshold | | +--------------------------+--------------------------+------------------------+ | \_TRAFFIC\_IN\_CRITICAL | Input traffic packets | integer | | | critical threshold | | +--------------------------+--------------------------+------------------------+ | \_TRAFFIC\_OUT\_WARNING | Output traffic packets | integer | | | warning threshold | | +--------------------------+--------------------------+------------------------+ | \_TRAFFIC\_OUT\_CRITICAL | Output traffic packets | integer | | | critical threshold | | +--------------------------+--------------------------+------------------------+ | \_INTERFACES | List of interfaces to | comma-separated string | | | check. Values separated | | | | by comma | | +--------------------------+--------------------------+------------------------+ Palo-alto ^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for Palo Alto Devices (Uptime, NTP, Sessions, Info) via snmp .. image:: ../images/packs/pack_icons/palo-alto.png :align: center :scale: 50% 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 :ref:`packs-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 | +====================+=============+=====================+=====================+ | Sessions\_Info | | check\_paloalto\_se | | | | | ssions\_info | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTSESSIONS\_WAR | | | | | N | | | | | | | | | | \_HOSTSESSIONS\_CRI | | | | | T | +--------------------+-------------+---------------------+---------------------+ | Uptime | | check\_paloalto\_up | | | | | time | \_HOSTSNMPCOMMUNITY | +--------------------+-------------+---------------------+---------------------+ | VPN Active Tunnels | | check\_paloalto\_ac | | | | | tive\_tunnels | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTACTIVE\_TUNNE | | | | | LS\_WARNING\_MIN | | | | | | | | | | \_HOSTACTIVE\_TUNNE | | | | | LS\_WARNING | | | | | | | | | | \_HOSTACTIVE\_TUNNE | | | | | LS\_CRITICAL | +--------------------+-------------+---------------------+---------------------+ | ha\_state | | check\_paloalto\_ha | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTSESSIONS\_WAR | | | | | N | | | | | | | | | | \_HOSTSESSIONS\_CRI | | | | | T | | | | | | | | | | \_HOSTHA\_LOCAL\_ST | | | | | ATE | +--------------------+-------------+---------------------+---------------------+ | Info | | check\_paloalto\_in | | | | | fo | \_HOSTSNMPCOMMUNITY | +--------------------+-------------+---------------------+---------------------+ **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 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$ --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 | string | | | configured on remote server | | +---------------------------------+----------------------------------+---------+ | \_SESSIONS\_WARN | Current Sessions warning | integer | | | threshold | | +---------------------------------+----------------------------------+---------+ | \_SESSIONS\_CRIT | Current Sessions critical | integer | | | threshold | | +---------------------------------+----------------------------------+---------+ | \_HA\_LOCAL\_STATE | Current device status HA State | string | +---------------------------------+----------------------------------+---------+ | \_NTP\_WARN | NTP timings warning level (in | integer | | | seconds) | | +---------------------------------+----------------------------------+---------+ | \_NTP\_CRIT | NTP timings critical level (in | integer | | | seconds) | | +---------------------------------+----------------------------------+---------+ | \_ACTIVE\_TUNNELS\_WARNING\_MIN | Minimum number of VPN Active | integer | | | Tunnels warning threshold | | +---------------------------------+----------------------------------+---------+ | \_ACTIVE\_TUNNELS\_WARNING | Maximum number of VPN Active | integer | | | Tunnels warning threshold | | +---------------------------------+----------------------------------+---------+ | \_ACTIVE\_TUNNELS\_CRITICAL | Maximum number of VPN Active | integer | | | Tunnels critical threshold | | +---------------------------------+----------------------------------+---------+ Palo-alto-7000-health ^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Hardware checks for Palo Alto 7000 series Devices (Fans, Temperature and Power supply) via snmp .. image:: ../images/packs/pack_icons/palo-alto-7000-health.png :align: center :scale: 50% 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 :ref:`packs-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 | | check\_paloalto\_70 | | | Supply | | 00\_health\_powersu | \_HOSTSNMPCOMMUNIT | | | | pply | 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 | The snmp community read configured on remote | string | | | device | | +------------------+-------------------------------------------------+---------+ | \_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 .. image:: ../images/packs/pack_icons/palo-alto-health.png :align: center :scale: 50% 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 :ref:`packs-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 fan sensor | | check\_paloalto\_he | | | | | alth\_fan | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTRPM\_WARNING | | | | | | | | | | \_HOSTRPM\_CRITICA | | | | | L | +---------------------+-------------+---------------------+--------------------+ | Paloalto temp | | check\_paloalto\_he | | | sensor | | alth\_temp | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTTEMP\_WARNIN | | | | | G | | | | | | | | | | \_HOSTTEMP\_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 | The snmp community read configured on remote | string | | | device | | +------------------+-------------------------------------------------+---------+ | \_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 | +------------------+-------------------------------------------------+---------+ Qradar ^^^^^^ **DESCRIPTION** ---------------------- Generic checks for QRadar devices .. image:: ../images/packs/pack_icons/qradar.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_qradar\_disk | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTDISK\_WARNING | | | | | | | | | | \_HOSTDISK\_CRITICAL | | | | | | | | | | \_PARTITIONS | +-----------------+-------------+-----------------------+----------------------+ | Swap | | check\_qradar\_swap | | | | | | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTSWAP\_WARNING | | | | | | | | | | \_HOSTSWAP\_CRITICAL | +-----------------+-------------+-----------------------+----------------------+ | Hostname | | check\_qradar\_hostna | | | | | me | \_HOSTSNMPCOMMUNITY | +-----------------+-------------+-----------------------+----------------------+ | CPU Usage | | check\_qradar\_cpu\_u | | | | | sage | \_HOSTSNMPCOMMUNITY | | | | | | | | | | \_HOSTCPU\_WARNING | | | | | | | | | | \_HOSTCPU\_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$ | string | | | for the default system community | | +------------------+-------------------------------------------------+---------+ | \_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 | string | | | /,/var | | +------------------+-------------------------------------------------+---------+ Sourcefire ^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for Sourcefire devices .. image:: ../images/packs/pack_icons/sourcefire.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | check\_sourcefire\_ | | | | | ssh | | +---------------------+-------------+---------------------+--------------------+ | Sourcefire NTP sync | | check\_sourcefire\_ | | | | | ntp\_sync | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTOFFSET\_WARN | | | | | ING | | | | | | | | | | \_HOSTOFFSET\_CRIT | | | | | ICAL | +---------------------+-------------+---------------------+--------------------+ | Sourcefire Storage | | check\_sourcefire\_ | | | | | storage | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSTORAGE\_WAR | | | | | N | | | | | | | | | | \_HOSTSTORAGE\_CRI | | | | | T | +---------------------+-------------+---------------------+--------------------+ | Sourcefire | | check\_sourcefire\_ | | | Established TCP | | tcp\_sessions | \_HOSTSNMPCOMMUNIT | | sessions | | | Y | | | | | | | | | | \_HOSTSESSION\_WAR | | | | | NING | | | | | | | | | | \_HOSTSESSION\_CRI | | | | | TICAL | +---------------------+-------------+---------------------+--------------------+ | Sourcefire HTTPS | | check\_sourcefire\_ | | | | | https | | +---------------------+-------------+---------------------+--------------------+ | Sourcefire Load | | check\_sourcefire\_ | | | | | load | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTLOAD\_WARNIN | | | | | G | | | | | | | | | | \_HOSTLOAD\_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 | string | | | $SNMPCOMMUNITYREAD$ for the default system | | | | community | | +---------------------+----------------------------------------------+---------+ | \_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 .. image:: ../images/packs/pack_icons/stonegate.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +=====================+=============+=====================+====================+ | Software version | | check\_stonegate\_s | | | | | w\_version | \_HOSTSNMPCOMMUNIT | | | | | Y | +---------------------+-------------+---------------------+--------------------+ | CPU\_usage | | check\_stonegate\_c | | | | | pu | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTCPU\_WARNING | | | | | | | | | | \_HOSTCPU\_CRITICA | | | | | L | +---------------------+-------------+---------------------+--------------------+ | Uptime | | check\_stonegate\_u | | | | | ptime | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTUPTIME\_WARN | | | | | ING | | | | | | | | | | \_HOSTUPTIME\_CRIT | | | | | ICAL | +---------------------+-------------+---------------------+--------------------+ | Interface\_status | | check\_stonegate\_i | | | $KEY$ | | nterface\_status | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_INTERFACES | +---------------------+-------------+---------------------+--------------------+ **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 | string | | | $SNMPCOMMUNITYREAD$ for the default system | | | | community | | +--------------------+-----------------------------------------------+---------+ | \_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 .. image:: ../images/packs/pack_icons/stonegate-fw.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | | check\_stonegate\_f | | | Accepted Packets | | w\_accepted\_packet | \_HOSTSNMPCOMMUNIT | | | | s | Y | | | | | | | | | | \_HOSTACCEPTED\_WA | | | | | RNING | | | | | | | | | | \_HOSTACCEPTED\_CR | | | | | ITICAL | +---------------------+-------------+---------------------+--------------------+ | Stonegate-fw Uptime | | check\_stonegate\_f | | | | | w\_uptime | \_HOSTSNMPCOMMUNIT | | | | | Y | +---------------------+-------------+---------------------+--------------------+ | Stonegate-fw Node | | check\_stonegate\_f | | | state | | w\_node\_state | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTNODE\_STATE | | | | | | | | | | \_HOSTALARM\_PERSI | | | | | STENCE | +---------------------+-------------+---------------------+--------------------+ | Stonegate-fw | | check\_stonegate\_f | | | Dropped Packets | | w\_dropped\_packets | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTDROPPED\_WAR | | | | | NING | | | | | | | | | | \_HOSTDROPPED\_CRI | | | | | TICAL | +---------------------+-------------+---------------------+--------------------+ | Stonegate-fw | | check\_stonegate\_f | | | CPU\_usage | | w\_cpu | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTCPU\_WARNING | | | | | | | | | | \_HOSTCPU\_CRITICA | | | | | L | +---------------------+-------------+---------------------+--------------------+ | Stonegate-fw | | check\_stonegate\_r | | | Rejected Packets | | ejected\_packets | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTREJECTED\_WA | | | | | RNING | | | | | | | | | | \_HOSTREJECTED\_CR | | | | | ITICAL | +---------------------+-------------+---------------------+--------------------+ | Stonegate-fw | | check\_stonegate\_f | | | Connections | | w\_conn | \_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 | string | | | $SNMPCOMMUNITYREAD$ for the default system | | | | community | | +----------------------+---------------------------------------------+---------+ | \_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 | integer | | | in minutes. Used in node cluster state | | | | service. Default 0 (No persistence) | | +----------------------+---------------------------------------------+---------+ Database -------- Elastic-node ^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks the status of a single Elastic node .. image:: ../images/packs/pack_icons/elastic-node.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_CPU\_loa | Checks CPU | check\_elastic\_c | | | d | average | pu | \_HOSTELASTIC\_P | | | percentage load | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | | | | | | | | | | \_HOSTCPU\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTCPU\_CRITI | | | | | CAL\_THRESHOLD | +-------------------+-------------------+-------------------+------------------+ | Elastic\_node\_me | Checks used | check\_elastic\_m | | | mory | memory percentage | emory | \_HOSTELASTIC\_P | | | | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | | | | | | | | | | \_HOSTMEMORY\_WA | | | | | RNING\_THRESHOLD | | | | | | | | | | \_HOSTMEMORY\_CR | | | | | ITICAL\_THRESHOL | | | | | D | +-------------------+-------------------+-------------------+------------------+ | Elastic\_software | Checks the | check\_node\_inde | | | \_indexing | indexing time | xing | \_HOSTELASTIC\_P | | | | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | | | | | | | | | | \_HOSTINDEXING\_ | | | | | WARNING\_THRESHO | | | | | LD | | | | | | | | | | \_HOSTINDEXING\_ | | | | | CRITICAL\_THRESH | | | | | OLD | +-------------------+-------------------+-------------------+------------------+ | Elastic\_document | Checks the number | check\_elastic\_d | | | s | of documents | ocuments | \_HOSTELASTIC\_P | | | | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | +-------------------+-------------------+-------------------+------------------+ | Elastic\_software | Checks the index | check\_node\_sear | | | \_search\_query | search query time | ch\_query | \_HOSTELASTIC\_P | | | | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | | | | | | | | | | \_HOSTSEARCH\_QU | | | | | ERY\_WARNING\_TH | | | | | RESHOLD | | | | | | | | | | \_HOSTSEARCH\_QU | | | | | ERY\_CRITICAL\_T | | | | | HRESHOLD | +-------------------+-------------------+-------------------+------------------+ | Elastic\_disk\_us | Checks Disk usage | check\_elastic\_d | | | ed | | isk\_space\_used | \_HOSTELASTIC\_P | | | | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | | | | | | | | | | \_HOSTDISK\_SPAC | | | | | E\_USED\_WARNING | | | | | \_THRESHOLD | | | | | | | | | | \_HOSTDISK\_SPAC | | | | | E\_USED\_CRITICA | | | | | L\_THRESHOLD | +-------------------+-------------------+-------------------+------------------+ | Elastic\_software | Shows Elastic | check\_elastic\_v | | | \_version | node version | ersion | \_HOSTELASTIC\_P | | | | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | +-------------------+-------------------+-------------------+------------------+ | Elastic\_cluster\ | Checks Shards | check\_shards\_st | | | _shards\_status | status | atus | \_HOSTELASTIC\_P | | | | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | | | | | | | | | | \_HOSTUNASSIGNED | | | | | \_SHARD\_WARNING | | | | | \_THRESHOLD | | | | | | | | | | \_HOSTUNASSIGNED | | | | | \_SHARD\_CRITICA | | | | | L\_THRESHOLD | +-------------------+-------------------+-------------------+------------------+ | Elastic\_cluster\ | Checks Cluster | check\_cluster\_h | | | _status | status | ealth | \_HOSTELASTIC\_P | | | | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | +-------------------+-------------------+-------------------+------------------+ | Elastic\_cluster\ | Shows Shards info | check\_shards\_co | | | _shards\_count | | unt | \_HOSTELASTIC\_P | | | | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | +-------------------+-------------------+-------------------+------------------+ | Elastic\_software | Checks the | check\_elastic\_u | | | \_uptime | Elastic node | ptime | \_HOSTELASTIC\_P | | | uptime | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | | | | | | | | | | \_HOSTNODE\_UPTI | | | | | ME\_WARNING\_THR | | | | | ESHOLD | | | | | | | | | | \_HOSTNODE\_UPTI | | | | | ME\_WARNING\_THR | | | | | ESHOLD | +-------------------+-------------------+-------------------+------------------+ | Elastic\_jvm\_mem | Checks used | check\_elastic\_m | | | ory | memory percentage | emory\_jvm | \_HOSTELASTIC\_P | | | of JVM | | ORT | | | | | | | | | | \_HOSTELASTIC\_N | | | | | ODENAME | | | | | | | | | | \_HOSTJVM\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTJVM\_CRITI | | | | | CAL\_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 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 | integer | | | (default 9200) | | +----------------------------------+---------------------------------+---------+ | \_ELASTIC\_NODENAME | Name of the Elastic node (as | string | | | registered in the service) | | +----------------------------------+---------------------------------+---------+ | \_CPU\_WARNING\_THRESHOLD | Warning threshold for the CPU | percent | | | used by Elastic node | | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_CPU\_CRITICAL\_THRESHOLD | Critical threshold for the CPU | percent | | | used by Elastic node | | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_MEMORY\_WARNING\_THRESHOLD | Warning threshold for the | percent | | | memory used by Elastic node | | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_MEMORY\_CRITICAL\_THRESHOLD | Critical threshold for the | percent | | | memory used by Elastic node | | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_JVM\_WARNING\_THRESHOLD | Warning threshold for the JVM | percent | | | Memory used by Elastic | | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_JVM\_CRITICAL\_THRESHOLD | Critical threshold for the JVM | percent | | | Memory used by Elastic | | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_DISK\_SPACE\_USED\_WARNING\_TH | Warning threshold for the disk | percent | | RESHOLD | space used by Elastic | | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_DISK\_SPACE\_USED\_CRITICAL\_T | Critical threshold for the disk | percent | | HRESHOLD | space used by Elastic | | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_INDEXING\_WARNING\_THRESHOLD | Warning threshold for the | integer | | | indexing time by Elastic (in | | | | milliseconds) | | +----------------------------------+---------------------------------+---------+ | \_INDEXING\_CRITICAL\_THRESHOLD | Critical threshold for the | integer | | | indexing time by Elastic (in | | | | milliseconds) | | +----------------------------------+---------------------------------+---------+ | \_SEARCH\_QUERY\_WARNING\_THRESH | Warning threshold for the | integer | | OLD | search query time by Elastic | | | | (in milliseconds) | | +----------------------------------+---------------------------------+---------+ | \_SEARCH\_QUERY\_CRITICAL\_THRES | Critical threshold for the | integer | | HOLD | search query time by Elastic | | | | (in milliseconds) | | +----------------------------------+---------------------------------+---------+ | \_UNASSIGNED\_SHARD\_WARNING\_TH | Warning threshold for | integer | | RESHOLD | unassigned shards | | +----------------------------------+---------------------------------+---------+ | \_UNASSIGNED\_SHARD\_CRITICAL\_T | Critical threshold for | integer | | HRESHOLD | unassigned shards | | +----------------------------------+---------------------------------+---------+ | \_NODE\_UPTIME\_WARNING\_THRESHO | Warning threshold for software | integer | | LD | uptime (in seconds) | | +----------------------------------+---------------------------------+---------+ | \_NODE\_UPTIME\_CRITICAL\_THRESH | Critical threshold for software | integer | | OLD | uptime (in seconds) | | +----------------------------------+---------------------------------+---------+ Influxdb-node ^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Health and performance checks of a InfluxDB node .. image:: ../images/packs/pack_icons/influxdb-node.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | InfluxDB Versions | Shows all | check\_influxdb\_ | | | | InfluxDB info | info | \_HOSTINFLUXDB\_ | | | | | PORT | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | USER | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | PASS | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | NODENAME | +-------------------+-------------------+-------------------+------------------+ | InfluxDB Requests | Checks diff of | check\_influxdb\_ | | | | Http api | requests | \_HOSTINFLUXDB\_ | | | resquests (ping/r | | PORT | | | ad/write/total) | | | | | | | \_HOSTINFLUXDB\_ | | | | | USER | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | PASS | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | NODENAME | | | | | | | | | | \_HOSTREQUEST\_W | | | | | ARNING\_THRESHOL | | | | | D | | | | | | | | | | \_HOSTREQUEST\_C | | | | | RITICAL\_THRESHO | | | | | LD | +-------------------+-------------------+-------------------+------------------+ | Collectd Plugin | Shows all | check\_influxdb\_ | | | | Collectd info | collectd | \_HOSTINFLUXDB\_ | | | | | PORT | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | USER | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | PASS | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | NODENAME | +-------------------+-------------------+-------------------+------------------+ | API ping | Checks the | check\_influxdb\_ | | | | response time of | api | \_HOSTINFLUXDB\_ | | | http API | | PORT | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | USER | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | PASS | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | NODENAME | | | | | | | | | | \_HOSTAPI\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTAPI\_CRITI | | | | | CAL\_THRESHOLD | +-------------------+-------------------+-------------------+------------------+ | InfluxDB Heap | Shows all Go heap | check\_influxdb\_ | | | | info | heap | \_HOSTINFLUXDB\_ | | | | | PORT | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | USER | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | PASS | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | NODENAME | | | | | | | | | | \_HOSTNODE\_TOTA | | | | | L\_MEMORY | | | | | | | | | | \_HOSTHEAP\_WARN | | | | | ING\_THRESHOLD | | | | | | | | | | \_HOSTHEAP\_CRIT | | | | | ICAL\_THRESHOLD | +-------------------+-------------------+-------------------+------------------+ | InfluxDB Points | Checks diff of | check\_influxdb\_ | | | | writing | points | \_HOSTINFLUXDB\_ | | | ok/fail/total | | PORT | | | points of Influx | | | | | Node | | \_HOSTINFLUXDB\_ | | | | | USER | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | PASS | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | NODENAME | +-------------------+-------------------+-------------------+------------------+ | InfluxDB | Checks the | check\_influxdb\_ | | | Diagnosis | behaviour of | operation | \_HOSTINFLUXDB\_ | | | Influx Create/Ins | | PORT | | | ert/Delete | | | | | | | \_HOSTINFLUXDB\_ | | | | | USER | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | PASS | | | | | | | | | | \_HOSTINFLUXDB\_ | | | | | NODENAME | | | | | | | | | | \_HOSTOPERATION\ | | | | | _WARNING\_THRESH | | | | | OLD | | | | | | | | | | \_HOSTOPERATION\ | | | | | _CRITICAL\_THRES | | | | | HOLD | +-------------------+-------------------+-------------------+------------------+ **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 | string | | | DB queries | | +----------------------------------+---------------------------------+---------+ | \_INFLUXDB\_PORT | InfluxDB port for the queries | integer | +----------------------------------+---------------------------------+---------+ | \_INFLUXDB\_NODENAME | Name of the InfluxDB node (as | string | | | registered in the service) | | +----------------------------------+---------------------------------+---------+ | \_HEAP\_WARNING\_THRESHOLD | Memory used by InfluxDB Warning | percent | | | threshold (percentage) | | +----------------------------------+---------------------------------+---------+ | \_HEAP\_CRITICAL\_THRESHOLD | Memory used by InfluxDB | percent | | | Critical threshold (percentage) | | +----------------------------------+---------------------------------+---------+ | \_NODE\_TOTAL\_MEMORY | Amount of total Memory of the | integer | | | node (in MegaBytes) | | +----------------------------------+---------------------------------+---------+ | \_OPERATION\_WARNING\_THRESHOLD | Warning threshold (in | integer | | | miliseconds) for completing a | | | | basic diagnosis | | | | (Create/Insert/Delete) | | +----------------------------------+---------------------------------+---------+ | \_OPERATION\_CRITICAL\_THRESHOLD | Critical threshold (in | integer | | | miliseconds) for completing a | | | | basic diagnosis | | | | (Create/Insert/Delete) | | +----------------------------------+---------------------------------+---------+ | \_API\_WARNING\_THRESHOLD | Warning threshold (in | integer | | | miliseconds) for pinging the | | | | http api | | +----------------------------------+---------------------------------+---------+ | \_API\_CRITICAL\_THRESHOLD | Critical threshold (in | integer | | | miliseconds) for pinging the | | | | http api | | +----------------------------------+---------------------------------+---------+ | \_REQUEST\_WARNING\_THRESHOLD | Warning threshold (absolute) | integer | | | for the http api read-requests | | +----------------------------------+---------------------------------+---------+ | \_REQUEST\_CRITICAL\_THRESHOLD | Critical threshold (absolute) | integer | | | for the http api read-requests | | +----------------------------------+---------------------------------+---------+ Log-occurrences ^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Check log occurrences in docs into logger indices .. image:: ../images/packs/pack_icons/log-occurrences.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | check\_log\_occurr | | | | ElasticSearch | ences | \_HOSTELASTICSEARC | | | logger databases | | 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 | string | | | the query (ip/hostname) | | +--------------------------------+-----------------------------------+---------+ | \_IDENTIFIER\_FIELD | Host identifier field name as | string | | | appears in logs (source, ip, | | | | ap\_address, etc.) | | +--------------------------------+-----------------------------------+---------+ | \_TIME\_RANGE | The time range (in minutes) we | integer | | | are looking back. Limited to 24 | | | | hours | | +--------------------------------+-----------------------------------+---------+ **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 | string | | | (realm name) | | +---------------------------------+---------------------------------+----------+ | Search field for the criteria | Main search field for the | string | | | criteria | | +---------------------------------+---------------------------------+----------+ | Regular expression | Main regular expression to | string | | | match in log message. Strings | | | | must be lowercase | | +---------------------------------+---------------------------------+----------+ | Warning | Occurrences warning threshold | integer | +---------------------------------+---------------------------------+----------+ | Critical | Occurrences critical threshold | integer | +---------------------------------+---------------------------------+----------+ | Secondary search field for the | Secondary search field for the | string | | criteria | criteria (optional) | | +---------------------------------+---------------------------------+----------+ | Secondary regular expression | Secondary regular expression to | string | | | match in log message | | | | (optional). Strings must be | | | | lowercase | | +---------------------------------+---------------------------------+----------+ | Disable pattern | Main regular expression to | string | | | disable alerts (optional). | | | | Strings must be lowercase | | +---------------------------------+---------------------------------+----------+ | Secondary disable pattern | Secondary regular expression to | string | | | disable alerts (optional). | | | | Strings must be lowercase | | +---------------------------------+---------------------------------+----------+ | Third search field | Third search field for the | string | | | criteria (optional) | | +---------------------------------+---------------------------------+----------+ | Third regular expression | Third regular expression to | string | | | match in log message | | | | (optional). Strings must be | | | | lowercase | | +---------------------------------+---------------------------------+----------+ | Third disable pattern | Third regular expression to | string | | | disable alerts (optional). | | | | Strings must be lowercase | | +---------------------------------+---------------------------------+----------+ Mongodb-node ^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for the status of a single MongoDB node .. image:: ../images/packs/pack_icons/mongodb-node.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_i | Checks the total | check\_total\_ins | | | nsert\_queries | number of insert | ert\_queries | \_HOSTMONGODB\_P | | | queries | | ORT | +-------------------+-------------------+-------------------+------------------+ | MongoDB\_total\_q | Checks the total | check\_total\_que | | | ueries | number of queries | ries | \_HOSTMONGODB\_P | | | | | ORT | +-------------------+-------------------+-------------------+------------------+ | MongoDB\_reader\_ | Checks the number | check\_reader\_cl | | | clients | of reader clients | ients | \_HOSTMONGODB\_P | | | | | ORT | +-------------------+-------------------+-------------------+------------------+ | MongoDB\_total\_u | Checks the total | check\_total\_upd | | | pdate\_queries | number of update | ate\_queries | \_HOSTMONGODB\_P | | | queries | | ORT | +-------------------+-------------------+-------------------+------------------+ | MongoDB\_writer\_ | Checks the number | check\_writer\_cl | | | clients | of writer cients | ients | \_HOSTMONGODB\_P | | | | | ORT | +-------------------+-------------------+-------------------+------------------+ | MongoDB\_software | Shows the mongodb | check\_server\_up | | | \_uptime | software uptime | time | \_HOSTMONGODB\_P | | | | | ORT | +-------------------+-------------------+-------------------+------------------+ | MongoDB\_active\_ | Checks the active | check\_active\_cl | | | clients | clients | ients | \_HOSTMONGODB\_P | | | | | ORT | +-------------------+-------------------+-------------------+------------------+ | MongoDB\_version | Shows the mongodb | check\_mongo\_ver | | | | version | sion | \_HOSTMONGODB\_P | | | | | ORT | +-------------------+-------------------+-------------------+------------------+ | MongoDB\_current\ | Checks the | check\_current\_c | | | _connections | current | onnections | \_HOSTMONGODB\_P | | | connections | | ORT | +-------------------+-------------------+-------------------+------------------+ | MongoDB\_total\_d | Checks the total | check\_total\_del | | | elete\_queries | number of delete | ete\_queries | \_HOSTMONGODB\_P | | | queries | | ORT | +-------------------+-------------------+-------------------+------------------+ | MongoDB\_node\_me | Checks the memory | check\_mongo\_mem | | | mory | usage | ory | \_HOSTMONGODB\_P | | | | | ORT | | | | | | | | | | \_HOSTMONGODB\_M | | | | | EMORY\_WARNING\_ | | | | | THRESHOLD | | | | | | | | | | \_HOSTMONGODB\_M | | | | | EMORY\_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 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 | integer | | | (default 27017) | | +----------------------------------+---------------------------------+---------+ | \_MONGODB\_STORAGE\_ENGINE | Name of the MongoDB storage | string | | | engine (as registered in the | | | | service) | | +----------------------------------+---------------------------------+---------+ | \_MONGODB\_MEMORY\_WARNING\_THRE | Threshold of memory warning to | integer | | SHOLD | MongoDB | | +----------------------------------+---------------------------------+---------+ | \_MONGODB\_MEMORY\_CRITICAL\_THR | Threshold of memory critical to | integer | | ESHOLD | MongoDB | | +----------------------------------+---------------------------------+---------+ Mysql-server ^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Mysql Database Plugin Monitoring. Uptime, Connection Time, InnoDB Hit Rates, etc .. image:: ../images/packs/pack_icons/mysql-server.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 Connection | Checks the | mysql\_check\_con | | | Time | connection time | nection\_time | \_HOSTMYSQLPORT | | | | | | | | | | \_HOSTMYSQLDATAB | | | | | ASE | | | | | | | | | | \_HOSTMYSQLUSER | | | | | | | | | | \_HOSTMYSQLPASS | | | | | | | | | | \_HOSTCONNECTION | | | | | \_TIME\_WARNING | | | | | | | | | | \_HOSTCONNECTION | | | | | \_TIME\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Mysql Amount of | Checks the actual | mysql\_check\_slo | | | Slow Processes | number of slow | w\_process | \_HOSTMYSQLPORT | | -now- | processes | | | | | | | \_HOSTMYSQLDATAB | | | | | ASE | | | | | | | | | | \_HOSTMYSQLUSER | | | | | | | | | | \_HOSTMYSQLPASS | | | | | | | | | | \_HOSTSLOW\_PROC | | | | | S\_WARNING | | | | | | | | | | \_HOSTSLOW\_PROC | | | | | S\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Mysql Temporary | Checks the | mysql\_check\_tmp | | | Tables created on | percentage of | \_dsk\_tbl | \_HOSTMYSQLPORT | | disk -percent- | temporary tables | | | | | created on disk | | \_HOSTMYSQLDATAB | | | | | ASE | | | | | | | | | | \_HOSTMYSQLUSER | | | | | | | | | | \_HOSTMYSQLPASS | | | | | | | | | | \_HOSTTMP\_DISK\ | | | | | _TBL\_WARNING | | | | | | | | | | \_HOSTTMP\_DISK\ | | | | | _TBL\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Mysql InnoDB | Checks the buffer | mysql\_check\_inn | | | Buffer Hit Rate | hit rate | odb\_bufferpool\_ | \_HOSTMYSQLPORT | | | | hitrate | | | | | | \_HOSTMYSQLDATAB | | | | | ASE | | | | | | | | | | \_HOSTMYSQLUSER | | | | | | | | | | \_HOSTMYSQLPASS | | | | | | | | | | \_HOSTBPHITRATE\ | | | | | _WARNING | | | | | | | | | | \_HOSTBPHITRATE\ | | | | | _CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Mysql Amount of | Checks the actual | mysql\_check\_slo | | | Slow Queries | number of slow | w\_queries | \_HOSTMYSQLPORT | | | queries | | | | | | | \_HOSTMYSQLDATAB | | | | | ASE | | | | | | | | | | \_HOSTMYSQLUSER | | | | | | | | | | \_HOSTMYSQLPASS | | | | | | | | | | \_HOSTSLOW\_Q\_W | | | | | ARNING | | | | | | | | | | \_HOSTSLOW\_Q\_C | | | | | RITICAL | +-------------------+-------------------+-------------------+------------------+ | Mysql Threads | Checks the actual | mysql\_check\_thr | | | Connected | number of | ead\_connected | \_HOSTMYSQLPORT | | | connected threads | | | | | | | \_HOSTMYSQLDATAB | | | | | ASE | | | | | | | | | | \_HOSTMYSQLUSER | | | | | | | | | | \_HOSTMYSQLPASS | | | | | | | | | | \_HOSTTHREAD\_WA | | | | | RNING | | | | | | | | | | \_HOSTTHREAD\_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 | +==============================+=====================================+=========+ | \_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 | integer | | | reach a WARNING state. Reference | | | | from the max\_connections variables | | | | from mysql | | +------------------------------+-------------------------------------+---------+ | \_THREAD\_CRITICAL | The amount of thread connections to | integer | | | reach a CRITICAL state. Reference | | | | from the max\_connections variables | | | | from mysql | | +------------------------------+-------------------------------------+---------+ | \_CONNECTION\_TIME\_WARNING | The amount of time it takes to | integer | | | connect to the Mysql Database | | | | reaching a WARNING state. | | +------------------------------+-------------------------------------+---------+ | \_CONNECTION\_TIME\_CRITICAL | The amount of time it takes to | integer | | | connect to the Mysql Database | | | | reaching a CRITICAL state. | | +------------------------------+-------------------------------------+---------+ | \_BPHITRATE\_WARNING | The percentage of hitrate from the | string | | | InnoDB Buffer Pool to reach a | | | | WARNING state. | | +------------------------------+-------------------------------------+---------+ | \_BPHITRATE\_CRITICAL | The percentage of hitrate from the | string | | | InnoDB Buffer Pool to reach a | | | | CRITICAL state. | | +------------------------------+-------------------------------------+---------+ | \_TMP\_DISK\_TBL\_WARNING | The percentage of temporary tables | percent | | | created in disk instead of memory | | | | to reach a WARNING state. | | +------------------------------+-------------------------------------+---------+ | \_TMP\_DISK\_TBL\_CRITICAL | The percentage of temporary tables | percent | | | created in disk instead of memory | | | | to reach a CRITICAL state. | | +------------------------------+-------------------------------------+---------+ | \_SLOW\_PROCS\_WARNING | The amount of slow process running | integer | | | NOW to reach a WARNING state. | | +------------------------------+-------------------------------------+---------+ | \_SLOW\_PROCS\_CRITICAL | The amount of slow process running | integer | | | NOW to reach a CRITICAL state. | | +------------------------------+-------------------------------------+---------+ | \_SLOW\_Q\_WARNING | The amount of slow queries running | integer | | | to reach a WARNING state. | | +------------------------------+-------------------------------------+---------+ | \_SLOW\_Q\_CRITICAL | The amount of slow queries running | integer | | | to reach a CRITICAL state. | | +------------------------------+-------------------------------------+---------+ Oracle-resources ^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Resource checks for Oracle databases (tablespace usage, users, sessions, etc.) .. image:: ../images/packs/pack_icons/oracle-resources.png :align: center :scale: 50% 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 :ref:`packs-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 Tablespace | | check\_oracle\_reso | | | usage | | urces\_tablespace | \_HOSTUSER | | | | | | | | | | \_HOSTPASSWD | | | | | | | | | | \_HOSTDDBB | | | | | | | | | | \_HOSTTABLESPACE\_ | | | | | WARNING | | | | | | | | | | \_HOSTTABLESPACE\_ | | | | | CRITICAL | +---------------------+-------------+---------------------+--------------------+ | Oracle sessions | | check\_oracle\_reso | | | | | urces\_sessions | \_HOSTUSER | | | | | | | | | | \_HOSTPASSWD | | | | | | | | | | \_HOSTDDBB | | | | | | | | | | \_HOSTSESSIONS\_WA | | | | | RN | | | | | | | | | | \_HOSTSESSIONS\_CR | | | | | IT | +---------------------+-------------+---------------------+--------------------+ | Oracle processes | | check\_oracle\_reso | | | | | urces\_procs | \_HOSTUSER | | | | | | | | | | \_HOSTPASSWD | | | | | | | | | | \_HOSTDDBB | | | | | | | | | | \_HOSTPROCS\_WARN | | | | | | | | | | \_HOSTPROCS\_CRIT | +---------------------+-------------+---------------------+--------------------+ | Oracle FRA usage | | check\_oracle\_reso | | | | | urces\_fra | \_HOSTUSER | | | | | | | | | | \_HOSTPASSWD | | | | | | | | | | \_HOSTDDBB | | | | | | | | | | \_HOSTFRA\_WARNING | | | | | | | | | | \_HOSTFRA\_CRITICA | | | | | L | +---------------------+-------------+---------------------+--------------------+ **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 | integer | | | (percent) | | +------------------------+-------------------------------------------+---------+ | \_TABLESPACE\_CRITICAL | Tablespace usage critical threshold | integer | | | (percent) | | +------------------------+-------------------------------------------+---------+ | \_FRA\_WARNING | Flash Recovery Area usage warning | integer | | | threshold (percent) | | +------------------------+-------------------------------------------+---------+ | \_FRA\_CRITICAL | Flash recovery Area usage critical | integer | | | threshold (percent) | | +------------------------+-------------------------------------------+---------+ | \_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 .. image:: ../images/packs/pack_icons/postgresql.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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- | | check\_postgresql\_ | | | table\_size | | table\_size | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | | | | | | | | | | \_HOSTTABLESIZE\_W | | | | | ARN | | | | | | | | | | \_HOSTTABLESIZE\_C | | | | | RIT | +---------------------+-------------+---------------------+--------------------+ | PostgreSQL-hitratio | | check\_postgresql\_ | | | | | hitratio | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | | | | | | | | | | \_HOSTHITRATIO\_WA | | | | | RN | | | | | | | | | | \_HOSTHITRATIO\_CR | | | | | IT | +---------------------+-------------+---------------------+--------------------+ | PostgreSQL-backends | | check\_postgresql\_ | | | | | backends | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | | | | | | | | | | \_HOSTBACKENDS\_WA | | | | | RN | | | | | | | | | | \_HOSTBACKENDS\_CR | | | | | IT | +---------------------+-------------+---------------------+--------------------+ | PostgreSQL- | | check\_postgresql\_ | | | database\_size | | database\_size | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | | | | | | | | | | \_HOSTDBSIZE\_WARN | | | | | | | | | | \_HOSTDBSIZE\_CRIT | +---------------------+-------------+---------------------+--------------------+ | PostgreSQL- | | check\_postgresql\_ | | | Query\_Time | | query\_time | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | | | | | | | | | | \_HOSTQUERYTIME\_W | | | | | ARN | | | | | | | | | | \_HOSTQUERYTIME\_C | | | | | RIT | +---------------------+-------------+---------------------+--------------------+ | PostgreSQL-Locks | | check\_postgresql\_ | | | | | locks | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | | | | | | | | | | \_HOSTLOCKS\_WARN | | | | | | | | | | \_HOSTLOCKS\_CRIT | +---------------------+-------------+---------------------+--------------------+ | PostgreSQL- | | check\_postgresql\_ | | | Txn\_time | | txn\_time | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | | | | | | | | | | \_HOSTTXNTIME\_WAR | | | | | N | | | | | | | | | | \_HOSTTXNTIME\_CRI | | | | | T | +---------------------+-------------+---------------------+--------------------+ | PostgreSQL- | | check\_postgresql\_ | | | connection | | connection | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | +---------------------+-------------+---------------------+--------------------+ | PostgreSQL- | | check\_postgresql\_ | | | index\_size | | index\_size | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | | | | | | | | | | \_HOSTINDEXSIZE\_W | | | | | ARN | | | | | | | | | | \_HOSTINDEXSIZE\_C | | | | | RIT | +---------------------+-------------+---------------------+--------------------+ | PostgreSQL-bloat | | check\_postgresql\_ | | | | | bloat | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | +---------------------+-------------+---------------------+--------------------+ | PostgreSQL- | | check\_postgresql\_ | | | disabled\_triggers | | disabled\_triggers | \_HOSTPOSTGRESQLPO | | | | | RT | | | | | | | | | | \_HOSTPOSTGRESQLUS | | | | | ER | | | | | | | | | | \_HOSTPOSTGRESQLPA | | | | | SSWORD | +---------------------+-------------+---------------------+--------------------+ **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 | string | | | G/M character). | | +----------------------+---------------------------------------------+---------+ | \_DBSIZE\_CRIT | Database size critical (must include unit | string | | | G/M character). | | +----------------------+---------------------------------------------+---------+ | \_BACKENDS\_WARN | Backends warning threshold (must include | string | | | percentage character). | | +----------------------+---------------------------------------------+---------+ | \_BACKENDS\_CRIT | Backends critical threshold (must include | string | | | percentage character). | | +----------------------+---------------------------------------------+---------+ | \_HITRATIO\_WARN | Hit ratio warning threshold (must include | string | | | percentage character). | | +----------------------+---------------------------------------------+---------+ | \_HITRATIO\_CRIT | Hit ratio critical threshold (must include | string | | | percentage character). | | +----------------------+---------------------------------------------+---------+ | \_INDEXSIZE\_WARN | Index size warning threshold (must include | string | | | unit G/M character). | | +----------------------+---------------------------------------------+---------+ | \_INDEXSIZE\_CRIT | Index size critical threshold (must include | string | | | unit G/M character). | | +----------------------+---------------------------------------------+---------+ | \_TABLESIZE\_WARN | Table size warning threshold (must include | string | | | percentage character). | | +----------------------+---------------------------------------------+---------+ | \_TABLESIZE\_CRIT | Table size critical threshold (must include | string | | | percentage character). | | +----------------------+---------------------------------------------+---------+ | \_LOCKS\_WARN | Locks warnings threshold. | integer | +----------------------+---------------------------------------------+---------+ | \_LOCKS\_CRIT | Locks critical threshold. | integer | +----------------------+---------------------------------------------+---------+ | \_QUERYTIME\_WARN | Query time warning threshold (must include | string | | | min expression, ex: 1min / 5min). | | +----------------------+---------------------------------------------+---------+ | \_QUERYTIME\_CRIT | Query time critical threshold (must include | string | | | min expression, ex: 1min / 5min). | | +----------------------+---------------------------------------------+---------+ | \_TXNTIME\_WARN | Transaction time warning threshold (must | string | | | include min expression, ex: 1min / 5min). | | +----------------------+---------------------------------------------+---------+ | \_TXNTIME\_CRIT | Transaction time critical threshold (must | string | | | include min expression, ex: 1min / 5min). | | +----------------------+---------------------------------------------+---------+ Printing -------- Generic-printer ^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for the printer status (also consumibles and trays) .. image:: ../images/packs/pack_icons/generic-printer.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | Printer\_Descript | Shows the printer | check\_printer\_d | | | ion | description | escription | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | $KEY$ | Checks the | check\_printer\_c | | | | consumables state | onsum | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_CONSUMLIST | +-------------------+-------------------+-------------------+------------------+ | Printer\_Pagecoun | Checks the page | check\_printer\_p | | | t | count number | agecount | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | $KEY$ | Checks the | check\_printer\_t | | | | printer trays | ray | \_HOSTSNMPCOMMUN | | | status | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_TRAYLIST | +-------------------+-------------------+-------------------+------------------+ **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 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 | +--------------+-------------------------------------------------+----------+ 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 :ref:`packs-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 | Checks the BGP | check\_bgp\_gener | | | - $KEY$ | Peer state | 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 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 | +---------------+---------------------------------------+----------+ Dns ^^^ **DESCRIPTION** ---------------------- This plugin uses the nslookup program to obtain the IP address for the given host/domain query .. image:: ../images/packs/pack_icons/dns.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | check\_dns | | | | the given host/domain | | \_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 .. image:: ../images/packs/pack_icons/dns-advanced.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | check\_dns\_advanced | | | | is what it's expected | | \_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 | string | | | service name | | +-----------------------+-------------------------------------------+----------+ | 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 | string | | | return | | +-----------------------+-------------------------------------------+----------+ Http ^^^^ **DESCRIPTION** ---------------------- Monitors HTTP response .. image:: ../images/packs/pack_icons/http.png :align: center :scale: 50% 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 :ref:`packs-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 | +==================+===================+===================+===================+ | Http | Checks the HTTP | check\_http | | | | web site response | | \_HOSTCHECK\_HTTP | | | time | | \_DOMAIN\_NAME | | | | | | | | | | \_HOSTCHECK\_HTTP | | | | | \_URI | | | | | | | | | | \_HOSTCHECK\_HTTP | | | | | \_PORT | | | | | | | | | | \_HOSTCHECK\_HTTP | | | | | \_AUTH | | | | | | | | | | \_HOSTWARNING\_TI | | | | | ME\_RESPONSE | | | | | | | | | | \_HOSTCRITICAL\_T | | | | | IME\_RESPONSE | +------------------+-------------------+-------------------+-------------------+ | HttpsCertificate | Checks the SSL | check\_https\_cer | | | | Certificate | tificate | \_HOSTCHECK\_HTTP | | | validity | | S\_DOMAIN\_NAME | | | | | | | | | | \_HOSTCHECK\_HTTP | | | | | S\_MINIMUM\_DAYS | | | | | | | | | | \_HOSTCHECK\_HTTP | | | | | S\_PORT | | | | | | | | | | \_HOSTCHECK\_HTTP | | | | | S\_AUTH | +------------------+-------------------+-------------------+-------------------+ **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. | string | | | Format user:password | | +-------------------------------+------------------------------------+---------+ | \_CHECK\_HTTPS\_DOMAIN\_NAME | Domain name or ip address for | string | | | HTTPS | | +-------------------------------+------------------------------------+---------+ | \_CHECK\_HTTPS\_PORT | HTTPS port | integer | +-------------------------------+------------------------------------+---------+ | \_CHECK\_HTTPS\_URI | HTTPS URI | string | +-------------------------------+------------------------------------+---------+ | \_CHECK\_HTTPS\_AUTH | Credentials for HTTPS access. | string | | | Format user:password | | +-------------------------------+------------------------------------+---------+ | \_CHECK\_HTTPS\_MINIMUM\_DAYS | Minimum number of days a | integer | | | certificate has to be valid | | +-------------------------------+------------------------------------+---------+ | \_WARNING\_TIME\_RESPONSE | Response time to result in warning | float | | | status (seconds) | | +-------------------------------+------------------------------------+---------+ | \_CRITICAL\_TIME\_RESPONSE | Response time to result in | float | | | critical status (seconds) | | +-------------------------------+------------------------------------+---------+ Http-proxy ^^^^^^^^^^ **DESCRIPTION** ---------------------- Http checks through a proxy .. image:: ../images/packs/pack_icons/http-proxy.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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- | Checks the https | check\_https\_pro | | | proxy\_$KEY$ | web site status | xy | \_HOSTHTTP\_PROX | | | through a proxy | | Y | | | | | | | | | | \_HOSTHTTP\_TIME | | | | | OUT | | | | | | | | | | \_HOSTHTTP\_NTRI | | | | | ES | | | | | | | | | | \_HTTPS\_LIST | +-------------------+-------------------+-------------------+------------------+ | http-proxy\_$KEY$ | Checks the http | check\_http\_prox | | | | web site status | y | \_HOSTHTTP\_PROX | | | through a proxy | | 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: | string | | | $DEFAULT\_PROXY$) | | +-----------------+--------------------------------------------------+---------+ | \_HTTP\_TIMEOUT | Amount of time to wait for a connection in | integer | | | seconds (default: 30) | | +-----------------+--------------------------------------------------+---------+ | \_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: | string | | | HTTP\_ | | +--------------+----------------------------------------------------+----------+ | 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: | string | | | HTTPS\_ | | +--------------+----------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/ntp-snmp.png :align: center :scale: 50% 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 :ref:`packs-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\_snmp | | check\_ntp\_by\_snm | | | | | p | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTTIME\_WARNIN | | | | | G | | | | | | | | | | \_HOSTTIME\_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 | +------------------+-------------------------------------------------+---------+ | \_TIME\_WARNING | Warning threshold for time difference (secs) | integer | | | against NTP server | | +------------------+-------------------------------------------------+---------+ | \_TIME\_CRITICAL | Critical threshold for time difference (secs) | integer | | | against NTP server | | +------------------+-------------------------------------------------+---------+ Operating System ---------------- Linux-nrpe ^^^^^^^^^^ **DESCRIPTION** ---------------------- Linux host monitoring via NRPE (Nagios remote plugin execution) .. image:: ../images/packs/pack_icons/linux-nrpe.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +=================+====================+===================+===================+ | Users | Checks the number | check\_nrpe\_user | | | | of users | s | \_HOSTUSERS\_WARN | | | | | | | | | | \_HOSTUSERS\_CRIT | +-----------------+--------------------+-------------------+-------------------+ | Zombie procs | Checks the number | check\_nrpe\_zomb | | | | of Zombie | ie\_procs | \_HOSTZOMBIEPROCS | | | processes | | \_WARN | | | | | | | | | | \_HOSTZOMBIEPROCS | | | | | \_CRIT | +-----------------+--------------------+-------------------+-------------------+ | Total procs | Checks the total | check\_nrpe\_tota | | | | number of | l\_procs | \_HOSTTOTALPROCS\ | | | processes | | _WARN | | | | | | | | | | \_HOSTTOTALPROCS\ | | | | | _CRIT | +-----------------+--------------------+-------------------+-------------------+ | Load | Checks the CPU | check\_nrpe\_load | | | | load | | \_HOSTLOAD\_WARN | | | | | | | | | | \_HOSTLOAD\_CRIT | +-----------------+--------------------+-------------------+-------------------+ | Swap | Checks the SWAP | check\_nrpe\_swap | | | | usage | | \_HOSTSWAP\_WARN | | | | | | | | | | \_HOSTSWAP\_CRIT | +-----------------+--------------------+-------------------+-------------------+ | Partition $KEY$ | Checks the disk | check\_nrpe\_disk | | | | usage | | \_HOSTSTORAGE\_WA | | | | | RN | | | | | | | | | | \_HOSTSTORAGE\_CR | | | | | IT | | | | | | | | | | \_PARTITIONS | +-----------------+--------------------+-------------------+-------------------+ **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 | string | | | /,/var | | +---------------------+----------------------------------------------+---------+ | \_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. .. image:: ../images/packs/pack_icons/linux-snmp.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | Linux SNMP - | Check about | check\_linux\_snm | | | Uptime | system uptime | p\_uptime | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTUPTIME\_WA | | | | | RN | | | | | | | | | | \_HOSTUPTIME\_CR | | | | | IT | +-------------------+-------------------+-------------------+------------------+ | TimeSync | Compare system | check\_linux\_tim | | | | time with time | e | \_HOSTSNMPCOMMUN | | | where shinken | | ITY | | | operate. Both | | | | | must be | | \_HOSTNTP\_WARN | | | synchronized with | | | | | a ntp source. | | \_HOSTNTP\_CRIT | +-------------------+-------------------+-------------------+------------------+ | Memory | Check about | check\_linux\_mem | | | | physical memory | ory | \_HOSTMEMORY\_WA | | | space usage. | | RN | | | | | | | | | | \_HOSTMEMORY\_CR | | | | | IT | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Linux SNMP - Swap | Check about swap | check\_linux\_snm | | | | space usage. Too | p\_swap | \_HOSTMEMORY\_WA | | | many use of swap | | RN | | | space means lacks | | | | | of memory or | | \_HOSTMEMORY\_CR | | | memory leaks. | | IT | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Disks | Overall disks | check\_linux\_dis | | | | usage | ks | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSTORAGE\_P | | | | | ATH | | | | | | | | | | \_HOSTSTORAGE\_W | | | | | ARN | | | | | | | | | | \_HOSTSTORAGE\_C | | | | | RIT | | | | | | | | | | \_HOSTSNMP\_MSG\ | | | | | _MAX\_SIZE | +-------------------+-------------------+-------------------+------------------+ | Cpu | Detect abnormal | check\_linux\_cpu | | | | CPU usage | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_WARN | | | | | | | | | | \_HOSTCPU\_CRIT | +-------------------+-------------------+-------------------+------------------+ | Load | Detect abnormal | check\_linux\_loa | | | | CPU usage | d | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTLOAD\_WARN | | | | | | | | | | \_HOSTLOAD\_CRIT | +-------------------+-------------------+-------------------+------------------+ | Linux SNMP - TCP | Check TCP | check\_linux\_snm | | | Connections | connections table | p\_tcpconn | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTTCP\_CONN\ | | | | | _WARN | | | | | | | | | | \_HOSTTCP\_CONN\ | | | | | _CRIT | +-------------------+-------------------+-------------------+------------------+ | Linux SNMP - | Shows system | check\_linux\_snm | | | SysDescr | description | p\_sysdescr | \_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 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 | string | | | allowed on the linux | | | | server | | +------------------------+--------------------------+--------------------------+ | \_SNMP\_MSG\_MAX\_SIZE | Maximum size of the snmp | integer | | | messages (in bytes) | | +------------------------+--------------------------+--------------------------+ | \_LOAD\_WARN | Value for starting | 3 comma-separated | | | warning state for the | integer | | | load average at | | | | 1m,5m,15m | | +------------------------+--------------------------+--------------------------+ | \_LOAD\_CRIT | Value for starting | 3 comma-separated | | | critical state for the | integer | | | load average at | | | | 1m,5m,15m | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_WARN | Warning level threshold | percent | | | for used disk space | | | | (percentage) | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_CRIT | Critical level threshold | percent | | | for used disk space | | | | (percentage) | | +------------------------+--------------------------+--------------------------+ | \_CPU\_WARN | Warning level for the | percent | | | CPU usage (percentage) | | +------------------------+--------------------------+--------------------------+ | \_CPU\_CRIT | Critical level for the | percent | | | CPU usage (percentage) | | +------------------------+--------------------------+--------------------------+ | \_MEMORY\_WARN | Physical memory and swap | percent | | | warning level | | | | (percentage) | | +------------------------+--------------------------+--------------------------+ | \_MEMORY\_CRIT | Physical memory and swap | percent | | | critical level | | | | (percentage) | | +------------------------+--------------------------+--------------------------+ | \_NTP\_WARN | NTP timings warning | integer | | | level (in seconds) | | +------------------------+--------------------------+--------------------------+ | \_NTP\_CRIT | NTP timings critical | integer | | | level (in seconds) | | +------------------------+--------------------------+--------------------------+ | \_SNMPVERSION | Device SNMP versions | string | | | supported are: 1 and 2c | | +------------------------+--------------------------+--------------------------+ | \_CHKLOG\_CONF | absolute path to | absolute path | | | checklog conf file. | | | | Default: /usr/local/shin | | | | ken/libexec/logFiles\_li | | | | nux.conf | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_PATH | Absolute path to check | absolute path | | | its storage | | +------------------------+--------------------------+--------------------------+ | \_UPTIME\_WARN | System uptime warning | integer | | | threshold (in seconds) | | +------------------------+--------------------------+--------------------------+ | \_UPTIME\_CRIT | System uptime critical | integer | | | threshold (in seconds) | | +------------------------+--------------------------+--------------------------+ | \_TCP\_CONN\_WARN | TCP connections warning | integer | | | threshold (total number) | | +------------------------+--------------------------+--------------------------+ | \_TCP\_CONN\_CRIT | TCP connections critical | integer | | | threshold (total number) | | +------------------------+--------------------------+--------------------------+ Linux-ssh ^^^^^^^^^ **DESCRIPTION** ---------------------- Standard linux checks, like CPU, RAM and disk space. Checks are done by SSH. .. image:: ../images/packs/pack_icons/linux-ssh.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | NFS Stats | Checks the NFS | check\_ssh\_linux | | | | (Network File | \_nfs\_stats | \_HOSTSSH\_PORT | | | System) | | | | | statistics | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Disks Stats | Checks the disk | check\_ssh\_linux | | | | statistics | \_disks\_stats | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Reboot | Checks the system | check\_ssh\_linux | | | | uptime | \_uptime | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | SSH Connexion | Checks the SSH | check\_ssh\_conne | | | | connexion | xion | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | TCP States | Checks the states | check\_ssh\_linux | | | | from TCP | \_tcp\_states | \_HOSTSSH\_PORT | | | connection table | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Memory | Checks the memory | check\_ssh\_linux | | | | usage | \_memory | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTMEMORY\_WA | | | | | RN | | | | | | | | | | \_HOSTMEMORY\_CR | | | | | IT | +-------------------+-------------------+-------------------+------------------+ | Load Average | Checks the system | check\_ssh\_linux | | | | load average | \_load\_average | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTLOAD\_WARN | | | | | | | | | | \_HOSTLOAD\_CRIT | +-------------------+-------------------+-------------------+------------------+ | NET Stats | Checks the | check\_ssh\_linux | | | | network | \_net\_stats | \_HOSTSSH\_PORT | | | statistics | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Disks | Checks the disk | check\_ssh\_linux | | | | usage | \_disks | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTSTORAGE\_U | | | | | NIT | | | | | | | | | | \_HOSTSTORAGE\_W | | | | | ARN | | | | | | | | | | \_HOSTSTORAGE\_C | | | | | RIT | | | | | | | | | | \_HOSTSTORAGE\_M | | | | | OUNTS | +-------------------+-------------------+-------------------+------------------+ | CPU Stats | Checks the CPU | check\_ssh\_linux | | | | load statistics | \_cpu\_stats | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Read-only | Checks if there | check\_ssh\_ro\_f | | | Filesystems | are Read-only | ilesystem | \_HOSTSSH\_PORT | | | filesystems | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Kernel Stats | Checks the Kernel | check\_ssh\_linux | | | | statistics | \_kernel\_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 | string | | | service (key interchange | | | | with Shinken user must | | | | be done ) | | +------------------------+--------------------------+--------------------------+ | \_SSH\_PORT | Remote port for the SSH | integer | | | service | | +------------------------+--------------------------+--------------------------+ | \_SSH\_KEY | SSH key (Shinken user) | string | +------------------------+--------------------------+--------------------------+ | \_SSH\_KEY\_PASSPHRASE | SSH passphrase (Shinken | string | | | user) | | +------------------------+--------------------------+--------------------------+ | \_LOAD\_WARN | Value for starting | 3 comma-separated | | | warning state for the | integer | | | load average at | | | | 1m,5m,15m | | +------------------------+--------------------------+--------------------------+ | \_LOAD\_CRIT | Value for starting | 3 comma-separated | | | critical state for the | integer | | | load average at | | | | 1m,5m,15m | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_WARN | Warning level for used | percent | | | disk space (percentage) | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_CRIT | Critical level for used | percent | | | disk space (percentage) | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_UNIT | Unit of disk space : B, | string | | | KB, MB, GB or TB | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_MOUNTS | List of mount points to | comma-separated absolute | | | monitor | path | +------------------------+--------------------------+--------------------------+ | \_CPU\_WARN | Warning level for the | percent | | | CPU usage (percentage) | | +------------------------+--------------------------+--------------------------+ | \_CPU\_CRIT | Critical level for the | percent | | | CPU usage (percentage) | | +------------------------+--------------------------+--------------------------+ | \_MEMORY\_WARN | Physical memory warning | percent | | | threshold (percentage) | | +------------------------+--------------------------+--------------------------+ | \_MEMORY\_CRIT | Physical memory critical | percent | | | threshold (percentage) | | +------------------------+--------------------------+--------------------------+ Linux-ssh-aggregated ^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Standard linux checks, like CPU, RAM and disk space. Checks are done by SSH. .. image:: ../images/packs/pack_icons/linux-ssh-aggregated.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | NFS Stats | Checks the NFS | check\_ssh\_linux | | | | (Network File | \_nfs\_stats | \_HOSTSSH\_PORT | | | System) | | | | | statistics | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Disks Stats | Checks the disk | check\_ssh\_linux | | | | statistics | \_disks\_stats | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Reboot | Checks the system | check\_ssh\_linux | | | | uptime | \_uptime | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | CPU Stats | Checks the CPU | check\_ssh\_linux | | | | load statistics. | \_cpu\_stats\_agg | \_HOSTSSH\_PORT | | | Returns only | regated | | | | aggregated | | \_HOSTSSH\_USER | | | metrics | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | SSH Connexion | Checks the SSH | check\_ssh\_conne | | | | connexion | xion | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | TCP States | Checks the states | check\_ssh\_linux | | | | from TCP | \_tcp\_states | \_HOSTSSH\_PORT | | | connection table | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Memory | Checks the memory | check\_ssh\_linux | | | | usage | \_memory | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTMEMORY\_WA | | | | | RN | | | | | | | | | | \_HOSTMEMORY\_CR | | | | | IT | +-------------------+-------------------+-------------------+------------------+ | Load Average | Checks the system | check\_ssh\_linux | | | | load average | \_load\_average | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTLOAD\_WARN | | | | | | | | | | \_HOSTLOAD\_CRIT | +-------------------+-------------------+-------------------+------------------+ | NET Stats | Checks the | check\_ssh\_linux | | | | network | \_net\_stats | \_HOSTSSH\_PORT | | | statistics | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Disks | Checks the disk | check\_ssh\_linux | | | | usage | \_disks | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTSTORAGE\_U | | | | | NIT | | | | | | | | | | \_HOSTSTORAGE\_W | | | | | ARN | | | | | | | | | | \_HOSTSTORAGE\_C | | | | | RIT | | | | | | | | | | \_HOSTSTORAGE\_M | | | | | OUNTS | +-------------------+-------------------+-------------------+------------------+ | Read-only | Checks if there | check\_ssh\_ro\_f | | | Filesystems | are Read-only | ilesystem | \_HOSTSSH\_PORT | | | filesystems | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | +-------------------+-------------------+-------------------+------------------+ | Kernel Stats | Checks the Kernel | check\_ssh\_linux | | | | statistics | \_kernel\_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 | string | | | service (key interchange | | | | with Shinken user must | | | | be done ) | | +------------------------+--------------------------+--------------------------+ | \_SSH\_PORT | Remote port for the SSH | integer | | | service | | +------------------------+--------------------------+--------------------------+ | \_SSH\_KEY | SSH key (Shinken user) | string | +------------------------+--------------------------+--------------------------+ | \_SSH\_KEY\_PASSPHRASE | SSH passphrase (Shinken | string | | | user) | | +------------------------+--------------------------+--------------------------+ | \_LOAD\_WARN | Value for starting | 3 comma-separated | | | warning state for the | integer | | | load average at | | | | 1m,5m,15m | | +------------------------+--------------------------+--------------------------+ | \_LOAD\_CRIT | Value for starting | 3 comma-separated | | | critical state for the | integer | | | load average at | | | | 1m,5m,15m | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_WARN | Warning level for used | percent | | | disk space (percentage) | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_CRIT | Critical level for used | percent | | | disk space (percentage) | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_UNIT | Unit of disk space : B, | string | | | KB, MB, GB or TB | | +------------------------+--------------------------+--------------------------+ | \_STORAGE\_MOUNTS | List of mount points to | comma-separated absolute | | | monitor | path | +------------------------+--------------------------+--------------------------+ | \_CPU\_WARN | Warning level for the | percent | | | CPU usage (percentage) | | +------------------------+--------------------------+--------------------------+ | \_CPU\_CRIT | Critical level for the | percent | | | CPU usage (percentage) | | +------------------------+--------------------------+--------------------------+ | \_MEMORY\_WARN | Physical memory warning | percent | | | threshold (percentage) | | +------------------------+--------------------------+--------------------------+ | \_MEMORY\_CRIT | Physical memory critical | percent | | | threshold (percentage) | | +------------------------+--------------------------+--------------------------+ Os_resources ^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Monitoring Windows an Linux Servers, via snmp .. image:: ../images/packs/pack_icons/os-resources.png :align: center :scale: 50% 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 :ref:`packs-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 | +=====================+=============+=====================+====================+ | Users | | os\_users | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTUSERS\_WARNI | | | | | NG\_THRESHOLD | | | | | | | | | | \_HOSTUSERS\_CRITI | | | | | CAL\_THRESHOLD | +---------------------+-------------+---------------------+--------------------+ | CPU usage 1m | | os\_cpu\_1m\_usage | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTCPU\_WARNING | | | | | \_THRESHOLD | | | | | | | | | | \_HOSTCPU\_CRITICA | | | | | L\_THRESHOLD | +---------------------+-------------+---------------------+--------------------+ | Uptime | | os\_uptime | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTUPTIME\_CRIT | | | | | ICAL\_THRESHOLD | +---------------------+-------------+---------------------+--------------------+ | Memory buffer usage | | os\_mem\_buffer | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTMEMORY\_BUFF | | | | | ER\_DEFAULT\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEMORY\_BUFF | | | | | ER\_DEFAULT\_CRITI | | | | | CAL | +---------------------+-------------+---------------------+--------------------+ | Virtual memory | | os\_vm\_usage | | | usage | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTVM\_WARNING\ | | | | | _THRESHOLD | | | | | | | | | | \_HOSTVM\_CRITICAL | | | | | \_THRESHOLD | +---------------------+-------------+---------------------+--------------------+ | RAM usage | | os\_ram\_usage | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTRAM\_WARNING | | | | | \_THRESHOLD | | | | | | | | | | \_HOSTRAM\_CRITICA | | | | | L\_THRESHOLD | +---------------------+-------------+---------------------+--------------------+ | Partition\_$KEY$ | | os\_partition\_usag | | | | | e | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSTORAGE\_WAR | | | | | NING\_THRESHOLD | | | | | | | | | | \_HOSTSTORAGE\_CRI | | | | | TICAL\_THRESHOLD | | | | | | | | | | \_PARTITIONS | +---------------------+-------------+---------------------+--------------------+ | Number of processes | | os\_count\_processe | | | | | s | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTCOUNT\_PROCE | | | | | SSES\_WARNING\_THR | | | | | ESHOLD | | | | | | | | | | \_HOSTCOUNT\_PROCE | | | | | SSES\_CRITICAL\_TH | | | | | RESHOLD | +---------------------+-------------+---------------------+--------------------+ | Processes\_$KEY$ | | os\_processes | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_PROCESSES | +---------------------+-------------+---------------------+--------------------+ **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 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$ --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 | Device SNMP Community, use | string | | | $SNMPCOMMUNITYREAD$ for the | | | | default system community | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | Device SNMP versions supported | string | | | are: 1 and 2c | | +----------------------------------+---------------------------------+---------+ | \_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 | percent | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_VM\_CRITICAL\_THRESHOLD | Virtual memory critical | percent | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_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 | Number of processes running | integer | | ESHOLD | warning threshold | | +----------------------------------+---------------------------------+---------+ | \_COUNT\_PROCESSES\_CRITICAL\_TH | Number of processes running | integer | | RESHOLD | critical threshold | | +----------------------------------+---------------------------------+---------+ | \_MEMORY\_BUFFER\_DEFAULT\_WARNI | Percent of memory buffer used | integer | | NG | warning threshold | | +----------------------------------+---------------------------------+---------+ | \_MEMORY\_BUFFER\_DEFAULT\_CRITI | Percent of memory buffer used | integer | | CAL | critical threshold | | +----------------------------------+---------------------------------+---------+ **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 | +------------+-----------------+----------+ | ProcIndex | Process index | integer | +------------+-----------------+----------+ Unix-files-ssh ^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks last modification day for a file via ssh protocol .. image:: ../images/packs/pack_icons/unix-files-ssh.png :align: center :scale: 50% Checks last modification day for a file via ssh protocol .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$ | | check\_unix-files-ssh | | | | | | \_HOSTSSH\_PORT | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_PASSWORD | | | | | | | | | | \_HOSTSSH\_KEY\_FILE | | | | | | | | | | \_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), | string | | | SSH\_KEY\_FILE will be used | | +------------------+-------------------------------------------------+---------+ | \_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 (\*, | string | | | ?, etc.) are supported | | +------------------+------------------------------------------------+----------+ | Path | File path | string | +------------------+------------------------------------------------+----------+ | Time period | Time period expressed in days. 1 means today, | integer | | | 2 means yesterday and today, etc. | | +------------------+------------------------------------------------+----------+ Windows ^^^^^^^ **DESCRIPTION** ---------------------- Standard windows checks, like CPU, RAM and disk space. Checks are done by WMI. .. image:: ../images/packs/pack_icons/windows.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | EachCpu | Detect abnormal | check\_windows\_e | | | | CPU usage | ach\_cpu | \_HOSTDOMAINUSER | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_C | | | | | PU\_WARN | | | | | | | | | | \_HOSTWINDOWS\_C | | | | | PU\_CRIT | +-------------------+-------------------+-------------------+------------------+ | EventLogApplicati | Detect abnormal | check\_windows\_e | | | on | application | ventlogs | \_HOSTDOMAINUSER | | | events | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_E | | | | | VENT\_LOG\_WARN | | | | | | | | | | \_HOSTWINDOWS\_E | | | | | VENT\_LOG\_CRIT | +-------------------+-------------------+-------------------+------------------+ | Network Interface | Detect abnormal | check\_windows\_n | | | | Network usage | etwork | \_HOSTDOMAINUSER | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_N | | | | | ET\_WARN | | | | | | | | | | \_HOSTWINDOWS\_N | | | | | ET\_CRIT | | | | | | | | | | \_HOSTWINDOWS\_N | | | | | ET\_WARN | | | | | | | | | | \_HOSTWINDOWS\_N | | | | | ET\_CRIT | +-------------------+-------------------+-------------------+------------------+ | Swap | Check swap space | check\_windows\_s | | | | usage. Too many | wap | \_HOSTDOMAINUSER | | | use of swap space | | | | | means lacks of | | \_HOSTDOMAINPASS | | | memory or memory | | WORD | | | leaks. | | | +-------------------+-------------------+-------------------+------------------+ | BigProcesses | | check\_windows\_b | | | | | ig\_processes | \_HOSTDOMAINUSER | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_B | | | | | IG\_PROCESSES\_W | | | | | ARN | +-------------------+-------------------+-------------------+------------------+ | Cpu | Detect abnormal | check\_windows\_o | | | | CPU usage | verall\_cpu | \_HOSTDOMAINUSER | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_A | | | | | LL\_CPU\_WARN | | | | | | | | | | \_HOSTWINDOWS\_A | | | | | LL\_CPU\_CRIT | +-------------------+-------------------+-------------------+------------------+ | Memory | Check about | check\_windows\_p | | | | memory usage. | hysical\_memory | \_HOSTDOMAINUSER | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_M | | | | | EM\_WARN | | | | | | | | | | \_HOSTWINDOWS\_M | | | | | EM\_CRIT | +-------------------+-------------------+-------------------+------------------+ | Services | | 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 | +-------------------+-------------------+-------------------+------------------+ | LoadAverage | Detect abnormal | check\_windows\_l | | | | CPU usage | oadaverage | \_HOSTDOMAINUSER | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_L | | | | | OAD\_WARN | | | | | | | | | | \_HOSTWINDOWS\_L | | | | | OAD\_CRIT | +-------------------+-------------------+-------------------+------------------+ | InactiveSessions | | check\_windows\_i | | | | | nactive\_ts\_sess | \_HOSTDOMAINUSER | | | | ions | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_M | | | | | IN\_INACTIVE\_SE | | | | | SSIONS | | | | | | | | | | \_HOSTWINDOWS\_M | | | | | AX\_INACTIVE\_SE | | | | | SSIONS | +-------------------+-------------------+-------------------+------------------+ | DisksIO | Overall disks IO | check\_windows\_d | | | | usage | isks\_io | \_HOSTDOMAINUSER | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | +-------------------+-------------------+-------------------+------------------+ | Disks | Overall disks | check\_windows\_d | | | | usage | isks | \_HOSTDOMAINUSER | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_D | | | | | ISK\_WARN | | | | | | | | | | \_HOSTWINDOWS\_D | | | | | ISK\_CRIT | +-------------------+-------------------+-------------------+------------------+ | EventLogSystem | Detect abnormal | check\_windows\_e | | | | system events | ventlogs | \_HOSTDOMAINUSER | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_E | | | | | VENT\_LOG\_WARN | | | | | | | | | | \_HOSTWINDOWS\_E | | | | | VENT\_LOG\_CRIT | +-------------------+-------------------+-------------------+------------------+ | Reboot | | check\_windows\_r | | | | | eboot | \_HOSTDOMAINUSER | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTWINDOWS\_R | | | | | EBOOT\_WARN | | | | | | | | | | \_HOSTWINDOWS\_R | | | | | EBOOT\_CRIT | +-------------------+-------------------+-------------------+------------------+ | ShareSpace-$KEY$ | Checks windows | check\_windows\_s | | | | share free space. | hare | \_HOSTDOMAINUSER | | | | | SHORT | | | | | | | | | | \_HOSTDOMAINPASS | | | | | WORD | | | | | | | | | | \_HOSTDOMAIN | | | | | | | | | | \_HOSTWINDOWS\_S | | | | | HARE\_WARN | | | | | | | | | | \_HOSTWINDOWS\_S | | | | | HARE\_CRIT | | | | | | | | | | \_shares | +-------------------+-------------------+-------------------+------------------+ **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) | string | | | of the user to query the | | | | server. Should have rights on | | | | the WMI tables for reading. | | +----------------------------------+---------------------------------+---------+ | \_DOMAINUSER | Full name of the user launching | string | | | the query (default | | | | DOMAIN\USERSHORT). | | +----------------------------------+---------------------------------+---------+ | \_DOMAINPASSWORD | Password for the user launching | string | | | the query. | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_SHARE\_WARN | Warning level for the share | percent | | | disk space (percentage). | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_SHARE\_CRIT | Critical level for the share | percent | | | disk space (percentage). | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_DISK\_WARN | Warning threshold for disk | percent | | | space (percentage). | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_DISK\_CRIT | Critical threshold for disk | percent | | | space (percentage). | | +----------------------------------+---------------------------------+---------+ | \_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 | string | | | (expressed as 5min: / 15m:) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_REBOOT\_CRIT | Critical Uptime of the host | string | | | (expressed as 5min: / 15m:) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_MEM\_WARN | Warning threshold for Windows | percent | | | RAM usage (percentage) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_MEM\_CRIT | Critical threshold for Windows | percent | | | RAM usage (percentage) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_ALL\_CPU\_WARN | Warning threshold for Windows | percent | | | combined CPU usage (percentage) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_ALL\_CPU\_CRIT | Critical threshold for Windows | percent | | | combined CPU usage (percentage) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_CPU\_WARN | Warning threshold for each CPU | percent | | | usage (percentage) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_CPU\_CRIT | Critical threshold for each CPU | percent | | | usage (percentage) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_LOAD\_WARN | Warning threshold for CPU load | string | | | (absolute, single value) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_LOAD\_CRIT | Critical threshold for CPU load | string | | | (absolute, single value) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_EXCLUDED\_AUTO\_SERVI | Regex to match Services to be | string | | CES | excluded from check | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_AUTO\_SERVICES\_WARN | Level for auto-services not | string | | | running | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_AUTO\_SERVICES\_CRIT | Level for auto-services not | string | | | running | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_BIG\_PROCESSES\_WARN | Level for Big processes | percent | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_NET\_WARN | Warning threshold for NET usage | percent | | | (percentage) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_NET\_CRIT | Critical threshold for NET | percent | | | usage (percentage) | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_MIN\_INACTIVE\_SESSIO | Windows min Inactive Sessions | integer | | NS | | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_MAX\_INACTIVE\_SESSIO | Windows max Inactive Sessions | integer | | NS | | | +----------------------------------+---------------------------------+---------+ | \_WINDOWS\_NETWORK\_INTERFACE | Default network interface (for | string | | | checking usage thresholds) | | +----------------------------------+---------------------------------+---------+ Windows-drive-size ^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Get drive size on windows servers by WMI interface .. image:: ../images/packs/pack_icons/windows-drive-size.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$\_STATU | | check\_drive\_size | | | S | | | \_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 .. image:: ../images/packs/pack_icons/windows-events.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$\_STAT | | check\_events\_wind | | | US | | ows\_status | \_HOSTUSER\_WMI | | | | | | | | | | \_HOSTPASSWORD\_WM | | | | | I | | | | | | | | | | \_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 | string | | | other Event log as shown in the Windows Event Viewer | | +------------+------------------------------------------------------+----------+ | type | Eventtype: # 1=error , 2=warning , | string | | | 3=Information,4=Security Audit Success,5=Security | | | | Audit Failure Multiple Eventypes possible with coma | | | | separation | | +------------+------------------------------------------------------+----------+ | id | Eventid Multiple Eventids possible with coma | integer | | | separation | | +------------+------------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/windows-process.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$\_CPU | | check\_process\_win | | | | | dows\_cpu | \_HOSTUSER\_WMI | | | | | | | | | | \_HOSTPASSWORD\_WM | | | | | I | | | | | | | | | | \_PROCESSES\_LIST | +---------------------+-------------+---------------------+--------------------+ | PROCESS\_$KEY$\_MEM | | check\_process\_win | | | | | dows\_mem | \_HOSTUSER\_WMI | | | | | | | | | | \_HOSTPASSWORD\_WM | | | | | I | | | | | | | | | | \_PROCESSES\_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** - **_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 | string | | | extension | | +-----------------+-------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/windows-services.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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$\_ST | | check\_services\_wi | | | ATUS | | ndows\_status | \_HOSTUSER\_WMI | | | | | | | | | | \_HOSTPASSWORD\_WM | | | | | I | | | | | | | | | | \_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 .. image:: ../images/packs/pack_icons/wocu-health-aggregator.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 - | Checks Wocu | check-wocu- | | | Aggregator - | Aggregator | aggregator-daemon | \_HOSTWEB\_PROTO | | $KEY$ | daemons status | | COL | | | and consumption | | | | | metrics | | \_HOSTDOMAIN | | | | | | | | | | \_HOSTACTIVE\_CO | | | | | NN\_WARNING | | | | | | | | | | \_HOSTACTIVE\_CO | | | | | NN\_CRITICAL | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_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 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 | string | | | default) | | +-----------------------------+--------------------------------------+---------+ | \_DOMAIN | Used for Nginx checks if value is | string | | | not default | | +-----------------------------+--------------------------------------+---------+ | \_ACTIVE\_CONN\_WARNING | Active connections warning threshold | integer | +-----------------------------+--------------------------------------+---------+ | \_ACTIVE\_CONN\_CRITICAL | Active connections critical | integer | | | threshold | | +-----------------------------+--------------------------------------+---------+ | \_SSH\_USER | SSH user (key interchange with Wocu | string | | | user must be done). | | +-----------------------------+--------------------------------------+---------+ | \_SSH\_PORT | SSH port (default 22). | integer | +-----------------------------+--------------------------------------+---------+ | \_SSH\_KEY\_PASSPHRASE | SSH passphrase (Wocu user) | string | +-----------------------------+--------------------------------------+---------+ | \_SSH\_KEY | SSH Key File (default | string | | | ~/.ssh/id\_rsa) | | +-----------------------------+--------------------------------------+---------+ | \_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, | integer | | | default 10s | | +-----------------------------+--------------------------------------+---------+ **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 | string | | | description. | | +--------------+----------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/wocu-health-generic.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 - | Checks Wocu | check-wocu-daemon | | | $KEY$ | daemons status | | \_HOSTWEB\_PROTO | | | and consumption | | COL | | | metrics | | | | | | | \_HOSTDOMAIN | | | | | | | | | | \_HOSTACTIVE\_CO | | | | | NN\_WARNING | | | | | | | | | | \_HOSTACTIVE\_CO | | | | | NN\_CRITICAL | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_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 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 | string | | | default) | | +-------------------------------+------------------------------------+---------+ | \_DOMAIN | Used for Nginx checks if value is | string | | | not default | | +-------------------------------+------------------------------------+---------+ | \_ACTIVE\_CONN\_WARNING | Active connections warning | integer | | | threshold | | +-------------------------------+------------------------------------+---------+ | \_ACTIVE\_CONN\_CRITICAL | Active connections critical | integer | | | threshold | | +-------------------------------+------------------------------------+---------+ | \_SSH\_USER | SSH user (key interchange with | string | | | Wocu user must be done). | | +-------------------------------+------------------------------------+---------+ | \_SSH\_PORT | SSH port (default 22). | integer | +-------------------------------+------------------------------------+---------+ | \_SSH\_KEY\_PASSPHRASE | SSH passphrase (Wocu user) | string | +-------------------------------+------------------------------------+---------+ | \_SSH\_KEY | SSH Key File (default | string | | | ~/.ssh/id\_rsa) | | +-------------------------------+------------------------------------+---------+ | \_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, | integer | | | default 10s | | +-------------------------------+------------------------------------+---------+ **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 | string | | | description. | | +--------------+----------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/wocu-health-monitoring.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 - | Checks Wocu | check-wocu- | | | Monitoring - | Monitoring | monitoring-daemon | \_HOSTWEB\_PROTO | | $KEY$ | daemons status | | COL | | | and consumption | | | | | metrics | | \_HOSTDOMAIN | | | | | | | | | | \_HOSTACTIVE\_CO | | | | | NN\_WARNING | | | | | | | | | | \_HOSTACTIVE\_CO | | | | | NN\_CRITICAL | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_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 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 | string | | | default) | | +-------------------------------+------------------------------------+---------+ | \_DOMAIN | Used for Nginx checks if value is | string | | | not default | | +-------------------------------+------------------------------------+---------+ | \_ACTIVE\_CONN\_WARNING | Active connections warning | integer | | | threshold | | +-------------------------------+------------------------------------+---------+ | \_ACTIVE\_CONN\_CRITICAL | Active connections critical | integer | | | threshold | | +-------------------------------+------------------------------------+---------+ | \_SSH\_USER | SSH user (key interchange with | string | | | Wocu user must be done). | | +-------------------------------+------------------------------------+---------+ | \_SSH\_PORT | SSH port (default 22). | integer | +-------------------------------+------------------------------------+---------+ | \_SSH\_KEY\_PASSPHRASE | SSH passphrase (Wocu user) | string | +-------------------------------+------------------------------------+---------+ | \_SSH\_KEY | SSH Key File (default | string | | | ~/.ssh/id\_rsa) | | +-------------------------------+------------------------------------+---------+ | \_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, | integer | | | default 10s | | +-------------------------------+------------------------------------+---------+ **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 | string | | | description. | | +--------------+----------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/wocu-health-monitoring-visor.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 - | Checks Wocu | check-wocu- | | | Monitoring Visor | Monitoring Visor | monitoring-visor- | \_HOSTWEB\_PROTO | | - $KEY$ | daemons status | daemon | COL | | | and consumption | | | | | metrics | | \_HOSTDOMAIN | | | | | | | | | | \_HOSTACTIVE\_CO | | | | | NN\_WARNING | | | | | | | | | | \_HOSTACTIVE\_CO | | | | | NN\_CRITICAL | | | | | | | | | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_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 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 | string | | | default) | | +-------------------------------+------------------------------------+---------+ | \_DOMAIN | Used for Nginx checks if value is | string | | | not default | | +-------------------------------+------------------------------------+---------+ | \_ACTIVE\_CONN\_WARNING | Active connections warning | integer | | | threshold | | +-------------------------------+------------------------------------+---------+ | \_ACTIVE\_CONN\_CRITICAL | Active connections critical | integer | | | threshold | | +-------------------------------+------------------------------------+---------+ | \_SSH\_USER | SSH user (key interchange with | string | | | Wocu user must be done). | | +-------------------------------+------------------------------------+---------+ | \_SSH\_PORT | SSH port (default 22). | integer | +-------------------------------+------------------------------------+---------+ | \_SSH\_KEY\_PASSPHRASE | SSH passphrase (Wocu user) | string | +-------------------------------+------------------------------------+---------+ | \_SSH\_KEY | SSH Key File (default | string | | | ~/.ssh/id\_rsa) | | +-------------------------------+------------------------------------+---------+ | \_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, | integer | | | default 10s | | +-------------------------------+------------------------------------+---------+ **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 | string | | | description. | | +--------------+----------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/wocu-health-satellite.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 - | Checks Wocu | check-wocu- | | | Satellite - $KEY$ | Satellite daemons | satellite-daemon | \_HOSTWEB\_PROTO | | | status and | | COL | | | consumption | | | | | metrics | | \_HOSTSSH\_USER | | | | | | | | | | \_HOSTSSH\_KEY\_ | | | | | PASSPHRASE | | | | | | | | | | \_HOSTSSH\_KEY | | | | | | | | | | \_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 | string | | | default) | | +------------------------+-------------------------------------------+---------+ | \_SSH\_USER | SSH user (key interchange with Wocu user | string | | | must be done). | | +------------------------+-------------------------------------------+---------+ | \_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 | string | | | description. | | +--------------+----------------------------------------------------+----------+ | 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 :ref:`packs-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 - | Checks LMD status | check-realm-lmd- | | | $KEY$ - LMD | from every realm | status | \_WOCU\_REALMS | | Status | | | | +-------------------+-------------------+-------------------+------------------+ | WOCU Realm - | Checks hosts/serv | check-realm- | | | $KEY$ - Stats | ices/bphost/bpser | status | \_HOSTAPI\_PROTO | | | vices statistics | | COL | | | from realms | | | | | | | \_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 - | Checks the time | check-realm-last- | | | $KEY$ - Last | from last check | check | \_HOSTLAST\_CHEC | | Check | command executed | | 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 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 | string | | | default) | | +---------------------+----------------------------------------------+---------+ | \_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 | percent | | | (percentage) | | +---------------------+----------------------------------------------+---------+ | \_SERVICE\_CRIT | Not OK Services critical threshold | percent | | | (percentage) | | +---------------------+----------------------------------------------+---------+ | \_BPHOST\_WARN | Not OK BPHosts warning threshold | percent | | | (percentage) | | +---------------------+----------------------------------------------+---------+ | \_BPHOST\_CRIT | Not OK BPHosts critical threshold | percent | | | (percentage) | | +---------------------+----------------------------------------------+---------+ | \_BPSERVICE\_WARN | Not OK BPServices warning threshold | percent | | | (percentage) | | +---------------------+----------------------------------------------+---------+ | \_BPSERVICE\_CRIT | Not OK BPServices critical threshold | percent | | | (percentage) | | +---------------------+----------------------------------------------+---------+ | \_LAST\_CHECK\_WARN | Minutes from last executed check warning | integer | | | threshold | | +---------------------+----------------------------------------------+---------+ | \_LAST\_CHECK\_CRIT | Minutes from last executed check critical | integer | | | threshold | | +---------------------+----------------------------------------------+---------+ | \_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 | string | | | service description. | | +------------------+------------------------------------------------+----------+ | name | Realm name to monitor. | string | +------------------+------------------------------------------------+----------+ | monitoring\_ip | IP address to query. | string | +------------------+------------------------------------------------+----------+ | monitoring\_port | Port to query. | integer | +------------------+------------------------------------------------+----------+ Voip ---- Mxone-advanced ^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Additional Pack for Advanced Licensed devices .. image:: ../images/packs/pack_icons/mxone-advanced.png :align: center :scale: 50% 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 :ref:`packs-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 | Gets the LIM | check\_mxone\_adv | | | us\_$KEY$ | backup operation | anced\_backup\_st | \_HOSTSNMPVERSIO | | | status | atus | N | | | | | | | | | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_LIM\_LIST | +-------------------+-------------------+-------------------+------------------+ | LIM\_Oper\_status | Gets the LIM | check\_mxone\_adv | | | \_$KEY$ | traffic state | anced\_oper\_stat | \_HOSTSNMPVERSIO | | | | us | 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 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 | string | | | web interface | | +---------------+---------------------------------------------------+----------+ | index | Index of node service (LIM) (integer) | integer | +---------------+---------------------------------------------------+----------+ | ip\_address | Management IP Address of node service (LIM). If | string | | | discovered IP is not accessible from Wocu, | | | | configure it manually | | +---------------+---------------------------------------------------+----------+ | name | Name of node service (LIM) | string | +---------------+---------------------------------------------------+----------+ Mxone-basic ^^^^^^^^^^^ **DESCRIPTION** ---------------------- Pack for Basic Licensed devices .. image:: ../images/packs/pack_icons/mxone-basic.png :align: center :scale: 50% 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 :ref:`packs-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 | Shows the total | check\_mxone\_bas | | | larms\_$KEY$ | number of active | ic\_alarms | \_HOSTSNMPVERSIO | | | (unhandled) | | N | | | alarms on the | | | | | node service | | \_HOSTSNMPCOMMUN | | | (LIM) | | ITY | | | | | | | | | | \_HOSTALARM\_WAR | | | | | NING | | | | | | | | | | \_HOSTALARM\_CRI | | | | | TICAL | | | | | | | | | | \_LIM\_LIST | +-------------------+-------------------+-------------------+------------------+ | MX-ONE\_Alarms\_m | Shows the current | check\_mxone\_bas | | | ax\_level\_$KEY$ | alarm status in | ic\_status | \_HOSTSNMPVERSIO | | | the node service | | N | | | (LIM). | | | | | | | \_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 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 | integer | | | (unhandled) alarms | | +--------------------+-----------------------------------------------+---------+ | \_ALARM\_CRITICAL | Critical threshold for number of active | integer | | | (unhandled) alarms | | +--------------------+-----------------------------------------------+---------+ | \_STATUS\_CRITICAL | Critical threshold for maximum severity level | integer | | | of active (unhandled) alarms. Must be in the | | | | 0-5 range | | +--------------------+-----------------------------------------------+---------+ **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 | string | | | web interface | | +---------------+---------------------------------------------------+----------+ | 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 .. image:: ../images/packs/pack_icons/sbc-acme-packet.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 CPU Usage | | sbc\_acme\_cpu\_usa | | | | | ge | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTCPU\_USAGE\_ | | | | | WARNING | | | | | | | | | | \_HOSTCPU\_USAGE\_ | | | | | CRITICAL | +---------------------+-------------+---------------------+--------------------+ | Inbound Sessions | | sbc\_acme\_inbound\ | | | $KEY$ | | _sessions | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_REALMLIST | +---------------------+-------------+---------------------+--------------------+ | System state | | sbc\_system\_state | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ | Outbound Sessions | | sbc\_acme\_outbound | | | $KEY$ | | \_sessions | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_REALMLIST | +---------------------+-------------+---------------------+--------------------+ | SBC Call Statistics | | sbc\_acme\_call\_st | | | | | ats | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTCONCURRENT\_ | | | | | SESSIONS\_WARNING | | | | | | | | | | \_HOSTCONCURRENT\_ | | | | | SESSIONS\_CRITICAL | +---------------------+-------------+---------------------+--------------------+ | SBC License Usage | | sbc\_acme\_license\ | | | | | _usage | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTLICENSE\_USA | | | | | GE\_WARNING | | | | | | | | | | \_HOSTLICENSE\_USA | | | | | GE\_CRITICAL | +---------------------+-------------+---------------------+--------------------+ | SBC Memory Usage | | sbc\_acme\_memory\_ | | | | | usage | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTMEMORY\_USAG | | | | | E\_WARNING | | | | | | | | | | \_HOSTMEMORY\_USAG | | | | | E\_CRITICAL | +---------------------+-------------+---------------------+--------------------+ | SBC AcmePacket Info | | sbc\_acme\_info | | | | | | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ | Call Rate $KEY$ | | sbc\_acme\_call\_ra | | | | | te | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_REALMLIST | +---------------------+-------------+---------------------+--------------------+ | SBC System Health | | sbc\_acme\_system\_ | | | | | health | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTSYSTEM\_HEAL | | | | | TH\_WARNING | | | | | | | | | | \_HOSTSYSTEM\_HEAL | | | | | TH\_CRITICAL | +---------------------+-------------+---------------------+--------------------+ | SBC Redundancy | | sbc\_acme\_redundan | | | State | | cy | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ **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 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 | string | | | on the SBC server | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | SNMP version of the SBC server | string | | | (allowed 1 and 2c) | | +----------------------------------+---------------------------------+---------+ | \_INBOUND\_SESSIONS\_WARNING | Inbound sessions warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_INBOUND\_SESSIONS\_CRITICAL | Inbound sessions critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_OUTBOUND\_SESSIONS\_WARNING | Outbound sessions warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_OUTBOUND\_SESSIONS\_CRITICAL | Outbound sessions critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_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 | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_CONCURRENT\_SESSIONS\_WARNING | Concurrent sessions Warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_CONCURRENT\_SESSIONS\_CRITICAL | Concurrent sessions Critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_LICENSE\_USAGE\_WARNING | License usage Warning threshold | integer | +----------------------------------+---------------------------------+---------+ | \_LICENSE\_USAGE\_CRITICAL | License usage Critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ **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 | integer | | | warning threshold | | +--------------------------------+----------------------------------+----------+ | inbound\_rejected\_critical | Inbound rejected sessions | integer | | | critical threshold | | +--------------------------------+----------------------------------+----------+ | outbound\_rejected\_warning | Outbound rejected sessions | integer | | | warning threshold | | +--------------------------------+----------------------------------+----------+ | outbound\_rejected\_critical | Outbound rejected sessions | integer | | | critical threshold | | +--------------------------------+----------------------------------+----------+ | inbound\_call\_rate\_warning | Inbound sessions increment | integer | | | warning threshold | | +--------------------------------+----------------------------------+----------+ | outbound\_call\_rate\_critical | Outbound sessions increment | integer | | | critical threshold | | +--------------------------------+----------------------------------+----------+ | inbound\_active\_warning | Inbound active sessions warning | integer | | | threshold | | +--------------------------------+----------------------------------+----------+ | inbound\_active\_critical | Inbound active sessions critical | integer | | | threshold | | +--------------------------------+----------------------------------+----------+ | outbound\_active\_warning | Outbound active sessions warning | integer | | | threshold | | +--------------------------------+----------------------------------+----------+ | outbound\_active\_critical | Outbound active sessions | integer | | | critical threshold | | +--------------------------------+----------------------------------+----------+ Sbc-audiocodes ^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Checks for Audiocodes SBC gateways via snmp .. image:: ../images/packs/pack_icons/sbc-audiocodes.png :align: center :scale: 50% 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 :ref:`packs-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 OffHook | | sbc\_audiocodes\_of | | | channels | | fhook\_channels | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTOFFHOOK\_CHA | | | | | NNELS\_WARNING | | | | | | | | | | \_HOSTOFFHOOK\_CHA | | | | | NNELS\_CRITICAL | +---------------------+-------------+---------------------+--------------------+ | SBC PSTN channels | | sbc\_audiocodes\_ps | | | | | tn\_channels | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTTRUNK\_CHANN | | | | | ELS\_IN\_SERVICE\_ | | | | | WARNING | | | | | | | | | | \_HOSTTRUNK\_CHANN | | | | | ELS\_IN\_SERVICE\_ | | | | | CRITICAL | +---------------------+-------------+---------------------+--------------------+ | SBC Audiocodes Info | | sbc\_audiocodes\_in | | | | | fo | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | +---------------------+-------------+---------------------+--------------------+ | SBC DSP utilization | | sbc\_audiocodes\_ds | | | | | p\_utilization | \_HOSTSNMPCOMMUNIT | | | | | Y | | | | | | | | | | \_HOSTSNMPVERSION | | | | | | | | | | \_HOSTACTIVE\_DSP\ | | | | | _CHANNELS\_WARNING | | | | | | | | | | \_HOSTACTIVE\_DSP\ | | | | | _CHANNELS\_CRITICA | | | | | L | +---------------------+-------------+---------------------+--------------------+ **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 | string | | | on the SBC server | | +----------------------------------+---------------------------------+---------+ | \_SNMPVERSION | SNMP version of the SBC server | string | +----------------------------------+---------------------------------+---------+ | \_ACTIVE\_DSP\_CHANNELS\_WARNING | Active DSP channels warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_ACTIVE\_DSP\_CHANNELS\_CRITICA | Active DSP channels critical | integer | | L | threshold | | +----------------------------------+---------------------------------+---------+ | \_TRUNK\_CHANNELS\_IN\_SERVICE\_ | Trunk channels in service | integer | | WARNING | warning threshold | | +----------------------------------+---------------------------------+---------+ | \_TRUNK\_CHANNELS\_IN\_SERVICE\_ | Trunk channels in service | integer | | CRITICAL | critical threshold | | +----------------------------------+---------------------------------+---------+ | \_OFFHOOK\_CHANNELS\_WARNING | Off Hook channels Warning | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ | \_OFFHOOK\_CHANNELS\_CRITICAL | Off Hook channels Critical | integer | | | threshold | | +----------------------------------+---------------------------------+---------+ Hardware -------- Cisco-ucs-server-hwinfo ^^^^^^^^^^^^^^^^^^^^^^^ **DESCRIPTION** ---------------------- Hardware health checks for Cisco UCS Rack Servers, via CICM (snmp) .. image:: ../images/packs/pack_icons/cisco-ucs-server-hwinfo.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_status | Checks the CPU | check\_ucs\_cpus\ | | | | status | _status | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Disks\_states | Checks the Disk | check\_ucs\_local | | | | status | disks | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Storage\_controll | Checks the | check\_ucs\_stora | | | er | Storage | ge\_controller | \_HOSTSNMPCOMMUN | | | Controller status | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Raid\_info | Shows Raid info | check\_ucs\_raids | | | | | \_info | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | CPUs\_info | Shows CPU info | check\_ucs\_cpus\ | | | | | _info | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | CPUs\_temperature | Checks the CPU | check\_ucs\_cpu\_ | | | s | temperature | temps | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTCPUTEMPWR | | | | | | | | | | \_HOSTCPUTEMPCR | +-------------------+-------------------+-------------------+------------------+ | FANs | Checks fans | check\_ucs\_fans | | | | status | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | PSUs\_voltage | Checks the | check\_ucs\_psus\ | | | | Powersupply | _voltage | \_HOSTSNMPCOMMUN | | | voltage | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTPSUVOLTWR | | | | | | | | | | \_HOSTPSUVOLTCR | +-------------------+-------------------+-------------------+------------------+ | Server\_info | Shows server info | check\_ucs\_serve | | | | | r\_info | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Disks\_info | Shows disk info | check\_ucs\_disks | | | | | \_info | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Raid\_status | Checks the Raid | check\_ucs\_raids | | | | status | \_status | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Memory\_status | Checks the memory | check\_ucs\_mem\_ | | | | status | status | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Memory\_info | Shows memory info | check\_ucs\_mem\_ | | | | | info | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | PSUs | Checks the | check\_ucs\_psus | | | | Powersupply | | \_HOSTSNMPCOMMUN | | | status | | 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 .. image:: ../images/packs/pack_icons/crossbeam.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 Failover\_g | Checks the | check\_failover\_ | | | roup\_status | failover group | group\_status | \_HOSTSNMPCOMMUN | | $KEY$ | status | | ITY | | | | | | | | | | \_CROSSBEAM\_FAI | | | | | LOVER\_GR\_STATU | | | | | S | +-------------------+-------------------+-------------------+------------------+ | XBEAM CPU\_System | Checks the System | check\_cpu\_syste | | | $KEY$ | CPU | m | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_SYSTE | | | | | M\_WARNING | | | | | | | | | | \_HOSTCPU\_SYSTE | | | | | M\_CRITICAL | | | | | | | | | | \_CROSSBEAM\_CPU | | | | | \_SYSTEM\_LIST | +-------------------+-------------------+-------------------+------------------+ | XBEAM HA Status | Checks the HA | check\_ha\_status | | | | Status | | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | XBEAM CPU\_Util | Checks the CPU | check\_cpu\_util | | | $KEY$ | utilization | | \_HOSTSNMPCOMMUN | | | percent | | ITY | | | | | | | | | | \_HOSTCPU\_UTIL\ | | | | | _WARNING | | | | | | | | | | \_HOSTCPU\_UTIL\ | | | | | _CRITICAL | | | | | | | | | | \_CROSSBEAM\_CPU | | | | | \_UTIL\_LIST | +-------------------+-------------------+-------------------+------------------+ | XBEAM Swap Usage | Checks the SWAP | check\_swap\_usag | | | | usage | e | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSWAP\_USAG | | | | | E\_WARNING | | | | | | | | | | \_HOSTSWAP\_USAG | | | | | E\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | XBEAM | Checks the CPU 15 | check\_cpu\_loada | | | CPU\_LoadAvg15 | minute load | vg15 | \_HOSTSNMPCOMMUN | | $KEY$ | average | | ITY | | | | | | | | | | \_HOSTCPU\_LOADA | | | | | VG15\_WARNING | | | | | | | | | | \_HOSTCPU\_LOADA | | | | | VG15\_CRITICAL | | | | | | | | | | \_CROSSBEAM\_CPU | | | | | \_LOADAVG15\_LIS | | | | | T | +-------------------+-------------------+-------------------+------------------+ | XBEAM CPU\_Iowait | Checks the CPU | check\_cpu\_iowai | | | $KEY$ | I/O wait time | t | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_IOWAI | | | | | T\_WARNING | | | | | | | | | | \_HOSTCPU\_IOWAI | | | | | T\_CRITICAL | | | | | | | | | | \_CROSSBEAM\_CPU | | | | | \_IOWAIT\_LIST | +-------------------+-------------------+-------------------+------------------+ | XBEAM CPU Temp | Checks the CPU | check\_cpu\_temp | | | | temperature | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_TEMP\ | | | | | _WARNING | | | | | | | | | | \_HOSTCPU\_TEMP\ | | | | | _CRITICAL | +-------------------+-------------------+-------------------+------------------+ | XBEAM Interface\_ | Checks the | check\_interface\ | | | in\_octets $KEY$ | interface traffic | _in\_octets | \_HOSTSNMPCOMMUN | | | in bytes | | ITY | | | | | | | | | | \_HOSTIN\_OCTETS | | | | | \_WARNING | | | | | | | | | | \_HOSTIN\_OCTETS | | | | | \_CRITICAL | | | | | | | | | | \_CROSSBEAM\_IN\ | | | | | _OCTETS\_LIST | +-------------------+-------------------+-------------------+------------------+ | XBEAM CPU\_Idle | Checks the CPU | check\_cpu\_idle | | | $KEY$ | Idle time | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_IDLE\ | | | | | _WARNING | | | | | | | | | | \_HOSTCPU\_IDLE\ | | | | | _CRITICAL | | | | | | | | | | \_CROSSBEAM\_CPU | | | | | \_IDLE\_LIST | +-------------------+-------------------+-------------------+------------------+ | XBEAM Uptime | Checks the system | check\_uptime | | | | uptime | | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | XBEAM | Checks the CPU 1 | check\_cpu\_loada | | | CPU\_LoadAvg1 | minute load | vg1 | \_HOSTSNMPCOMMUN | | $KEY$ | average | | ITY | | | | | | | | | | \_HOSTCPU\_LOADA | | | | | VG1\_WARNING | | | | | | | | | | \_HOSTCPU\_LOADA | | | | | VG1\_CRITICAL | | | | | | | | | | \_CROSSBEAM\_CPU | | | | | \_LOADAVG1\_LIST | +-------------------+-------------------+-------------------+------------------+ | XBEAM Vap\_Status | Checks the VAP | check\_vap\_statu | | | $KEY$ | status | s | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_CROSSBEAM\_VAP | | | | | \_STATUS\_LIST | +-------------------+-------------------+-------------------+------------------+ | XBEAM Memory Free | Checks the free | check\_mem\_free | | | | memory | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTMEM\_FREE\ | | | | | _WARNING | | | | | | | | | | \_HOSTMEM\_FREE\ | | | | | _CRITICAL | +-------------------+-------------------+-------------------+------------------+ | XBEAM | Checks the CPU 5 | check\_cpu\_loada | | | CPU\_LoadAvg5 | minute load | vg5 | \_HOSTSNMPCOMMUN | | $KEY$ | average | | ITY | | | | | | | | | | \_HOSTCPU\_LOADA | | | | | VG5\_WARNING | | | | | | | | | | \_HOSTCPU\_LOADA | | | | | VG5\_CRITICAL | | | | | | | | | | \_CROSSBEAM\_CPU | | | | | \_LOADAVG5\_LIST | +-------------------+-------------------+-------------------+------------------+ | XBEAM Chassis | Checks XBEAM | check\_chassis\_t | | | Temperature | Chassis | emp | \_HOSTSNMPCOMMUN | | | temperature | | ITY | | | | | | | | | | \_HOSTCHASSIS\_T | | | | | EMP\_WARNING | | | | | | | | | | \_HOSTCHASSIS\_T | | | | | EMP\_CRITICAL | +-------------------+-------------------+-------------------+------------------+ | XBEAM CPU\_Load | Checks the CPU | check\_cpu\_load | | | $KEY$ | instant load | | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTCPU\_LOAD\ | | | | | _WARNING | | | | | | | | | | \_HOSTCPU\_LOAD\ | | | | | _CRITICAL | | | | | | | | | | \_CROSSBEAM\_CPU | | | | | \_LOAD\_LIST | +-------------------+-------------------+-------------------+------------------+ | XBEAM Memory | Checks the memory | check\_mem\_usage | | | Usage | usage | | \_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 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 | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_CPU\_LOADAVG1\_CRITICAL | CPU Load average 1 minute critical | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_CPU\_LOADAVG5\_WARNING | CPU Load average 5 minute warning | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_CPU\_LOADAVG5\_CRITICAL | CPU Load average 5 minute critical | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_CPU\_LOADAVG15\_WARNING | CPU Load average 15 minute warning | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_CPU\_LOADAVG15\_CRITICAL | CPU Load average 15 minute critical | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ | \_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 | integer | | | threshold | | +----------------------------+---------------------------------------+---------+ **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) .. image:: ../images/packs/pack_icons/crossbeam-apm.png :align: center :scale: 50% .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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 | +===================+===================+===================+==================+ | Cluster State | Shows the Cluster | check\_xbeam\_clu | | | | state | ster\_state | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Log server | Checks the Log | check\_xbeam\_log | | | connection | Server connection | server\_conn | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Log send | Checks the Log | check\_xbeam\_log | | | | send service | \_send | \_HOSTSNMPCOMMUN | | | | | ITY | +-------------------+-------------------+-------------------+------------------+ | Checkpoint total | Checks the | check\_checkpoint | | | memory | Checkpoint memory | \_total\_memory | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTMEM\_WARNI | | | | | NG | | | | | | | | | | \_HOSTMEM\_CRITI | | | | | CAL | +-------------------+-------------------+-------------------+------------------+ | Checkpoint | Checks the | check\_checkpoint | | | connections and | Checkpoint | \_connections\_cp | \_HOSTSNMPCOMMUN | | CPU | connections and | u | ITY | | | CPU | | | | | | | \_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 .. image:: ../images/packs/pack_icons/dell-server-hwinfo.png :align: center :scale: 50% iDRAC7 and iDRAC8 supported .. Important:: The terms and concepts used in this section are explained in the :ref:`packs-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\_status | Overall check for | check\_dell\_cpus | | | | CPU(s) status | \_status | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Chassis\_intrusio | Shows overall | check\_dell\_over | | | n | status of Dell | all\_chassis\_int | \_HOSTSNMPCOMMUN | | | PowerEdge | rusion | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Disks\_states | Overall check for | check\_dell\_loca | | | | Disk(s) state | ldisks | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | PSUs\_voltage | Overall check for | check\_dell\_psus | | | | PowerSupply(s) | \_volt | \_HOSTSNMPCOMMUN | | | voltage | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTPSUVOLTWAR | | | | | NING | | | | | | | | | | \_HOSTPSUVOLTCRI | | | | | TICAL | +-------------------+-------------------+-------------------+------------------+ | CMOS\_battery | Shows overall | check\_dell\_over | | | | status of Dell | all\_battery | \_HOSTSNMPCOMMUN | | | PowerEdge CMOS | | ITY | | | battery | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | FANs\_rpm | Checks the Fan(s) | check\_dell\_fans | | | | speed (rpm) | \_rpm | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTRPMDEFAULT | | | | | WARNING | | | | | | | | | | \_HOSTRPMDEFAULT | | | | | CRITICAL | +-------------------+-------------------+-------------------+------------------+ | Disks\_info | Shows overall | check\_dell\_loca | | | | Disk(s) state | ldisks\_info | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | Temperatures | Overall check for | check\_dell\_temp | | | | temperature | s | \_HOSTSNMPCOMMUN | | | sensor(s) | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTTEMPWARNIN | | | | | G | | | | | | | | | | \_HOSTTEMPCRITIC | | | | | AL | +-------------------+-------------------+-------------------+------------------+ | CPUs\_info | Shows info about | check\_dell\_cpus | | | | CPU(s) | \_info | \_HOSTSNMPCOMMUN | | | | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | +-------------------+-------------------+-------------------+------------------+ | CPUs temperature | Overall check for | check\_dell\_cpus | | | | CPU(s) | \_temps | \_HOSTSNMPCOMMUN | | | temperature | | ITY | | | | | | | | | | \_HOSTSNMPVERSIO | | | | | N | | | | | | | | | | \_HOSTTEMPWARNIN | | | | | G | | | | | | | | | | \_HOSTTEMPCRITIC | | | | | AL | +-------------------+-------------------+-------------------+------------------+ | RAID\_info | Shows RAID info | check\_dell\_raid | | | | | \_info | \_HOSTSNMPC