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

Update documentation for external commands. 

Refs #5956
Refs #5609
This commit is contained in:
Michael Friedrich 2014-04-16 16:47:25 +02:00
parent 7c0d93ea0a
commit 0c3d246dbb
4 changed files with 205 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/3.08-external-commands.md
View File

@ -34,7 +34,7 @@ Debian packages use `nagios` as the default user and group name. Therefore chang
### <a id="external-command-list"></a> External Command List
A list of currently supported external commands can be found on the
[Icinga Wiki](https://wiki.icinga.org/display/icinga2/External+Commands).
A list of currently supported external commands can be found [here](#external-commands-list-detail)
Detailed information on the commands and their required parameters can be found
on the [Icinga 1.x documentation](http://docs.icinga.org/latest/en/extcommands2.html).

2
doc/6.12-schemas.md
View File

@ -82,6 +82,8 @@ A detailed list which table attributes are supported can be found here: [https:/
#### <a id="schema-livestatus-command-queries"></a> Livestatus COMMAND Queries
A list of available external commands and their parameters can be found [here](#external-commands-list-detail)
$ echo -e 'COMMAND <externalcommandstring>' | netcat 127.0.0.1 6558

147
doc/6.13-external-commands-list,md Normal file
View File

@ -0,0 +1,147 @@
## <a id="external-commands-list-detail"></a> External Commands List
Additional details can be found in the [Icinga 1.x Documentation](http://docs.icinga.org/latest/en/extcommands2.html)
Command name | Parameters | Description
------------------------------------------|-----------------------------------|--------------------------
PROCESS_HOST_CHECK_RESULT | ;<host_name>;<status_code>;<plugin_output> (3) |
PROCESS_SERVICE_CHECK_RESULT | ;<host_name>;<service_name>;<return_code>;<plugin_output> (4) |
SCHEDULE_HOST_CHECK | ;<host_name>;<check_time> (2) |
SCHEDULE_FORCED_HOST_CHECK | ;<host_name>;<check_time> (2) |
SCHEDULE_SVC_CHECK | ;<host_name>;<service_name>;<check_time> (3) |
SCHEDULE_FORCED_SVC_CHECK | ;<host_name>;<service_name>;<check_time> (3) |
ENABLE_HOST_CHECK | ;<host_name> (1) |
DISABLE_HOST_CHECK | ;<host_name> (1) |
ENABLE_SVC_CHECK | ;<host_name>;<service_name> (2) |
DISABLE_SVC_CHECK | ;<host_name>;<service_name> (2) |
SHUTDOWN_PROCESS | (0) |
RESTART_PROCESS | (0) |
SCHEDULE_FORCED_HOST_SVC_CHECKS | ;<host_name>;<check_time> (2) |
SCHEDULE_HOST_SVC_CHECKS | ;<host_name>;<check_time> (2) |
ENABLE_HOST_SVC_CHECKS | ;<host_name> (1) |
DISABLE_HOST_SVC_CHECKS | ;<host_name> (1) |
ACKNOWLEDGE_SVC_PROBLEM | ;<host_name>;<service_name>;<sticky>;<notify>;<persistent>;<author>;<comment> (7) |
ACKNOWLEDGE_SVC_PROBLEM_EXPIRE | ;<host_name>;<service_name>;<sticky>;<notify>;<persistent>;<timestamp>;<author>;<comment> (8) |
REMOVE_SVC_ACKNOWLEDGEMENT | ;<host_name>;<service_name> (2) |
ACKNOWLEDGE_HOST_PROBLEM | ;<host_name>;<sticky>;<notify>;<persistent>;<author>;<comment> (6) |
ACKNOWLEDGE_HOST_PROBLEM_EXPIRE | ;<host_name>;<sticky>;<notify>;<persistent>;<timestamp>;<author>;<comment> (7) |
REMOVE_HOST_ACKNOWLEDGEMENT | ;<host_name> (1) |
DISABLE_HOST_FLAP_DETECTION | ;<host_name> (1) |
ENABLE_HOST_FLAP_DETECTION | ;<host_name> (1) |
DISABLE_SVC_FLAP_DETECTION | ;<host_name>;<service_name> (2) |
ENABLE_SVC_FLAP_DETECTION | ;<host_name>;<service_name> (2) |
ENABLE_HOSTGROUP_SVC_CHECKS | ;<hostgroup_name> (1) |
DISABLE_HOSTGROUP_SVC_CHECKS | ;<hostgroup_name> (1) |
ENABLE_SERVICEGROUP_SVC_CHECKS | ;<servicegroup_name> (1) |
DISABLE_SERVICEGROUP_SVC_CHECKS | ;<servicegroup_name> (1) |
ENABLE_PASSIVE_HOST_CHECKS | ;<host_name> (1) |
DISABLE_PASSIVE_HOST_CHECKS | ;<host_name> (1) |
ENABLE_PASSIVE_SVC_CHECKS | ;<host_name>;<service_name> (2) |
DISABLE_PASSIVE_SVC_CHECKS | ;<host_name>;<service_name> (2) |
ENABLE_SERVICEGROUP_PASSIVE_SVC_CHECKS | ;<servicegroup_name> (1) |
DISABLE_SERVICEGROUP_PASSIVE_SVC_CHECKS | ;<servicegroup_name> (1) |
ENABLE_HOSTGROUP_PASSIVE_SVC_CHECKS | ;<hostgroup_name> (1) |
DISABLE_HOSTGROUP_PASSIVE_SVC_CHECKS | ;<hostgroup_name> (1) |
PROCESS_FILE | ;<file_name>;<delete> (2) |
SCHEDULE_SVC_DOWNTIME | ;<host_name>;<service_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (9) |
DEL_SVC_DOWNTIME | ;<downtime_id> (1) |
SCHEDULE_HOST_DOWNTIME | ;<host_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) |
DEL_HOST_DOWNTIME | ;<downtime_id> (1) |
SCHEDULE_HOST_SVC_DOWNTIME | ;<host_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) |
SCHEDULE_HOSTGROUP_HOST_DOWNTIME | ;<hostgroup_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) |
SCHEDULE_HOSTGROUP_SVC_DOWNTIME | ;<hostgroup_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) |
SCHEDULE_SERVICEGROUP_HOST_DOWNTIME | ;<servicegroup_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) |
SCHEDULE_SERVICEGROUP_SVC_DOWNTIME | ;<servicegroup_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) |
ADD_HOST_COMMENT | ;<host_name>;<persistent>;<author>;<comment> (4) |
DEL_HOST_COMMENT | ;<comment_id> (1) |
ADD_SVC_COMMENT | ;<host_name>;<service_name>;<persistent>;<author>;<comment> (5) |
DEL_SVC_COMMENT | ;<comment_id> (1) |
DEL_ALL_HOST_COMMENTS | ;<host_name> (1) |
DEL_ALL_SVC_COMMENTS | ;<host_name>;<service_name> (2) |
SEND_CUSTOM_HOST_NOTIFICATION | ;<host_name>;<options>;<author>;<comment> (4) |
SEND_CUSTOM_SVC_NOTIFICATION | ;<host_name>;<service_name>;<options>;<author>;<comment> (5) |
DELAY_HOST_NOTIFICATION | ;<host_name>;<notification_time> (2) |
DELAY_SVC_NOTIFICATION | ;<host_name>;<service_name>;<notification_time> (3) |
ENABLE_HOST_NOTIFICATIONS | ;<host_name> (1) |
DISABLE_HOST_NOTIFICATIONS | ;<host_name> (1) |
ENABLE_SVC_NOTIFICATIONS | ;<host_name>;<service_name> (2) |
DISABLE_SVC_NOTIFICATIONS | ;<host_name>;<service_name> (2) |
DISABLE_HOSTGROUP_HOST_CHECKS | ;<hostgroup_name> (1) |
DISABLE_HOSTGROUP_PASSIVE_HOST_CHECKS | ;<hostgroup_name> (1) |
DISABLE_SERVICEGROUP_HOST_CHECKS | ;<servicegroup_name> (1) |
DISABLE_SERVICEGROUP_PASSIVE_HOST_CHECKS | ;<servicegroup_name> (1) |
ENABLE_HOSTGROUP_HOST_CHECKS | ;<hostgroup_name> (1) |
ENABLE_HOSTGROUP_PASSIVE_HOST_CHECKS | ;<hostgroup_name> (1) |
ENABLE_SERVICEGROUP_HOST_CHECKS | ;<servicegroup_name> (1) |
ENABLE_SERVICEGROUP_PASSIVE_HOST_CHECKS | ;<servicegroup_name> (1) |
ENABLE_NOTIFICATIONS | (0) |
DISABLE_NOTIFICATIONS | (0) |
ENABLE_FLAP_DETECTION | (0) |
DISABLE_FLAP_DETECTION | (0) |
ENABLE_EVENT_HANDLERS | (0) |
DISABLE_EVENT_HANDLERS | (0) |
ENABLE_PERFORMANCE_DATA | (0) |
DISABLE_PERFORMANCE_DATA | (0) |
START_EXECUTING_HOST_CHECKS | (0) |
STOP_EXECUTING_HOST_CHECKS | (0) |
START_EXECUTING_SVC_CHECKS | (0) |
STOP_EXECUTING_SVC_CHECKS | (0) |
CHANGE_SVC_MODATTR | ;<host_name>;<service_name>;<value> (3) |
CHANGE_HOST_MODATTR | ;<host_name>;<value> (2) |
CHANGE_NORMAL_SVC_CHECK_INTERVAL | ;<host_name>;<service_name>;<check_interval> (3) |
CHANGE_NORMAL_HOST_CHECK_INTERVAL | ;<host_name>;<check_interval> (2) |
CHANGE_RETRY_SVC_CHECK_INTERVAL | ;<host_name>;<service_name>;<check_interval> (3) |
CHANGE_RETRY_HOST_CHECK_INTERVAL | ;<host_name>;<check_interval> (2) |
ENABLE_HOST_EVENT_HANDLER | ;<host_name> (1) |
DISABLE_HOST_EVENT_HANDLER | ;<host_name> (1) |
ENABLE_SVC_EVENT_HANDLER | ;<host_name>;<service_name> (2) |
DISABLE_SVC_EVENT_HANDLER | ;<host_name>;<service_name> (2) |
CHANGE_HOST_EVENT_HANDLER | ;<host_name>;<event_command_name> (2) |
CHANGE_SVC_EVENT_HANDLER | ;<host_name>;<service_name>;<event_command_name> (3) |
CHANGE_HOST_CHECK_COMMAND | ;<host_name>;<check_command_name> (2) |
CHANGE_SVC_CHECK_COMMAND | ;<host_name>;<service_name>;<check_command_name> (3) |
CHANGE_MAX_HOST_CHECK_ATTEMPTS | ;<host_name>;<check_attempts> (2) |
CHANGE_MAX_SVC_CHECK_ATTEMPTS | ;<host_name>;<service_name>;<check_attempts> (3) |
CHANGE_HOST_CHECK_TIMEPERIOD | ;<host_name>;<timeperiod_name> (2) |
CHANGE_SVC_CHECK_TIMEPERIOD | ;<host_name>;<service_name>;<timeperiod_name> |
CHANGE_CUSTOM_HOST_VAR | ;<host_name>;<var_name>;<var_value> (3) |
CHANGE_CUSTOM_SVC_VAR | ;<host_name>;<service_name>;<var_name>;<var_value> (4) |
CHANGE_CUSTOM_USER_VAR | ;<user_name>;<var_name>;<var_value> (3) |
CHANGE_CUSTOM_CHECKCOMMAND_VAR | ;<check_command_name>;<var_name>;<var_value> (3) |
CHANGE_CUSTOM_EVENTCOMMAND_VAR | ;<event_command_name>;<var_name>;<var_value> (3) |
CHANGE_CUSTOM_NOTIFICATIONCOMMAND_VAR | ;<notification_command_name>;<var_name>;<var_value> (3) |
ENABLE_HOSTGROUP_HOST_NOTIFICATIONS | ;<hostgroup_name> (1) |
ENABLE_HOSTGROUP_SVC_NOTIFICATIONS | ;<hostgroup_name> (1) |
DISABLE_HOSTGROUP_HOST_NOTIFICATIONS | ;<hostgroup_name> (1) |
DISABLE_HOSTGROUP_SVC_NOTIFICATIONS | ;<hostgroup_name> (1) |
ENABLE_SERVICEGROUP_HOST_NOTIFICATIONS | ;<servicegroup_name> (1) |
DISABLE_SERVICEGROUP_HOST_NOTIFICATIONS | ;<servicegroup_name> (1) |
ENABLE_SERVICEGROUP_SVC_NOTIFICATIONS | ;<servicegroup_name> (1) |
DISABLE_SERVICEGROUP_SVC_NOTIFICATIONS | ;<servicegroup_name> (1) |

70
doc/8-differences-between-icinga-1x-and-2.md
View File

@ -165,24 +165,15 @@ account by Icinga 1.x Classic UI and Web.
## <a id="differences-1x-2-custom-attributes"></a> Custom Attributes
Icinga 2 allows you to define custom attributes in the `vars` dictionary.
### <a id="differences-1x-2-action-url-notes-url-notes"></a> Action Url, Notes Url, Notes
Icinga 1.x objects support configuration attributes not required as runtime
values but for external resources such as Icinga 1.x Classic UI or Web.
The `notes`, `notes_url`, `action_url`, `icon_image`, `icon_image_alt`
attributes for host and service objects, additionally `statusmap_image` and
`2d_coords` for the host's representation in status maps.
attributes for host and service objects are still available in Icinga 2.
### <a id="differences-1x-2-action-url-notes-url-notes"></a> Statusmap Image, 2D Coords
These attributes can be set using the `vars` dictionary in Icinga 2 `Host`
or `Service` objects:
vars = {
notes = "Icinga 2 is the best!"
notes_url = "http://docs.icinga.org"
action_url = "http://dev.icinga.org"
icon_image = "../../images/logos/Stats2.png"
icon_image_alt = "icinga2 alt icon text"
"2d_coords" = "1,2"
statusmap_image = "../../images/logos/icinga.gif"
}
@ -227,8 +218,6 @@ and their users.
## <a id="differences-1x-2-macros"></a> Macros
TODO
Various object attributes and runtime variables can be accessed as macros in
commands in Icinga 1.x - Icinga 2 supports all required [custom attributes](#custom-attributes).
@ -270,8 +259,6 @@ With the freely definable custom attributes in Icinga 2 it looks like this:
### <a id="differences-1x-2-environment-macros"></a> Environment Macros
TODO
The global configuration setting `enable_environment_macros` does not exist in
Icinga 2.
@ -353,6 +340,57 @@ Changes to global runtime macros:
TIME | icinga.time
## <a id="differences-1x-2-external-commands"></a> External Commands
`CHANGE_CUSTOM_CONTACT_VAR` was renamed to `CHANGE_CUSTOM_USER_VAR`.
The following external commands are not supported:
CHANGE_CONTACT_HOST_NOTIFICATION_TIMEPERIOD
CHANGE_HOST_NOTIFICATION_TIMEPERIOD
CHANGE_SVC_NOTIFICATION_TIMEPERIOD
DEL_DOWNTIME_BY_HOSTGROUP_NAME
DEL_DOWNTIME_BY_START_TIME_COMMENT
DISABLE_ALL_NOTIFICATIONS_BEYOND_HOST
DISABLE_CONTACT_HOST_NOTIFICATIONS
DISABLE_CONTACT_SVC_NOTIFICATIONS
DISABLE_CONTACTGROUP_HOST_NOTIFICATIONS
DISABLE_CONTACTGROUP_SVC_NOTIFICATIONS
DISABLE_FAILURE_PREDICTION
DISABLE_HOST_AND_CHILD_NOTIFICATIONS
DISABLE_HOST_FRESHNESS_CHECKS
DISABLE_HOST_SVC_NOTIFICATIONS
DISABLE_NOTIFICATIONS_EXPIRE_TIME
DISABLE_SERVICE_FRESHNESS_CHECKS
ENABLE_ALL_NOTIFICATIONS_BEYOND_HOST
ENABLE_CONTACT_HOST_NOTIFICATIONS
ENABLE_CONTACT_SVC_NOTIFICATIONS
ENABLE_CONTACTGROUP_HOST_NOTIFICATIONS
ENABLE_CONTACTGROUP_SVC_NOTIFICATIONS
ENABLE_FAILURE_PREDICTION
ENABLE_HOST_AND_CHILD_NOTIFICATIONS
ENABLE_HOST_FRESHNESS_CHECKS
ENABLE_HOST_SVC_NOTIFICATIONS
ENABLE_SERVICE_FRESHNESS_CHECKS
READ_STATE_INFORMATION
SAVE_STATE_INFORMATION
SCHEDULE_AND_PROPAGATE_HOST_DOWNTIME
SCHEDULE_AND_PROPAGATE_TRIGGERED_HOST_DOWNTIME
SET_HOST_NOTIFICATION_NUMBER
SET_SVC_NOTIFICATION_NUMBER
START_ACCEPTING_PASSIVE_HOST_CHECKS
START_ACCEPTING_PASSIVE_SVC_CHECKS
START_OBSESSING_OVER_HOST
START_OBSESSING_OVER_HOST_CHECKS
START_OBSESSING_OVER_SVC
START_OBSESSING_OVER_SVC_CHECKS
STOP_ACCEPTING_PASSIVE_HOST_CHECKS
STOP_ACCEPTING_PASSIVE_SVC_CHECKS
STOP_OBSESSING_OVER_HOST
STOP_OBSESSING_OVER_HOST_CHECKS
STOP_OBSESSING_OVER_SVC
STOP_OBSESSING_OVER_SVC_CHECKS
## <a id="differences-1x-2-checks"></a> Checks
### <a id="differences-1x-2-check-output"></a> Check Output