1 # <a id="appendix"></a> Appendix
3 ## <a id="external-commands-list-detail"></a> External Commands List
5 Additional details can be found in the [Icinga 1.x Documentation](http://docs.icinga.org/latest/en/extcommands2.html)
7 Command name | Parameters | Description
8 ------------------------------------------|-----------------------------------|--------------------------
9 PROCESS_HOST_CHECK_RESULT | ;<host_name>;<status_code>;<plugin_output> (3) | -
10 PROCESS_SERVICE_CHECK_RESULT | ;<host_name>;<service_name>;<return_code>;<plugin_output> (4) | -
11 SCHEDULE_HOST_CHECK | ;<host_name>;<check_time> (2) | -
12 SCHEDULE_FORCED_HOST_CHECK | ;<host_name>;<check_time> (2) | -
13 SCHEDULE_SVC_CHECK | ;<host_name>;<service_name>;<check_time> (3) | -
14 SCHEDULE_FORCED_SVC_CHECK | ;<host_name>;<service_name>;<check_time> (3) | -
15 ENABLE_HOST_CHECK | ;<host_name> (1) | -
16 DISABLE_HOST_CHECK | ;<host_name> (1) | -
17 ENABLE_SVC_CHECK | ;<host_name>;<service_name> (2) | -
18 DISABLE_SVC_CHECK | ;<host_name>;<service_name> (2) | -
19 SHUTDOWN_PROCESS | - | -
20 RESTART_PROCESS | - | -
21 SCHEDULE_FORCED_HOST_SVC_CHECKS | ;<host_name>;<check_time> (2) | -
22 SCHEDULE_HOST_SVC_CHECKS | ;<host_name>;<check_time> (2) | -
23 ENABLE_HOST_SVC_CHECKS | ;<host_name> (1) | -
24 DISABLE_HOST_SVC_CHECKS | ;<host_name> (1) | -
25 ACKNOWLEDGE_SVC_PROBLEM | ;<host_name>;<service_name>;<sticky>;<notify>;<persistent>;<author>;<comment> (7) | Note: Icinga 2 treats all comments as persistent.
26 ACKNOWLEDGE_SVC_PROBLEM_EXPIRE | ;<host_name>;<service_name>;<sticky>;<notify>;<persistent>;<timestamp>;<author>;<comment> (8) | Note: Icinga 2 treats all comments as persistent.
27 REMOVE_SVC_ACKNOWLEDGEMENT | ;<host_name>;<service_name> (2) | -
28 ACKNOWLEDGE_HOST_PROBLEM | ;<host_name>;<sticky>;<notify>;<persistent>;<author>;<comment> (6) | Note: Icinga 2 treats all comments as persistent.
29 ACKNOWLEDGE_HOST_PROBLEM_EXPIRE | ;<host_name>;<sticky>;<notify>;<persistent>;<timestamp>;<author>;<comment> (7) | Note: Icinga 2 treats all comments as persistent.
30 REMOVE_HOST_ACKNOWLEDGEMENT | ;<host_name> (1) | -
31 DISABLE_HOST_FLAP_DETECTION | ;<host_name> (1) | -
32 ENABLE_HOST_FLAP_DETECTION | ;<host_name> (1) | -
33 DISABLE_SVC_FLAP_DETECTION | ;<host_name>;<service_name> (2) | -
34 ENABLE_SVC_FLAP_DETECTION | ;<host_name>;<service_name> (2) | -
35 ENABLE_HOSTGROUP_SVC_CHECKS | ;<hostgroup_name> (1) | -
36 DISABLE_HOSTGROUP_SVC_CHECKS | ;<hostgroup_name> (1) | -
37 ENABLE_SERVICEGROUP_SVC_CHECKS | ;<servicegroup_name> (1) | -
38 DISABLE_SERVICEGROUP_SVC_CHECKS | ;<servicegroup_name> (1) | -
39 ENABLE_PASSIVE_HOST_CHECKS | ;<host_name> (1) | -
40 DISABLE_PASSIVE_HOST_CHECKS | ;<host_name> (1) | -
41 ENABLE_PASSIVE_SVC_CHECKS | ;<host_name>;<service_name> (2) | -
42 DISABLE_PASSIVE_SVC_CHECKS | ;<host_name>;<service_name> (2) | -
43 ENABLE_SERVICEGROUP_PASSIVE_SVC_CHECKS | ;<servicegroup_name> (1) | -
44 DISABLE_SERVICEGROUP_PASSIVE_SVC_CHECKS | ;<servicegroup_name> (1) | -
45 ENABLE_HOSTGROUP_PASSIVE_SVC_CHECKS | ;<hostgroup_name> (1) | -
46 DISABLE_HOSTGROUP_PASSIVE_SVC_CHECKS | ;<hostgroup_name> (1) | -
47 PROCESS_FILE | ;<file_name>;<delete> (2) | -
48 SCHEDULE_SVC_DOWNTIME | ;<host_name>;<service_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (9) | -
49 DEL_SVC_DOWNTIME | ;<downtime_id> (1) | -
50 SCHEDULE_HOST_DOWNTIME | ;<host_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) | -
51 DEL_HOST_DOWNTIME | ;<downtime_id> (1) | -
52 SCHEDULE_HOST_SVC_DOWNTIME | ;<host_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) | -
53 SCHEDULE_HOSTGROUP_HOST_DOWNTIME | ;<hostgroup_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) | -
54 SCHEDULE_HOSTGROUP_SVC_DOWNTIME | ;<hostgroup_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) | -
55 SCHEDULE_SERVICEGROUP_HOST_DOWNTIME | ;<servicegroup_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) | -
56 SCHEDULE_SERVICEGROUP_SVC_DOWNTIME | ;<servicegroup_name>;<start_time>;<end_time>;<fixed>;<trigger_id>;<duration>;<author>;<comment> (8) | -
57 ADD_HOST_COMMENT | ;<host_name>;<persistent>;<author>;<comment> (4) | Note: Icinga 2 treats all comments as persistent.
58 DEL_HOST_COMMENT | ;<comment_id> (1) | -
59 ADD_SVC_COMMENT | ;<host_name>;<service_name>;<persistent>;<author>;<comment> (5) | Note: Icinga 2 treats all comments as persistent.
60 DEL_SVC_COMMENT | ;<comment_id> (1) | -
61 DEL_ALL_HOST_COMMENTS | ;<host_name> (1) | -
62 DEL_ALL_SVC_COMMENTS | ;<host_name>;<service_name> (2) | -
63 SEND_CUSTOM_HOST_NOTIFICATION | ;<host_name>;<options>;<author>;<comment> (4) | -
64 SEND_CUSTOM_SVC_NOTIFICATION | ;<host_name>;<service_name>;<options>;<author>;<comment> (5) | -
65 DELAY_HOST_NOTIFICATION | ;<host_name>;<notification_time> (2) | -
66 DELAY_SVC_NOTIFICATION | ;<host_name>;<service_name>;<notification_time> (3) | -
67 ENABLE_HOST_NOTIFICATIONS | ;<host_name> (1) | -
68 DISABLE_HOST_NOTIFICATIONS | ;<host_name> (1) | -
69 ENABLE_SVC_NOTIFICATIONS | ;<host_name>;<service_name> (2) | -
70 DISABLE_SVC_NOTIFICATIONS | ;<host_name>;<service_name> (2) | -
71 ENABLE_HOST_SVC_NOTIFICATIONS | ;<host_name> (1) | -
72 DISABLE_HOST_SVC_NOTIFICATIONS | ;<host_name> (1) | -
73 DISABLE_HOSTGROUP_HOST_CHECKS | ;<hostgroup_name> (1) | -
74 DISABLE_HOSTGROUP_PASSIVE_HOST_CHECKS | ;<hostgroup_name> (1) | -
75 DISABLE_SERVICEGROUP_HOST_CHECKS | ;<servicegroup_name> (1) | -
76 DISABLE_SERVICEGROUP_PASSIVE_HOST_CHECKS | ;<servicegroup_name> (1) | -
77 ENABLE_HOSTGROUP_HOST_CHECKS | ;<hostgroup_name> (1) | -
78 ENABLE_HOSTGROUP_PASSIVE_HOST_CHECKS | ;<hostgroup_name> (1) | -
79 ENABLE_SERVICEGROUP_HOST_CHECKS | ;<servicegroup_name> (1) | -
80 ENABLE_SERVICEGROUP_PASSIVE_HOST_CHECKS | ;<servicegroup_name> (1) | -
81 ENABLE_NOTIFICATIONS | - | -
82 DISABLE_NOTIFICATIONS | - | -
83 ENABLE_FLAP_DETECTION | - | -
84 DISABLE_FLAP_DETECTION | - | -
85 ENABLE_EVENT_HANDLERS | - | -
86 DISABLE_EVENT_HANDLERS | - | -
87 ENABLE_PERFORMANCE_DATA | - | -
88 DISABLE_PERFORMANCE_DATA | - | -
89 START_EXECUTING_HOST_CHECKS | - | -
90 STOP_EXECUTING_HOST_CHECKS | - | -
91 START_EXECUTING_SVC_CHECKS | - | -
92 STOP_EXECUTING_SVC_CHECKS | - | -
93 CHANGE_SVC_MODATTR | ;<host_name>;<service_name>;<value> (3) | -
94 CHANGE_HOST_MODATTR | ;<host_name>;<value> (2) | -
95 CHANGE_USER_MODATTR | ;<user_name>;<value> (2) | -
96 CHANGE_CHECKCOMMAND_MODATTR | ;<checkcommand_name>;<value> (2) | -
97 CHANGE_EVENTCOMMAND_MODATTR | ;<eventcommand_name>;<value> (2) | -
98 CHANGE_NOTIFICATIONCOMMAND_MODATTR | ;<notificationcommand_name>;<value> (2) | -
99 CHANGE_NORMAL_SVC_CHECK_INTERVAL | ;<host_name>;<service_name>;<check_interval> (3) | -
100 CHANGE_NORMAL_HOST_CHECK_INTERVAL | ;<host_name>;<check_interval> (2) | -
101 CHANGE_RETRY_SVC_CHECK_INTERVAL | ;<host_name>;<service_name>;<check_interval> (3) | -
102 CHANGE_RETRY_HOST_CHECK_INTERVAL | ;<host_name>;<check_interval> (2) | -
103 ENABLE_HOST_EVENT_HANDLER | ;<host_name> (1) | -
104 DISABLE_HOST_EVENT_HANDLER | ;<host_name> (1) | -
105 ENABLE_SVC_EVENT_HANDLER | ;<host_name>;<service_name> (2) | -
106 DISABLE_SVC_EVENT_HANDLER | ;<host_name>;<service_name> (2) | -
107 CHANGE_HOST_EVENT_HANDLER | ;<host_name>;<event_command_name> (2) | -
108 CHANGE_SVC_EVENT_HANDLER | ;<host_name>;<service_name>;<event_command_name> (3) | -
109 CHANGE_HOST_CHECK_COMMAND | ;<host_name>;<check_command_name> (2) | -
110 CHANGE_SVC_CHECK_COMMAND | ;<host_name>;<service_name>;<check_command_name> (3) | -
111 CHANGE_MAX_HOST_CHECK_ATTEMPTS | ;<host_name>;<check_attempts> (2) | -
112 CHANGE_MAX_SVC_CHECK_ATTEMPTS | ;<host_name>;<service_name>;<check_attempts> (3) | -
113 CHANGE_HOST_CHECK_TIMEPERIOD | ;<host_name>;<timeperiod_name> (2) | -
114 CHANGE_SVC_CHECK_TIMEPERIOD | ;<host_name>;<service_name>;<timeperiod_name> | -
115 CHANGE_CUSTOM_HOST_VAR | ;<host_name>;<var_name>;<var_value> (3) | -
116 CHANGE_CUSTOM_SVC_VAR | ;<host_name>;<service_name>;<var_name>;<var_value> (4) | -
117 CHANGE_CUSTOM_USER_VAR | ;<user_name>;<var_name>;<var_value> (3) | -
118 CHANGE_CUSTOM_CHECKCOMMAND_VAR | ;<check_command_name>;<var_name>;<var_value> (3) | -
119 CHANGE_CUSTOM_EVENTCOMMAND_VAR | ;<event_command_name>;<var_name>;<var_value> (3) | -
120 CHANGE_CUSTOM_NOTIFICATIONCOMMAND_VAR | ;<notification_command_name>;<var_name>;<var_value> (3) | -
121 ENABLE_HOSTGROUP_HOST_NOTIFICATIONS | ;<hostgroup_name> (1) | -
122 ENABLE_HOSTGROUP_SVC_NOTIFICATIONS | ;<hostgroup_name> (1) | -
123 DISABLE_HOSTGROUP_HOST_NOTIFICATIONS | ;<hostgroup_name> (1) | -
124 DISABLE_HOSTGROUP_SVC_NOTIFICATIONS | ;<hostgroup_name> (1) | -
125 ENABLE_SERVICEGROUP_HOST_NOTIFICATIONS | ;<servicegroup_name> (1) | -
126 DISABLE_SERVICEGROUP_HOST_NOTIFICATIONS | ;<servicegroup_name> (1) | -
127 ENABLE_SERVICEGROUP_SVC_NOTIFICATIONS | ;<servicegroup_name> (1) | -
128 DISABLE_SERVICEGROUP_SVC_NOTIFICATIONS | ;<servicegroup_name> (1) | -
131 ## <a id="schemas"></a> Schemas
133 By convention `CheckCommand`, `EventCommand`, and `NotificationCommand` objects
134 are exported using a prefix. This is mandatory for unique objects in the
138 ------------------------|------------------------
139 CheckCommand | check_
140 EventCommand | event_
141 NotificationCommand | notification_
143 ### <a id="schema-status-files"></a> Status Files
145 Status files used by Icinga 1.x Classic UI: `status.dat`, `objects.cache`.
147 Icinga 2 specific extensions:
149 * host and service objects support 'check_source' (added in Classic UI 1.10.0)
150 * command objects support custom variables (added in Classic UI 1.11.2)
151 * host and service objects support 'is_reachable' (added in Classic UI 1.11.3)
152 * 2.2 adds custom attributes with arrays and dictionaries. They are dumped as JSON encoded string and `_is_json`
153 is set as additional custom variable in `objects.cache`.
155 ### <a id="schema-db-ido"></a> DB IDO Schema
157 There is a detailed documentation for the Icinga IDOUtils 1.x
158 database schema available on [http://docs.icinga.org/latest/en/db_model.html]
160 #### <a id="schema-db-ido-extensions"></a> DB IDO Schema Extensions
162 Icinga 2 specific extensions are shown below:
164 New tables: `endpoints`, `endpointstatus`
166 Table | Column | Type | Default | Description
167 --------------------|--------------------|----------|---------|-------------
168 endpoints | endpoint_object_id | bigint | NULL | FK: objects table
169 endpoints | identity | TEXT | NULL | endpoint name
170 endpoints | node | TEXT | NULL | local node name
172 Table | Column | Type | Default | Description
173 --------------------|--------------------|----------|---------|-------------
174 endpointstatus | endpoint_object_id | bigint | NULL | FK: objects table
175 endpointstatus | identity | TEXT | NULL | endpoint name
176 endpointstatus | node | TEXT | NULL | local node name
177 endpointstatus | is_connected | smallint | 0 | update on endpoint connect/disconnect
181 Table | Column | Type | Default | Description
182 --------------------|-------------------------|----------|---------|-------------
183 all status/history | endpoint_object_id | bigint | NULL | FK: objects table
184 servicestatus | check_source | TEXT | NULL | node name where check was executed
185 hoststatus | check_source | TEXT | NULL | node name where check was executed
186 statehistory | check_source | TEXT | NULL | node name where check was executed
187 servicestatus | is_reachable | integer | NULL | object reachability
188 hoststatus | is_reachable | integer | NULL | object reachability
189 logentries | object_id | bigint | NULL | FK: objects table (service associated with column)
190 {host,service}group | notes | TEXT | NULL | -
191 {host,service}group | notes_url | TEXT | NULL | -
192 {host,service}group | action_url | TEXT | NULL | -
193 customvariable* | is_json | integer | 0 | Defines whether `varvalue` is a json encoded string from custom attributes, or not
195 Additional command custom variables populated from 'vars' dictionary.
196 Additional global custom variables populated from 'Vars' constant (object_id is NULL).
198 ### <a id="schema-livestatus"></a> Livestatus Schema
200 #### <a id="schema-livestatus-extensions"></a> Livestatus Schema Extensions
202 Icinga 2 specific extensions are shown below:
204 New table: `endpoints`
207 ----------|--------------
211 endpoints | is_connected
216 ----------|--------------
218 services | is_reachable
220 services | cv_is_json
221 contacts | cv_is_json
223 services | check_source
225 downtimes | trigger_time
226 commands | custom_variable_names
227 commands | custom_variable_values
228 commands | custom_variables
229 commands | modified_attributes
230 commands | modified_attributes_list
231 status | custom_variable_names
232 status | custom_variable_values
233 status | custom_variables
235 Command custom variables reflect the local 'vars' dictionary.
236 Status custom variables reflect the global 'Vars' constant.
238 #### <a id="schema-livestatus-hosts-table-attributes"></a> Livestatus Hosts Table Attributes
241 ----------------------|-----------|-------------------------
243 display_name | string | .
244 alias | string | same as display_name.
246 address6 | string | NEW in Icinga.
247 check_command | string | .
248 check_command_expanded | string | .
249 event_handler | string | .
250 notification_period | string | host with notifications: period.
251 check_period | string | .
253 notes_expanded | string | .
254 notes_url | string | .
255 notes_url_expanded | string | .
256 action_url | string | .
257 action_url_expanded | string | .
258 plugin_output | string | .
259 perf_data | string | .
260 icon_image | string | .
261 icon_image_expanded | string | .
262 icon_image_alt | stirng | .
263 statusmap_image | string | .
264 long_plugin_output | string | .
265 max_check_attempts | int | .
266 flap_detection_enabled | int | .
267 check_freshness | int | .
268 process_performance_data | int | .
269 accept_passive_checks | int | .
270 event_handler_enabled | int | .
271 acknowledgement_type | int | Only 0 or 1.
274 last_hard_state | int | .
275 current_attempt | int | .
276 last_notification | int | host with notifications: last notification.
277 next_notification | int | host with notifications: next notification.
279 last_hard_state_change | int | .
280 has_been_checked | int | .
281 current_notification_number | int | host with notifications: number.
282 total_services | int | .
283 checks_enabled | int | .
284 notifications_enabled | int | .
285 acknowledged | int | .
288 no_more_notifications | int | notification_interval == 0 && volatile == false.
290 last_state_change | int | .
291 last_time_up | int | .
292 last_time_down | int | .
293 last_time_unreachable | int | .
294 is_flapping | int | .
295 scheduled_downtime_depth | int | .
296 active_checks_enabled | int | .
297 modified_attributes | array | .
298 modified_attributes_list | array | .
299 check_interval | double | .
300 retry_interval | double | .
301 notification_interval | double | host with notifications: smallest interval.
302 low_flap_threshold | double | flapping_threshold
303 high_flap_threshold | double | flapping_threshold
305 execution_time | double | .
306 percent_state_change | double | flapping.
307 in_notification_period | int | host with notifications: matching period.
308 in_check_period | int | .
309 contacts | array | host with notifications, users and user groups.
310 downtimes | array | id.
311 downtimes_with_info | array | id+author+comment.
312 comments | array | id.
313 comments_with_info | array | id+author+comment.
314 comments_with_extra_info | array | id+author+comment+entry_type+entry_time.
315 custom_variable_names | array | .
316 custom_variable_values | array | .
317 custom_variables | array | Array of custom variable array pair.
318 parents | array | Direct host parents.
319 childs | array | Direct host children (Note: `childs` is inherited from the origin MK_Livestatus protocol).
320 num_services | int | .
321 worst_service_state | int | All services and their worst state.
322 num_services_ok | int | All services with Ok state.
323 num_services_warn | int | All services with Warning state.
324 num_services_crit | int | All services with Critical state.
325 num_services_unknown | int | All services with Unknown state.
326 worst_service_hard_state | int | All services and their worst hard state.
327 num_services_hard_ok | int | All services in a hard state with Ok state.
328 num_services_hard_warn | int | All services in a hard state with Warning state.
329 num_services_hard_crit | int | All services in a hard state with Critical state.
330 num_services_hard_unknown | int | All services in a hard state with Unknown state.
331 hard_state | int | Returns OK, if state is OK. Returns current state if now a hard state type. Returns last hard state otherwise.
332 staleness | int | Indicates time since last check normalized onto the check_interval.
333 groups | array | All hostgroups this host is a member of.
334 contact_groups | array | All usergroups associated with this host through notifications.
335 services | array | All services associated with this host.
336 services_with_state | array | All services associated with this host with state and hasbeenchecked.
337 services_with_info | array | All services associated with this host with state, hasbeenchecked and output.
339 Not supported: `initial_state`, `pending_flex_downtime`, `check_flapping_recovery_notification`,
340 `is_executing`, `check_options`, `obsess_over_host`, `first_notification_delay`, `x_3d`, `y_3d`, `z_3d`,
341 `x_2d`, `y_2d`, `filename`, `pnpgraph_present`.
343 #### <a id="schema-livestatus-hostgroups-table-attributes"></a> Livestatus Hostgroups Table Attributes
346 ----------------------|-----------|-------------------------
348 alias | string | `display_name` attribute.
350 notes_url | string | .
351 action_url | string | .
353 members_with_state | array | Host name and state.
354 worst_host_state | int | Of all group members.
355 num_hosts | int | In this group.
356 num_hosts_pending | int | .
357 num_hosts_up | int | .
358 num_hosts_down | int | .
359 num_hosts_unreach | int | .
360 num_services | int | Number of services associated with hosts in this hostgroup.
361 worst_services_state | int | .
362 num_services_pending | int | .
363 num_services_ok | int | .
364 num_services_warn | int | .
365 num_services_crit | int | .
366 num_services_unknown | int | .
367 worst_service_hard_state | int | .
368 num_services_hard_ok | int | .
369 num_services_hard_warn | int | .
370 num_services_hard_crit | int | .
371 num_services_hard_unknown | int | .
373 #### <a id="schema-livestatus-services-table-attributes"></a> Livestatus Services Table Attributes
376 ----------------------|-----------|-------------------------
377 description | string | .
378 display_name | string | .
379 alias | string | same as display_name.
380 check_command | string | .
381 check_command_expanded | string | .
382 event_handler | string | .
383 notification_period | string | host with notifications: period.
384 check_period | string | .
386 notes_expanded | string | .
387 notes_url | string | .
388 notes_url_expanded | string | .
389 action_url | string | .
390 action_url_expanded | string | .
391 plugin_output | string | .
392 perf_data | string | .
393 icon_image | string | .
394 icon_image_expanded | string | .
395 icon_image_alt | stirng | .
396 statusmap_image | string | .
397 long_plugin_output | string | .
398 max_check_attempts | int | .
399 flap_detection_enabled | int | .
400 check_freshness | int | .
401 process_performance_data | int | .
402 accept_passive_checks | int | .
403 event_handler_enabled | int | .
404 acknowledgement_type | int | Only 0 or 1.
407 last_hard_state | int | .
408 current_attempt | int | .
409 last_notification | int | service with notifications: last notification.
410 next_notification | int | service with notifications: next notification.
412 last_hard_state_change | int | .
413 has_been_checked | int | .
414 current_notification_number | int | service with notifications: number.
415 checks_enabled | int | .
416 notifications_enabled | int | .
417 acknowledged | int | .
420 no_more_notifications | int | notification_interval == 0 && volatile == false.
422 last_state_change | int | .
423 last_time_ok | int | .
424 last_time_warning | int | .
425 last_time_critical | int | .
426 last_time_unknown | int | .
427 is_flapping | int | .
428 scheduled_downtime_depth | int | .
429 active_checks_enabled | int | .
430 modified_attributes | array | .
431 modified_attributes_list | array | .
432 check_interval | double | .
433 retry_interval | double | .
434 notification_interval | double | service with notifications: smallest interval.
435 low_flap_threshold | double | flapping_threshold
436 high_flap_threshold | double | flapping_threshold
438 execution_time | double | .
439 percent_state_change | double | flapping.
440 in_notification_period | int | service with notifications: matching period.
441 in_check_period | int | .
442 contacts | array | service with notifications, users and user groups.
443 downtimes | array | id.
444 downtimes_with_info | array | id+author+comment.
445 comments | array | id.
446 comments_with_info | array | id+author+comment.
447 comments_with_extra_info | array | id+author+comment+entry_type+entry_time.
448 custom_variable_names | array | .
449 custom_variable_values | array | .
450 custom_variables | array | Array of custom variable array pair.
451 hard_state | int | Returns OK, if state is OK. Returns current state if now a hard state type. Returns last hard state otherwise.
452 staleness | int | Indicates time since last check normalized onto the check_interval.
453 groups | array | All hostgroups this host is a member of.
454 contact_groups | array | All usergroups associated with this host through notifications.
455 host_ | join | Prefix for attributes from implicit join with hosts table.
457 Not supported: `initial_state`, `is_executing`, `check_options`, `obsess_over_service`, `first_notification_delay`,
460 #### <a id="schema-livestatus-servicegroups-table-attributes"></a> Livestatus Servicegroups Table Attributes
463 ----------------------|-----------|-------------------------
465 alias | string | `display_name` attribute.
467 notes_url | string | .
468 action_url | string | .
469 members | array | CSV format uses `host|service` syntax.
470 members_with_state | array | Host, service, hoststate, servicestate.
471 worst_service_state | int | .
472 num_services | int | .
473 num_services_pending | int | .
474 num_services_ok | int | .
475 num_services_warn | int | .
476 num_services_crit | int | .
477 num_services_unknown | int | .
478 num_services_hard_ok | int | .
479 num_services_hard_warn | int | .
480 num_services_hard_crit | int | .
481 num_services_hard_unknown | int | .
483 #### <a id="schema-livestatus-contacts-table-attributes"></a> Livestatus Contacts Table Attributes
486 ----------------------|-----------|-------------------------
488 alias | string | `display_name` attribute.
491 host_notification_period | string | .
492 service_notification_period | string | .
493 host_notifications_enabled | int | .
494 service_notifications_enabled | int | .
495 in_host_notification_period | int | .
496 in_service_notification_period | int | .
497 custom_variable_names | array | .
498 custom_variable_values | array | .
499 custom_variables | array | Array of customvariable array pairs.
500 modified_attributes | array | .
501 modified_attributes_list | array | .
504 Not supported: `can_submit_commands`.
506 #### <a id="schema-livestatus-contactgroups-table-attributes"></a> Livestatus Contactgroups Table Attributes
509 ----------------------|-----------|-------------------------
511 alias | string | `display_name` attribute.
515 #### <a id="schema-livestatus-commands-table-attributes"></a> Livestatus Commands Table Attributes
518 ----------------------|-----------|-------------------------
519 name | string | 3 types of commands in Icinga 2.
523 #### <a id="schema-livestatus-status-table-attributes"></a> Livestatus Status Table Attributes
526 ----------------------|-----------|-------------------------
527 connections | int | Since application start.
528 connections_rate | double | .
529 service_checks | int | Since application start.
530 service_checks_rate | double | .
531 host_checks | int | Since application start.
532 host_checks_rate | double | .
533 external_commands | int | Since application start.
534 external_commands_rate | double | .
535 nagios_pid | string | Application PID.
536 enable_notifications | int | .
537 execute_service_checks | int | .
538 accept_passive_service_checks | int | .
539 execute_host_checks | int | .
540 accept_passive_host_checks | int | .
541 enable_event_handlers | int | .
542 check_service_freshness | int | .
543 check_host_freshness | int | .
544 enable_flap_detection | int | .
545 process_performance_data | int | .
546 check_external_commands | int | Always enabled.
547 program_start | int | In seconds.
548 last_command_check | int | Always.
549 interval_length | int | Compatibility mode: 60.
551 num_services | int | .
552 program_version | string | 2.0.
553 livestatus_active_connections | string | .
555 Not supported: `neb_callbacks`, `neb_callbacks_rate`, `requests`, `requests_rate`, `forks`, `forks_rate`,
556 `log_messages`, `log_messages_rate`, `livechecks`, `livechecks_rate`, `livecheck_overflows`,
557 `livecheck_overflows_rate`, `obsess_over_services`, `obsess_over_hosts`, `last_log_rotation`,
558 `external_command_buffer_slots`, `external_command_buffer_usage`, `external_command_buffer_max`,
559 `cached_log_messages`, `livestatus_queued_connections`, `livestatus_threads`.
562 #### <a id="schema-livestatus-comments-table-attributes"></a> Livestatus Comments Table Attributes
565 ----------------------|-----------|-------------------------
568 id | int | legacy_id.
569 entry_time | string | Seconds.
570 type | int | 1=host, 2=service.
572 persistent | int | Always.
573 source | string | Always external (1).
576 expire_time | string | Seconds.
577 service_ | join | Prefix for attributes from implicit join with services table.
578 host_ | join | Prefix for attributes from implicit join with hosts table.
581 #### <a id="schema-livestatus-downtimes-table-attributes"></a> Livestatus Downtimes Table Attributes
584 ----------------------|-----------|-------------------------
587 id | int | legacy_id.
588 entry_time | string | Seconds.
589 type | int | 1=active, 0=pending.
591 start_time | string | Seconds.
592 end_time | string | Seconds.
593 fixed | int | 0=flexible, 1=fixed.
595 triggered_by | int | legacy_id.
596 triggers | int | NEW in Icinga 2.
597 trigger_time | string | NEW in Icinga 2.
598 service_ | join | Prefix for attributes from implicit join with services table.
599 host_ | join | Prefix for attributes from implicit join with hosts table.
602 #### <a id="schema-livestatus-timeperiod-table-attributes"></a> Livestatus Timeperiod Table Attributes
605 ----------------------|-----------|-------------------------
607 alias | string | `display_name` attribute.
608 in | int | Current time is in timeperiod or not.
610 #### <a id="schema-livestatus-log-table-attributes"></a> Livestatus Log Table Attributes
613 ----------------------|-----------|-------------------------
614 time | int | Time of log event (unix timestamp).
615 lineno | int | Line number in `CompatLogger` log file.
616 class | int | Log message class: 0=info, 1=state, 2=program, 3=notification, 4=passive, 5=command.
617 message | string | Complete message line.
618 type | string | Text before the colon `:`.
619 options | string | Text after the colon `:`.
620 comment | string | Comment if available.
621 plugin_output | string | Check output if available.
622 state | int | Host or service state.
623 state_type | int | State type if available.
624 attempt | int | Current check attempt.
625 service_description | string | .
626 host_name | string | .
627 contact_name | string | .
628 command_name | string | .
629 current_service_ | join | Prefix for attributes from implicit join with services table.
630 current_host_ | join | Prefix for attributes from implicit join with hosts table.
631 current_contact_ | join | Prefix for attributes from implicit join with contacts table.
632 current_command_ | join | Prefix for attributes from implicit join with commands table.
634 #### <a id="schema-livestatus-statehist-table-attributes"></a> Livestatus Statehist Table Attributes
637 ----------------------|-----------|-------------------------
638 time | int | Time of log event (unix timestamp).
639 lineno | int | Line number in `CompatLogger` log file.
640 from | int | Start timestamp (unix timestamp).
641 until | int | End timestamp (unix timestamp).
642 duration | int | until-from.
643 duration_part | double | duration / query_part.
644 state | int | State: 0=ok, 1=warn, 2=crit, 3=unknown, -1=notmonitored.
645 host_down | int | Host associated with the service is down or not.
646 in_downtime | int | Host/service is in downtime.
647 in_host_downtime | int | Host associated with the service is in a downtime or not.
648 is_flapping | int | Host/service is flapping.
649 in_notification_period | int | Host/service notification periods match or not.
650 notification_period | string | Host/service notification period.
651 host_name | string | .
652 service_description | string | .
653 log_output | string | Log file output for this state.
654 duration_ok | int | until-from for OK state.
655 duration_part_ok | double | .
656 duration_warning | int | until-from for Warning state.
657 duration_part_warning | double | .
658 duration_critical | int | until-from for Critical state.
659 duration_part_critical | double | .
660 duration_unknown | int | until-from for Unknown state.
661 duration_part_unknown | double | .
662 duration_unmonitored | int | until-from for Not-Monitored state.
663 duration_part_unmonitored | double | .
664 current_service_ | join | Prefix for attributes from implicit join with services table.
665 current_host_ | join | Prefix for attributes from implicit join with hosts table.
667 Not supported: `debug_info`.
669 #### <a id="schema-livestatus-hostsbygroup-table-attributes"></a> Livestatus Hostsbygroup Table Attributes
671 All (hosts)[19-appendix.md#schema-livestatus-hosts-table-attributes] table attributes grouped with
672 the (hostgroups)[19-appendix.md#schema-livestatus-hostgroups-table-attributes] table prefixed with `hostgroup_`.
674 #### <a id="schema-livestatus-servicesbygroup-table-attributes"></a> Livestatus Servicesbygroup Table Attributes
676 All (services)[19-appendix.md#schema-livestatus-services-table-attributes] table attributes grouped with
677 the (servicegroups)[19-appendix.md#schema-livestatus-servicegroups-table-attributes] table prefixed with `servicegroup_`.
679 #### <a id="schema-livestatus-servicesbyhostgroup-table-attributes"></a> Livestatus Servicesbyhostgroup Table Attributes
681 All (services)[19-appendix.md#schema-livestatus-services-table-attributes] table attributes grouped with
682 the (hostgroups)[19-appendix.md#schema-livestatus-hostgroups-table-attributes] table prefixed with `hostgroup_`.