From 5aa07b51a2883a8ed5475418c3ec0df7fc1e5d5e Mon Sep 17 00:00:00 2001 From: Michael Friedrich Date: Fri, 19 Jul 2019 14:14:34 +0200 Subject: [PATCH] Docs: Rename 'custom attribute' to 'custom variable' refs #6830 --- doc/03-monitoring-basics.md | 188 ++++++----- doc/04-configuration.md | 22 +- doc/06-distributed-monitoring.md | 2 +- doc/07-agent-based-monitoring.md | 4 +- doc/08-advanced-topics.md | 22 +- doc/09-object-types.md | 20 +- doc/10-icinga-template-library.md | 446 +++++++++++++------------- doc/12-icinga2-api.md | 6 +- doc/13-addons.md | 2 +- doc/15-troubleshooting.md | 2 +- doc/17-language-reference.md | 8 +- doc/18-library-reference.md | 4 +- doc/20-script-debugger.md | 6 +- doc/23-migrating-from-icinga-1x.md | 28 +- doc/24-appendix.md | 2 +- etc/icinga2/conf.d/hosts.conf | 2 +- etc/icinga2/conf.d/notifications.conf | 2 +- etc/icinga2/conf.d/services.conf | 2 +- etc/icinga2/conf.d/win32/hosts.conf | 2 +- 19 files changed, 395 insertions(+), 375 deletions(-) diff --git a/doc/03-monitoring-basics.md b/doc/03-monitoring-basics.md index f8fe8cc0642..bd46a1757bc 100644 --- a/doc/03-monitoring-basics.md +++ b/doc/03-monitoring-basics.md @@ -208,10 +208,10 @@ You can also import existing non-template objects. ### Multiple Templates -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. @@ -226,7 +226,7 @@ template Host "web-server" { ``` 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. @@ -265,10 +265,22 @@ object Host "wp1.example.com" { } ``` -## Custom Attributes + + -In addition to built-in attributes you can define your own attributes -inside the `vars` attribute: +## Custom Variables + +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" { @@ -295,17 +307,17 @@ or vars["ssh_port"] = 2222 ``` -### Custom Attribute Values +### Custom Variable Values -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. @@ -338,7 +350,7 @@ Another example which is shown in the example configuration: } ``` -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) @@ -354,11 +366,13 @@ expects. } ``` + + -### Functions as Custom Attributes +### Functions as Custom Variables -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: ``` @@ -430,22 +444,25 @@ Accessing object attributes at runtime inside these functions is described in th ## Runtime Macros -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 @@ -464,7 +481,7 @@ object Host "router" { 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. @@ -483,12 +500,12 @@ up macros and their respective values: 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: ``` @@ -500,7 +517,7 @@ object Service "ping" { } ``` -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 @@ -510,14 +527,14 @@ rules -- by specifying the full attribute name: $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 -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 @@ -583,7 +600,7 @@ attributes can be accessed too. ### Command Runtime Macros -The following custom attributes are available in all commands: +The following custom variables are available in all commands: Name | Description -----------------------|-------------- @@ -591,7 +608,7 @@ The following custom attributes are available in all commands: ### User Runtime Macros -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 @@ -688,7 +705,7 @@ More explanations on assign where expressions can be found [here](03-monitoring- 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) @@ -710,12 +727,12 @@ objects in that scope (host and/or service objects). 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"] = { @@ -725,7 +742,7 @@ Remember the examples shown for [custom attribute values](03-monitoring-basics.m 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. @@ -742,9 +759,9 @@ apply Notification "mail-icingaadmin" to Host { 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 /"] = { @@ -801,7 +818,7 @@ Assign a service to a specific host in a host group [array](18-library-reference 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" @@ -827,8 +844,8 @@ Match the host name by using a [regular expression](18-library-reference.md#glob 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. ``` @@ -843,11 +860,11 @@ object HostGroup "mysql-server" { 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" { @@ -871,7 +888,7 @@ The sample configuration already includes a detailed example in [hosts.conf](04- 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" { @@ -902,17 +919,17 @@ apply Notification "mail-noc" to Service { ``` 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 } @@ -922,7 +939,7 @@ apply Notification "host-mail-noc" to Host { 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 { @@ -939,7 +956,7 @@ In the example above the notification template `mail-host-notification` 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` @@ -993,7 +1010,7 @@ object Host "router-v6" { ``` 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, @@ -1009,7 +1026,7 @@ apply Service for (identifier => oid in host.vars.oids) { } ``` -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 @@ -1026,13 +1043,15 @@ unwanted services. A different approach would be to match the `oid` value with a > **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. + + -#### Apply For and Custom Attribute Override +#### Apply For and Custom Variable Override Imagine a different more advanced example: You are monitoring your network device (host) with many interfaces (services). The following requirements/problems apply: @@ -1052,11 +1071,11 @@ dynamically generated. 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" { @@ -1068,7 +1087,7 @@ 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) */ @@ -1141,17 +1160,17 @@ interface_config = { ``` 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 @@ -1161,7 +1180,7 @@ dictionary, add it to the generated service custom attributes like this: 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). @@ -1211,7 +1230,7 @@ more object attributes which can be e.g. seen in external interfaces. > 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 @@ -1292,7 +1311,7 @@ object Host "opennebula-host" { } ``` -`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. @@ -1573,11 +1592,11 @@ already provides an example for this question. > **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" { @@ -1597,7 +1616,7 @@ As you can see, there is the option to use two different notification 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 @@ -1904,7 +1923,7 @@ Please continue reading in the [plugins section](05-service-monitoring.md#servic #### Passing Check Command Parameters from Host or Service -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 @@ -1915,9 +1934,9 @@ In order to practice passing command parameters you should [integrate your own p 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** @@ -1926,8 +1945,8 @@ on the command line. > 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 (`+=`). ``` @@ -1998,7 +2017,7 @@ apply Service "mysql-icinga-db-health" { 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): ``` @@ -2026,10 +2045,10 @@ object Host "icinga2-client1.localdomain { 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. ``` @@ -2055,8 +2074,8 @@ apply Service for (disk => config in host.vars.local_disks) { ``` -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 @@ -2107,7 +2126,7 @@ the value is not set. For example, if the service calling the check command 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. @@ -2169,7 +2188,7 @@ References: [abbreviated lambda syntax](17-language-reference.md#nullary-lambdas #### Environment Variables 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: @@ -2203,7 +2222,7 @@ the database credentials in the user's environment. > **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) @@ -2221,7 +2240,7 @@ object CheckCommand "mysql_health_env" { } ``` -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** @@ -2350,7 +2369,7 @@ account but all parents are inherited. 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. ``` @@ -2457,7 +2476,10 @@ apply Dependency "internet" to Service { } ``` -### Apply Dependencies based on Custom Attributes + + + +### Apply Dependencies based on Custom Variables 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' @@ -2465,7 +2487,7 @@ attributes. 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: @@ -2487,7 +2509,7 @@ template Host "generic-vm" { ``` 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" { @@ -2510,7 +2532,7 @@ object Host "www.example2.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 { @@ -2957,7 +2979,7 @@ object EventCommand "event_by_ssh" { ``` 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. @@ -2990,7 +3012,7 @@ apply Service "http" { } ``` -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. ``` diff --git a/doc/04-configuration.md b/doc/04-configuration.md index 077807daf82..690c80ca2e6 100644 --- a/doc/04-configuration.md +++ b/doc/04-configuration.md @@ -48,7 +48,7 @@ Consider these ideas: In either way of choosing the right strategy you should additionally check the following: -* Are there any specific attributes describing the host/service you could set as `vars` custom attributes? +* Are there any specific attributes describing the host/service you could set as `vars` custom variables? You can later use them for applying assign/ignore rules, or export them into external interfaces. * Put hosts into hostgroups, services into servicegroups and use these attributes for your apply rules. * Use templates to store generic attributes for your objects and apply rules making your configuration more readable. @@ -276,11 +276,11 @@ The `import` keyword is used to import the `generic-host` template which takes care of setting up the host check command to `hostalive`. If you require a different check command, you can override it in the object definition. -The `vars` attribute can be used to define custom attributes which are available +The `vars` attribute can be used to define custom variables which are available for check and notification commands. Most of the [Plugin Check Commands](10-icinga-template-library.md#icinga-template-library) in the Icinga Template Library require an `address` attribute. -The custom attribute `os` is evaluated by the `linux-servers` group in +The custom variable `os` is evaluated by the `linux-servers` group in [groups.conf](04-configuration.md#groups-conf) making the local host a member. The example host will show you how to: @@ -324,7 +324,7 @@ object Host NodeName { address = "127.0.0.1" address6 = "::1" - /* Set custom attribute `os` for hostgroup assignment in `groups.conf`. */ + /* Set custom variable `os` for hostgroup assignment in `groups.conf`. */ vars.os = "Linux" /* Define http vhost attributes for service apply rules in `services.conf`. */ @@ -377,8 +377,8 @@ Service(s) | Applied on host(s) `load`, `procs`, `swap`, `users`, `icinga` | The `NodeName` host only. `ping4`, `ping6` | All hosts with `address` resp. `address6` attribute. `ssh` | All hosts with `address` and `vars.os` set to `Linux` -`http`, optional: `Icinga Web 2` | All hosts with custom attribute `http_vhosts` defined as dictionary. -`disk`, `disk /` | All hosts with custom attribute `disks` defined as dictionary. +`http`, optional: `Icinga Web 2` | All hosts with custom variable `http_vhosts` defined as dictionary. +`disk`, `disk /` | All hosts with custom variable `disks` defined as dictionary. The Debian packages also include an additional `apt` service check applied to the local host. @@ -407,7 +407,7 @@ The `apply` keyword can be used to create new objects which are associated with another group of objects. You can `import` existing templates, define (custom) attributes. -The custom attribute `backup_downtime` is defined to a specific timerange string. +The custom variable `backup_downtime` is defined to a specific timerange string. This variable value will be used for applying a `ScheduledDowntime` object to these services in [downtimes.conf](04-configuration.md#downtimes-conf). @@ -430,7 +430,7 @@ apply Service "ssh" { ``` In this example, the service `ssh` is applied to all hosts having the `address` -attribute defined `AND` having the custom attribute `os` set to the string +attribute defined `AND` having the custom variable `os` set to the string `Linux`. You can modify this condition to match multiple expressions by combining `AND` and `OR` using `&&` and `||` [operators](17-language-reference.md#expression-operators), for example @@ -443,7 +443,7 @@ hosts, you can go one step further: Generate apply rules based on array items or dictionary key-value pairs. The idea is simple: Your host in [hosts.conf](04-configuration.md#hosts-conf) defines the -`disks` dictionary as custom attribute in `vars`. +`disks` dictionary as custom variable in `vars`. Remember the example from [hosts.conf](04-configuration.md#hosts-conf): @@ -583,7 +583,7 @@ Read more on that topic [here](03-monitoring-basics.md#notification-commands). #### groups.conf The example host defined in [hosts.conf](hosts-conf) already has the -custom attribute `os` set to `Linux` and is therefore automatically +custom variable `os` set to `Linux` and is therefore automatically a member of the host group `linux-servers`. This is done by using the [group assign](17-language-reference.md#group-assign) expressions similar @@ -681,7 +681,7 @@ More details on `Notification` object attributes can be found [here](09-object-t #### downtimes.conf The `load` service apply rule defined in [services.conf](04-configuration.md#services-conf) defines -the `backup_downtime` custom attribute. +the `backup_downtime` custom variable. The ScheduledDowntime apply rule uses this attribute to define the default value for the time ranges required for recurring downtime slots. diff --git a/doc/06-distributed-monitoring.md b/doc/06-distributed-monitoring.md index 74a95e11ca5..0324bbe1e54 100644 --- a/doc/06-distributed-monitoring.md +++ b/doc/06-distributed-monitoring.md @@ -2435,7 +2435,7 @@ Based on the [master with clients](06-distributed-monitoring.md#distributed-moni scenario we'll now add a local nscp check which queries the NSClient++ API to check the free disk space. Define a host object called `icinga2-client2.localdomain` on the master. Add the `nscp_api_password` -custom attribute and specify the drives to check. +custom variable and specify the drives to check. ``` [root@icinga2-master1.localdomain /]# cd /etc/icinga2/zones.d/master diff --git a/doc/07-agent-based-monitoring.md b/doc/07-agent-based-monitoring.md index 7f75262a4f1..5355ac74950 100644 --- a/doc/07-agent-based-monitoring.md +++ b/doc/07-agent-based-monitoring.md @@ -12,8 +12,8 @@ the `check_snmp` plugin binary, but there are plenty of [existing plugins](05-se for specific use cases already around, for example monitoring Cisco routers. The following example uses the [SNMP ITL](10-icinga-template-library.md#plugin-check-command-snmp) `CheckCommand` and just -overrides the `snmp_oid` custom attribute. A service is created for all hosts which -have the `snmp-community` custom attribute. +overrides the `snmp_oid` custom variable. A service is created for all hosts which +have the `snmp-community` custom variable. ``` apply Service "uptime" { diff --git a/doc/08-advanced-topics.md b/doc/08-advanced-topics.md index af17e05f4fe..d58558bcbdb 100644 --- a/doc/08-advanced-topics.md +++ b/doc/08-advanced-topics.md @@ -587,7 +587,7 @@ You might also want to add additional checks for SSL certificate expiration. [Apply rules](03-monitoring-basics.md#using-apply) can be used to create a rule set which is entirely based on host objects and their attributes. -In addition to that [apply for and custom attribute override](03-monitoring-basics.md#using-apply-for) +In addition to that [apply for and custom variable override](03-monitoring-basics.md#using-apply-for) extend the possibilities. The following example defines a dictionary on the host object which contains @@ -664,7 +664,7 @@ apply Service "webserver_url" for (instance => config in host.vars.webserver.ins } ``` -The variables defined in the host dictionary are not using the typical custom attribute +The variables defined in the host dictionary are not using the typical custom variable prefix recommended for CheckCommand parameters. Instead they are re-used for multiple service checks in this example. In addition to defining check parameters this way, you can also enrich the `display_name` @@ -674,7 +674,7 @@ attribute with more details. This will be shown in in Icinga Web 2 for example. There is a limited scope where functions can be used as object attributes such as: -* As value for [Custom Attributes](03-monitoring-basics.md#custom-attributes-functions) +* As value for [Custom Variables](03-monitoring-basics.md#custom-variables-functions) * Returning boolean expressions for [set_if](08-advanced-topics.md#use-functions-command-arguments-setif) inside command arguments * Returning a [command](08-advanced-topics.md#use-functions-command-attribute) array inside command objects @@ -683,7 +683,7 @@ The other way around you can create objects dynamically using your own global fu > **Note** > > Functions called inside command objects share the same global scope as runtime macros. -> Therefore you can access host custom attributes like `host.vars.os`, or any other +> Therefore you can access host custom variables like `host.vars.os`, or any other > object attribute from inside the function definition used for [set_if](08-advanced-topics.md#use-functions-command-arguments-setif) or [command](08-advanced-topics.md#use-functions-command-attribute). Tips when implementing functions: @@ -850,7 +850,7 @@ object HostGroup "printers-lexmark" { ``` Take a different more complex example: All hosts with the -custom attribute `vars_app` as nested dictionary should be +custom variable `vars_app` as nested dictionary should be added to the host group `ABAP-app-server`. But only if the `app_type` for all entries is set to `ABAP`. @@ -875,7 +875,7 @@ object Host "appserver02" { } globals.check_app_type = function(host, type) { - /* ensure that other hosts without the custom attribute do not match */ + /* ensure that other hosts without the custom variable do not match */ if (typeof(host.vars.vars_app) != Dictionary) { return false } @@ -924,7 +924,7 @@ The more significant problem was to only add the command parameter `--disk` to t when the dictionary `compellent` contains the key `disks`, and omit it if not found. By defining `set_if` as [abbreviated lambda function](17-language-reference.md#nullary-lambdas) -and evaluating the host custom attribute `compellent` containing the `disks` this problem was +and evaluating the host custom variable `compellent` containing the `disks` this problem was solved like this: ``` @@ -972,11 +972,11 @@ The more programmatic approach for `set_if` could look like this: if (typeof(srv_vars.compellent) == Dictionary) { return srv_vars.compellent.contains("disks") } else { - log(LogInformationen, "checkcommand set_if", "custom attribute compellent_checks is not a dictionary, ignoring it.") + log(LogInformationen, "checkcommand set_if", "custom variable compellent_checks is not a dictionary, ignoring it.") return false } } else { - log(LogWarning, "checkcommand set_if", "empty custom attributes") + log(LogWarning, "checkcommand set_if", "empty custom variables") return false } }} @@ -990,7 +990,7 @@ or [EventCommands](09-object-types.md#objecttype-eventcommand) which does not re a returned checkresult including state/output. The following example was taken from the community support channels. The requirement was to -specify a custom attribute inside the notification apply rule and decide which notification +specify a custom variable inside the notification apply rule and decide which notification script to call based on that. ``` @@ -1013,7 +1013,7 @@ apply Notification "mail-admins-short" to Host { The solution is fairly simple: The `command` attribute is implemented as function returning an array required by the caller Icinga 2. The local variable `mailscript` sets the default value for the notification scrip location. -If the notification custom attribute `short` is set, it will override the local variable `mailscript` +If the notification custom variable `short` is set, it will override the local variable `mailscript` with a new value. The `mailscript` variable is then used to compute the final notification command array being returned. diff --git a/doc/09-object-types.md b/doc/09-object-types.md index f9a0f624f20..17fc64aa7f8 100644 --- a/doc/09-object-types.md +++ b/doc/09-object-types.md @@ -63,7 +63,7 @@ chapter. ### CheckCommand -A check command definition. Additional default command custom attributes can be +A check command definition. Additional default command custom variables can be defined here. Example: @@ -108,7 +108,7 @@ Configuration Attributes: --------------------------|-----------------------|---------------------------------- command | Array | **Required.** The command. This can either be an array of individual command arguments. Alternatively a string can be specified in which case the shell interpreter (usually /bin/sh) takes care of parsing the command. When using the "arguments" attribute this must be an array. Can be specified as function for advanced implementations. env | Dictionary | **Optional.** A dictionary of macros which should be exported as environment variables prior to executing the command. - vars | Dictionary | **Optional.** A dictionary containing custom attributes that are specific to this command. + vars | Dictionary | **Optional.** A dictionary containing custom variables that are specific to this command. timeout | Duration | **Optional.** The command timeout in seconds. Defaults to `1m`. arguments | Dictionary | **Optional.** A dictionary of command arguments. @@ -348,7 +348,7 @@ Configuration Attributes: --------------------------|-----------------------|---------------------------------- command | Array | **Required.** The command. This can either be an array of individual command arguments. Alternatively a string can be specified in which case the shell interpreter (usually /bin/sh) takes care of parsing the command. When using the "arguments" attribute this must be an array. Can be specified as function for advanced implementations. env | Dictionary | **Optional.** A dictionary of macros which should be exported as environment variables prior to executing the command. - vars | Dictionary | **Optional.** A dictionary containing custom attributes that are specific to this command. + vars | Dictionary | **Optional.** A dictionary containing custom variables that are specific to this command. timeout | Duration | **Optional.** The command timeout in seconds. Defaults to `1m`. arguments | Dictionary | **Optional.** A dictionary of command arguments. @@ -383,7 +383,7 @@ Configuration Attributes: address | String | **Optional.** The host's IPv4 address. Available as command runtime macro `$address$` if set. address6 | String | **Optional.** The host's IPv6 address. Available as command runtime macro `$address6$` if set. groups | Array of object names | **Optional.** A list of host groups this host belongs to. - vars | Dictionary | **Optional.** A dictionary containing custom attributes that are specific to this host. + vars | Dictionary | **Optional.** A dictionary containing custom variables that are specific to this host. check\_command | Object name | **Required.** The name of the check command. max\_check\_attempts | Number | **Optional.** The number of times a host is re-checked before changing into a hard state. Defaults to 3. check\_period | Object name | **Optional.** The name of a time period which determines when this host should be checked. Not set by default (effectively 24x7). @@ -511,7 +511,7 @@ Configuration Attributes: --------------------------|-----------------------|---------------------------------- host\_name | Object name | **Required.** The name of the host this notification belongs to. service\_name | Object name | **Optional.** The short name of the service this notification belongs to. If omitted, this notification object is treated as host notification. - vars | Dictionary | **Optional.** A dictionary containing custom attributes that are specific to this notification object. + vars | Dictionary | **Optional.** A dictionary containing custom variables that are specific to this notification object. users | Array of object names | **Required.** A list of user names who should be notified. **Optional.** if the `user_groups` attribute is set. user\_groups | Array of object names | **Required.** A list of user group names who should be notified. **Optional.** if the `users` attribute is set. times | Dictionary | **Optional.** A dictionary containing `begin` and `end` attributes for the notification. @@ -648,7 +648,7 @@ Configuration Attributes: --------------------------|-----------------------|---------------------------------- command | Array | **Required.** The command. This can either be an array of individual command arguments. Alternatively a string can be specified in which case the shell interpreter (usually /bin/sh) takes care of parsing the command. When using the "arguments" attribute this must be an array. Can be specified as function for advanced implementations. env | Dictionary | **Optional.** A dictionary of macros which should be exported as environment variables prior to executing the command. - vars | Dictionary | **Optional.** A dictionary containing custom attributes that are specific to this command. + vars | Dictionary | **Optional.** A dictionary containing custom variables that are specific to this command. timeout | Duration | **Optional.** The command timeout in seconds. Defaults to `1m`. arguments | Dictionary | **Optional.** A dictionary of command arguments. @@ -746,7 +746,7 @@ Configuration Attributes: display\_name | String | **Optional.** A short description of the service. host\_name | Object name | **Required.** The host this service belongs to. There must be a `Host` object with that name. groups | Array of object names | **Optional.** The service groups this service belongs to. - vars | Dictionary | **Optional.** A dictionary containing custom attributes that are specific to this service. + vars | Dictionary | **Optional.** A dictionary containing custom variables that are specific to this service. check\_command | Object name | **Required.** The name of the check command. max\_check\_attempts | Number | **Optional.** The number of times a service is re-checked before changing into a hard state. Defaults to 3. check\_period | Object name | **Optional.** The name of a time period which determines when this service should be checked. Not set by default (effectively 24x7). @@ -952,7 +952,7 @@ Configuration Attributes: display\_name | String | **Optional.** A short description of the user. email | String | **Optional.** An email string for this user. Useful for notification commands. pager | String | **Optional.** A pager string for this user. Useful for notification commands. - vars | Dictionary | **Optional.** A dictionary containing custom attributes that are specific to this user. + vars | Dictionary | **Optional.** A dictionary containing custom variables that are specific to this user. groups | Array of object names | **Optional.** An array of group names. enable\_notifications | Boolean | **Optional.** Whether notifications are enabled for this user. Defaults to true. period | Object name | **Optional.** The name of a time period which determines when a notification for this user should be triggered. Not set by default (effectively 24x7). @@ -1414,7 +1414,7 @@ Configuration Attributes: enable\_host\_checks | Boolean | **Optional.** Whether active host checks are globally enabled. Defaults to true. enable\_service\_checks | Boolean | **Optional.** Whether active service checks are globally enabled. Defaults to true. enable\_perfdata | Boolean | **Optional.** Whether performance data processing is globally enabled. Defaults to true. - vars | Dictionary | **Optional.** A dictionary containing custom attributes that are available globally. + vars | Dictionary | **Optional.** A dictionary containing custom variables that are available globally. environment | String | **Optional.** Specify the Icinga environment. This overrides the `Environment` constant specified in the configuration or on the CLI with `--define`. Defaults to empty. ### IdoMySqlConnection @@ -1746,7 +1746,7 @@ Configuration Attributes: ### PerfdataWriter Writes check result performance data to a defined path using macro -pattern consisting of custom attributes and runtime macros. +pattern consisting of custom variables and runtime macros. This configuration object is available as [perfdata feature](14-features.md#writing-performance-data-files). Example: diff --git a/doc/10-icinga-template-library.md b/doc/10-icinga-template-library.md index fe1d6fdd940..200ce7e69dd 100644 --- a/doc/10-icinga-template-library.md +++ b/doc/10-icinga-template-library.md @@ -78,7 +78,7 @@ plugin scripts. 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 -----------------------|--------------- @@ -95,7 +95,7 @@ The `cluster` check command does not support any vars. 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 -----------------------|--------------- @@ -107,7 +107,7 @@ cluster\_lag\_critical | **Optional.** Critical threshold for log lag in seconds 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 --------------------------------|----------------------------- @@ -127,7 +127,7 @@ or [runtime object checks](08-advanced-topics.md#access-object-attributes-at-run 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 ----------------|-------------- @@ -138,7 +138,7 @@ dummy\_text | **Optional.** Plugin output. Defaults to "Check was successfu 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 ----------------|-------------- @@ -196,7 +196,7 @@ which contains the path of the plugins from the Monitoring Plugins project. 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 ------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- @@ -216,7 +216,7 @@ apt_list | **Optional.** List packages available for upgrade. 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 -----------------|--------------------------------- @@ -231,7 +231,7 @@ breeze_critical | **Required.** Percentage strength below which a WARNING statu 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 ---------------- | -------------- @@ -256,7 +256,7 @@ by_ssh_skip_stderr | **Optional.** Ignore all or (if specified) first n lines on 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 -------------------|-------------- @@ -287,7 +287,7 @@ clamd_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 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 ----------------|-------------- @@ -304,7 +304,7 @@ dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to fal 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 ---------------------|-------------- @@ -328,7 +328,7 @@ The [check_disk](https://www.monitoring-plugins.org/doc/man/check_disk.html) plu 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 --------------------|------------------------ @@ -365,7 +365,7 @@ disk\_include\_type | **Optional.** Check only filesystems of indicated ty 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 ------------------------|------------------------ @@ -386,7 +386,7 @@ uses the nslookup program to obtain the IP address for the given host/domain que 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 ---------------------|-------------- @@ -407,7 +407,7 @@ dns_timeout | **Optional.** Seconds before connection times out. Defaul 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 -----------------------|-------------------------------------------------------------------------------------------------------- @@ -424,7 +424,7 @@ file_age_ignoremissing | **Optional.** Return OK if the file does not exist. Def 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 -------------------|---------------------------------------------------------- @@ -440,7 +440,7 @@ necessary to set the `suid` flag on `fping`. 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 ----------------|-------------- @@ -465,7 +465,7 @@ necessary to set the `suid` flag on `fping`. 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 ----------------|-------------- @@ -487,7 +487,7 @@ fping_source_interface | **Optional.** The source interface name. 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 -------------------|-------------- @@ -521,7 +521,7 @@ This plugin uses the 'qstat' command, the popular game server status query tool. 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 -------------------|------------------- @@ -542,7 +542,7 @@ Check command object for the [check_ping](https://www.monitoring-plugins.org/doc 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 ----------------|-------------- @@ -560,7 +560,7 @@ ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no 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 ----------------|-------------- @@ -578,7 +578,7 @@ ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no 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 ----------------|-------------- @@ -597,7 +597,7 @@ The [check_hpjd](https://www.monitoring-plugins.org/doc/man/check_hpjd.html) plu 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 ----------------|-------------- @@ -615,7 +615,7 @@ check connection times, and report on certificate expiration times. 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 ---------------------------------|--------------------------------- @@ -674,7 +674,7 @@ The main difference is that check_ping executes the system's ping(1) command and 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 ----------------|-------------- @@ -698,7 +698,7 @@ icmp_ttl | **Optional.** The TTL on outgoing packets. 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 ----------------------|-------------- @@ -731,7 +731,7 @@ can be used to check LDAP servers. 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 ------------------------|-------------- @@ -757,7 +757,7 @@ ldap_verbose | **Optional.** Show details for command-line debugging (disabled 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 ----------------|-------------- @@ -774,7 +774,7 @@ load_percpu | **Optional.** Divide the load averages by the number of CPUs ( 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 ------------------------|-------------- @@ -791,7 +791,7 @@ mailq_sudo | **Optional.** Use sudo to execute the mailq command. 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 ------------------------|--------------------------------------------------------------- @@ -824,7 +824,7 @@ The result from the query should be numeric. For extra security, create a user w **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 ------------------------|--------------------------------------------------------------- @@ -846,7 +846,7 @@ The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin 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 ----------------------|--------------------------------------------------------------- @@ -866,7 +866,7 @@ The `check_nrpe` plugin can be used to query an [NRPE](https://icinga.com/docs/i 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 ----------------|-------------- @@ -887,7 +887,7 @@ nrpe_version_2 | **Optional.** Use this if you want to connect using NRPE v2 pro 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 ----------------|-------------- @@ -909,7 +909,7 @@ checks the clock offset between the local host and a remote NTP server. **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 ----------------|-------------- @@ -931,7 +931,7 @@ checks the health of an NTP server. It supports checking the offset with the syn 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 ----------------|-------------- @@ -959,7 +959,7 @@ If a query is specified using the `pgsql_query` attribute, it will be executed a 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 ------------------------|--------------------------------------------------------------- @@ -985,7 +985,7 @@ round trip average (milliseconds). 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 ----------------|-------------- @@ -1007,7 +1007,7 @@ round trip average (milliseconds). 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 ----------------|-------------- @@ -1028,7 +1028,7 @@ round trip average (milliseconds). 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 ----------------|-------------- @@ -1046,7 +1046,7 @@ ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no 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 ---------------------|-------------- @@ -1078,7 +1078,7 @@ checks all processes and generates WARNING or CRITICAL states if the specified 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 ---------------------|-------------- @@ -1112,7 +1112,7 @@ typically be executed at regular predictable intervals. Please be sure that the 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 -------------------|-------------- @@ -1132,7 +1132,7 @@ radius_timeout | **Optional.** The number of seconds before connection times 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 --- | --- @@ -1149,7 +1149,7 @@ rpc_verbose | **Optional.** Show verbose output. Defaults to false. 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 -----------------------|-------------- @@ -1178,7 +1178,7 @@ simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 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 ----------------|-------------- @@ -1190,7 +1190,7 @@ smart_device | **Required.** The name of a local hard drive to monitor. 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 ----------------------|-------------- @@ -1221,7 +1221,7 @@ checks the status of remote machines and obtains system information via SNMP. **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 --------------------|-------------- @@ -1253,7 +1253,7 @@ snmp_perf_oids | **Optional.** Label performance data with OIDs instead of 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 ---------------------|-------------- @@ -1284,7 +1284,7 @@ snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 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 ----------------|-------------- @@ -1298,7 +1298,7 @@ snmp_community | **Optional.** The SNMP community. Defaults to "public". 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 ----------------------|-------------- @@ -1328,7 +1328,7 @@ spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 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 ----------------|-------------- @@ -1344,7 +1344,7 @@ ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 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 ------------------------------|-------------- @@ -1361,7 +1361,7 @@ ssl_sni | **Optional.** The `server_name` that is send to 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 -----------------------|-------------- @@ -1391,7 +1391,7 @@ ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 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 ----------------|-------------- @@ -1407,7 +1407,7 @@ swap_noswap | **Optional.** Resulting state when there is no swap regardless 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 ----------------|-------------- @@ -1438,7 +1438,7 @@ tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 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 ----------------|-------------- @@ -1457,7 +1457,7 @@ The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugi 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 ----------------|-------------- @@ -1477,7 +1477,7 @@ The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) p 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 ----------------|-------------- @@ -1520,7 +1520,7 @@ The data collection is instant and free disk space (default, see `disk_win_show_ > Percentage based thresholds can be used by adding a '%' to the threshold > value. -Custom attributes: +Custom variables: Name | Description :---------------------|:------------ @@ -1536,7 +1536,7 @@ disk\_win\_show\_used | **Optional**. Use used instead of free space. 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 :---------------|:------------ @@ -1555,7 +1555,7 @@ The memory collection is instant and free memory is used for threshold computati > value. Keep in mind that memory\_win\_unit is applied before the > value is calculated. -Custom attributes: +Custom variables: Name | Description :-----------------|:------------ @@ -1570,7 +1570,7 @@ memory\_win\_show\_used | **Optional**. Show used memory instead of the free mem 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 :-------------------|:------------ @@ -1586,7 +1586,7 @@ This plugins allows to collect data from a Performance Counter. After the first 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 :---------------------|:------------ @@ -1603,7 +1603,7 @@ perfmon\_win\_syntax | **Optional**. Use this in the performance output instead 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 :------------------|:------------ @@ -1619,7 +1619,7 @@ ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000 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 :----------------|:------------ @@ -1633,7 +1633,7 @@ procs\_win\_user | **Optional**. Count this users processes. 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 :-------------------------|:------------ @@ -1647,7 +1647,7 @@ service\_win\_service | **Required**. Name of the service to check. Check command object for `check_swap.exe` plugin. The data collection is instant. -Custom attributes: +Custom variables: Name | Description :--------------- | :------------ @@ -1666,7 +1666,7 @@ Querying Microsoft for Windows updates can take multiple seconds to minutes. An > 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 :-------------------|:------------ @@ -1690,7 +1690,7 @@ Unless the `ignore_reboot` flag is set, if any updates require a reboot the plug 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 :-----------------|:------------ @@ -1703,7 +1703,7 @@ uptime\_win\_unit | **Optional**. The unit to display the received value in, thr Check command object for `check_users.exe` plugin. -Custom attributes: +Custom variables: Name | Description :----------------|:------------ @@ -1750,7 +1750,7 @@ and integrate them into Icinga 2. The check plugin `check_nscp_api` can be integrated with the `nscp_api` CheckCommand object: -Custom attributes: +Custom variables: Name | Description :----------------------|:---------------------- @@ -1791,7 +1791,7 @@ Note that it is not necessary to run NSClient++ as a Windows service for these c 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 ----------------|-------------- @@ -1839,19 +1839,19 @@ nscp_memory_showall | **Optional.** Shows more details in plugin output, defau 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 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 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 @@ -1874,13 +1874,13 @@ nscp_service_showall | **Optional.** Shows more details in plugin output, defa 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 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 @@ -1980,7 +1980,7 @@ You can enable these plugin check commands by adding the following the include d 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 @@ -2007,7 +2007,7 @@ snmp_timeout | **Optional.** The command timeout in seconds. Defaults 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 @@ -2034,7 +2034,7 @@ snmp_timeout | **Optional.** The command timeout in seconds. Defaults 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 ------------------------|-------------- @@ -2063,7 +2063,7 @@ snmp_timeout | **Optional.** The command timeout in seconds. Defaults 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 ------------------------|-------------- @@ -2092,7 +2092,7 @@ snmp_storage_olength | **Optional.** Max-size of the SNMP message, usefull in ca 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 ----------------------------|-------------- @@ -2133,7 +2133,7 @@ snmp_timeout | **Optional.** The command timeout in seconds. Defa 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 ---------------------------|-------------- @@ -2164,7 +2164,7 @@ snmp_process_cpu_threshold | **Optional.** Defines the warning and critical thre 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 ---------------------------|-------------- @@ -2213,7 +2213,7 @@ This category contains plugins for various Big Data systems. 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 ----------------------|----------------------------------------------------------------- @@ -2231,7 +2231,7 @@ cloudera_verify_ssl | **Optional.** Verify SSL. Defaults to true. 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 --------------------------|----------------------------------------------------------------- @@ -2246,7 +2246,7 @@ cloudera_hdfs_space_crit | **Required.** Critical threshold in percent. 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 --------------------------|----------------------------------------------------------------- @@ -2268,7 +2268,7 @@ database. 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 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------ @@ -2300,7 +2300,7 @@ uses the `DBD::Sybase` Perl library based on [FreeTDS](http://www.freetds.org/) 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 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------ @@ -2350,7 +2350,7 @@ uses the `DBD::MySQL` Perl library to monitor a 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 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------ @@ -2398,7 +2398,7 @@ uses the `DBD::Oracle` Perl library to monitor an [Oracle](https://www.oracle.co 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 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------ @@ -2423,9 +2423,9 @@ Environment Macros: Name | Description --------------------|------------------------------------------------------------------------------------------------------------------------------------------ -ORACLE\_HOME | **Required.** Specifies the location of the oracle instant client libraries. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting 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 @@ -2434,7 +2434,7 @@ uses the `psql` binary to monitor a [PostgreSQL](https://www.postgresql.org/abou 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 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------ @@ -2464,7 +2464,7 @@ postgres_tempdir | **Optional.** Specify directory for temporary files. The 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 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------ @@ -2493,7 +2493,7 @@ mongodb_sampletime | **Optional.** Time used to sample number of p 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 -----------------------------|------------------------------------------------------------------------------------------------------- @@ -2511,7 +2511,7 @@ uses the `Redis` Perl library to monitor a [Redis](https://redis.io/) instance. 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 -------------------------|-------------------------------------------------------------------------------------------------------------- @@ -2541,7 +2541,7 @@ redis_replication_delay | **Optional.** Allows to set threshold on replication 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 -----------------------------|---------------------------------------------------------------------------------- @@ -2564,7 +2564,7 @@ proxysql\_ignore\_hostgroup | **Optional.** ProxySQL hostgroup(s) to ignore (on 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 --------------------------------|---------------------------------------------------------------------------------- @@ -2596,13 +2596,13 @@ The plugin can run in two different ways: 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 --------------------------------|----------------------------------------------------------------------- @@ -2636,7 +2636,7 @@ check_by_ssh or similar, whichever suits your needs and particular taste. The plugin checks the health of the storage subsystem, power supplies, memory modules, temperature probes etc., and gives an alert if any of the components are faulty or operate outside normal parameters. -Custom attributes passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): +Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): Name | Description --------------------------------|----------------------------------------------------------------------- @@ -2671,7 +2671,7 @@ openmanage_warning | **Optional.** Custom temperature warning limits 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 ------------------------|---------------------------------------------------------------------------------- @@ -2684,7 +2684,7 @@ lmsensors_sensor | **Optional.** Set what to monitor, for example CPU or 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 ------------------------|---------------------------------------------------------------------------------- @@ -2712,7 +2712,7 @@ vars.hddtemp_timeout = 5 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 --------------------------------|----------------------------------------------------------------------- @@ -2724,7 +2724,7 @@ arcconf_path | **Required.** Path to the `arcconf` binary, e. 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 --------------------------------|----------------------------------------------------------------------- @@ -2757,7 +2757,7 @@ lsi_nocleanlogs | **Optional.** If set to true, does not clean u 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 --------------------------------|----------------------------------------------------------------------- @@ -2776,7 +2776,7 @@ The user running Icinga 2 needs sufficient permissions to read the Icinga Web 2 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 ------------------------------------------|----------------------------------------------------------------------------------------- @@ -2789,7 +2789,7 @@ icingacli_businessprocess_statetype | **Optional.** Define which state typ 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 ------------------------------------------|----------------------------------------------------------------------------------------- @@ -2818,7 +2818,7 @@ icingacli_elasticsearch_from | **Optional.** Negative value of time 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 ------------------------------------------|----------------------------------------------------------------------------------------- @@ -2840,7 +2840,7 @@ uses the `ipmimonitoring` binary to monitor sensor data for IPMI devices. Please 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 ---------------------------------|----------------------------------------------------------------------------------------------------- @@ -2869,7 +2869,7 @@ ipmi_unify_file | **Optional.** Path to the unify file to unify 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 ---------------------------------|----------------------------------------------------------------------------------------------------- @@ -2949,7 +2949,7 @@ This category includes all plugins for metric-based checks. 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 ------------------------------------|----------------------------------------------------------------------------------------------------- @@ -2976,7 +2976,7 @@ generates a html page containing information about the monitored node and all of 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 ------------------------------------|----------------------------------------------------------------------------------------------------- @@ -3047,7 +3047,7 @@ interfacetable_notype | **Optional.** Remove the interface type fo 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 ------------------------|--------------------------------------------------------- @@ -3066,7 +3066,7 @@ iftraffic_max_counter | **Optional.** Maximum counter value of net devices in ki 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 ------------------------|--------------------------------------------------------- @@ -3084,7 +3084,7 @@ iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in 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 --------------------------|--------------------------------------------------------- @@ -3126,7 +3126,7 @@ Brocade ICX6610-24-HPOE, Cisco UC Telefonzeugs, FOUNDRY-SN-AGENT-MIB, FRITZ!BOX 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 --------------------------------|--------------------------------------------------------- @@ -3178,7 +3178,7 @@ The [check_printer_health](https://labs.consol.de/nagios/check_printer_health/in 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 --------------------------------|--------------------------------------------------------- @@ -3234,7 +3234,7 @@ This category contains plugins which receive details about network services 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 ------------------------|--------------------------------------------------------------------------- @@ -3259,7 +3259,7 @@ chown -c root: /etc/sudoers.d/icinga 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 ------------------------|--------------------------------------------------------------------------- @@ -3281,7 +3281,7 @@ The [check_mem.pl](https://github.com/justintime/nagios-plugins) plugin checks t 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 -------------|----------------------------------------------------------------------------------------------------------------------- @@ -3296,7 +3296,7 @@ mem_critical | **Required.** Specify the critical threshold as number interprete 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 ---------------------------|------------- @@ -3308,7 +3308,7 @@ The [check_iostats](https://github.com/dnsmichi/icinga-plugins/blob/master/scrip 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 ---------------|----------------------------------------------------------------------------------------------------------------------- @@ -3328,7 +3328,7 @@ The [check_iostat](https://github.com/dnsmichi/icinga-plugins/blob/master/script 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 ---------------|----------------------------------------------------------------------------------------------------------------------- @@ -3346,7 +3346,7 @@ The [check_yum](https://github.com/calestyo/check_yum) plugin checks the YUM pac 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 ------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- @@ -3370,7 +3370,7 @@ The [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glust 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 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ @@ -3387,7 +3387,7 @@ glusterfs_inode_critical | **Optional.** Return a critical error if inode usag 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 -----------------|--------------------------------------------------------- @@ -3419,7 +3419,7 @@ chmod -c 0440 /etc/sudoers.d/icinga [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 -----------------|--------------------------------------------------------- @@ -3439,7 +3439,7 @@ The [check_esxi_hardware.py](https://www.claudiokuenzler.com/monitoring-plugins/ 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 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ @@ -3467,7 +3467,7 @@ Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_ 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 ------------------------|-------------- @@ -3500,7 +3500,7 @@ vmware_crit | **Optional.** The critical threshold for volumes. Defa 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 ------------------------|-------------- @@ -3523,7 +3523,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -3551,7 +3551,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -3579,7 +3579,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -3607,7 +3607,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -3634,7 +3634,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -3657,7 +3657,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -3687,7 +3687,7 @@ vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and runni 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 ------------------------|-------------- @@ -3710,7 +3710,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -3733,7 +3733,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -3758,7 +3758,7 @@ vmware_crit | **Optional.** The critical threshold in percent. Defau 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 ------------------------|-------------- @@ -3781,7 +3781,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -3804,7 +3804,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -3829,7 +3829,7 @@ vmware_crit | **Optional.** The critical threshold in percent. Defau 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 ------------------------|-------------- @@ -3852,7 +3852,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -3877,7 +3877,7 @@ vmware_crit | **Optional.** The critical threshold in percent. Defau 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 ------------------------|-------------- @@ -3902,7 +3902,7 @@ vmware_crit | **Optional.** The critical threshold in percent. No va 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 ------------------------|-------------- @@ -3928,7 +3928,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -3953,7 +3953,7 @@ vmware_crit | **Optional.** The critical threshold in percent. No va 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 ------------------------|-------------- @@ -3979,7 +3979,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -4004,7 +4004,7 @@ vmware_isregexp | **Optional.** Treat blacklist expression as regexp. 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 ------------------------|-------------- @@ -4029,7 +4029,7 @@ vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes 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 ------------------------|-------------- @@ -4054,7 +4054,7 @@ vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes 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 ------------------------|-------------- @@ -4079,7 +4079,7 @@ vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes 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 ------------------------|-------------- @@ -4104,7 +4104,7 @@ vmware_isregexp | **Optional.** Treat blacklist expression as regexp. 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 ------------------------|-------------- @@ -4137,7 +4137,7 @@ vmware_spaceleft | **Optional.** This has to be used in conjunction with 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 ------------------------|-------------- @@ -4160,7 +4160,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -4185,7 +4185,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4210,7 +4210,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4235,7 +4235,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4260,7 +4260,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4285,7 +4285,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4310,7 +4310,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4335,7 +4335,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4360,7 +4360,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4385,7 +4385,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4410,7 +4410,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4435,7 +4435,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4462,7 +4462,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -4489,7 +4489,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -4515,7 +4515,7 @@ vmware_isregexp | **Optional.** Treat blacklist and whitelist expression 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 ------------------------|-------------- @@ -4538,7 +4538,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -4565,7 +4565,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -4588,7 +4588,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -4614,7 +4614,7 @@ vmware_isregexp | **Optional.** Treat blacklist and whitelist expression 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 ------------------------|-------------- @@ -4640,7 +4640,7 @@ vmware_isregexp | **Optional.** Treat blacklist and whitelist expression 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 ------------------------|-------------- @@ -4666,7 +4666,7 @@ vmware_isregexp | **Optional.** Treat blacklist and whitelist expression 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 ------------------------|-------------- @@ -4693,7 +4693,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -4720,7 +4720,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -4747,7 +4747,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -4773,7 +4773,7 @@ vmware_isregexp | **Optional.** Treat blacklist and whitelist expression 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 ------------------------|-------------- @@ -4800,7 +4800,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -4827,7 +4827,7 @@ vmware_multiline | **Optional.** Multiline output in overview. This mean 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 ------------------------|-------------- @@ -4856,7 +4856,7 @@ vmware_standbyok | **Optional.** For storage systems where a standby mult 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 ------------------------|-------------- @@ -4881,7 +4881,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -4907,7 +4907,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4933,7 +4933,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -4959,7 +4959,7 @@ vmware_crit | **Optional.** Critical threshold in percent. Defaults 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 ------------------------|-------------- @@ -4983,7 +4983,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -5010,7 +5010,7 @@ vmware_crit | **Optional.** Critical threshold in percent. Defaults 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.
**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 ------------------------|-------------- @@ -5036,7 +5036,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -5063,7 +5063,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -5087,7 +5087,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -5113,7 +5113,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -5139,7 +5139,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -5165,7 +5165,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -5189,7 +5189,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -5215,7 +5215,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -5241,7 +5241,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -5267,7 +5267,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -5291,7 +5291,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -5315,7 +5315,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -5339,7 +5339,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -5363,7 +5363,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -5389,7 +5389,7 @@ vmware_crit | **Optional.** The critical threshold. No value defined 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 ------------------------|-------------- @@ -5412,7 +5412,7 @@ vmware_authfile | **Optional.** Use auth file instead username/password 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 ------------------------|-------------- @@ -5437,7 +5437,7 @@ vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and runni 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 ------------------------|-------------- @@ -5468,7 +5468,7 @@ The [check_apache_status.pl](https://github.com/lbetz/check_apache_status) plugi 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 --------------------------------|---------------------------------------------------------------------------------- @@ -5490,7 +5490,7 @@ apache_status_critical | **Optional.** Critical threshold (number of open slots 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 --------------------------|-------------- @@ -5532,7 +5532,7 @@ web application and queries Java message beans on an application server. It is 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 -----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------- @@ -5577,7 +5577,7 @@ jmx4perl_check | **Optional.** Name of a check configuration as de 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 ----------------|-------------------------------------------------------------------------- @@ -5593,7 +5593,7 @@ The [check_nginx_status.pl](https://github.com/regilero/check_nginx_status) plug 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 --------------------------------|---------------------------------------------------------------------------------- @@ -5618,7 +5618,7 @@ The [check_rbl](https://github.com/matteocorti/check_rbl) plugin 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 ----------------|-------------------------------------------------------------------------- @@ -5634,7 +5634,7 @@ rbl_timeout | **Optional** Seconds before plugin times out (default: 15). 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 ------------------------|---------------------------------------------------------------------------------- @@ -5661,7 +5661,7 @@ acceptance, and regression tests. A test harness allows you to run many test cas 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 ------------------------|-------------- @@ -5678,7 +5678,7 @@ The [check_varnish](https://github.com/varnish/varnish-nagios) plugin, 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 ------------------------|---------------------------------------------------------------------------------- @@ -5713,7 +5713,7 @@ frontend stats 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 ------------------------|---------------------------------------------------------------------------------- @@ -5734,7 +5734,7 @@ This plugin need read/write access to the statistics socket with an operator lev 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 ----------------------------|---------------------------------------------------------------------------------- @@ -5753,7 +5753,7 @@ haproxy\_status\_socket | **Required.** Path to the socket check_haproxy sho 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 --------------------------|---------------------------------------------------------------------------------- diff --git a/doc/12-icinga2-api.md b/doc/12-icinga2-api.md index f3d3d76c553..9f8969d7b92 100644 --- a/doc/12-icinga2-api.md +++ b/doc/12-icinga2-api.md @@ -246,7 +246,7 @@ filter expression has to be a [lambda function](17-language-reference.md#nullary which must return a boolean value. The following example allows the API user to query all hosts and services which have a -custom attribute `os` that matches the regular expression `^Linux`. +custom variable `os` that matches the regular expression `^Linux`. The [regex function](18-library-reference.md#global-functions-regex) is available as global function. ``` @@ -661,7 +661,7 @@ The following joins are available: Zones | parent Here's an example that retrieves all service objects for hosts which have had their `os` -custom attribute set to `Linux`. The result set contains the `display_name` and `check_command` +custom variable set to `Linux`. The result set contains the `display_name` and `check_command` attributes for the service. The query also returns the host's `name` and `address` attribute via a join: @@ -892,7 +892,7 @@ If attributes are of the [Dictionary](17-language-reference.md#dictionary) type, "attrs": { "vars.os": "Linux" } ``` -The following example updates the `address` attribute and the custom attribute `os` for the `example.localdomain` host: +The following example updates the `address` attribute and the custom variable `os` for the `example.localdomain` host: ``` $ curl -k -s -u root:icinga -H 'Accept: application/json' \ diff --git a/doc/13-addons.md b/doc/13-addons.md index 01bdfee3f34..641e76f68a5 100644 --- a/doc/13-addons.md +++ b/doc/13-addons.md @@ -220,7 +220,7 @@ fix this: * Pass the check command name inside the [format template configuration](14-features.md#writing-performance-data-files) The latter becomes difficult with agent based checks like NRPE or SSH where the first command argument acts as -graph template identifier. There is the possibility to define the pnp template name as custom attribute +graph template identifier. There is the possibility to define the pnp template name as custom variable and use that inside the formatting templates as `SERVICECHECKCOMMAND` for instance. Example for services: diff --git a/doc/15-troubleshooting.md b/doc/15-troubleshooting.md index 44310ba3639..08a4e80a8c8 100644 --- a/doc/15-troubleshooting.md +++ b/doc/15-troubleshooting.md @@ -274,7 +274,7 @@ did not properly escape the single dollar sign preventing its usage as [runtime critical/config: Error: Validation failed for Object 'ping4' (Type: 'Service') at /etc/icinga2/zones.d/global-templates/windows.conf:24: Closing $ not found in macro format string 'top-syntax=${list}'. ``` -Correct the custom attribute value to +Correct the custom variable value to ``` "top-syntax=$${list}" diff --git a/doc/17-language-reference.md b/doc/17-language-reference.md index 541c51aeefc..ddf04861445 100644 --- a/doc/17-language-reference.md +++ b/doc/17-language-reference.md @@ -440,7 +440,7 @@ instantiated at run-time. Parent objects do not necessarily have to be templates, however in general they are. The `vars` dictionary for the `localhost` object contains all three -custom attributes and the custom attribute `colour` has the value `"blue"`. +custom variables and the custom variable `colour` has the value `"blue"`. Parent objects are resolved in the order they're specified using the `import` keyword. @@ -496,7 +496,7 @@ ZonesDir |**Read-only.** Contains the path of the zones.d directory. Constant | Description --------------------|------------------- -Vars |**Read-write.** Contains a dictionary with global custom attributes. Not set by default. +Vars |**Read-write.** Contains a dictionary with global custom variables. Not set by default. NodeName |**Read-write.** Contains the cluster node name. Set to the local hostname by default. ReloadTimeout |**Read-write.** Defines the reload timeout for child processes. Defaults to `300s`. Environment |**Read-write.** The name of the Icinga environment. Included in the SNI host name for outbound connections. Not set by default. @@ -632,7 +632,7 @@ In this example all generated service object names consist of `prefix-` and the value of the `key` iterator. The prefix string can be omitted if not required. The `key` and `value` variables can be used for object attribute assignment, e.g. for -setting the `check_command` attribute or custom attributes as command parameters. +setting the `check_command` attribute or custom variables as command parameters. `apply for` rules are first evaluated against all objects matching the `for loop` list and afterwards the `assign where` and `ignore where` conditions are evaluated. @@ -1173,7 +1173,7 @@ log("Hello from '" + current_filename + "' in line " + current_line) ## Reserved Keywords -These keywords are reserved and must not be used as constants or custom attributes. +These keywords are reserved and must not be used as constants or custom variables. ``` object diff --git a/doc/18-library-reference.md b/doc/18-library-reference.md index e44a2128797..9ec4acd3175 100644 --- a/doc/18-library-reference.md +++ b/doc/18-library-reference.md @@ -704,10 +704,10 @@ The returned value depends on the attribute value which is resolved from the specified runtime macro. This function is only available in runtime evaluated functions, e.g. -for [custom attributes](03-monitoring-basics.md#custom-attributes-functions) which +for [custom variables](03-monitoring-basics.md#custom-variables-functions) which use the [abbreviated lambda syntax](17-language-reference.md#nullary-lambdas). -This example sets the `snmp_address` custom attribute +This example sets the `snmp_address` custom variable based on `$address$` and `$address6$`. ``` diff --git a/doc/20-script-debugger.md b/doc/20-script-debugger.md index 711600c3b39..733142d2109 100644 --- a/doc/20-script-debugger.md +++ b/doc/20-script-debugger.md @@ -25,7 +25,7 @@ Here is a list of common errors which can be diagnosed with the script debugger: ## Debugging Configuration Errors The following example illustrates the problem of a service [apply rule](03-monitoring-basics.md#using-apply-for) -which expects a dictionary value for `config`, but the host custom attribute only +which expects a dictionary value for `config`, but the host custom variable only provides a string value: ``` @@ -130,7 +130,7 @@ an internal error, they return an empty result to the caller. In order to analyse these server-side errors, you can use the script debugger. -The following example tries filter for all host objects where the custom attribute +The following example tries filter for all host objects where the custom variable `os` is set. There are various possibilities to check that, one of them would be `host.vars.os != ""`. Another idea is to use the [contains](18-library-reference.md#dictionary-contains) method on the custom attribute dictionary like this: `host.vars.contains("os")`. @@ -141,7 +141,7 @@ $ curl -k -s -u root:icinga -H 'Accept: application/json' -H 'X-HTTP-Method-Over -d '{ "filter": "host.vars.contains(\"os\")", "attrs": [ "__name" ], "joins": [ "host.name", "host.vars" ], "pretty": true }' ``` -This will fail on all hosts which don't have any custom attribute specified. +This will fail on all hosts which don't have any custom variable specified. ``` # icinga2 daemon -X diff --git a/doc/23-migrating-from-icinga-1x.md b/doc/23-migrating-from-icinga-1x.md index f0df9d0192c..aaf5e02623e 100644 --- a/doc/23-migrating-from-icinga-1x.md +++ b/doc/23-migrating-from-icinga-1x.md @@ -144,7 +144,7 @@ These assign rules can be applied for all groups: `HostGroup`, `ServiceGroup` an > **Tip** > -> Define custom attributes and assign/ignore members based on these attribute pattern matches. +> Define custom variables and assign/ignore members based on these attribute pattern matches. @@ -230,9 +230,9 @@ In Icinga 2 you'd just use the following macro to access all `address` attribute $address$ ``` -#### Manual Config Migration Hints for Runtime Custom Attributes +#### Manual Config Migration Hints for Runtime Custom Variables -Custom variables from Icinga 1.x are available as Icinga 2 custom attributes. +Custom variables from Icinga 1.x are available as Icinga 2 custom variables. ``` define command { @@ -282,7 +282,7 @@ while the service check command resolves its value to the service attribute attr > **Note** > -> Custom attributes in Icinga 2 are case-sensitive. `vars.CVTEST` is not the same as `vars.CvTest`. +> Custom variables in Icinga 2 are case-sensitive. `vars.CVTEST` is not the same as `vars.CvTest`. #### Manual Config Migration Hints for Contacts (Users) @@ -968,29 +968,27 @@ The `alias` is used for group, timeperiod, etc. objects too. Icinga 2 only supports the `display_name` attribute which is also taken into account by Icinga web interfaces. -### Custom Attributes +### Custom Variables -Icinga 2 allows you to define custom attributes in the `vars` dictionary. +Icinga 2 allows you to define custom variables in the `vars` dictionary. The `notes`, `notes_url`, `action_url`, `icon_image`, `icon_image_alt` attributes for host and service objects are still available in Icinga 2. `2d_coords` and `statusmap_image` are not supported in Icinga 2. -#### Custom Variables - Icinga 1.x custom variable attributes must be prefixed using an underscore (`_`). -In Icinga 2 these attributes must be added to the `vars` dictionary as custom attributes. +In Icinga 2 these attributes must be added to the `vars` dictionary as custom variables. ``` vars.dn = "cn=icinga2-dev-host,ou=icinga,ou=main,ou=IcingaConfig,ou=LConf,dc=icinga,dc=org" vars.cv = "my custom cmdb description" ``` -These custom attributes are also used as [command parameters](03-monitoring-basics.md#command-passing-parameters). +These custom variables are also used as [command parameters](03-monitoring-basics.md#command-passing-parameters). -While Icinga 1.x only supports numbers and strings as custom attribute values, +While Icinga 1.x only supports numbers and strings as custom variable values, Icinga 2 extends that to arrays and (nested) dictionaries. For more details -look [here](03-monitoring-basics.md#custom-attributes). +look [here](03-monitoring-basics.md#custom-variables). ### Host Service Relation @@ -1026,13 +1024,13 @@ and their users. ### Macros Various object attributes and runtime variables can be accessed as macros in -commands in Icinga 1.x -- Icinga 2 supports all required [custom attributes](03-monitoring-basics.md#custom-attributes). +commands in Icinga 1.x -- Icinga 2 supports all required [custom variables](03-monitoring-basics.md#custom-variables). #### Command Arguments If you have previously used Icinga 1.x, you may already be familiar with user and argument definitions (e.g., `USER1` or `ARG1`). Unlike in Icinga 1.x -the Icinga 2 custom attributes may have arbitrary names and arguments are no +the Icinga 2 custom variables may have arbitrary names and arguments are no longer specified in the `check_command` setting. In Icinga 1.x arguments are specified in the `check_command` attribute and @@ -1056,7 +1054,7 @@ can be set using the `env` attribute in command objects. #### Runtime Macros Icinga 2 requires an object specific namespace when accessing configuration -and stateful runtime macros. Custom attributes can be accessed directly. +and stateful runtime macros. Custom variables can be accessed directly. If a runtime macro from Icinga 1.x is not listed here, it is not supported by Icinga 2. diff --git a/doc/24-appendix.md b/doc/24-appendix.md index aa293d047bd..03874bb7dc0 100644 --- a/doc/24-appendix.md +++ b/doc/24-appendix.md @@ -188,7 +188,7 @@ New columns: {host,service}group | notes | TEXT | NULL | - {host,service}group | notes_url | TEXT | NULL | - {host,service}group | action_url | TEXT | NULL | - - customvariable* | is_json | integer | 0 | Defines whether `varvalue` is a json encoded string from custom attributes, or not + customvariable* | is_json | integer | 0 | Defines whether `varvalue` is a json encoded string from custom variables, or not servicestatus | original_attributes | TEXT | NULL | JSON encoded dictionary of original attributes if modified at runtime. hoststatus | original_attributes | TEXT | NULL | JSON encoded dictionary of original attributes if modified at runtime. diff --git a/etc/icinga2/conf.d/hosts.conf b/etc/icinga2/conf.d/hosts.conf index 5ff1f9b6155..0118f033ed0 100644 --- a/etc/icinga2/conf.d/hosts.conf +++ b/etc/icinga2/conf.d/hosts.conf @@ -23,7 +23,7 @@ object Host NodeName { address = "127.0.0.1" address6 = "::1" - /* Set custom attribute `os` for hostgroup assignment in `groups.conf`. */ + /* Set custom variable `os` for hostgroup assignment in `groups.conf`. */ vars.os = "Linux" /* Define http vhost attributes for service apply rules in `services.conf`. */ diff --git a/etc/icinga2/conf.d/notifications.conf b/etc/icinga2/conf.d/notifications.conf index 6a7e1f5a489..ac65875468d 100644 --- a/etc/icinga2/conf.d/notifications.conf +++ b/etc/icinga2/conf.d/notifications.conf @@ -2,7 +2,7 @@ * The example notification apply rules. * * Only applied if host/service objects have - * the custom attribute `notification` defined + * the custom variable `notification` defined * and containing `mail` as key. * * Check `hosts.conf` for an example. diff --git a/etc/icinga2/conf.d/services.conf b/etc/icinga2/conf.d/services.conf index 416915bc079..c8e1b3cc659 100644 --- a/etc/icinga2/conf.d/services.conf +++ b/etc/icinga2/conf.d/services.conf @@ -42,7 +42,7 @@ apply Service "ping6" { /* * Apply the `ssh` service to all hosts * with the `address` attribute defined and - * the custom attribute `os` set to `Linux`. + * the custom variable `os` set to `Linux`. */ apply Service "ssh" { import "generic-service" diff --git a/etc/icinga2/conf.d/win32/hosts.conf b/etc/icinga2/conf.d/win32/hosts.conf index 53d169a8a69..ecee11a9409 100644 --- a/etc/icinga2/conf.d/win32/hosts.conf +++ b/etc/icinga2/conf.d/win32/hosts.conf @@ -23,7 +23,7 @@ object Host NodeName { address = "127.0.0.1" address6 = "::1" - /* Set custom attribute `os` for hostgroup assignment in `groups.conf`. */ + /* Set custom variable `os` for hostgroup assignment in `groups.conf`. */ vars.os = "Windows" /* Define disks and attributes for service apply rules in `services.conf`. */