tyler.durden
/
icinga2
mirror of https://github.com/Icinga/icinga2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation: set_if usage with boolean values and functions 

fixes #9069
This commit is contained in:
Michael Friedrich 2015-04-16 14:26:20 +02:00
parent 5ce1c13d37
commit 02d2044ec2
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/6-object-types.md
View File

@ -82,7 +82,7 @@ Configuration Attributes:
Name |Description Name |Description
----------------|---------------- ----------------|----------------
execute |**Required.** The "execute" script method takes care of executing the check. In virtually all cases you should import the "plugin-check-command" template to take care of this setting. execute |**Required.** The "execute" script method takes care of executing the check. In virtually all cases you should import the "plugin-check-command" template to take care of this setting.
command |**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. command |**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 |**Optional.** A dictionary of macros which should be exported as environment variables prior to executing the command. env |**Optional.** A dictionary of macros which should be exported as environment variables prior to executing the command.
vars |**Optional.** A dictionary containing custom attributes that are specific to this command. vars |**Optional.** A dictionary containing custom attributes that are specific to this command.
timeout |**Optional.** The command timeout in seconds. Defaults to 60 seconds. timeout |**Optional.** The command timeout in seconds. Defaults to 60 seconds.
@ -128,12 +128,12 @@ CheckCommand:
Option | Description Option | Description
------------|-------------- ------------|--------------
value | Optional argument value. value | Optional argument value set by a macro string or a function call.
key | Optional argument key overriding the key identifier. key | Optional argument key overriding the key identifier.
description | Optional argument description. description | Optional argument description.
required | Required argument. Execution error if not set. Defaults to false (optional). required | Required argument. Execution error if not set. Defaults to false (optional).
skip_key | Use the value as argument and skip the key. skip_key | Use the value as argument and skip the key.
set_if | Argument is added if the macro resolves to a defined numeric value. String values are not supported. set_if | Argument is added if the macro resolves to a defined numeric or boolean value. String values are not supported. Function calls returning a value are supported too.
order | Set if multiple arguments require a defined argument order. order | Set if multiple arguments require a defined argument order.
repeat_key | If the argument value is an array, repeat the argument key, or not. Defaults to true (repeat). repeat_key | If the argument value is an array, repeat the argument key, or not. Defaults to true (repeat).