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

Add documentation for multi-line plugin output for API actions 

Signed-off-by: Michael Friedrich <michael.friedrich@icinga.com>
This commit is contained in:
Irina Kaprizkina 2017-09-10 23:10:58 -04:00 committed by Michael Friedrich
parent b439a45299
commit 4dad601fb6
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/12-icinga2-api.md
View File

@ -801,7 +801,7 @@ Send a `POST` request to the URL endpoint `/v1/actions/process-check-result`.
Parameter | Type | Description Parameter | Type | Description
------------------|--------------|-------------- ------------------|--------------|--------------
exit\_status | Number | **Required.** For services: 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN, for hosts: 0=OK, 1=CRITICAL. exit\_status | Number | **Required.** For services: 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN, for hosts: 0=OK, 1=CRITICAL.
plugin\_output | String | **Required.** The plugins main output. Does **not** contain the performance data. plugin\_output | String | **Required.** One or more lines of the plugin main output. Does **not** contain the performance data.
performance\_data | Array | **Optional.** The performance data. performance\_data | Array | **Optional.** The performance data.
check\_command | Array | **Optional.** The first entry should be the check commands path, then one entry for each command line option followed by an entry for each of its argument. check\_command | Array | **Optional.** The first entry should be the check commands path, then one entry for each command line option followed by an entry for each of its argument.
check\_source | String | **Optional.** Usually the name of the `command_endpoint` check\_source | String | **Optional.** Usually the name of the `command_endpoint`
@ -831,6 +831,12 @@ Example for using the `Host` type and filter by the host name:
You can avoid URL encoding of white spaces in object names by using the `filter` attribute in the request body. You can avoid URL encoding of white spaces in object names by using the `filter` attribute in the request body.
> **Note**
>
> Multi-line plugin output requires the following format: The first line is treated as `short` plugin output corresponding
> to the first line of the plugin output. Subsequent lines are treated as `long` plugin output. Please note that the
> performance data is separated from the plugin output and has to be passed as `performance_data` attribute.
### reschedule-check <a id="icinga2-api-actions-reschedule-check"></a> ### reschedule-check <a id="icinga2-api-actions-reschedule-check"></a>
Reschedule a check for hosts and services. The check can be forced if required. Reschedule a check for hosts and services. The check can be forced if required.