upstream/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2026-04-24 07:37:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Merge c67db879d8 into 3a39ceb603

Browse source
This commit is contained in:
babos77 2026-04-09 23:24:54 -07:00 committed by GitHub
commit dbe7ecd070
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 555 additions and 82 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

429
doc/10-icinga-template-library.md
View file

@ -3607,14 +3607,73 @@ Checks the CPU load of a network device.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise.
thola_device_snmp_community | **Optional.** SNMP community of the device
thola_device_snmp_protocol | **Optional.** SNMP version to use
thola_cpu_load_critical | **Optional.** Critical threshold for the CPU load in %
thola_cpu_load_warning | **Optional.** Warning threshold for the CPU load in %
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP Community of target device
thola_device_snmp_protocol | **Optional.** SNMP Version of target device
thola_device_snmp_port | **Optional.** SNMP Port of target device
thola_device_snmp_discover_parallel_requests | **Optional.** Amount of parallel connection requests used while trying to get a valid SNMP connection
thola_device_snmp_discover_retries | **Optional.** Number of discover retries
thola_device_snmp_discover_timeout | **Optional.** The timeout in seconds used while trying to get a valid SNMP connection
thola_device_snmp_max_repetitions | **Optional.** The max repetitions of the SNMP connection. Overrides the device class settings if set
thola_device_snmp_v3_level | **Optional.** SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')
thola_device_snmp_v3_context | **Optional.** SNMP v3 context name
thola_device_snmp_v3_user | **Optional.** SNMP v3 user name
thola_device_snmp_v3_auth_key | **Optional.** SNMP v3 authentication passphrase
thola_device_snmp_v3_auth_proto | **Optional.** SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')
thola_device_snmp_v3_priv_key | **Optional.** SNMP v3 privacy passphrase
thola_device_snmp_v3_priv_proto | **Optional.** SNMP v3 privacy protocol (e.g. 'DES' or 'AES')
thola_device_http_port | **Optional.** HTTP port
thola_device_https_port | **Optional.** HTTPS port
thola_device_http_username | **Optional.** HTTP username
thola_device_http_password | **Optional.** HTTP password
thola_timeout | **Optional.** Timeout in seconds
thola_cpu_load_critical | **Optional.** Critical threshold for the CPU load in %
thola_cpu_load_warning | **Optional.** Warning threshold for the CPU load in %
##### thola-disk <a id="plugin-contrib-command-thola-disk"></a>
Checks the disk of a device.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP Community of target device
thola_device_snmp_protocol | **Optional.** SNMP Version of target device
thola_device_snmp_port | **Optional.** SNMP Port of target device
thola_device_snmp_discover_parallel_requests | **Optional.** Amount of parallel connection requests used while trying to get a valid SNMP connection
thola_device_snmp_discover_retries | **Optional.** Number of discover retries
thola_device_snmp_discover_timeout | **Optional.** The timeout in seconds used while trying to get a valid SNMP connection
thola_device_snmp_max_repetitions | **Optional.** The max repetitions of the SNMP connection. Overrides the device class settings if set
thola_device_snmp_v3_level | **Optional.** SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')
thola_device_snmp_v3_context | **Optional.** SNMP v3 context name
thola_device_snmp_v3_user | **Optional.** SNMP v3 user name
thola_device_snmp_v3_auth_key | **Optional.** SNMP v3 authentication passphrase
thola_device_snmp_v3_auth_proto | **Optional.** SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')
thola_device_snmp_v3_priv_key | **Optional.** SNMP v3 privacy passphrase
thola_device_snmp_v3_priv_proto | **Optional.** SNMP v3 privacy protocol (e.g. 'DES' or 'AES')
thola_device_http_port | **Optional.** HTTP port
thola_device_https_port | **Optional.** HTTPS port
thola_device_http_username | **Optional.** HTTP username
thola_device_http_password | **Optional.** HTTP password
thola_timeout | **Optional.** Timeout in seconds
thola_disk_critical | **Optional.** Critical threshold for free disk space
thola_disk_warning | **Optional.** Warning threshold for free disk space
##### thola-interface-metrics <a id="plugin-contrib-command-thola-interface-metrics"></a>
@ -3622,11 +3681,41 @@ Checks the interface metrics of a network device.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|-----------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP community of the device
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP Community of target device
thola_device_snmp_protocol | **Optional.** SNMP Version of target device
thola_device_snmp_port | **Optional.** SNMP Port of target device
thola_device_snmp_discover_parallel_requests | **Optional.** Amount of parallel connection requests used while trying to get a valid SNMP connection
thola_device_snmp_discover_retries | **Optional.** Number of discover retries
thola_device_snmp_discover_timeout | **Optional.** The timeout in seconds used while trying to get a valid SNMP connection
thola_device_snmp_max_repetitions | **Optional.** The max repetitions of the SNMP connection. Overrides the device class settings if set
thola_device_snmp_v3_level | **Optional.** SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')
thola_device_snmp_v3_context | **Optional.** SNMP v3 context name
thola_device_snmp_v3_user | **Optional.** SNMP v3 user name
thola_device_snmp_v3_auth_key | **Optional.** SNMP v3 authentication passphrase
thola_device_snmp_v3_auth_proto | **Optional.** SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')
thola_device_snmp_v3_priv_key | **Optional.** SNMP v3 privacy passphrase
thola_device_snmp_v3_priv_proto | **Optional.** SNMP v3 privacy protocol (e.g. 'DES' or 'AES')
thola_device_http_port | **Optional.** HTTP port
thola_device_https_port | **Optional.** HTTPS port
thola_device_http_username | **Optional.** HTTP username
thola_device_http_password | **Optional.** HTTP password
thola_timeout | **Optional.** Timeout in seconds
thola_interface_metrics_value | **Optional.** If set, only the specified values will be read from the interfaces (e.g. 'ifDescr')
thola_interface_metrics_snmp_gets_instead_of_walk | **Optional.** Use SNMP Gets instead of Walks
thola_interface_metrics_ifDescr_regex | **Optional.** Apply a regex on the ifDescr of the interfaces. Use it together with the 'ifDescr-regex-replace' flag
thola_interface_metrics_ifDescr_regex_replace | **Optional.** Apply a regex on the ifDescr of the interfaces. Use it together with the 'ifDescr-regex' flag
thola_interface_metrics_ifType_filter | **Optional.** Filter out interfaces which ifType equals the given types
thola_interface_metrics_ifName_filter | **Optional.** Filter out interfaces which ifName matches the given regex
thola_interface_metrics_ifDescr_filter | **Optional.** Filter out interfaces which ifDescription matches the given regex
##### thola-hardware-health <a id="plugin-contrib-command-thola-hardware-health"></a>
@ -3634,11 +3723,34 @@ Checks the hardware health of a network device.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------------|-----------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP community of the device
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP Community of target device
thola_device_snmp_protocol | **Optional.** SNMP Version of target device
thola_device_snmp_port | **Optional.** SNMP Port of target device
thola_device_snmp_discover_parallel_requests | **Optional.** Amount of parallel connection requests used while trying to get a valid SNMP connection
thola_device_snmp_discover_retries | **Optional.** Number of discover retries
thola_device_snmp_discover_timeout | **Optional.** The timeout in seconds used while trying to get a valid SNMP connection
thola_device_snmp_max_repetitions | **Optional.** The max repetitions of the SNMP connection. Overrides the device class settings if set
thola_device_snmp_v3_level | **Optional.** SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')
thola_device_snmp_v3_context | **Optional.** SNMP v3 context name
thola_device_snmp_v3_user | **Optional.** SNMP v3 user name
thola_device_snmp_v3_auth_key | **Optional.** SNMP v3 authentication passphrase
thola_device_snmp_v3_auth_proto | **Optional.** SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')
thola_device_snmp_v3_priv_key | **Optional.** SNMP v3 privacy passphrase
thola_device_snmp_v3_priv_proto | **Optional.** SNMP v3 privacy protocol (e.g. 'DES' or 'AES')
thola_device_http_port | **Optional.** HTTP port
thola_device_https_port | **Optional.** HTTPS port
thola_device_http_username | **Optional.** HTTP username
thola_device_http_password | **Optional.** HTTP password
thola_timeout | **Optional.** Timeout in seconds
##### thola-identify <a id="plugin-contrib-command-thola-identify"></a>
@ -3646,17 +3758,44 @@ Checks if a device can be identified by the given properties.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------------------------|--------------------------------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP community of the device
thola_identify_model | **Optional.** Model that is compared to the actual model of the device
thola_identify_os_version | **Optional.** OS-version that is compared to the actual OS-version of the device
thola_identify_vendor | **Optional.** Vendor that is compared to the actual vendor of the device
thola_identify_serial_number | **Optional.** Serial number that is compared to the actual serial number of the device
thola_identify_discover_retries | **Optional.** The number of discover retries before aborting
thola_identify_discover_timeouts | **Optional.** The number of discover timeouts before aborting
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP Community of target device
thola_device_snmp_protocol | **Optional.** SNMP Version of target device
thola_device_snmp_port | **Optional.** SNMP Port of target device
thola_device_snmp_discover_parallel_requests | **Optional.** Amount of parallel connection requests used while trying to get a valid SNMP connection
thola_device_snmp_discover_retries | **Optional.** Number of discover retries
thola_device_snmp_discover_timeout | **Optional.** The timeout in seconds used while trying to get a valid SNMP connection
thola_device_snmp_max_repetitions | **Optional.** The max repetitions of the SNMP connection. Overrides the device class settings if set
thola_device_snmp_v3_level | **Optional.** SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')
thola_device_snmp_v3_context | **Optional.** SNMP v3 context name
thola_device_snmp_v3_user | **Optional.** SNMP v3 user name
thola_device_snmp_v3_auth_key | **Optional.** SNMP v3 authentication passphrase
thola_device_snmp_v3_auth_proto | **Optional.** SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')
thola_device_snmp_v3_priv_key | **Optional.** SNMP v3 privacy passphrase
thola_device_snmp_v3_priv_proto | **Optional.** SNMP v3 privacy protocol (e.g. 'DES' or 'AES')
thola_device_http_port | **Optional.** HTTP port
thola_device_https_port | **Optional.** HTTPS port
thola_device_http_username | **Optional.** HTTP username
thola_device_http_password | **Optional.** HTTP password
thola_timeout | **Optional.** Timeout in seconds
thola_identify_vendor | **Optional.** Vendor that is compared to the actual vendor of the device
thola_identify_model | **Optional.** Model that is compared to the actual model of the device
thola_identify_os | **Optional.** OS that is compared to the actual OS of the device
thola_identify_os_version | **Optional.** OS-version that is compared to the actual OS-version of the device
thola_identify_serial_number | **Optional.** Serial number that is compared to the actual serial number of the device
thola_identify_vendor_diff_warning | **Optional.** Use warning level if vendor differs to the expected value
thola_identify_model_diff_warning | **Optional.** Use warning level if model differs to the expected value
thola_identify_os_diff_warning | **Optional.** Use warning level if os differs to the expected value
thola_identify_os_version_diff_warning | **Optional.** Use warning level if os version differs to the expected value
thola_identify_serial_number_diff_warning | **Optional.** Use warning level if serial number differs to the expected value
> **Note**:
>
@ -3669,13 +3808,36 @@ Checks the memory usage of a device.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------------------------|-----------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP community of the device
thola_memory_usage_critical | **Optional.** Critical threshold for the memory usage in %
thola_memory_usage_warning | **Optional.** Warning threshold for the memory usage in %
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP Community of target device
thola_device_snmp_protocol | **Optional.** SNMP Version of target device
thola_device_snmp_port | **Optional.** SNMP Port of target device
thola_device_snmp_discover_parallel_requests | **Optional.** Amount of parallel connection requests used while trying to get a valid SNMP connection
thola_device_snmp_discover_retries | **Optional.** Number of discover retries
thola_device_snmp_discover_timeout | **Optional.** The timeout in seconds used while trying to get a valid SNMP connection
thola_device_snmp_max_repetitions | **Optional.** The max repetitions of the SNMP connection. Overrides the device class settings if set
thola_device_snmp_v3_level | **Optional.** SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')
thola_device_snmp_v3_context | **Optional.** SNMP v3 context name
thola_device_snmp_v3_user | **Optional.** SNMP v3 user name
thola_device_snmp_v3_auth_key | **Optional.** SNMP v3 authentication passphrase
thola_device_snmp_v3_auth_proto | **Optional.** SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')
thola_device_snmp_v3_priv_key | **Optional.** SNMP v3 privacy passphrase
thola_device_snmp_v3_priv_proto | **Optional.** SNMP v3 privacy protocol (e.g. 'DES' or 'AES')
thola_device_http_port | **Optional.** HTTP port
thola_device_https_port | **Optional.** HTTPS port
thola_device_http_username | **Optional.** HTTP username
thola_device_http_password | **Optional.** HTTP password
thola_timeout | **Optional.** Timeout in seconds
thola_memory_usage_critical | **Optional.** Critical threshold for the memory usage in %
thola_memory_usage_warning | **Optional.** Warning threshold for the memory usage in %
##### thola-sbc <a id="plugin-contrib-command-thola-sbc"></a>
@ -3683,13 +3845,110 @@ Checks special metrics from sbc network devices.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------------------------------|-----------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP community of the device
thola_sbc_system_health_score_critical | **Optional.** Critical threshold for the health score in %
thola_sbc_system_health_score_warning | **Optional.** Warning threshold for the health score in %
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP Community of target device
thola_device_snmp_protocol | **Optional.** SNMP Version of target device
thola_device_snmp_port | **Optional.** SNMP Port of target device
thola_device_snmp_discover_parallel_requests | **Optional.** Amount of parallel connection requests used while trying to get a valid SNMP connection
thola_device_snmp_discover_retries | **Optional.** Number of discover retries
thola_device_snmp_discover_timeout | **Optional.** The timeout in seconds used while trying to get a valid SNMP connection
thola_device_snmp_max_repetitions | **Optional.** The max repetitions of the SNMP connection. Overrides the device class settings if set
thola_device_snmp_v3_level | **Optional.** SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')
thola_device_snmp_v3_context | **Optional.** SNMP v3 context name
thola_device_snmp_v3_user | **Optional.** SNMP v3 user name
thola_device_snmp_v3_auth_key | **Optional.** SNMP v3 authentication passphrase
thola_device_snmp_v3_auth_proto | **Optional.** SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')
thola_device_snmp_v3_priv_key | **Optional.** SNMP v3 privacy passphrase
thola_device_snmp_v3_priv_proto | **Optional.** SNMP v3 privacy protocol (e.g. 'DES' or 'AES')
thola_device_http_port | **Optional.** HTTP port
thola_device_https_port | **Optional.** HTTPS port
thola_device_http_username | **Optional.** HTTP username
thola_device_http_password | **Optional.** HTTP password
thola_timeout | **Optional.** Timeout in seconds
thola_sbc_system_health_score_critical | **Optional.** Critical threshold for the health score in %
thola_sbc_system_health_score_warning | **Optional.** Warning threshold for the health score in %
##### thola-server <a id="plugin-contrib-command-thola-server"></a>
Checks the server specific metrics of a device.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP Community of target device
thola_device_snmp_protocol | **Optional.** SNMP Version of target device
thola_device_snmp_port | **Optional.** SNMP Port of target device
thola_device_snmp_discover_parallel_requests | **Optional.** Amount of parallel connection requests used while trying to get a valid SNMP connection
thola_device_snmp_discover_retries | **Optional.** Number of discover retries
thola_device_snmp_discover_timeout | **Optional.** The timeout in seconds used while trying to get a valid SNMP connection
thola_device_snmp_max_repetitions | **Optional.** The max repetitions of the SNMP connection. Overrides the device class settings if set
thola_device_snmp_v3_level | **Optional.** SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')
thola_device_snmp_v3_context | **Optional.** SNMP v3 context name
thola_device_snmp_v3_user | **Optional.** SNMP v3 user name
thola_device_snmp_v3_auth_key | **Optional.** SNMP v3 authentication passphrase
thola_device_snmp_v3_auth_proto | **Optional.** SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')
thola_device_snmp_v3_priv_key | **Optional.** SNMP v3 privacy passphrase
thola_device_snmp_v3_priv_proto | **Optional.** SNMP v3 privacy protocol (e.g. 'DES' or 'AES')
thola_device_http_port | **Optional.** HTTP port
thola_device_https_port | **Optional.** HTTPS port
thola_device_http_username | **Optional.** HTTP username
thola_device_http_password | **Optional.** HTTP password
thola_timeout | **Optional.** Timeout in seconds
thola_server_procs_warning | **Optional.** Warning threshold for procs count
thola_server_procs_critical | **Optional.** Critical threshold for procs count
thola_server_users_warning | **Optional.** Warning threshold for users count
thola_server_users_critical | **Optional.** Critical threshold for users count
##### thola-snmp <a id="plugin-contrib-command-thola-snmp"></a>
Checks the server specific metrics of a device.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP Community of target device
thola_device_snmp_protocol | **Optional.** SNMP Version of target device
thola_device_snmp_port | **Optional.** SNMP Port of target device
thola_device_snmp_discover_parallel_requests | **Optional.** Amount of parallel connection requests used while trying to get a valid SNMP connection
thola_device_snmp_discover_retries | **Optional.** Number of discover retries
thola_device_snmp_discover_timeout | **Optional.** The timeout in seconds used while trying to get a valid SNMP connection
thola_device_snmp_max_repetitions | **Optional.** The max repetitions of the SNMP connection. Overrides the device class settings if set
thola_device_snmp_v3_level | **Optional.** SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')
thola_device_snmp_v3_context | **Optional.** SNMP v3 context name
thola_device_snmp_v3_user | **Optional.** SNMP v3 user name
thola_device_snmp_v3_auth_key | **Optional.** SNMP v3 authentication passphrase
thola_device_snmp_v3_auth_proto | **Optional.** SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')
thola_device_snmp_v3_priv_key | **Optional.** SNMP v3 privacy passphrase
thola_device_snmp_v3_priv_proto | **Optional.** SNMP v3 privacy protocol (e.g. 'DES' or 'AES')
thola_device_http_port | **Optional.** HTTP port
thola_device_https_port | **Optional.** HTTPS port
thola_device_http_username | **Optional.** HTTP username
thola_device_http_password | **Optional.** HTTP password
thola_timeout | **Optional.** Timeout in seconds
##### thola-thola-server <a id="plugin-contrib-command-thola-thola-server"></a>
@ -3697,9 +3956,14 @@ Checks if a Thola API is running on a given server.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------|-----------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
##### thola-ups <a id="plugin-contrib-command-thola-ups"></a>
@ -3707,31 +3971,54 @@ Checks whether a UPS device has its main voltage applied.
Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------------------|-----------------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP community of the device
thola_ups_batt_current_critical_max | **Optional.** High critical threshold for the battery current in Volt
thola_ups_batt_current_critical_min | **Optional.** Low critical threshold for the battery current in Volt
thola_ups_batt_current_warning_max | **Optional.** High warning threshold for the battery current in Volt
thola_ups_batt_current_warning_min | **Optional.** Low warning threshold for the battery current in Volt
thola_ups_batt_temperature_critical_max | **Optional.** High critical threshold for the battery temperature in degree celsius
thola_ups_batt_temperature_critical_min | **Optional.** Low critical threshold for the battery temperature in degree celsius
thola_ups_batt_temperature_warning_max | **Optional.** High warning threshold for the battery temperature in degree celsius
thola_ups_batt_temperature_warning_min | **Optional.** Low warning threshold for the battery temperature in degree celsius
thola_ups_current_load_critical_max | **Optional.** High critical threshold for the current load in percent
thola_ups_current_load_critical_min | **Optional.** Low critical threshold for the current load in percent
thola_ups_current_load_warning_max | **Optional.** High warning threshold for the current load in percent
thola_ups_current_load_warning_min | **Optional.** Low warning threshold for the current load in percent
thola_ups_rectifier_current_critical_max | **Optional.** High critical threshold for the current rectifier in Volt
thola_ups_rectifier_current_critical_min | **Optional.** Low critical threshold for the current rectifier in Volt
thola_ups_rectifier_current_warning_max | **Optional.** High warning threshold for the current rectifier in Volt
thola_ups_rectifier_current_warning_min | **Optional.** Low warning threshold for the current rectifier in Volt
thola_ups_system_voltage_critical_max | **Optional.** High critical threshold for the system voltage in Volt
thola_ups_system_voltage_critical_min | **Optional.** Low critical threshold for the system voltage in Volt
thola_ups_system_voltage_warning_max | **Optional.** High warning threshold for the system voltage in Volt
thola_ups_system_voltage_warning_min | **Optional.** Low warning threshold for the system voltage in Volt
Name | Description
----------------------------------------------------|--------------------------------------------------------
thola_api_address | **Required.** Address of the Thola API to connect to
thola_api_username | **Optional.** The username for authorization on the Thola API
thola_api_password | **Optional.** The password for authorization on the Thola API
thola_api_format | **Optional.** The format used to send data to the Thola API ('json' or 'xml')
thola_insecure_ssl_cert | **Optional.** Allow insecure SSL certificate of the Thola API
thola_json_metrics | **Optional.** Output performance data as json
thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise
thola_device_snmp_community | **Optional.** SNMP Community of target device
thola_device_snmp_protocol | **Optional.** SNMP Version of target device
thola_device_snmp_port | **Optional.** SNMP Port of target device
thola_device_snmp_discover_parallel_requests | **Optional.** Amount of parallel connection requests used while trying to get a valid SNMP connection
thola_device_snmp_discover_retries | **Optional.** Number of discover retries
thola_device_snmp_discover_timeout | **Optional.** The timeout in seconds used while trying to get a valid SNMP connection
thola_device_snmp_max_repetitions | **Optional.** The max repetitions of the SNMP connection. Overrides the device class settings if set
thola_device_snmp_v3_level | **Optional.** SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')
thola_device_snmp_v3_context | **Optional.** SNMP v3 context name
thola_device_snmp_v3_user | **Optional.** SNMP v3 user name
thola_device_snmp_v3_auth_key | **Optional.** SNMP v3 authentication passphrase
thola_device_snmp_v3_auth_proto | **Optional.** SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')
thola_device_snmp_v3_priv_key | **Optional.** SNMP v3 privacy passphrase
thola_device_snmp_v3_priv_proto | **Optional.** SNMP v3 privacy protocol (e.g. 'DES' or 'AES')
thola_device_http_port | **Optional.** HTTP port
thola_device_https_port | **Optional.** HTTPS port
thola_device_http_username | **Optional.** HTTP username
thola_device_http_password | **Optional.** HTTP password
thola_timeout | **Optional.** Timeout in seconds
thola_ups_batt_current_critical_max | **Optional.** High critical threshold for the battery current in Volt
thola_ups_batt_current_critical_min | **Optional.** Low critical threshold for the battery current in Volt
thola_ups_batt_current_warning_max | **Optional.** High warning threshold for the battery current in Volt
thola_ups_batt_current_warning_min | **Optional.** Low warning threshold for the battery current in Volt
thola_ups_batt_temperature_critical_max | **Optional.** High critical threshold for the battery temperature in degree celsius
thola_ups_batt_temperature_critical_min | **Optional.** Low critical threshold for the battery temperature in degree celsius
thola_ups_batt_temperature_warning_max | **Optional.** High warning threshold for the battery temperature in degree celsius
thola_ups_batt_temperature_warning_min | **Optional.** Low warning threshold for the battery temperature in degree celsius
thola_ups_current_load_critical_max | **Optional.** High critical threshold for the current load in percent
thola_ups_current_load_critical_min | **Optional.** Low critical threshold for the current load in percent
thola_ups_current_load_warning_max | **Optional.** High warning threshold for the current load in percent
thola_ups_current_load_warning_min | **Optional.** Low warning threshold for the current load in percent
thola_ups_rectifier_current_critical_max | **Optional.** High critical threshold for the current rectifier in Volt
thola_ups_rectifier_current_critical_min | **Optional.** Low critical threshold for the current rectifier in Volt
thola_ups_rectifier_current_warning_max | **Optional.** High warning threshold for the current rectifier in Volt
thola_ups_rectifier_current_warning_min | **Optional.** Low warning threshold for the current rectifier in Volt
thola_ups_system_voltage_critical_max | **Optional.** High critical threshold for the system voltage in Volt
thola_ups_system_voltage_critical_min | **Optional.** Low critical threshold for the system voltage in Volt
thola_ups_system_voltage_warning_max | **Optional.** High warning threshold for the system voltage in Volt
thola_ups_system_voltage_warning_min | **Optional.** Low warning threshold for the system voltage in Volt
### Network Services <a id="plugin-contrib-network-services"></a>

208
itl/plugins-contrib.d/network-components.conf
View file

@ -960,7 +960,27 @@ template CheckCommand "generic-thola-check-command" {
"--target-api" = {
required = true
value = "$thola_api_address$"
description = "Address of the thola API"
description = "Address of the Thola API"
}
"--target-api-username" = {
value = "$thola_api_username$"
description = "The username for authorization on the Thola API"
}
"--target-api-password" = {
value = "$thola_api_password$"
description = "The password for authorization on the Thola API"
}
"--target-api-format" = {
value = "$thola_api_format$"
description = "The format used to send data to the Thola API ('json' or 'xml')"
}
"--insecure-ssl-cert" = {
set_if = "$thola_insecure_ssl_cert$"
description = "Allow insecure SSL certificate of the Thola API"
}
"--json-metrics" = {
set_if = "$thola_json_metrics$"
description = "Output performance data as json"
}
}
}
@ -985,6 +1005,74 @@ template CheckCommand "generic-thola-device-check-command" {
value = "$thola_device_snmp_protocol$"
description = "SNMP Version of target device"
}
"--snmp-port" = {
value = "$thola_device_snmp_port$"
description = "SNMP Port of target device"
}
"--snmp-discover-par-requests" = {
value = "$thola_device_snmp_discover_parallel_requests$"
description = "Amount of parallel connection requests used while trying to get a valid SNMP connection"
}
"--snmp-discover-retries" = {
value = "$thola_device_snmp_discover_retries$"
description = "Number of discover retries"
}
"--snmp-discover-timeout" = {
value = "$thola_device_snmp_discover_timeout$"
description = "The timeout in seconds used while trying to get a valid SNMP connection"
}
"--snmp-max-repetitions" = {
value = "$thola_device_snmp_max_repetitions$"
description = "The max repetitions of the SNMP connection. Overrides the device class settings if set"
}
"--snmp-v3-level" = {
value = "$thola_device_snmp_v3_level$"
description = "SNMP v3 level ('noAuthNoPriv', 'authNoPriv' or 'authPriv')"
}
"--snmp-v3-context" = {
value = "$thola_device_snmp_v3_context$"
description = "SNMP v3 context name"
}
"--snmp-v3-user" = {
value = "$thola_device_snmp_v3_user$"
description = "SNMP v3 user name"
}
"--snmp-v3-auth-key" = {
value = "$thola_device_snmp_v3_auth_key$"
description = "SNMP v3 authentication passphrase"
}
"--snmp-v3-auth-proto" = {
value = "$thola_device_snmp_v3_auth_proto$"
description = "SNMP v3 authentication protocol (e.g. 'MD5' or 'SHA')"
}
"--snmp-v3-priv-key" = {
value = "$thola_device_snmp_v3_priv_key$"
description = "SNMP v3 privacy passphrase"
}
"--snmp-v3-priv-proto" = {
value = "$thola_device_snmp_v3_priv_proto$"
description = "SNMP v3 privacy protocol (e.g. 'DES' or 'AES')"
}
"--http-port" = {
value = "$thola_device_http_port$"
description = "HTTP port"
}
"--https-port" = {
value = "$thola_device_https_port$"
description = "HTTPS port"
}
"--http-username" = {
value = "$thola_device_http_username$"
description = "HTTP username"
}
"--http-password" = {
value = "$thola_device_http_password$"
description = "HTTP password"
}
"--timeout" = {
value = "$thola_timeout$"
description = "Timeout in seconds"
}
}
vars.thola_device_address = "$check_address$"
@ -1007,10 +1095,59 @@ object CheckCommand "thola-cpu-load" {
}
}
object CheckCommand "thola-disk" {
import "generic-thola-device-check-command"
command += [ "disk" ]
arguments += {
"--critical" = {
value = "$thola_disk_critical$"
description = "Critical threshold for free disk space"
}
"--warning" = {
value = "$thola_disk_warning$"
description = "Warning threshold for free disk space"
}
}
}
object CheckCommand "thola-interface-metrics" {
import "generic-thola-device-check-command"
command += [ "interface-metrics" ]
arguments += {
"--value" = {
repeat_key = true
value = "$thola_interface_metrics_value$"
description = "If set, only the specified values will be read from the interfaces (e.g. 'ifDescr')"
}
"--snmp-gets-instead-of-walk" = {
set_if = "$thola_interface_metrics_snmp_gets_instead_of_walk$"
description = "Use SNMP Gets instead of Walks"
}
"--ifDescr-regex" = {
value = "$thola_interface_metrics_ifDescr_regex$"
description = "Apply a regex on the ifDescr of the interfaces. Use it together with the 'ifDescr-regex-replace' flag"
}
"--ifDescr-regex-replace" = {
value = "$thola_interface_metrics_ifDescr_regex_replace$"
description = "Apply a regex on the ifDescr of the interfaces. Use it together with the 'ifDescr-regex' flag"
}
"--ifType-filter" = {
value = "$thola_interface_metrics_ifType_filter$"
description = "Filter out interfaces which ifType equals the given types"
}
"--ifName-filter" = {
value = "$thola_interface_metrics_ifName_filter$"
description = "Filter out interfaces which ifName matches the given regex"
}
"--ifDescr-filter" = {
value = "$thola_interface_metrics_ifDescr_filter$"
description = "Filter out interfaces which ifDescription matches the given regex"
}
}
}
object CheckCommand "thola-hardware-health" {
@ -1025,29 +1162,45 @@ object CheckCommand "thola-identify" {
command += [ "identify" ]
arguments += {
"--vendor" = {
value = "$thola_identify_vendor$"
description = "Vendor that is compared to the actual vendor of the device"
}
"--vendor-diff-warning" = {
set_if = "$thola_identify_vendor_diff_warning$"
description = "Use warning level if vendor differs to the expected value"
}
"--model" = {
value = "$thola_identify_model$"
description = "Model that is compared to the actual model of the device"
}
"--model-diff-warning" = {
set_if = "$thola_identify_model_diff_warning$"
description = "Use warning level if model differs to the expected value"
}
"--os" = {
value = "$thola_identify_os$"
description = "OS that is compared to the actual OS of the device"
}
"--os-diff-warning" = {
set_if = "$thola_identify_os_diff_warning$"
description = "Use warning level if os differs to the expected value"
}
"--os-version" = {
value = "$thola_identify_os_version$"
description = "OS-version that is compared to the actual OS-version of the device"
}
"--vendor" = {
value = "$thola_identify_vendor$"
description = "Vendor that is compared to the actual vendor of the device"
"--os-version-diff-warning" = {
set_if = "$thola_identify_os_version_diff_warning$"
description = "Use warning level if os version differs to the expected value"
}
"--serial-number" = {
value = "$thola_identify_serial_number$"
description = "Serial number that is compared to the actual serial number of the device"
}
"--snmp-discover-retries" = {
value = "$thola_identify_discover_retries$"
description = "Number of discover retries"
}
"--snmp-discover-timeout" = {
value = "$thola_identify_discover_timeouts$"
description = "Number of discover timeouts"
"--serial-number-diff-warning" = {
set_if = "$thola_identify_serial_number_diff_warning$"
description = "Use warning level if serial number differs to the expected value"
}
}
}
@ -1086,6 +1239,39 @@ object CheckCommand "thola-sbc" {
}
}
object CheckCommand "thola-server" {
import "generic-thola-device-check-command"
command += [ "server" ]
arguments += {
"--procs-warning" = {
value = "$thola_server_procs_warning$"
description = "Warning threshold for procs count"
}
"--procs-critical" = {
value = "$thola_server_procs_critical$"
description = "Critical threshold for procs count"
}
"--users-warning" = {
value = "$thola_server_users_warning$"
description = "Warning threshold for users count"
}
"--users-critical" = {
value = "$thola_server_users_critical$"
description = "Critical threshold for users count"
}
}
}
object CheckCommand "thola-snmp" {
import "generic-thola-device-check-command"
command += [ "snmp" ]
}
object CheckCommand "thola-thola-server" {
import "generic-thola-check-command"