Difference between revisions of "Nagios XI"
(One intermediate revision by the same user not shown) | |||
Line 47: | Line 47: | ||
The Nagios XI package contains the following operations, than can be used to create ITOM Jobs directly, or included in your [[Business_Process_Designer|Business Processes]] and/or IT Operations Management Rubooks. | The Nagios XI package contains the following operations, than can be used to create ITOM Jobs directly, or included in your [[Business_Process_Designer|Business Processes]] and/or IT Operations Management Rubooks. | ||
− | ---- | + | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px"> |
− | + | ===Acknowledgements=== | |
− | ===Acknowledgements - Acknowledge Host Problem=== | + | <div class="mw-collapsible-content"> |
+ | ====Acknowledge Host Problem==== | ||
This operation can be used to Acknowledge a Host Problem. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=39 Nagios XI Documentation] for more information on the action and input parameters. | This operation can be used to Acknowledge a Host Problem. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=39 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 60: | Line 61: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 69: | Line 70: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 75: | Line 76: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ===Acknowledge Service Problem=== | |
− | |||
− | === | ||
This operation can be used to Acknowledge a Service Problem on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=40 Nagios XI Documentation] for more information on the action and input parameters. | This operation can be used to Acknowledge a Service Problem on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=40 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 88: | Line 87: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 98: | Line 97: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 104: | Line 103: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ===Remove Host Acknowledgement=== | |
− | |||
− | === | ||
This operation can be used to Remove an Acknowledgement from a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=116 Nagios XI Documentation] for more information on the action and input parameters. | This operation can be used to Remove an Acknowledgement from a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=116 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 117: | Line 114: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 127: | Line 124: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ===Remove Service Acknowledgement=== | |
− | |||
− | === | ||
This operation can be used to Remove an Acknowledgement from a Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=40 Nagios XI Documentation] for more information on the action and input parameters. | This operation can be used to Remove an Acknowledgement from a Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=40 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 140: | Line 135: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
* <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | * <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 151: | Line 146: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | ---- | + | </div></div> |
− | + | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px"> | |
− | ===Checks - Disable Host Checks=== | + | ===Checks=== |
+ | <div class="mw-collapsible-content"> | ||
+ | ====Disable Host Checks==== | ||
Disables checking on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=54 Nagios XI Documentation] for more information on the action and input parameters. | Disables checking on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=54 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 164: | Line 161: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 174: | Line 171: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Disable Host Service Checks==== | |
− | |||
− | === | ||
Disables checking of all Services on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=34 Nagios XI Documentation] for more information on the action and input parameters. | Disables checking of all Services on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=34 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 187: | Line 182: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 197: | Line 192: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Disable Service Checks==== | |
− | |||
− | === | ||
Disables checking of a specific Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=6 Nagios XI Documentation] for more information on the action and input parameters. | Disables checking of a specific Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=6 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 210: | Line 203: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
* <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | * <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 221: | Line 214: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Enable Host Chesks==== | |
− | |||
− | === | ||
Enables checking on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=53 Nagios XI Documentation] for more information on the action and input parameters. | Enables checking on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=53 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 234: | Line 225: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 244: | Line 235: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Enable Host Service Checks==== | |
− | |||
− | === | ||
Enables checking of all Services on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=33 Nagios XI Documentation] for more information on the action and input parameters. | Enables checking of all Services on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=33 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 257: | Line 246: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 267: | Line 256: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Enable Service Checks==== | |
− | |||
− | === | ||
Enables checking of a specific Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=5 Nagios XI Documentation] for more information on the action and input parameters. | Enables checking of a specific Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=5 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 280: | Line 267: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
* <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | * <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 291: | Line 278: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Process Service Check Results==== | |
− | |||
− | === | ||
This is used to submit a passive check result for a particular service. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=114 Nagios XI Documentation] for more information on the action and input parameters. | This is used to submit a passive check result for a particular service. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=114 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 304: | Line 289: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 311: | Line 296: | ||
* <code>PluginOutput</code> '''(MANDATORY)''' - Any errors returned by the operation | * <code>PluginOutput</code> '''(MANDATORY)''' - Any errors returned by the operation | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 317: | Line 302: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | ---- | + | </div></div> |
− | + | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px"> | |
− | ===Comments - Add Host Comment=== | + | ===Comments=== |
+ | <div class="mw-collapsible-content"> | ||
+ | ====Add Host Comment==== | ||
This operation can be used to add a Comment to a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=1 Nagios XI Documentation] for more information on the action and input parameters. | This operation can be used to add a Comment to a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=1 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 330: | Line 317: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 337: | Line 324: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 343: | Line 330: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Add Service Comment==== | |
− | |||
− | === | ||
This operation can be used to add a Comment to a Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=2 Nagios XI Documentation] for more information on the action and input parameters. | This operation can be used to add a Comment to a Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=2 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 356: | Line 341: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 364: | Line 349: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 370: | Line 355: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | ---- | + | </div></div> |
− | + | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px"> | |
− | ===Notifications - Disable Notifications=== | + | ===Notifications=== |
+ | <div class="mw-collapsible-content"> | ||
+ | ====Disable Notifications==== | ||
Disables Host and Service notifications on a program-wide basis. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=7 Nagios XI Documentation] for more information on the action and input parameters. | Disables Host and Service notifications on a program-wide basis. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=7 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 383: | Line 370: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
This operation has no input parameters. | This operation has no input parameters. | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 393: | Line 380: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Disable Host Notifications==== | |
− | |||
− | === | ||
Disables notifications for a particular Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=16 Nagios XI Documentation] for more information on the action and input parameters. | Disables notifications for a particular Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=16 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 406: | Line 391: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 416: | Line 401: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Disable Host Service Notifications==== | |
− | |||
− | === | ||
Disables notifications for all Services on a particular Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=16 Nagios XI Documentation] for more information on the action and input parameters. | Disables notifications for all Services on a particular Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=16 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 429: | Line 412: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 439: | Line 422: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Disable Service Notifications==== | |
− | |||
− | === | ||
Disables notifications for a particular Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=12 Nagios XI Documentation] for more information on the action and input parameters. | Disables notifications for a particular Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=12 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 452: | Line 433: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
* <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | * <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 463: | Line 444: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Enable Notifications==== | |
− | |||
− | === | ||
Enables Host and Service notifications on a program-wide basis. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=8 Nagios XI Documentation] for more information on the action and input parameters. | Enables Host and Service notifications on a program-wide basis. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=8 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 476: | Line 455: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
This operation has no input parameters. | This operation has no input parameters. | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 486: | Line 465: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Enable Host Notifications==== | |
− | |||
− | === | ||
Enables notifications for a particular Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=15 Nagios XI Documentation] for more information on the action and input parameters. | Enables notifications for a particular Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=15 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 499: | Line 476: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 509: | Line 486: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Enable Host Service Notifications==== | |
− | |||
− | === | ||
Enables notifications for all Services on the specified Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=35 Nagios XI Documentation] for more information on the action and input parameters. | Enables notifications for all Services on the specified Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=35 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 522: | Line 497: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 532: | Line 507: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Enable Service Notifications==== | |
− | |||
− | === | ||
Enables notifications for a particular Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=11 Nagios XI Documentation] for more information on the action and input parameters. | Enables notifications for a particular Service on a Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=11 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 545: | Line 518: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
* <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | * <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 556: | Line 529: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | ---- | + | </div></div> |
− | + | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px"> | |
− | ===Schedules - Schedule and Propagate Host Downtime=== | + | ===Schedules=== |
+ | <div class="mw-collapsible-content"> | ||
+ | ====Schedule and Propagate Host Downtime==== | ||
Schedules downtime for a specified Host and all of its children (Hosts). See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=28 Nagios XI Documentation] for more information on the action and input parameters. | Schedules downtime for a specified Host and all of its children (Hosts). See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=28 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 569: | Line 544: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 580: | Line 555: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 586: | Line 561: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule and Propagate Triggered Host Downtime==== | |
− | |||
− | === | ||
Schedules downtime for a specified Host and all of its children (Hosts). See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=27 Nagios XI Documentation] for more information on the action and input parameters. | Schedules downtime for a specified Host and all of its children (Hosts). See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=27 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 599: | Line 572: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 610: | Line 583: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 616: | Line 589: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule Forced Host Check==== | |
− | |||
− | === | ||
Schedules a forced active check of a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=128 Nagios XI Documentation] for more information on the action and input parameters. | Schedules a forced active check of a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=128 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 629: | Line 600: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
* <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | * <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 640: | Line 611: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule Forced Host Service Checks==== | |
− | |||
− | === | ||
Schedules a forced active check of all Services on a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=130 Nagios XI Documentation] for more information on the action and input parameters. | Schedules a forced active check of all Services on a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=130 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 653: | Line 622: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
* <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | * <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 664: | Line 633: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule Forced Service Check==== | |
− | |||
− | === | ||
Schedules a forced active check of a specific Service on a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=129 Nagios XI Documentation] for more information on the action and input parameters. | Schedules a forced active check of a specific Service on a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=129 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 677: | Line 644: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 683: | Line 650: | ||
* <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | * <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 689: | Line 656: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule HostGroup Hosts Downtime==== | |
− | |||
− | === | ||
Schedules downtime for all Hosts in the specified HostGroup. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=123 Nagios XI Documentation] for more information on the action and input parameters. | Schedules downtime for all Hosts in the specified HostGroup. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=123 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 702: | Line 667: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostGroupName</code> '''(MANDATORY)''' - The HostGroupName which you want to perform the action on | * <code>HostGroupName</code> '''(MANDATORY)''' - The HostGroupName which you want to perform the action on | ||
Line 713: | Line 678: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 719: | Line 684: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule HostGroup Services Downtime==== | |
− | |||
− | === | ||
Schedules downtime for all Services on Hosts in the specified HostGroup. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=124 Nagios XI Documentation] for more information on the action and input parameters. | Schedules downtime for all Services on Hosts in the specified HostGroup. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=124 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 732: | Line 695: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostGroupName</code> '''(MANDATORY)''' - The HostGroupName which you want to perform the action on | * <code>HostGroupName</code> '''(MANDATORY)''' - The HostGroupName which you want to perform the action on | ||
Line 743: | Line 706: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 749: | Line 712: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule Host Check==== | |
− | |||
− | === | ||
Schedules the next active check of a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=127 Nagios XI Documentation] for more information on the action and input parameters. | Schedules the next active check of a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=127 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 762: | Line 723: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
* <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | * <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 773: | Line 734: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule Host Downtime==== | |
− | |||
− | === | ||
Schedules downtime for a specified Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=118 Nagios XI Documentation] for more information on the action and input parameters. | Schedules downtime for a specified Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=118 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 786: | Line 745: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 797: | Line 756: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 803: | Line 762: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule Host Services Checks==== | |
− | |||
− | === | ||
Schedules the next active check of all Services on a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=30 Nagios XI Documentation] for more information on the action and input parameters. | Schedules the next active check of all Services on a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=30 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 816: | Line 773: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
* <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | * <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 827: | Line 784: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule Host Services Downtime==== | |
− | |||
− | === | ||
Schedules downtime for all Services on a specified Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=122 Nagios XI Documentation] for more information on the action and input parameters. | Schedules downtime for all Services on a specified Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=122 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 840: | Line 795: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 851: | Line 806: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 857: | Line 812: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule ServiceGroup Hosts Downtime==== | |
− | |||
− | === | ||
Schedules downtime for all Hosts that have Services in a specified ServiceGroup. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=121 Nagios XI Documentation] for more information on the action and input parameters. | Schedules downtime for all Hosts that have Services in a specified ServiceGroup. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=121 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 870: | Line 823: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>ServiceGroupName</code> '''(MANDATORY)''' - The ServiceGroupName which you want to perform the action on | * <code>ServiceGroupName</code> '''(MANDATORY)''' - The ServiceGroupName which you want to perform the action on | ||
Line 881: | Line 834: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 887: | Line 840: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule ServiceGroup Services Downtime==== | |
− | |||
− | === | ||
Schedules downtime for all Services in a specified ServiceGroup. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=120 Nagios XI Documentation] for more information on the action and input parameters. | Schedules downtime for all Services in a specified ServiceGroup. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=120 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 900: | Line 851: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>ServiceGroupName</code> '''(MANDATORY)''' - The ServiceGroupName which you want to perform the action on | * <code>ServiceGroupName</code> '''(MANDATORY)''' - The ServiceGroupName which you want to perform the action on | ||
Line 911: | Line 862: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 917: | Line 868: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule Service Check==== | |
− | |||
− | === | ||
Schedules the next active check of a specific Service on a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=129 Nagios XI Documentation] for more information on the action and input parameters. | Schedules the next active check of a specific Service on a particular Host at CheckTime. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=129 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 930: | Line 879: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 936: | Line 885: | ||
* <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | * <code>CheckTime</code> '''(MANDATORY)''' - In the format 2019-12-31 09:00:00 | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 942: | Line 891: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | + | ====Schedule Service Downtime==== | |
− | |||
− | === | ||
Schedules downtime for a specific Service on a specified Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=119 Nagios XI Documentation] for more information on the action and input parameters. | Schedules downtime for a specific Service on a specified Host. See the [https://assets.nagios.com/downloads/nagioscore/docs/externalcmds/cmdinfo.php?command_id=119 Nagios XI Documentation] for more information on the action and input parameters. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 955: | Line 902: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
Line 967: | Line 914: | ||
* <code>Comment</code> '''(MANDATORY)''' | * <code>Comment</code> '''(MANDATORY)''' | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 973: | Line 920: | ||
* <code>success</code> - the value of the success response from the Nagios operation | * <code>success</code> - the value of the success response from the Nagios operation | ||
− | ---- | + | </div></div> |
− | + | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px"> | |
− | ===Status - Get Host Status=== | + | ===Status=== |
+ | <div class="mw-collapsible-content"> | ||
+ | ====Get Host Status==== | ||
Retrieves the Status of a Host. | Retrieves the Status of a Host. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 986: | Line 935: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 999: | Line 948: | ||
* <code>lastStateChange</code> - The DateTime when the state last changed | * <code>lastStateChange</code> - The DateTime when the state last changed | ||
− | + | ====Get Service Status==== | |
− | |||
− | === | ||
Retrieves the Status of a Service on a Host. | Retrieves the Status of a Service on a Host. | ||
− | ====Extra Credentials==== | + | =====Extra Credentials===== |
This operation requires an extra credential to be provided: | This operation requires an extra credential to be provided: | ||
Line 1,012: | Line 959: | ||
* Credential Keysafe Key Type: <code>API Key</code> | * Credential Keysafe Key Type: <code>API Key</code> | ||
− | ====Input Parameters==== | + | =====Input Parameters===== |
* <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | * <code>HostName</code> '''(MANDATORY)''' - The hostname or IP Address of the Host which you want to perform the action on | ||
* <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | * <code>ServiceName</code> '''(MANDATORY)''' - The name of the Service on the above Host which you want to perform the action on | ||
− | ====Output Parameters==== | + | =====Output Parameters===== |
* <code>errors</code> - Any errors returned by the operation | * <code>errors</code> - Any errors returned by the operation | ||
Line 1,024: | Line 971: | ||
* <code>statusText</code> - The status description | * <code>statusText</code> - The status description | ||
* <code>currentState</code> - The state code | * <code>currentState</code> - The state code | ||
− | * <code>lastStateChange</code> - The DateTime when the state last changed | + | * <code>lastStateChange</code> - The DateTime when the state last changed |
+ | </div></div> |
Revision as of 19:20, 18 March 2020
Home > Administration > IT Operations Management > ITOM Package Library > Nagios XI | Index |
IntroductionThe Nagios XI package for Hornbill's IT Operations Management (ITOM) contains a administrative operations that allows you to manage your Nagios XI deployment. |
|
Target Environment Requirements
Script Execution Machine Requirements
- If the script execution policy on the machine executing these operations is set to Restricted, then this will need to be updated to something less restrictive. See the PowerShell Documentation for more information.
KeySafe Configuration
When creating SIS jobs for operations contained within this package, they need to be run on the target machine as a user who has the correct privileges within your environment, and will require an additional KeySafe Key to hold the account credentials to connect to your Nagios XI deployment.
To configure your Target Machine account authentication in KeySafe:
- In the Admin console, navigate to: System > Security > KeySafe;
- Click on + then select
Username + Password
; - Give the KeySafe Key a Title (this is the name/identifier for the target machine account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Business Process or Runbook);
- Optionally add a description;
- Populate the Username field with the domain/local account username for the account being used on the target machine;
- Populate the Password field with the password for the above account;
- Select Create Key to save.
To configure your Nagios XI account authentication in KeySafe:
- In the Admin console, navigate to: System > Security > KeySafe;
- In the Type field, select
API Key
- Give the API Key a title (this is the name/identifier for the Dynatrace account as you will see it when using the Integration Call node in your business process);
- Optionally add a description;
- API Key - this should be populated with an API Key that has the rights to perform the operations contained within this package
- API Endpoint - this should be populated with the API Endpoint for your Nagios XI instance. For example: https://yournagiosxiserver/nagiosxi/api/v1
- Click Create Key to save
See screenshots to the right for examples.
Package Operations
The Nagios XI package contains the following operations, than can be used to create ITOM Jobs directly, or included in your Business Processes and/or IT Operations Management Rubooks.
Acknowledgements
Acknowledge Host Problem
This operation can be used to Acknowledge a Host Problem. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onSticky
(MANDATORY)Notify
(MANDATORY)Persistent
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Acknowledge Service Problem
This operation can be used to Acknowledge a Service Problem on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action onSticky
(MANDATORY)Notify
(MANDATORY)Persistent
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Remove Host Acknowledgement
This operation can be used to Remove an Acknowledgement from a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Remove Service Acknowledgement
This operation can be used to Remove an Acknowledgement from a Service on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Checks
Disable Host Checks
Disables checking on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Disable Host Service Checks
Disables checking of all Services on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Disable Service Checks
Disables checking of a specific Service on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Enable Host Chesks
Enables checking on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Enable Host Service Checks
Enables checking of all Services on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Enable Service Checks
Enables checking of a specific Service on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Process Service Check Results
This is used to submit a passive check result for a particular service. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action onReturnCode
(MANDATORY) - Any errors returned by the operationPluginOutput
(MANDATORY) - Any errors returned by the operation
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Comments
Add Host Comment
This operation can be used to add a Comment to a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onPersistent
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Add Service Comment
This operation can be used to add a Comment to a Service on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action onPersistent
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Notifications
Disable Notifications
Disables Host and Service notifications on a program-wide basis. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
This operation has no input parameters.
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Disable Host Notifications
Disables notifications for a particular Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Disable Host Service Notifications
Disables notifications for all Services on a particular Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Disable Service Notifications
Disables notifications for a particular Service on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Enable Notifications
Enables Host and Service notifications on a program-wide basis. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
This operation has no input parameters.
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Enable Host Notifications
Enables notifications for a particular Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Enable Host Service Notifications
Enables notifications for all Services on the specified Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Enable Service Notifications
Enables notifications for a particular Service on a Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedules
Schedule and Propagate Host Downtime
Schedules downtime for a specified Host and all of its children (Hosts). See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onStartTime
(MANDATORY) - In the format 2019-12-31 09:00:00EndTime
(MANDATORY) - In the format 2019-12-31 09:00:00Fixed
(MANDATORY)TriggerID
(MANDATORY)Duration
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule and Propagate Triggered Host Downtime
Schedules downtime for a specified Host and all of its children (Hosts). See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onStartTime
(MANDATORY) - In the format 2019-12-31 09:00:00EndTime
(MANDATORY) - In the format 2019-12-31 09:00:00Fixed
(MANDATORY)TriggerID
(MANDATORY)Duration
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule Forced Host Check
Schedules a forced active check of a particular Host at CheckTime. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onCheckTime
(MANDATORY) - In the format 2019-12-31 09:00:00
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule Forced Host Service Checks
Schedules a forced active check of all Services on a particular Host at CheckTime. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onCheckTime
(MANDATORY) - In the format 2019-12-31 09:00:00
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule Forced Service Check
Schedules a forced active check of a specific Service on a particular Host at CheckTime. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action onCheckTime
(MANDATORY) - In the format 2019-12-31 09:00:00
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule HostGroup Hosts Downtime
Schedules downtime for all Hosts in the specified HostGroup. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostGroupName
(MANDATORY) - The HostGroupName which you want to perform the action onStartTime
(MANDATORY) - In the format 2019-12-31 09:00:00EndTime
(MANDATORY) - In the format 2019-12-31 09:00:00Fixed
(MANDATORY)TriggerID
(MANDATORY)Duration
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule HostGroup Services Downtime
Schedules downtime for all Services on Hosts in the specified HostGroup. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostGroupName
(MANDATORY) - The HostGroupName which you want to perform the action onStartTime
(MANDATORY) - In the format 2019-12-31 09:00:00EndTime
(MANDATORY) - In the format 2019-12-31 09:00:00Fixed
(MANDATORY)TriggerID
(MANDATORY)Duration
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule Host Check
Schedules the next active check of a particular Host at CheckTime. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onCheckTime
(MANDATORY) - In the format 2019-12-31 09:00:00
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule Host Downtime
Schedules downtime for a specified Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onStartTime
(MANDATORY) - In the format 2019-12-31 09:00:00EndTime
(MANDATORY) - In the format 2019-12-31 09:00:00Fixed
(MANDATORY)TriggerID
(MANDATORY)Duration
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule Host Services Checks
Schedules the next active check of all Services on a particular Host at CheckTime. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onCheckTime
(MANDATORY) - In the format 2019-12-31 09:00:00
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule Host Services Downtime
Schedules downtime for all Services on a specified Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onStartTime
(MANDATORY) - In the format 2019-12-31 09:00:00EndTime
(MANDATORY) - In the format 2019-12-31 09:00:00Fixed
(MANDATORY)TriggerID
(MANDATORY)Duration
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule ServiceGroup Hosts Downtime
Schedules downtime for all Hosts that have Services in a specified ServiceGroup. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
ServiceGroupName
(MANDATORY) - The ServiceGroupName which you want to perform the action onStartTime
(MANDATORY) - In the format 2019-12-31 09:00:00EndTime
(MANDATORY) - In the format 2019-12-31 09:00:00Fixed
(MANDATORY)TriggerID
(MANDATORY)Duration
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule ServiceGroup Services Downtime
Schedules downtime for all Services in a specified ServiceGroup. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
ServiceGroupName
(MANDATORY) - The ServiceGroupName which you want to perform the action onStartTime
(MANDATORY) - In the format 2019-12-31 09:00:00EndTime
(MANDATORY) - In the format 2019-12-31 09:00:00Fixed
(MANDATORY)TriggerID
(MANDATORY)Duration
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule Service Check
Schedules the next active check of a specific Service on a particular Host at CheckTime. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action onCheckTime
(MANDATORY) - In the format 2019-12-31 09:00:00
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Schedule Service Downtime
Schedules downtime for a specific Service on a specified Host. See the Nagios XI Documentation for more information on the action and input parameters.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action onStartTime
(MANDATORY) - In the format 2019-12-31 09:00:00EndTime
(MANDATORY) - In the format 2019-12-31 09:00:00Fixed
(MANDATORY)TriggerID
(MANDATORY)Duration
(MANDATORY)Author
(MANDATORY)Comment
(MANDATORY)
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILsuccess
- the value of the success response from the Nagios operation
Status
Get Host Status
Retrieves the Status of a Host.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILstatusUpdateTime
- The DateTime the Status was updatedstatusText
- The status descriptioncurrentState
- The state codelastStateChange
- The DateTime when the state last changed
Get Service Status
Retrieves the Status of a Service on a Host.
Extra Credentials
This operation requires an extra credential to be provided:
- Credential Reference:
credential1
- Credential Keysafe Key Type:
API Key
Input Parameters
HostName
(MANDATORY) - The hostname or IP Address of the Host which you want to perform the action onServiceName
(MANDATORY) - The name of the Service on the above Host which you want to perform the action on
Output Parameters
errors
- Any errors returned by the operationoutcome
- Outcome of the operation. Can be OK or FAILstatusUpdateTime
- The DateTime the Status was updatedstatusText
- The status descriptioncurrentState
- The state codelastStateChange
- The DateTime when the state last changed