icinga modify-check-command
modifies a check command object
Description
modifies a check command object
Synopsis
icinga modify-check-command
[--site <site>]
[--cluster <cluster>]
--name <name>
--commands <commands>
[--arguments <arguments>]
[--vars <vars>]
Arguments
site
- (string)
Site where this command will be executed
Example: --site "site-1"
Default: input.site
Attributes: optional
cluster
- (string)
Name of Icinga cluster
Example: --cluster "icinga-default"
Default: icinga-default
Attributes: optional
name
- (string)
Name of the check command object. Must be unique on a per-host basis
Example: --name "checkcommand1"
Default: _None_
Attributes: required
commands
- (string)
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.
Example: --commands "/usr/local/sbin/check_http"
Default: _None_
Attributes: required, multiple allowed
arguments
- (string)
A dictionary of command arguments
Example: --arguments "{ "-I": "$mytest_iparam$" }"
Default: _None_
Attributes: optional
vars
- (string)
A dictionary containing custom variables that are specific to this command.
Example: --vars "{http_ssl: false, http_sni: false}"
Default: _None_
Attributes: optional
Examples
Input:
Output:{
"results": [
{
"code": 200,
"name": "ccmd1",
"status": "Attributes updated.",
"type": "CheckCommand"
}
]
}
Access Control
To use this command, you need access to the following:
Field | Value |
---|---|
Action | "update" |
Service Type | "icinga" |
Service Instance | cluster |
Namespace | |
Object Type | "check_command" |
Object ID | name |
Please see Access Control for details.