### Multiple Templates <a id="object-inheritance-using-multiple-templates"></a>
-The following example uses [custom attributes](03-monitoring-basics.md#custom-attributes) which
+The following example uses [custom variables](03-monitoring-basics.md#custom-variables) which
are provided in each template. The `web-server` template is used as the
base template for any host providing web services. In addition to that it
-specifies the custom attribute `webserver_type`, e.g. `apache`. Since this
+specifies the custom variable `webserver_type`, e.g. `apache`. Since this
template is also the base template, we import the `generic-host` template here.
This provides the `check_command` attribute by default and we don't need
to set it anywhere later on.
```
The `wp-server` host template specifies a Wordpress instance and sets
-the `application_type` custom attribute. Please note the `+=` [operator](17-language-reference.md#dictionary-operators)
+the `application_type` custom variable. Please note the `+=` [operator](17-language-reference.md#dictionary-operators)
which adds [dictionary](17-language-reference.md#dictionary) items,
but does not override any previous `vars` attribute.
}
```
-## Custom Attributes <a id="custom-attributes"></a>
+<!-- Keep this for compatibility -->
+<a id="custom-attributes"></a>
-In addition to built-in attributes you can define your own attributes
-inside the `vars` attribute:
+## Custom Variables <a id="custom-variables"></a>
+
+In addition to built-in object attributes you can define your own custom
+attributes inside the `vars` attribute.
+
+> **Tip**
+>
+> This is called `custom variables` throughout the documentation, backends and web interfaces.
+>
+> Older documentation versions referred to this as `custom attribute`.
+
+The following example specifies the key `ssh_port` as custom
+variable and assigns an integer value.
```
object Host "localhost" {
vars["ssh_port"] = 2222
```
-### Custom Attribute Values <a id="custom-attributes-values"></a>
+### Custom Variable Values <a id="custom-variables-values"></a>
-Valid values for custom attributes include:
+Valid values for custom variables include:
* [Strings](17-language-reference.md#string-literals), [numbers](17-language-reference.md#numeric-literals) and [booleans](17-language-reference.md#boolean-literals)
* [Arrays](17-language-reference.md#array) and [dictionaries](17-language-reference.md#dictionary)
-* [Functions](03-monitoring-basics.md#custom-attributes-functions)
+* [Functions](03-monitoring-basics.md#custom-variables-functions)
You can also define nested values such as dictionaries in dictionaries.
-This example defines the custom attribute `disks` as dictionary.
+This example defines the custom variable `disks` as dictionary.
The first key is set to `disk /` is itself set to a dictionary
with one key-value pair.
}
```
-This defines the `notification` custom attribute as dictionary
+This defines the `notification` custom variable as dictionary
with the key `mail`. Its value is a dictionary with the key `groups`
which itself has an array as value. Note: This array is the exact
same as the `user_groups` attribute for [notification apply rules](#03-monitoring-basics.md#using-apply-notifications)
}
```
+<!-- Keep this for compatibility -->
+<a id="custom-attributes-functions"></a>
-### Functions as Custom Attributes <a id="custom-attributes-functions"></a>
+### Functions as Custom Variables <a id="custom-variables-functions"></a>
-Icinga 2 lets you specify [functions](17-language-reference.md#functions) for custom attributes.
-The special case here is that whenever Icinga 2 needs the value for such a custom attribute it runs
+Icinga 2 lets you specify [functions](17-language-reference.md#functions) for custom variables.
+The special case here is that whenever Icinga 2 needs the value for such a custom variable it runs
the function and uses whatever value the function returns:
```
## Runtime Macros <a id="runtime-macros"></a>
-Macros can be used to access other objects' attributes at runtime. For example they
-are used in command definitions to figure out which IP address a check should be
-run against:
+Macros can be used to access other objects' attributes and [custom variables](03-monitoring-basics.md#custom-variables)
+at runtime. For example they are used in command definitions to figure out
+which IP address a check should be run against:
```
object CheckCommand "my-ping" {
- command = [ PluginDir + "/check_ping", "-H", "$ping_address$" ]
+ command = [ PluginDir + "/check_ping" ]
arguments = {
+ "-H" = "$ping_address$"
"-w" = "$ping_wrta$,$ping_wpl$%"
"-c" = "$ping_crta$,$ping_cpl$%"
"-p" = "$ping_packets$"
}
+ // Resolve from a host attribute, or custom variable.
vars.ping_address = "$address$"
+ // Default values
vars.ping_wrta = 100
vars.ping_wpl = 5
In this example we are using the `$address$` macro to refer to the host's `address`
attribute.
-We can also directly refer to custom attributes, e.g. by using `$ping_wrta$`. Icinga
+We can also directly refer to custom variables, e.g. by using `$ping_wrta$`. Icinga
automatically tries to find the closest match for the attribute you specified. The
exact rules for this are explained in the next section.
2. Service object
3. Host object
4. Command object
-5. Global custom attributes in the `Vars` constant
+5. Global custom variables in the `Vars` constant
-This execution order allows you to define default values for custom attributes
+This execution order allows you to define default values for custom variables
in your command objects.
-Here's how you can override the custom attribute `ping_packets` from the previous
+Here's how you can override the custom variable `ping_packets` from the previous
example:
```
}
```
-If a custom attribute isn't defined anywhere, an empty value is used and a warning is
+If a custom variable isn't defined anywhere, an empty value is used and a warning is
written to the Icinga 2 log.
You can also directly refer to a specific attribute -- thereby ignoring these evaluation
$service.vars.ping_wrta$
```
-This retrieves the value of the `ping_wrta` custom attribute for the service. This
-returns an empty value if the service does not have such a custom attribute no matter
+This retrieves the value of the `ping_wrta` custom variable for the service. This
+returns an empty value if the service does not have such a custom variable no matter
whether another object such as the host has this attribute.
### Host Runtime Macros <a id="host-runtime-macros"></a>
-The following host custom attributes are available in all commands that are executed for
+The following host custom variables are available in all commands that are executed for
hosts or services:
Name | Description
### Command Runtime Macros <a id="command-runtime-macros"></a>
-The following custom attributes are available in all commands:
+The following custom variables are available in all commands:
Name | Description
-----------------------|--------------
### User Runtime Macros <a id="user-runtime-macros"></a>
-The following custom attributes are available in all commands that are executed for
+The following custom variables are available in all commands that are executed for
users:
Name | Description
Before you start with apply rules keep the following in mind:
* Define the best match.
- * A set of unique [custom attributes](03-monitoring-basics.md#custom-attributes) for these hosts/services?
+ * A set of unique [custom variables](03-monitoring-basics.md#custom-variables) for these hosts/services?
* Or [group](03-monitoring-basics.md#groups) memberships, e.g. a host being a member of a hostgroup which should have a service set?
* A generic pattern [match](18-library-reference.md#global-functions-match) on the host/service name?
* [Multiple expressions combined](03-monitoring-basics.md#using-apply-expressions) with `&&` or `||` [operators](17-language-reference.md#expression-operators)
vars.application_type = host.vars.application_type
```
-[Custom attributes](03-monitoring-basics.md#custom-attributes) can also store
+[Custom variables](03-monitoring-basics.md#custom-variables) can also store
nested dictionaries and arrays. That way you can use them for not only matching
for their existence or values in apply expressions, but also assign
("inherit") their values into the generated objected from apply rules.
-Remember the examples shown for [custom attribute values](03-monitoring-basics.md#custom-attributes-values):
+Remember the examples shown for [custom variable values](03-monitoring-basics.md#custom-variables-values):
```
vars.notification["mail"] = {
You can do two things here:
-* Check for the existence of the `notification` custom attribute and its nested dictionary key `mail`.
+* Check for the existence of the `notification` custom variable and its nested dictionary key `mail`.
If this is boolean true, the notification object will be generated.
* Assign the value of the `groups` key to the `user_groups` attribute.
A more advanced example is to use [apply rules with for loops on arrays or
dictionaries](03-monitoring-basics.md#using-apply-for) provided by
-[custom atttributes](03-monitoring-basics.md#custom-attributes) or groups.
+[custom atttributes](03-monitoring-basics.md#custom-variables) or groups.
-Remember the examples shown for [custom attribute values](03-monitoring-basics.md#custom-attributes-values):
+Remember the examples shown for [custom variable values](03-monitoring-basics.md#custom-variables-values):
```
vars.disks["disk /"] = {
assign where "hostgroup-dev" in host.groups
```
-Assign an object when a custom attribute is [equal](17-language-reference.md#expression-operators) to a value:
+Assign an object when a custom variable is [equal](17-language-reference.md#expression-operators) to a value:
```
assign where host.vars.application_type == "database"
assign where regex("^webserver-[\\d+]", host.name)
```
-[Match](18-library-reference.md#global-functions-match) all `*mysql*` patterns in the host name and (`&&`) custom attribute `prod_mysql_db`
-matches the `db-*` pattern. All hosts with the custom attribute `test_server` set to `true`
+[Match](18-library-reference.md#global-functions-match) all `*mysql*` patterns in the host name and (`&&`) custom variable `prod_mysql_db`
+matches the `db-*` pattern. All hosts with the custom variable `test_server` set to `true`
should be ignored, or any host name ending with `*internal` pattern.
```
Similar example for advanced notification apply rule filters: If the service
attribute `notes` [matches](18-library-reference.md#global-functions-match) the `has gold support 24x7` string `AND` one of the
-two condition passes, either the `customer` host custom attribute is set to `customer-xy`
-`OR` the host custom attribute `always_notify` is set to `true`.
+two condition passes, either the `customer` host custom variable is set to `customer-xy`
+`OR` the host custom variable `always_notify` is set to `true`.
The notification is ignored for services whose host name ends with `*internal`
-`OR` the `priority` custom attribute is [less than](17-language-reference.md#expression-operators) `2`.
+`OR` the `priority` custom variable is [less than](17-language-reference.md#expression-operators) `2`.
```
template Notification "cust-xy-notification" {
and [services.conf](04-configuration.md#services-conf) for this use case.
The example for `ssh` applies a service object to all hosts with the `address`
-attribute being defined and the custom attribute `os` set to the string `Linux` in `vars`.
+attribute being defined and the custom variable `os` set to the string `Linux` in `vars`.
```
apply Service "ssh" {
```
In this example the `mail-noc` notification will be created as object for all services having the
-`notification.mail` custom attribute defined. The notification command is set to `mail-service-notification`
+`notification.mail` custom variable defined. The notification command is set to `mail-service-notification`
and all members of the user group `noc` will get notified.
It is also possible to generally apply a notification template and dynamically overwrite values from
-the template by checking for custom attributes. This can be achieved by using [conditional statements](17-language-reference.md#conditional-statements):
+the template by checking for custom variables. This can be achieved by using [conditional statements](17-language-reference.md#conditional-statements):
```
apply Notification "host-mail-noc" to Host {
import "mail-host-notification"
- // replace interval inherited from `mail-host-notification` template with new notfication interval set by a host custom attribute
+ // replace interval inherited from `mail-host-notification` template with new notfication interval set by a host custom variable
if (host.vars.notification_interval) {
interval = host.vars.notification_interval
}
period = host.vars.notification_period
}
- // Send SMS instead of email if the host's custom attribute `notification_type` is set to `sms`
+ // Send SMS instead of email if the host's custom variable `notification_type` is set to `sms`
if (host.vars.notification_type == "sms") {
command = "sms-host-notification"
} else {
contains all relevant notification settings.
The apply rule is applied on all host objects where the `host.address` is defined.
-If the host object has a specific custom attribute set, its value is inherited
+If the host object has a specific custom variable set, its value is inherited
into the local notification object scope, e.g. `host.vars.notification_interval`,
`host.vars.notification_period` and `host.vars.notification_type`.
This overwrites attributes already specified in the imported `mail-host-notification`
```
The idea is to create service objects for `if01` and `temp` but not `bgp`.
-The oid value should also be used as service custom attribute `snmp_oid`.
+The oid value should also be used as service custom variable `snmp_oid`.
This is the command argument required by the [snmp](10-icinga-template-library.md#plugin-check-command-snmp)
check command.
The service's `display_name` should be set to the identifier inside the dictionary,
}
```
-Icinga 2 evaluates the `apply for` rule for all objects with the custom attribute
+Icinga 2 evaluates the `apply for` rule for all objects with the custom variable
`oids` set.
It iterates over all dictionary items inside the `for` loop and evaluates the
`assign/ignore where` expressions. You can access the loop variable
> **Note**
>
> You don't need an `assign where` expression which checks for the existence of the
-> `oids` custom attribute.
+> `oids` custom variable.
This method saves you from creating multiple apply rules. It also moves
the attribute specification logic from the service to the host.
+<!-- Keep this for compatibility -->
+<a id="using-apply-for-custom-attribute-override"></a>
-#### Apply For and Custom Attribute Override <a id="using-apply-for-custom-attribute-override"></a>
+#### Apply For and Custom Variable Override <a id="using-apply-for-custom-variable-override"></a>
Imagine a different more advanced example: You are monitoring your network device (host)
with many interfaces (services). The following requirements/problems apply:
const IftrafficSnmpCommunity = "public"
```
-Define the `interfaces` [custom attribute](03-monitoring-basics.md#custom-attributes)
+Define the `interfaces` [custom variable](03-monitoring-basics.md#custom-variables)
on the `cisco-catalyst-6509-34` host object and add three example interfaces as dictionary keys.
Specify additional attributes inside the nested dictionary
-as learned with [custom attribute values](03-monitoring-basics.md#custom-attributes-values):
+as learned with [custom variable values](03-monitoring-basics.md#custom-variables-values):
```
object Host "cisco-catalyst-6509-34" {
* and key name in service apply for later on
*/
vars.interfaces["GigabitEthernet0/2"] = {
- /* define all custom attributes with the
+ /* define all custom variables with the
* same name required for command parameters/arguments
* in service apply (look into your CheckCommand definition)
*/
```
Access the dictionary keys with the [indexer](17-language-reference.md#indexer) syntax
-and assign them to custom attributes used as command parameters for the `iftraffic`
+and assign them to custom variables used as command parameters for the `iftraffic`
check command.
```
- /* map the custom attributes as command arguments */
+ /* map the custom variables as command arguments */
vars.iftraffic_units = interface_config.iftraffic_units
vars.iftraffic_community = interface_config.iftraffic_community
```
If you just want to inherit all attributes specified inside the `interface_config`
-dictionary, add it to the generated service custom attributes like this:
+dictionary, add it to the generated service custom variables like this:
```
/* the above can be achieved in a shorter fashion if the names inside host.vars.interfaces
vars += interface_config
```
-If the user did not specify default values for required service custom attributes,
+If the user did not specify default values for required service custom variables,
add them here. This also helps to avoid unwanted configuration validation errors or
runtime failures. Please read more about conditional statements [here](17-language-reference.md#conditional-statements).
> after successful [configuration validation](11-cli-commands.md#config-validation).
Verify that the apply-for-rule successfully created the service objects with the
-inherited custom attributes:
+inherited custom variables:
```
# icinga2 daemon -C
}
```
-`hosting` is a custom attribute with the Dictionary value type.
+`hosting` is a custom variable with the Dictionary value type.
This is mandatory to iterate with the `key => value` notation
in the below apply for rule.
> **Tip**
>
> Please make sure to read the [apply](03-monitoring-basics.md#using-apply) and
-> [custom attribute values](03-monitoring-basics.md#custom-attributes-values) chapter to
+> [custom variable values](03-monitoring-basics.md#custom-variables-values) chapter to
> fully understand these examples.
-Specify the user and groups as nested custom attribute on the host object:
+Specify the user and groups as nested custom variable on the host object:
```
object Host "icinga2-client1.localdomain" {
apply rules here: One for `mail` and one for `sms`.
This example assigns the `users` and `groups` nested keys from the `notification`
-custom attribute to the actual notification object attributes.
+custom variable to the actual notification object attributes.
Since errors are hard to debug if host objects don't specify the required
configuration attributes, you can add a safety condition which logs which
#### Passing Check Command Parameters from Host or Service <a id="command-passing-parameters"></a>
-Check command parameters are defined as custom attributes which can be accessed as runtime macros
+Check command parameters are defined as custom variables which can be accessed as runtime macros
by the executed check command.
The check command parameters for ITL provided plugin check command definitions are documented
The following example will use `check_mysql` provided by the [Monitoring Plugins installation](02-installation.md#setting-up-check-plugins).
-Define the default check command custom attributes, for example `mysql_user` and `mysql_password`
+Define the default check command custom variables, for example `mysql_user` and `mysql_password`
(freely definable naming schema) and optional their default threshold values. You can
-then use these custom attributes as runtime macros for [command arguments](03-monitoring-basics.md#command-arguments)
+then use these custom variables as runtime macros for [command arguments](03-monitoring-basics.md#command-arguments)
on the command line.
> **Tip**
> readability. `mysql_user` helps understanding the context better than just
> `user` as argument.
-The default custom attributes can be overridden by the custom attributes
-defined in the host or service using the check command `my-mysql`. The custom attributes
+The default custom variables can be overridden by the custom variables
+defined in the host or service using the check command `my-mysql`. The custom variables
can also be inherited from a parent template using additive inheritance (`+=`).
```
Take a different example: The example host configuration in [hosts.conf](04-configuration.md#hosts-conf)
also applies an `ssh` service check. Your host's ssh port is not the default `22`, but set to `2022`.
-You can pass the command parameter as custom attribute `ssh_port` directly inside the service apply rule
+You can pass the command parameter as custom variable `ssh_port` directly inside the service apply rule
inside [services.conf](04-configuration.md#services-conf):
```
The host `localhost` with the generated services from the `basic-partitions` dictionary (see
[apply for](03-monitoring-basics.md#using-apply-for) for details) checks a basic set of disk partitions
-with modified custom attributes (warning thresholds at `10%`, critical thresholds at `5%`
+with modified custom variables (warning thresholds at `10%`, critical thresholds at `5%`
free disk space).
-The custom attribute `disk_partition` can either hold a single string or an array of
+The custom variable `disk_partition` can either hold a single string or an array of
string values for passing multiple partitions to the `check_disk` check plugin.
```
```
-More details on using arrays in custom attributes can be found in
-[this chapter](03-monitoring-basics.md#custom-attributes).
+More details on using arrays in custom variables can be found in
+[this chapter](03-monitoring-basics.md#custom-variables).
#### Command Arguments <a id="command-arguments"></a>
does not have `vars.http_port` set, it won't get added to the command
line.
-If the `vars.http_ssl` custom attribute is set in the service, host or command
+If the `vars.http_ssl` custom variable is set in the service, host or command
object definition, Icinga 2 will add the `-S` argument based on the `set_if`
numeric value to the command line. String values are not supported.
#### Environment Variables <a id="command-environment-variables"></a>
The `env` command object attribute specifies a list of environment variables with values calculated
-from custom attributes which should be exported as environment variables prior to executing the command.
+from custom variables which should be exported as environment variables prior to executing the command.
This is useful for example for hiding sensitive information on the command line output
when passing credentials to database checks:
> **Note**
>
> If the CheckCommand also supports setting the parameter in the command line,
-> ensure to use a different name for the custom attribute. Otherwise Icinga 2
+> ensure to use a different name for the custom variable. Otherwise Icinga 2
> adds the command line parameter.
If a specific CheckCommand object provided with the [Icinga Template Library](10-icinga-template-library.md#icinga-template-library)
}
```
-Specify the custom attributes `mysql_health_env_username` and `mysql_health_env_password`
+Specify the custom variables `mysql_health_env_username` and `mysql_health_env_password`
in the service object then.
> **Note**
The `parent_host_name` and `parent_service_name` attributes are mandatory for
service dependencies, `parent_host_name` is required for host dependencies.
[Apply rules](03-monitoring-basics.md#using-apply) will allow you to
-[determine these attributes](03-monitoring-basics.md#dependencies-apply-custom-attributes) in a more
+[determine these attributes](03-monitoring-basics.md#dependencies-apply-custom-variables) in a more
dynamic fashion if required.
```
}
```
-### Apply Dependencies based on Custom Attributes <a id="dependencies-apply-custom-attributes"></a>
+<!-- Keep this for compatibility -->
+<a id="dependencies-apply-custom-attrÃbutes"></a>
+
+### Apply Dependencies based on Custom Variables <a id="dependencies-apply-custom-variables"></a>
You can use [apply rules](03-monitoring-basics.md#using-apply) to set parent or
child attributes, e.g. `parent_host_name` to other objects'
A common example are virtual machines hosted on a master. The object
name of that master is auto-generated from your CMDB or VMWare inventory
-into the host's custom attributes (or a generic template for your
+into the host's custom variables (or a generic template for your
cloud).
Define your master host object:
```
Add a template for all hosts on your example.com cloud setting
-custom attribute `vm_parent` to `master.example.com`:
+custom variable `vm_parent` to `master.example.com`:
```
template Host "generic-vm-example.com" {
Apply the host dependency to all child hosts importing the
`generic-vm` template and set the `parent_host_name`
-to the previously defined custom attribute `host.vars.vm_parent`.
+to the previously defined custom variable `host.vars.vm_parent`.
```
apply Dependency "vm-host-to-parent-master" to Host {
```
The actual event command only passes the `event_by_ssh_command` attribute.
-The `event_by_ssh_service` custom attribute takes care of passing the correct
+The `event_by_ssh_service` custom variable takes care of passing the correct
daemon name, while `test $service.state_id$ -gt 0` makes sure that the daemon
is only restarted when the service is not in an `OK` state.
}
```
-Specify the `httpd_name` custom attribute on the host to assign the
+Specify the `httpd_name` custom variable on the host to assign the
service and set the event handler service.
```
Check command for the built-in `icinga` check. This check returns performance
data for the current Icinga instance and optionally allows for minimum version checks.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------------|---------------
Check command for the built-in `cluster-zone` check.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------------|---------------
Check command for the built-in `ido` check.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|-----------------------------
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):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Specialised check command object for passive checks which uses the functionality of the "dummy" check command with appropriate default values.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The plugin [apt](https://www.monitoring-plugins.org/doc/man/check_apt.html) checks for software updates on systems that use
package management systems based on the apt-get(8) command found in Debian based systems.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
The [check_breeze](https://www.monitoring-plugins.org/doc/man/check_breeze.html) plugin reports the signal
strength of a Breezecom wireless equipment.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------|---------------------------------
The [check_by_ssh](https://www.monitoring-plugins.org/doc/man/check_by_ssh.html) plugin uses SSH to execute
commands on a remote host.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------- | --------------
The [check_clamd](https://www.monitoring-plugins.org/doc/man/check_clamd.html) plugin tests CLAMD
connections with the specified host (or unix socket).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------------|--------------
The [check_dhcp](https://www.monitoring-plugins.org/doc/man/check_dhcp.html) plugin
tests the availability of DHCP servers on a network.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The [check_dig](https://www.monitoring-plugins.org/doc/man/check_dig.html) plugin
test the DNS service on the specified host using dig.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------|--------------
checks the amount of used disk space on a mounted file system and generates an alert
if free space is less than one of the threshold values.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------|------------------------
The [check_disk_smb](https://www.monitoring-plugins.org/doc/man/check_disk_smb.html) plugin
uses the `smbclient` binary to check SMB shares.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|------------------------
An optional DNS server to use may be specified. If no DNS server is specified, the
default server(s) specified in `/etc/resolv.conf` will be used.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------|--------------
The [check_file_age](https://www.monitoring-plugins.org/doc/man/check_file_age.html) plugin
checks a file's size and modification time to make sure it's not empty and that it's sufficiently recent.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------------|--------------------------------------------------------------------------------------------------------
The [check_flexlm](https://www.monitoring-plugins.org/doc/man/check_flexlm.html) plugin
checks available flexlm license managers. Requires the `lmstat` command.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------------|----------------------------------------------------------
This CheckCommand expects an IPv4 address.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
This CheckCommand expects an IPv6 address.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The [check_ftp](https://www.monitoring-plugins.org/doc/man/check_ftp.html) plugin
tests FTP connections with the specified host (or unix socket).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------------|--------------
If you don't have the package installed, you will need to [download](http://www.activesw.com/people/steve/qstat.html)
or install the package `quakestat` before you can use this plugin.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------------|-------------------
plugin with host check default values. This variant uses the host's `address` attribute
if available and falls back to using the `address6` attribute if the `address` attribute is not set.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
plugin with host check default values. This variant uses the host's `address` attribute.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
plugin with host check default values. This variant uses the host's `address6` attribute.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
tests the state of an HP printer with a JetDirect card. Net-snmp must be installed
on the computer running the plugin.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The plugin can either test the HTTP response of a server, or if `http_certificate` is set to a non-empty value, the TLS certificate age for a HTTPS host.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------------|---------------------------------
parses its output while `check_icmp` talks ICMP itself. `check_icmp` must be installed with
`setuid` root.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The [check_imap](https://www.monitoring-plugins.org/doc/man/check_imap.html) plugin
tests IMAP connections with the specified host (or unix socket).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------|--------------
The plugin can also be used for monitoring ldaps connections instead of the deprecated `check_ldaps`.
This can be ensured by enabling `ldap_starttls` or `ldap_ssl`.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
The [check_load](https://www.monitoring-plugins.org/doc/man/check_load.html) plugin
tests the current system load average.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The [check_mailq](https://www.monitoring-plugins.org/doc/man/check_mailq.html) plugin
checks the number of messages in the mail queue (supports multiple sendmail queues, qmail).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
The [check_mysql](https://www.monitoring-plugins.org/doc/man/check_mysql.html) plugin
tests connections to a MySQL server.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|---------------------------------------------------------------
**Note**: You must specify `mysql_query_password` with an empty string to force an empty password,
overriding any my.cnf settings.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|---------------------------------------------------------------
negates the status of a plugin (returns OK for CRITICAL and vice-versa).
Additional switches can be used to control which state becomes what.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------|---------------------------------------------------------------
server or [NSClient++](https://www.nsclient.org). **Note**: This plugin
is considered insecure/deprecated.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin
collects data from the [NSClient++](https://www.nsclient.org) service.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
**Note**: If you want to monitor an NTP server, please use `ntp_peer`.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
jitter and stratum. This plugin will not check the clock offset between the local host and NTP
server; please use `ntp_time` for that purpose.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
connecting to the server. The result from the query has to be numeric in order
to compare it against the query thresholds if set.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|---------------------------------------------------------------
This command uses the host's `address` attribute if available and falls back to using
the `address6` attribute if the `address` attribute is not set.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
This command uses the host's `address` attribute if not explicitly specified using
the `ping_address` attribute.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
This command uses the host's `address6` attribute if not explicitly specified using
the `ping_address` attribute.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin
tests POP connections with the specified host (or unix socket).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------|--------------
metric is outside the required threshold ranges. The metric defaults to number
of processes. Search filters can be applied to limit the processes to check.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------|--------------
password used does not allow access to sensitive system resources.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------------|--------------
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):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--- | ---
The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
tests SIMAP connections with the specified host (or unix socket).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------------|--------------
The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
will attempt to open an SMTP connection with the host.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------|--------------
**Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------|--------------
Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
plugin, using SNMPv3 authentication and encryption options.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------|--------------
Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
plugin, using the uptime OID by default.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
tests SPOP connections with the specified host (or unix socket).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------|--------------
The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
connects to an SSH server at a specified host and port.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
using ssl-related options.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------------|--------------
The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
tests SSMTP connections with the specified host (or unix socket).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------------|--------------
The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
checks the swap space on a local machine.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
tests TCP connections with the specified host (or unix socket).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
tests UDP connections with the specified host (or unix socket).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
must be running for this plugin to work.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
checks the number of users currently logged in on the local system and generates an
error if the number exceeds the thresholds specified.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
> Percentage based thresholds can be used by adding a '%' to the threshold
> value.
-Custom attributes:
+Custom variables:
Name | Description
:---------------------|:------------
Check command object for the `check_load.exe` plugin.
This plugin collects the inverse of the performance counter `\Processor(_Total)\% Idle Time` two times, with a wait time of one second between the collection. To change this wait time use [`perfmon-windows`](10-icinga-template-library.md#windows-plugins-load-windows).
-Custom attributes:
+Custom variables:
Name | Description
:---------------|:------------
> value. Keep in mind that memory\_win\_unit is applied before the
> value is calculated.
-Custom attributes:
+Custom variables:
Name | Description
:-----------------|:------------
Check command object for the `check_network.exe` plugin.
Collects the total Bytes inbound and outbound for all interfaces in one second, to itemise interfaces or use a different collection interval use [`perfmon-windows`](10-icinga-template-library.md#windows-plugins-load-windows).
-Custom attributes:
+Custom variables:
Name | Description
:-------------------|:------------
To receive a list of possible Performance Counter Objects run `check_perfmon.exe --print-objects` and to view an objects instances and counters run `check_perfmon.exe --print-object-info -P "name of object"`
-Custom attributes:
+Custom variables:
Name | Description
:---------------------|:------------
Check command object for the `check_ping.exe` plugin.
ping-windows should automatically detect whether `ping_win_address` is an IPv4 or IPv6 address. If not, use ping4-windows and ping6-windows. Also note that check\_ping.exe waits at least `ping_win_timeout` milliseconds between the pings.
-Custom attributes:
+Custom variables:
Name | Description
:------------------|:------------
Check command object for `check_procs.exe` plugin.
When using `procs_win_user` this plugins needs administrative privileges to access the processes of other users, to just enumerate them no additional privileges are required.
-Custom attributes:
+Custom variables:
Name | Description
:----------------|:------------
Check command object for `check_service.exe` plugin.
This checks thresholds work different since the binary decision whether a service is running or not does not allow for three states. As a default `check_service.exe` will return CRITICAL when `service_win_service` is not running, the `service_win_warn` flag changes this to WARNING.
-Custom attributes:
+Custom variables:
Name | Description
:-------------------------|:------------
Check command object for `check_swap.exe` plugin.
The data collection is instant.
-Custom attributes:
+Custom variables:
Name | Description
:--------------- | :------------
> The Network Services Account which runs Icinga 2 by default does not have the required
> permissions to run this check.
-Custom attributes:
+Custom variables:
Name | Description
:-------------------|:------------
Check command object for `check_uptime.exe` plugin.
Uses GetTickCount64 to get the uptime, so boot time is not included.
-Custom attributes:
+Custom variables:
Name | Description
:-----------------|:------------
Check command object for `check_users.exe` plugin.
-Custom attributes:
+Custom variables:
Name | Description
:----------------|:------------
The check plugin `check_nscp_api` can be integrated with the `nscp_api` CheckCommand object:
-Custom attributes:
+Custom variables:
Name | Description
:----------------------|:----------------------
The check command object for NSClient++ is available as `nscp-local`.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_os_version` NSClient++ plugin.
-This command has the same custom attributes like the `nscp-local` check command.
+This command has the same custom variables like the `nscp-local` check command.
### nscp-local-pagefile <a id="nscp-check-local-pagefile"></a>
Check command object for the `check_pagefile` NSClient++ plugin.
-This command has the same custom attributes like the `nscp-local` check command.
+This command has the same custom variables like the `nscp-local` check command.
### nscp-local-process <a id="nscp-check-local-process"></a>
Check command object for the `check_process` NSClient++ plugin.
-This command has the same custom attributes like the `nscp-local` check command.
+This command has the same custom variables like the `nscp-local` check command.
### nscp-local-service <a id="nscp-check-local-service"></a>
Check command object for the `check_uptime` NSClient++ plugin.
-This command has the same custom attributes like the `nscp-local` check command.
+This command has the same custom variables like the `nscp-local` check command.
### nscp-local-version <a id="nscp-check-local-version"></a>
Check command object for the `check_version` NSClient++ plugin.
-This command has the same custom attributes like the `nscp-local` check command.
+This command has the same custom variables like the `nscp-local` check command.
In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
### nscp-local-disk <a id="nscp-check-local-disk"></a>
Check command object for the [check_snmp_env.pl](http://nagios.manubulon.com/snmp_env.html) plugin.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------------|--------------
Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------|--------------
Check command object for the [check_snmp_win.pl](http://nagios.manubulon.com/snmp_windows.html) plugin.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------|--------------
The [cloudera_service_status](https://github.com/miso231/icinga2-cloudera-plugin) plugin
uses Cloudera Manager API to monitor cluster services
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------|-----------------------------------------------------------------
The [cloudera_hdfs_space](https://github.com/miso231/icinga2-cloudera-plugin) plugin
connects to Hadoop Namenode and gets used capacity of selected disk
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------|-----------------------------------------------------------------
The [cloudera_hdfs_files](https://github.com/miso231/icinga2-cloudera-plugin) plugin
connects to Hadoop Namenode and gets total number of files on HDFS
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------|-----------------------------------------------------------------
The Git repository is located on [GitHub](https://github.com/lausser/check_db2_health).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------------|------------------------------------------------------------------------------------------------------------------------------
The Git repository is located on [GitHub](https://github.com/lausser/check_mssql_health).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------------|------------------------------------------------------------------------------------------------------------------------------
The Git repository is located on [GitHub](https://github.com/lausser/check_mysql_health).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------------|------------------------------------------------------------------------------------------------------------------------------
The Git repository is located on [GitHub](https://github.com/lausser/check_oracle_health).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------------|------------------------------------------------------------------------------------------------------------------------------
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 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`.
+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 variable `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 variable `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 variable `oracle_tns_admin`.
#### postgres <a id="plugin-contrib-command-postgres"></a>
The Git repository is located on [GitHub](https://github.com/bucardo/check_postgres).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------------|------------------------------------------------------------------------------------------------------------------------------
The [check_mongodb.py](https://github.com/mzupan/nagios-plugin-mongodb) plugin
uses the `pymongo` Python library to monitor a [MongoDB](https://docs.mongodb.com/manual/) instance.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------------|------------------------------------------------------------------------------------------------------------------------------
The [check_elasticsearch](https://github.com/anchor/nagios-plugin-elasticsearch) plugin
uses the HTTP API to monitor an [Elasticsearch](https://www.elastic.co/products/elasticsearch) node.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------------------|-------------------------------------------------------------------------------------------------------
measure response time, hitrate, memory utilization, check replication synchronization, etc. It is
also possible to test data in a specified key and calculate averages or summaries on ranges.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------------------|--------------------------------------------------------------------------------------------------------------
The [check_proxysql](https://github.com/sysown/proxysql-nagios) plugin,
uses the `proxysql` binary to monitor [proxysql](https://proxysql.com/).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------------------|----------------------------------------------------------------------------------
The [check_memcached](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin
is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|----------------------------------------------------------------------------------
1. Local execution using the `hpasmcli` command line tool.
2. Remote SNMP query which invokes the HP Insight Tools on the remote node.
-You can either set or omit `hpasm_hostname` custom attribute and select the corresponding node.
+You can either set or omit `hpasm_hostname` custom variable and select the corresponding node.
The `hpasm_remote` attribute enables the plugin to execute remote SNMP queries if set to `true`.
For compatibility reasons this attribute uses `true` as default value, and ensures that
specifying the `hpasm_hostname` always enables remote checks.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|-----------------------------------------------------------------------
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):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|-----------------------------------------------------------------------
The [check_lmsensors](https://github.com/jackbenny/check_temp) plugin,
uses the `lm-sensors` binary to monitor temperature sensors.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|----------------------------------------------------------------------------------
The [check_hddtemp](https://github.com/vint21h/nagios-check-hddtemp) plugin,
uses the `hddtemp` binary to monitor hard drive temperature.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|----------------------------------------------------------------------------------
The [check_adaptec_raid](https://github.com/thomas-krenn/check_adaptec_raid) plugin
uses the `arcconf` binary to monitor Adaptec RAID controllers.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|-----------------------------------------------------------------------
The [check_lsi_raid](https://github.com/thomas-krenn/check_lsi_raid) plugin
uses the `storcli` binary to monitor MegaRAID RAID controllers.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|-----------------------------------------------------------------------
The [check_smart_attributes](https://github.com/thomas-krenn/check_smart_attributes) plugin
uses the `smartctl` binary to monitor SMART values of SSDs and HDDs.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|-----------------------------------------------------------------------
This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process)
and executed as `icingacli businessprocess` CLI command.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------------------------|-----------------------------------------------------------------------------------------
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):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------------------------|-----------------------------------------------------------------------------------------
This subcommand is provided by the [x509 module](https://github.com/Icinga/icingaweb2-module-x509) and executed as `icingacli x509 check host`. Please refer to the [documentation](https://github.com/Icinga/icingaweb2-module-x509/blob/master/doc/10-Monitoring.md#host-check-command) for more information.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------------------------|-----------------------------------------------------------------------------------------
read the [documentation](https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin)
for installation and configuration details.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------------|-----------------------------------------------------------------------------------------------------
The `ipmi-alive` check commands allows you to create a ping check for the IPMI Interface.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------------|-----------------------------------------------------------------------------------------------------
The [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin
uses the `rest-client` Ruby library to monitor a [Graphite](https://graphiteapp.org) instance.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------------------|-----------------------------------------------------------------------------------------------------
The Git repository is located on [GitHub](https://github.com/Tontonitch/interfacetable_v3t).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------------------|-----------------------------------------------------------------------------------------------------
The [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic) plugin
checks the utilization of a given interface name using the SNMP protocol.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|---------------------------------------------------------
The [check_iftraffic64](https://exchange.icinga.com/exchange/check_iftraffic64) plugin
checks the utilization of a given interface name using the SNMP protocol.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|---------------------------------------------------------
The [check_interfaces](https://git.netways.org/plugins/check_interfaces) plugin
uses SNMP to monitor network interfaces and their utilization.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------|---------------------------------------------------------
Juniper IVE, Pulse-Gateway MAG4610, Cisco IronPort AsyncOS, Foundry, etc. A complete list can be
found in the plugin [documentation](https://labs.consol.de/nagios/check_nwc_health/index.html).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|---------------------------------------------------------
uses SNMP to monitor printer. The plugin is able to generate supply statistics and check hardware.
A complete list can be found in the plugin [documentation](https://labs.consol.de/nagios/check_printer_health/index.html).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|---------------------------------------------------------
The [check_lsyncd](https://github.com/ohitz/check_lsyncd) plugin,
uses the `lsyncd` status file to monitor [lsyncd](https://axkibe.github.io/lsyncd/).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|---------------------------------------------------------------------------
chmod -c 0440 /etc/sudoers.d/icinga
```
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|---------------------------------------------------------------------------
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).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------|-----------------------------------------------------------------------------------------------------------------------
The [check_running_kernel](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin
is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu.
-Custom attributes:
+Custom variables:
Name | Description
---------------------------|-------------
uses the `iostat` binary to monitor I/O on a Linux host. The default thresholds are rather high
so you can use a grapher for baselining before setting your own.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------|-----------------------------------------------------------------------------------------------------------------------
uses the `iostat` binary to monitor disk I/O on a Linux host. The default thresholds are rather high
so you can use a grapher for baselining before setting your own.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------|-----------------------------------------------------------------------------------------------------------------------
management system for package updates.
The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
is used to check the GlusterFS storage health on the server.
The plugin requires `sudo` permissions.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
The [ceph plugin](https://github.com/ceph/ceph-nagios-plugins)
is used to check the Ceph storage health on the server.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------|---------------------------------------------------------
[monitoring-plugins-btrfs](https://packages.debian.org/monitoring-plugins-btrfs) provide the necessary binary on debian/ubuntu.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------|---------------------------------------------------------
uses the [pywbem](https://pywbem.github.io/pywbem/) Python library to monitor the hardware of ESXi servers
through the [VMWare API](https://www.vmware.com/support/pubs/sdk_pubs.html) and CIM service.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List of vmware machines and their power state. BEWARE!! In larger environments systems can cause trouble displaying the informations needed due to the mass of data. Use **vmware_alertonly** to avoid this.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. All issues for the host.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Simple check to verify a successful connection to VMware SOAP API.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU. CPU ready time is dependent on the number of virtual machines on the host and their CPU loads. High or growing ready time can be a hint CPU bottlenecks.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. CPU time spent in wait state. The wait total includes time spent the CPU idle, CPU swap wait, and CPU I/O wait states. High or growing wait time can be a hint I/O bottlenecks.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Actively used CPU of the host, as a percentage of the total available CPU. Active CPU is approximately equal to the ratio of the used CPU to the available CPU.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Amount of machine memory used on the host. Consumed memory includes Includes memory used by the Service Console, the VMkernel vSphere services, plus the total consumed metrics for all running virtual machines in MB.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Amount of memory that is used by swap. Sum of memory swapped of all powered on VMs and vSphere services on the host in MB. In case of an error all VMs with their swap used will be displayed.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. The sum of all vmmemctl values in MB for all powered-on virtual machines, plus vSphere services on the host. If the balloon target value is greater than the balloon value, the VMkernel inflates the balloon, causing more virtual machine memory to be reclaimed. If the balloon target value is less than the balloon value, the VMkernel deflates the balloon, which allows the virtual machine to consume additional memory if needed (used by VM memory control driver). In case of an error all VMs with their vmmemctl values will be displayed.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows net info.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Check all active NICs.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows all disk io info. Without subselect no thresholds can be given. All I/O values are aggregated from historical intervals over the past 24 hours with a 5 minute sample rate.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to process a SCSI read command issued from the Guest OS to the virtual machine.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) taken to process a SCSI write command issued by the Guest OS to the virtual machine.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate. For hosts, this metric includes the rates for all virtual machines running on the host.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) taken during the collection interval to process a SCSI command issued by the guest OS to the virtual machine. The sum of kernelWriteLatency and deviceWriteLatency.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List vm's with attached host mounted media like cd,dvd or floppy drives. This is important for monitoring because a virtual machine with a mount cd or dvd drive can not be moved to another host.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows host service info.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows runtime info: VMs, overall status, connection state, health, storagehealth, temperature and sensor are represented as one value and without thresholds.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows connection state.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. This is to avoid a double alarm if you use **vmware-esx-soap-host-runtime-health** and **vmware-esx-soap-host-runtime-storagehealth**.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Local storage status check.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List host bus adapters.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List SCSI logical units. The listing will include: LUN, canonical name of the disc, all of displayed name which is not part of the canonical name and status.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. CPU time spent in wait state. The wait total includes time spent the CPU idle, CPU swap wait, and CPU I/O wait states. High or growing wait time can be a hint I/O bottlenecks.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Amount of actively used virtual CPU, as a percentage of total available CPU. This is the host's view of the CPU usage, not the guest operating system view. It is the average CPU utilization over all available virtual CPUs in the virtual machine.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Amount of guest physical memory in MB consumed by the virtual machine for guest memory. Consumed memory does not include overhead memory. It includes shared memory and memory that might be reserved, but not actually used. Use this metric for charge-back purposes.<br>
**vm consumed memory = memory granted -- memory saved**
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Amount of guest physical memory that is currently reclaimed from the virtual machine through ballooning. This is the amount of guest physical memory that has been allocated and pinned by the balloon driver.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows net info.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows all disk io info. Without subselect no thresholds can be given. All I/O values are aggregated from historical intervals over the past 24 hours with a 5 minute sample rate.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows the connection state.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
uses the [/server-status](https://httpd.apache.org/docs/current/mod/mod_status.html)
HTTP endpoint to monitor status metrics for the Apache webserver.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|----------------------------------------------------------------------------------
The [check_ssl_cert](https://github.com/matteocorti/check_ssl_cert) plugin
uses the openssl binary (and optional curl) to check a X.509 certificate.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------|--------------
part of the `JMX::Jmx4Perl` Perl module which includes detailed
[documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
The [check_kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details) plugin
uses the Kerberos `kinit` binary to monitor Kerberos 5 KDC by acquiring a ticket.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------------------------------------------------------------------
uses the [/nginx_status](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
HTTP endpoint which provides metrics for monitoring Nginx.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------------|----------------------------------------------------------------------------------
uses the `Net::DNS` Perl library to check whether your SMTP server
is blacklisted.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------------------------------------------------------------------
The [check_squid](https://exchange.icinga.com/exchange/check_squid) plugin
uses the `squidclient` binary to monitor a [Squid proxy](http://www.squid-cache.org).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|----------------------------------------------------------------------------------
and collect/report your results. WebInject offers real-time results
display and may also be used for monitoring system response times.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
also available in the [monitoring-plugins-contrib](https://packages.debian.org/sid/nagios-plugins-contrib) on debian,
uses the `varnishstat` binary to monitor [varnish](https://varnish-cache.org/).
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|----------------------------------------------------------------------------------
The statistics page will be available at `http://127.0.0.1/stats;csv;norefresh`.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|----------------------------------------------------------------------------------
stats socket /run/haproxy/admin.sock user haproxy group icinga mode 660 level operator
```
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------------|----------------------------------------------------------------------------------
The [check_phpfpm_status](http://github.com/regilero/check_phpfpm_status) plugin,
uses the `php-fpm` status page to monitor php-fpm.
-Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
+Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------------|----------------------------------------------------------------------------------
projects / icinga2 / commitdiff