]> granicus.if.org Git - icinga2/blobdiff - doc/10-icinga-template-library.md
Merge pull request #5906 from sahnd/feature/check_openmanage
[icinga2] / doc / 10-icinga-template-library.md
index 60a6a3960b6de1d8264d29f2a1aac49059b238cb..6536709f4c2e20ba60c8df9caf34706c02855fe1 100644 (file)
@@ -108,6 +108,21 @@ Name         | Description
 ido\_type    | **Required.** The type of the IDO connection object. Can be either "IdoMysqlConnection" or "IdoPgsqlConnection".
 ido\_name    | **Required.** The name of the IDO connection object.
 
+### dummy <a id="itl-dummy"></a>
+
+Check command for the built-in `dummy` check. This allows to set
+a check result state and output and can be used in [freshness checks](08-advanced-topics.md#check-result-freshness)
+or [runtime object checks](08-advanced-topics.md#access-object-attributes-at-runtime).
+In contrast to the [check_dummy](https://www.monitoring-plugins.org/doc/man/check_dummy.html)
+plugin, Icinga 2 implements a light-weight in memory check with 2.9+.
+
+Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+
+Name            | Description
+----------------|--------------
+dummy\_state     | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
+dummy\_text      | **Optional.** Plugin output. Defaults to "Check was successful.".
+
 ### random <a id="itl-random"></a>
 
 Check command for the built-in `random` check. This check returns random states
@@ -350,19 +365,6 @@ dns_ctime            | **Optional.** Return critical if elapsed time exceeds val
 dns_timeout          | **Optional.** Seconds before connection times out. Defaults to 10.
 
 
-### dummy <a id="plugin-check-command-dummy"></a>
-
-The [check_dummy](https://www.monitoring-plugins.org/doc/man/check_dummy.html) plugin
-will simply return the state corresponding to the numeric value of the `dummy_state`
-argument with optional text.
-
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
-
-Name            | Description
-----------------|--------------
-dummy_state     | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
-dummy_text      | **Optional.** Plugin output. Defaults to "Check was successful.".
-
 
 ### file_age <a id="plugin-check-command-file-age"></a>
 
@@ -605,7 +607,7 @@ http_invertregex                 | **Optional.** Changes behavior of http_expect
 http_warn_time                   | **Optional.** The warning threshold.
 http_critical_time               | **Optional.** The critical threshold.
 http_expect                      | **Optional.** Comma-delimited list of strings, at least one of them is expected in the first (status) line of the server response. Default: HTTP/1.
-http_certificate                 | **Optional.** Minimum number of days a certificate has to be valid. This parameter explicitly sets the port to 443 and ignores the URL if passed.
+http_certificate                 | **Optional.** Minimum number of days a certificate has to be valid. Port defaults to 443. When this option is used the URL is not checked. The first parameter defines the warning threshold (in days), the second parameter the critical threshold (in days). (Example `http_certificate = "30,20"`).
 http_clientcert                  | **Optional.** Name of file contains the client certificate (PEM format).
 http_privatekey                  | **Optional.** Name of file contains the private key (PEM format).
 http_headerstring                | **Optional.** String to expect in the response headers.
@@ -1098,6 +1100,22 @@ radius_expect      | **Optional.** The response string to expect from the server
 radius_retries     | **Optional.** The number of times to retry a failed connection.
 radius_timeout     | **Optional.** The number of seconds before connection times out (default: 10).
 
+### rpc <a id="plugin-check-command-rpc"></a>
+
+The [check_rpc](https://www.monitoring-plugins.org/doc/man/check_rpc.html)
+plugin tests if a service is registered and running using `rpcinfo -H host -C rpc_command`.
+
+Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+
+Name        | Description
+---         | ---
+rpc_address | **Optional.** The rpc host address. Defaults to "$address$ if the host `address` attribute is set, "$address6$" otherwise.
+rpc_command | **Required.** The programm name (or number).
+rpc_port    | **Optional.** The port that should be checked.
+rpc_version | **Optional.** The version you want to check for (one or more).
+rpc_udp     | **Optional.** Use UDP test. Defaults to false.
+rpc_tcp     | **Optional.** Use TCP test. Defaults to false.
+rpc_verbose | **Optional.** Show verbose output. Defaults to false.
 
 ### simap <a id="plugin-check-command-simap"></a>
 
@@ -1978,6 +1996,8 @@ snmp_crit               | **Optional.** The critical threshold.
 snmp_is_cisco          | **Optional.** Change OIDs for Cisco switches. Defaults to false.
 snmp_is_hp              | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
 snmp_perf               | **Optional.** Enable perfdata values. Defaults to true.
+snmp_memcached          | **Optional.** Include cached memory in used memory, Defaults to false.
+snmp_membuffer          | **Optional.** Exclude buffered memory in used memory, Defaults to false.
 snmp_timeout            | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
 
 ### snmp-storage <a id="plugin-check-command-snmp-storage"></a>
@@ -2005,6 +2025,7 @@ snmp_crit               | **Optional.** The critical threshold.
 snmp_storage_name       | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
 snmp_perf               | **Optional.** Enable perfdata values. Defaults to true.
 snmp_timeout            | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
+snmp_storage_olength   | **Optional.** Max-size of the SNMP message, usefull in case of Too Long responses.
 
 ### snmp-interface <a id="plugin-check-command-snmp-interface"></a>
 
@@ -2288,8 +2309,9 @@ Environment Macros:
 
 Name                | Description
 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
-ORACLE_HOME         | **Required.** Specifies the location of the oracle instant client libraries. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting "oracle_home".
-TNS_ADMIN           | **Required.** Specifies the location of the tnsnames.ora including the database connection strings. Defaults to "/etc/icinga2/plugin-configs". Can be overridden by setting "oracle_tns_admin".
+ORACLE\_HOME         | **Required.** Specifies the location of the oracle instant client libraries. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting the custom attribute `oracle_home`.
+LD\_LIBRARY\_PATH    | **Required.** Specifies the location of the oracle instant client libraries for the run-time shared library loader. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting the custom attribute `oracle_ld_library_path`.
+TNS\_ADMIN           | **Required.** Specifies the location of the tnsnames.ora including the database connection strings. Defaults to "/etc/icinga2/plugin-configs". Can be overridden by setting the custom attribute `oracle_tns_admin`.
 
 #### postgres <a id="plugin-contrib-command-postgres"></a>
 
@@ -2445,6 +2467,47 @@ hpasm_servertype         | **Optional.** The type of the server: proliant (default) or
 hpasm_eval-nics                        | **Optional.** Check network interfaces (and groups). Try it and report me whyt you think about it. I need to build up some know how on this subject. If you get an error and think, it is not justified for your configuration, please tell me about it. (always send the output of "snmpwalk -On .... 1.3.6.1.4.1.232" and a description how you setup your nics and why it is correct opposed to the plugins error message.
 hpasm_remote                   | **Optional.** Run remote SNMP checks if enabled. Otherwise checks are executed locally using the `hpasmcli` binary. Defaults to `true`.
 
+#### openmanage <a id="plugin-contrib-command-openmanage"></a>
+
+The [check_openmanage](http://folk.uio.no/trondham/software/check_openmanage.html) plugin
+checks the hardware health of Dell PowerEdge (and some PowerVault) servers.
+It uses the Dell OpenManage Server Administrator (OMSA) software, which must be running on
+the monitored system. check_openmanage can be used remotely with SNMP or locally with icinga2 agent,
+check_by_ssh or similar, whichever suits your needs and particular taste.
+
+The plugin checks the health of the storage subsystem, power supplies, memory modules, 
+temperature probes etc., and gives an alert if any of the components are faulty or operate outside normal parameters.
+
+Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+
+Name                           | Description
+--------------------------------|-----------------------------------------------------------------------
+openmanage_all                 | **Optional.** Check everything, even log content
+openmanage_blacklist           | **Optional.** Blacklist missing and/or failed components
+openmanage_check               | **Optional.** Fine-tune which components are checked
+openmanage_community           | **Optional.** SNMP community string [default=public]
+openmanage_config              | **Optional.** Specify configuration file
+openmanage_critical            | **Optional.** Custom temperature critical limits
+openmanage_extinfo             | **Optional.** Append system info to alerts
+openmanage_fahrenheit          | **Optional.** Use Fahrenheit as temperature unit
+openmanage_hostname            | **Optional.** Hostname or IP (required for SNMP)
+openmanage_htmlinfo            | **Optional.** HTML output with clickable links
+openmanage_info                        | **Optional.** Prefix any alerts with the service tag
+openmanage_ipv6                        | **Optional.** Use IPv6 instead of IPv4 [default=no]
+openmanage_legacy_perfdata     | **Optional.** Legacy performance data output
+openmanage_no_storage          | **Optional.** Don't check storage
+openmanage_only                        | **Optional.** Only check a certain component or alert type
+openmanage_perfdata            | **Optional.** Output performance data [default=no]
+openmanage_port                        | **Optional.** SNMP port number [default=161]
+openmanage_protocol            | **Optional.** SNMP protocol version [default=2c]
+openmanage_short_state         | **Optional.** Prefix alerts with alert state abbreviated
+openmanage_show_blacklist      | **Optional.** Show blacklistings in OK output
+openmanage_state               | **Optional.** Prefix alerts with alert state
+openmanage_tcp                 | **Optional.** Use TCP instead of UDP [default=no]
+openmanage_timeout             | **Optional.** Plugin timeout in seconds [default=30]
+openmanage_vdisk_critical      | **Optional.** Make any alerts on virtual disks critical
+openmanage_warning             | **Optional.** Custom temperature warning limits
+
 #### adaptec-raid <a id="plugin-contrib-command-adaptec-raid"></a>
 
 The [check_adaptec_raid](https://github.com/thomas-krenn/check_adaptec_raid) plugin
@@ -2486,6 +2549,8 @@ smart_attributes_device         | **Required.** Device name (e.g. /dev/sda) to m
 
 This category includes all plugins using the icingacli provided by Icinga Web 2.
 
+The user running Icinga 2 needs sufficient permissions to read the Icinga Web 2 configuration directory. e.g. `usermod -a -G icingaweb2 icinga`. You need to restart, not reload Icinga 2 for the new group membership to work.
+
 #### Business Process <a id="plugin-contrib-icingacli-businessprocess"></a>
 
 This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process)
@@ -2500,6 +2565,16 @@ icingacli_businessprocess_config          | **Optional.** Configuration file con
 icingacli_businessprocess_details         | **Optional.** Get details for root cause analysis. Defaults to false.
 icingacli_businessprocess_statetype       | **Optional.** Define which state type to look at, `soft` or `hard`. Overrides the default value inside the businessprocess module, if configured.
 
+#### Director <a id="plugin-contrib-icingacli-director"></a>
+
+This subcommand is provided by the [director module](https://github.com/Icinga/icingaweb2-module-director) > 1.4.2 and executed as `icingacli director health check`. Please refer to the [documentation](https://github.com/Icinga/icingaweb2-module-director/blob/master/doc/60-CLI.md#health-check-plugin) for all available sub-checks.
+
+Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+
+Name                                      | Description
+------------------------------------------|-----------------------------------------------------------------------------------------
+icingacli_director_check                  | **Optional.** Run only a specific test suite.
+icingacli_director_db                     | **Optional.** Use a specific Icinga Web DB resource.
 
 ### IPMI Devices <a id="plugin-contrib-ipmi"></a>
 
@@ -2820,7 +2895,7 @@ or the guest system.
 
 The [check_mem.pl](https://github.com/justintime/nagios-plugins) plugin checks the
 memory usage on linux and unix hosts. It is able to count cache memory as free when
-compared to thresholds. More details can be found on [this blog entry]((http://sysadminsjourney.com/content/2009/06/04/new-and-improved-checkmempl-nagios-plugin).
+compared to thresholds. More details can be found on [this blog entry](http://sysadminsjourney.com/content/2009/06/04/new-and-improved-checkmempl-nagios-plugin).
 
 Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):