granicus.if.org Git - icinga2/blob - doc/16-icinga-template-library.md

   1 # <a id="icinga-template-library"></a> Icinga Template Library
   2
   3 The Icinga Template Library (ITL) implements standard templates and object
   4 definitions for commonly used services.
   5
   6 By default the ITL is included in the `icinga2.conf` configuration file:
   7
   8     include <itl>
   9
  10 ## <a id="itl-generic-templates"></a> Generic Templates
  11
  12 These templates are imported by the provided example configuration.
  13
  14 ### <a id="itl-plugin-check-command"></a> plugin-check-command
  15
  16 Command template for check plugins executed by Icinga 2.
  17
  18 The `plugin-check-command` command does not support any vars.
  19
  20 ### <a id="itl-plugin-notification-command"></a> plugin-notification-command
  21
  22 Command template for notification scripts executed by Icinga 2.
  23
  24 The `plugin-notification-command` command does not support any vars.
  25
  26 ### <a id="itl-plugin-event-command"></a> plugin-event-command
  27
  28 Command template for event handler scripts executed by Icinga 2.
  29
  30 The `plugin-event-command` command does not support any vars.
  31
  32 ## <a id="itl-check-commands"></a> Check Commands
  33
  34 These check commands are embedded into Icinga 2 and do not require any external
  35 plugin scripts.
  36
  37 ### <a id="itl-icinga"></a> icinga
  38
  39 Check command for the built-in `icinga` check. This check returns performance
  40 data for the current Icinga instance.
  41
  42 The `icinga` check command does not support any vars.
  43
  44 ### <a id="itl-icinga-cluster"></a> cluster
  45
  46 Check command for the built-in `cluster` check. This check returns performance
  47 data for the current Icinga instance and connected endpoints.
  48
  49 The `cluster` check command does not support any vars.
  50
  51 ### <a id="itl-icinga-cluster-zone"></a> cluster-zone
  52
  53 Check command for the built-in `cluster-zone` check.
  54
  55 Cluster Attributes:
  56
  57 Name         | Description
  58 -------------|---------------
  59 cluster_zone | **Optional.** The zone name. Defaults to "$host.name$".
  60
  61 # <a id="plugin-check-commands"></a> Plugin Check Commands
  62
  63 The Plugin Check Commands provides example configuration for plugin check commands
  64 provided by the Monitoring Plugins project.
  65
  66 By default the Plugin Check Commands are included in the `icinga2.conf` configuration
  67 file:
  68
  69     include <plugins>
  70
  71 The plugin check commands assume that there's a global constant named `PluginDir`
  72 which contains the path of the plugins from the Monitoring Plugins project.
  73
  74
  75 ### <a id="plugin-check-command-ping4"></a> ping4
  76
  77 Check command object for the `check_ping` plugin.
  78
  79 Custom Attributes:
  80
  81 Name            | Description
  82 ----------------|--------------
  83 ping_address    | **Optional.** The host's IPv4 address. Defaults to "$address$".
  84 ping_wrta       | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
  85 ping_wpl        | **Optional.** The packet loss warning threshold in %. Defaults to 5.
  86 ping_crta       | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
  87 ping_cpl        | **Optional.** The packet loss critical threshold in %. Defaults to 15.
  88 ping_packets    | **Optional.** The number of packets to send. Defaults to 5.
  89 ping_timeout    | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
  90
  91 ### <a id="plugin-check-command-ping6"></a> ping6
  92
  93 Check command object for the `check_ping` plugin.
  94
  95 Custom Attributes:
  96
  97 Name            | Description
  98 ----------------|--------------
  99 ping_address    | **Optional.** The host's IPv6 address. Defaults to "$address6$".
 100 ping_wrta       | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
 101 ping_wpl        | **Optional.** The packet loss warning threshold in %. Defaults to 5.
 102 ping_crta       | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
 103 ping_cpl        | **Optional.** The packet loss critical threshold in %. Defaults to 15.
 104 ping_packets    | **Optional.** The number of packets to send. Defaults to 5.
 105 ping_timeout    | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
 106
 107 ### <a id="plugin-check-command-hostalive"></a> hostalive
 108
 109 Check command object for the `check_ping` plugin with host check default values.
 110
 111 Custom Attributes:
 112
 113 Name            | Description
 114 ----------------|--------------
 115 ping_address    | **Optional.** The host's IPv4 address. Defaults to "$address$".
 116 ping_wrta       | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
 117 ping_wpl        | **Optional.** The packet loss warning threshold in %. Defaults to 80.
 118 ping_crta       | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
 119 ping_cpl        | **Optional.** The packet loss critical threshold in %. Defaults to 100.
 120 ping_packets    | **Optional.** The number of packets to send. Defaults to 5.
 121 ping_timeout    | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
 122
 123 ### <a id="plugin-check-command-fping4"></a> fping4
 124
 125 Check command object for the `check_fping` plugin.
 126
 127 Custom Attributes:
 128
 129 Name            | Description
 130 ----------------|--------------
 131 fping_address   | **Optional.** The host's IPv4 address. Defaults to "$address$".
 132 fping_wrta      | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
 133 fping_wpl       | **Optional.** The packet loss warning threshold in %. Defaults to 5.
 134 fping_crta      | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
 135 fping_cpl       | **Optional.** The packet loss critical threshold in %. Defaults to 15.
 136 fping_number    | **Optional.** The number of packets to send. Defaults to 5.
 137 fping_interval  | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
 138 fping_bytes     | **Optional.** The size of ICMP packet.
 139 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
 140 fping_source_ip | **Optional.** The name or ip address of the source ip.
 141 fping_source_interface | **Optional.** The source interface name.
 142
 143 ### <a id="plugin-check-command-fping6"></a> fping6
 144
 145 Check command object for the `check_fping` plugin.
 146
 147 Custom Attributes:
 148
 149 Name            | Description
 150 ----------------|--------------
 151 fping_address   | **Optional.** The host's IPv6 address. Defaults to "$address6$".
 152 fping_wrta      | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
 153 fping_wpl       | **Optional.** The packet loss warning threshold in %. Defaults to 5.
 154 fping_crta      | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
 155 fping_cpl       | **Optional.** The packet loss critical threshold in %. Defaults to 15.
 156 fping_number    | **Optional.** The number of packets to send. Defaults to 5.
 157 fping_interval  | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
 158 fping_bytes     | **Optional.** The size of ICMP packet.
 159 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
 160 fping_source_ip | **Optional.** The name or ip address of the source ip.
 161 fping_source_interface | **Optional.** The source interface name.
 162
 163
 164 ### <a id="plugin-check-command-dummy"></a> dummy
 165
 166 Check command object for the `check_dummy` plugin.
 167
 168 Custom Attributes:
 169
 170 Name            | Description
 171 ----------------|--------------
 172 dummy_state     | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
 173 dummy_text      | **Optional.** Plugin output. Defaults to "Check was successful.".
 174
 175 ### <a id="plugin-check-command-passive"></a> passive
 176
 177 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
 178
 179 Custom Attributes:
 180
 181 Name            | Description
 182 ----------------|--------------
 183 dummy_state     | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
 184 dummy_text      | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
 185
 186 ### <a id="plugin-check-command-tcp"></a> tcp
 187
 188 Check command object for the `check_tcp` plugin.
 189
 190 Custom Attributes:
 191
 192 Name            | Description
 193 ----------------|--------------
 194 tcp_address     | **Optional.** The host's address. Defaults to "$address$".
 195 tcp_port        | **Required.** The port that should be checked.
 196
 197 ### <a id="plugin-check-command-ssl"></a> ssl
 198
 199 Check command object for the `check_tcp` plugin, using ssl-related options.
 200
 201 Custom Attributes:
 202
 203 Name                          | Description
 204 ------------------------------|--------------
 205 ssl_address                   | **Optional.** The host's address. Defaults to "$address$".
 206 ssl_port                      | **Required.** The port that should be checked.
 207 ssl_timeout                   | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
 208 ssl_cert_valid_days_warn      | **Optional.** Warning threshold for days before the certificate will expire. When used, ssl_cert_valid_days_critical must also be set.
 209 ssl_cert_valid_days_critical  | **Optional.** Critical threshold for days before the certificate will expire. When used, ssl_cert_valid_days_warn must also be set.
 210
 211 ### <a id="plugin-check-command-udp"></a> udp
 212
 213 Check command object for the `check_udp` plugin.
 214
 215 Custom Attributes:
 216
 217 Name            | Description
 218 ----------------|--------------
 219 udp_address     | **Optional.** The host's address. Defaults to "$address$".
 220 udp_port        | **Required.** The port that should be checked.
 221
 222 ### <a id="plugin-check-command-http"></a> http
 223
 224 Check command object for the `check_http` plugin.
 225
 226 Custom Attributes:
 227
 228 Name                     | Description
 229 -------------------------|--------------
 230 http_address             | **Optional.** The host's address. Defaults to "$address".
 231 http_vhost               | **Optional.** The virtual host that should be sent in the "Host" header.
 232 http_uri                 | **Optional.** The request URI.
 233 http_port                | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
 234 http_ssl                 | **Optional.** Whether to use SSL. Defaults to false.
 235 http_sni                 | **Optional.** Whether to use SNI. Defaults to false.
 236 http_auth_pair           | **Optional.** Add 'username:password' authorization pair.
 237 http_proxy_auth_pair     | **Optional.** Add 'username:password' authorization pair for proxy.
 238 http_ignore_body         | **Optional.** Don't download the body, just the headers.
 239 http_linespan            | **Optional.** Allow regex to span newline.
 240 http_expect_body_regex   | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
 241 http_expect_body_eregi   | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
 242 http_invertregex         | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
 243 http_warn_time           | **Optional.** The warning threshold.
 244 http_critical_time       | **Optional.** The critical threshold.
 245 http_expect              | **Optional.** Comma-delimited list of strings, at least one of them is expected in the first (status) line of the server response. Default: HTTP/1.
 246 http_certificate         | **Optional.** Minimum number of days a certificate has to be valid. Port defaults to 443.
 247 http_clientcert          | **Optional.** Name of file contains the client certificate (PEM format).
 248 http_privatekey          | **Optional.** Name of file contains the private key (PEM format).
 249 http_headerstring        | **Optional.** String to expect in the response headers.
 250 http_string              | **Optional.** String to expect in the content.
 251 http_post                | **Optional.** URL encoded http POST data.
 252 http_method              | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
 253 http_maxage              | **Optional.** Warn if document is more than seconds old.
 254 http_contenttype         | **Optional.** Specify Content-Type header when POSTing.
 255 http_useragent           | **Optional.** String to be sent in http header as User Agent.
 256 http_header              | **Optional.** Any other tags to be sent in http header.
 257 http_extendedperfdata    | **Optional.** Print additional perfdata. Defaults to "false".
 258 http_onredirect          | **Optional.** How to handle redirect pages. Possible values: "ok" (default), "warning", "critical", "follow", "sticky" (like follow but stick to address), "stickyport" (like sticky but also to port)
 259 http_pagesize            | **Optional.** Minimum page size required:Maximum page size required.
 260 http_timeout             | **Optional.** Seconds before connection times out.
 261
 262
 263 ### <a id="plugin-check-command-ftp"></a> ftp
 264
 265 Check command object for the `check_ftp` plugin.
 266
 267 Custom Attributes:
 268
 269 Name               | Description
 270 -------------------|--------------
 271 ftp_address        | **Optional.** The host's address. Defaults to "$address$".
 272
 273 ### <a id="plugin-check-command-smtp"></a> smtp
 274
 275 Check command object for the `check_smtp` plugin.
 276
 277 Custom Attributes:
 278
 279 Name                 | Description
 280 ---------------------|--------------
 281 smtp_address         | **Optional.** The host's address. Defaults to "$address$".
 282 smtp_port            | **Optional.** The port that should be checked. Defaults to 25.
 283 smtp_mail_from       | **Optional.** Test a MAIL FROM command with the given email address.
 284
 285 ### <a id="plugin-check-command-ssmtp"></a> ssmtp
 286
 287 Check command object for the `check_ssmtp` plugin.
 288
 289 Custom Attributes:
 290
 291 Name            | Description
 292 ----------------|--------------
 293 ssmtp_address   | **Required.** The host's address. Defaults to "$address$".
 294 ssmtp_port      | **Optional.** The port that should be checked. Defaults to 465.
 295
 296 ### <a id="plugin-check-command-imap"></a> imap
 297
 298 Check command object for the `check_imap` plugin.
 299
 300 Custom Attributes:
 301
 302 Name            | Description
 303 ----------------|--------------
 304 imap_address    | **Optional.** The host's address. Defaults to "$address$".
 305 imap_port       | **Optional.** The port that should be checked. Defaults to 143.
 306
 307 ### <a id="plugin-check-command-simap"></a> simap
 308
 309 Check command object for the `check_simap` plugin.
 310
 311 Custom Attributes:
 312
 313 Name            | Description
 314 ----------------|--------------
 315 simap_address   | **Optional.** The host's address. Defaults to "$address$".
 316 simap_port      | **Optional.** The host's port.
 317
 318 ### <a id="plugin-check-command-pop"></a> pop
 319
 320 Check command object for the `check_pop` plugin.
 321
 322 Custom Attributes:
 323
 324 Name            | Description
 325 ----------------|--------------
 326 pop_address     | **Optional.** The host's address. Defaults to "$address$".
 327 pop_port        | **Optional.** The port that should be checked. Defaults to 110.
 328
 329 ### <a id="plugin-check-command-spop"></a> spop
 330
 331 Check command object for the `check_spop` plugin.
 332
 333 Custom Attributes:
 334
 335 Name            | Description
 336 ----------------|--------------
 337 spop_address    | **Optional.** The host's address. Defaults to "$address$".
 338 spop_port       | **Optional.** The host's port.
 339
 340 ### <a id="plugin-check-command-ntp-time"></a> ntp_time
 341
 342 Check command object for the `check_ntp_time` plugin.
 343
 344 Custom Attributes:
 345
 346 Name            | Description
 347 ----------------|--------------
 348 ntp_address     | **Optional.** The host's address. Defaults to "$address$".
 349
 350 ### <a id="plugin-check-command-ssh"></a> ssh
 351
 352 Check command object for the `check_ssh` plugin.
 353
 354 Custom Attributes:
 355
 356 Name            | Description
 357 ----------------|--------------
 358 ssh_address     | **Optional.** The host's address. Defaults to "$address$".
 359 ssh_port        | **Optional.** The port that should be checked. Defaults to 22.
 360 ssh_timeout     | **Optional.** Seconds before connection times out. Defaults to 10.
 361
 362 ### <a id="plugin-check-command-disk"></a> disk
 363
 364 Check command object for the `check_disk` plugin.
 365
 366 Custom Attributes:
 367
 368 Name                    | Description
 369 ------------------------|------------------------
 370 disk_wfree              | **Optional.** The free space warning threshold in %. Defaults to 20.
 371 disk_cfree              | **Optional.** The free space critical threshold in %. Defaults to 10.
 372 disk_inode_wfree        | **Optional.** The free inode warning threshold.
 373 disk_inode_cfree        | **Optional.** The free inode critical threshold.
 374 disk_partition          | **Optional.** The partition. **Deprecated in 2.3.**
 375 disk_partition_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.**
 376 disk_partitions         | **Optional.** The partition(s). Multiple partitions must be defined as array.
 377 disk_partitions_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array.
 378
 379 ### <a id="plugin-check-command-users"></a> users
 380
 381 Check command object for the `check_users` plugin.
 382
 383 Custom Attributes:
 384
 385 Name            | Description
 386 ----------------|--------------
 387 users_wgreater  | **Optional.** The user count warning threshold. Defaults to 20.
 388 users_cgreater  | **Optional.** The user count critical threshold. Defaults to 50.
 389
 390 ### <a id="plugin-check-command-processes"></a> procs
 391
 392 Check command object for the `check_procs` plugin.
 393
 394 Custom Attributes:
 395
 396 Name                 | Description
 397 ---------------------|--------------
 398 procs_warning        | **Optional.** The process count warning threshold. Defaults to 250.
 399 procs_critical       | **Optional.** The process count critical threshold. Defaults to 400.
 400 procs_metric         | **Optional.** Check thresholds against metric.
 401 procs_timeout        | **Optional.** Seconds before plugin times out.
 402 procs_traditional    | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to "false".
 403 procs_state          | **Optional.** Only scan for processes that have one or more of the status flags you specify.
 404 procs_ppid           | **Optional.** Only scan for children of the parent process ID indicated.
 405 procs_vsz            | **Optional.** Only scan for processes with VSZ higher than indicated.
 406 procs_rss            | **Optional.** Only scan for processes with RSS higher than indicated.
 407 procs_pcpu           | **Optional.** Only scan for processes with PCPU higher than indicated.
 408 procs_user           | **Optional.** Only scan for processes with user name or ID indicated.
 409 procs_argument       | **Optional.** Only scan for processes with args that contain STRING.
 410 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
 411 procs_command        | **Optional.** Only scan for exact matches of COMMAND (without path).
 412 procs_nokthreads     | **Optional.** Only scan for non kernel threads. Defaults to "false".
 413
 414 ### <a id="plugin-check-command-swap"></a> swap
 415
 416 Check command object for the `check_swap` plugin.
 417
 418 Custom Attributes:
 419
 420 Name            | Description
 421 ----------------|--------------
 422 swap_wfree      | **Optional.** The free swap space warning threshold in %. Defaults to 50.
 423 swap_cfree      | **Optional.** The free swap space critical threshold in %. Defaults to 25.
 424
 425 ### <a id="plugin-check-command-load"></a> load
 426
 427 Check command object for the `check_load` plugin.
 428
 429 Custom Attributes:
 430
 431 Name            | Description
 432 ----------------|--------------
 433 load_wload1     | **Optional.** The 1-minute warning threshold. Defaults to 5.
 434 load_wload5     | **Optional.** The 5-minute warning threshold. Defaults to 4.
 435 load_wload15    | **Optional.** The 15-minute warning threshold. Defaults to 3.
 436 load_cload1     | **Optional.** The 1-minute critical threshold. Defaults to 10.
 437 load_cload5     | **Optional.** The 5-minute critical threshold. Defaults to 6.
 438 load_cload15    | **Optional.** The 15-minute critical threshold. Defaults to 4.
 439
 440 ### <a id="plugin-check-command-snmp"></a> snmp
 441
 442 Check command object for the `check_snmp` plugin.
 443
 444 Custom Attributes:
 445
 446 Name                | Description
 447 --------------------|--------------
 448 snmp_address        | **Optional.** The host's address. Defaults to "$address$".
 449 snmp_oid            | **Required.** The SNMP OID.
 450 snmp_community      | **Optional.** The SNMP community. Defaults to "public".
 451 snmp_warn           | **Optional.** The warning threshold.
 452 snmp_crit           | **Optional.** The critical threshold.
 453 snmp_string         | **Optional.** Return OK state if the string matches exactly with the output value
 454 snmp_ereg           | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
 455 snmp_eregi          | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
 456 snmp_label          | **Optional.** Prefix label for output value
 457 snmp_invert_search  | **Optional.** Invert search result and return CRITICAL state if found
 458 snmp_units          | **Optional.** Units label(s) for output value (e.g., 'sec.').
 459 snmp_timeout        | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
 460
 461 ### <a id="plugin-check-command-snmpv3"></a> snmpv3
 462
 463 Check command object for the `check_snmp` plugin, using SNMPv3 authentication and encryption options.
 464
 465 Custom Attributes:
 466
 467 Name              | Description
 468 ------------------|--------------
 469 snmpv3_address    | **Optional.** The host's address. Defaults to "$address$".
 470 snmpv3_user       | **Required.** The username to log in with.
 471 snmpv3_auth_alg   | **Optional.** The authentication algorithm. Defaults to SHA.
 472 snmpv3_auth_key   | **Required.** The authentication key.
 473 snmpv3_priv_alg   | **Optional.** The encryption algorithm. Defaults to AES.
 474 snmpv3_priv_key   | **Required.** The encryption key.
 475 snmpv3_oid        | **Required.** The SNMP OID.
 476 snmpv3_warn       | **Optional.** The warning threshold.
 477 snmpv3_crit       | **Optional.** The critical threshold.
 478 snmpv3_label      | **Optional.** Prefix label for output value.
 479
 480 ### <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
 481
 482 Check command object for the `check_snmp` plugin.
 483
 484 Custom Attributes:
 485
 486 Name            | Description
 487 ----------------|--------------
 488 snmp_address    | **Optional.** The host's address. Defaults to "$address$".
 489 snmp_oid        | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
 490 snmp_community  | **Optional.** The SNMP community. Defaults to "public".
 491
 492 ### <a id="plugin-check-command-dns"></a> dns
 493
 494 Check command object for the `check_dns` plugin.
 495
 496 Custom Attributes:
 497
 498 Name                 | Description
 499 ---------------------|--------------
 500 dns_lookup           | **Optional.** The hostname or IP to query the DNS for. Defaults to $host_name$.
 501 dns_server           | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
 502 dns_expected_answer  | **Optional.** The answer to look for. A hostname must end with a dot. **Deprecated in 2.3.**
 503 dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
 504 dns_authoritative    | **Optional.** Expect the server to send an authoritative answer.
 505
 506 ### <a id="plugin-check-command-dig"></a> dig
 507
 508 Check command object for the `check_dig` plugin.
 509
 510 Custom Attributes:
 511
 512 Name                 | Description
 513 ---------------------|--------------
 514 dig_server           | **Optional.** The DNS server to query. Defaults to "127.0.0.1".
 515 dig_lookup           | **Optional.** The address that should be looked up.
 516
 517 ### <a id="plugin-check-command-dhcp"></a> dhcp
 518
 519 Check command object for the `check_dhcp` plugin.
 520
 521 Custom Attributes:
 522
 523 Name            | Description
 524 ----------------|--------------
 525 dhcp_serverip   | **Optional.** The IP address of the DHCP server which we should get a response from.
 526 dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server.
 527 dhcp_timeout    | **Optional.** The timeout in seconds.
 528 dhcp_interface  | **Optional.** The interface to use.
 529 dhcp_mac        | **Optional.** The MAC address to use in the DHCP request.
 530 dhcp_unicast    | **Optional.** Whether to use unicast requests. Defaults to false.
 531
 532 ### <a id="plugin-check-command-nscp"></a> nscp
 533
 534 Check command object for the `check_nt` plugin.
 535
 536 Custom Attributes:
 537
 538 Name            | Description
 539 ----------------|--------------
 540 nscp_address    | **Optional.** The host's address. Defaults to "$address$".
 541 nscp_port       | **Optional.** The NSClient++ port. Defaults to 12489.
 542 nscp_password   | **Optional.** The NSClient++ password.
 543 nscp_variable   | **Required.** The variable that should be checked.
 544 nscp_params     | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
 545 nscp_warn       | **Optional.** The warning threshold.
 546 nscp_crit       | **Optional.** The critical threshold.
 547 nscp_timeout    | **Optional.** The query timeout in seconds.
 548
 549 ### <a id="plugin-check-command-by-ssh"></a> by_ssh
 550
 551 Check command object for the `check_by_ssh` plugin.
 552
 553 Custom Attributes:
 554
 555 Name            | Description
 556 ----------------|--------------
 557 by_ssh_address  | **Optional.** The host's address. Defaults to "$address$".
 558 by_ssh_port     | **Optional.** The SSH port. Defaults to 22.
 559 by_ssh_command  | **Optional.** The command that should be executed.
 560 by_ssh_logname  | **Optional.** The SSH username.
 561 by_ssh_identity | **Optional.** The SSH identity.
 562 by_ssh_quiet    | **Optional.** Whether to suppress SSH warnings. Defaults to false.
 563 by_ssh_warn     | **Optional.** The warning threshold.
 564 by_ssh_crit     | **Optional.** The critical threshold.
 565 by_ssh_timeout  | **Optional.** The timeout in seconds.
 566
 567 ### <a id="plugin-check-command-ups"></a> ups
 568
 569 Check command object for the `check_ups` plugin.
 570
 571 Custom Attributes:
 572
 573 Name            | Description
 574 ----------------|--------------
 575 ups_address     | **Optional.** The host's address. Defaults to "$address$".
 576 ups_name        | **Optional.** The UPS name. Defaults to `ups`.
 577
 578
 579 ### <a id="plugin-check-command-nrpe"></a> nrpe
 580
 581 Check command object for the `check_nrpe` plugin.
 582
 583 Custom Attributes:
 584
 585 Name            | Description
 586 ----------------|--------------
 587 nrpe_address    | **Optional.** The host's address. Defaults to "$address$".
 588 nrpe_port       | **Optional.** The NRPE port. Defaults to 5668.
 589 nrpe_command    | **Optional.** The command that should be executed.
 590 nrpe_no_ssl     | **Optional.** Whether to disable SSL or not. Defaults to `false`.
 591 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
 592 nrpe_timeout    | **Optional.** The timeout in seconds.
 593 nrpe_arguments  | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
 594
 595 ### <a id="plugin-check-command-apt"></a> apt
 596
 597 Check command for the `check_apt` plugin.
 598
 599 The `apt` check command does not support any vars.
 600
 601
 602 ### <a id="plugin-check-command-running-kernel"></a> running_kernel
 603
 604 Check command object for the `check_running_kernel` plugin
 605 provided by the `nagios-plugins-contrib` package on Debian.
 606
 607 The `running_kernel` check command does not support any vars.
 608
 609
 610 # <a id="snmp-manubulon-plugin-check-commands"></a> SNMP Manubulon Plugin Check Commands
 611
 612 The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check
 613 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
 614
 615 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
 616 is set to the path where the Manubublon SNMP plugins are installed.
 617
 618 You can enable these plugin check commands by adding the following the include directive in your
 619 configuration [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) file:
 620
 621     include <manubulon>
 622
 623 ## Checks by Host Type
 624
 625 **N/A**      : Not available for this type.
 626
 627 **SNMP**     : Available for simple SNMP query.
 628
 629 **??**       : Untested.
 630
 631 **Specific** : Script name for platform specific checks.
 632
 633
 634   Host type               | Interface  | storage  | load/cpu  | mem | process  | env | specific
 635   ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
 636   Linux                   |   Yes      |   Yes    |   Yes     | Yes |   Yes    | No  |
 637   Windows                 |   Yes      |   Yes    |   Yes     | Yes |   Yes    | No  | check_snmp_win.pl
 638   Cisco router/switch     |   Yes      |   N/A    |   Yes     | Yes |   N/A    | Yes |
 639   HP router/switch        |   Yes      |   N/A    |   Yes     | Yes |   N/A    | No  |
 640   Bluecoat proxy          |   Yes      |   SNMP   |   Yes     | SNMP|   No     | Yes |
 641   CheckPoint on SPLAT     |   Yes      |   Yes    |   Yes     | Yes |   Yes    | No  | check_snmp_cpfw.pl
 642   CheckPoint on Nokia IP  |   Yes      |   Yes    |   Yes     | No  |   ??     | No  | check_snmp_vrrp.pl
 643   Boostedge               |   Yes      |   Yes    |   Yes     | Yes |   ??     | No  | check_snmp_boostedge.pl
 644   AS400                   |   Yes      |   Yes    |   Yes     | Yes |   No     | No  |
 645   NetsecureOne Netbox     |   Yes      |   Yes    |   Yes     | ??  |   Yes    | No  |
 646   Radware Linkproof       |   Yes      |   N/A    |   SNMP    | SNMP|   No     | No  | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
 647   IronPort                |   Yes      |   SNMP   |   SNMP    | SNMP|   No     | Yes |
 648   Cisco CSS               |   Yes      |   ??     |   Yes     | Yes |   No     | ??  | check_snmp_css.pl
 649
 650
 651 ### <a id="plugin-check-command-snmp-load"></a> snmp-load
 652
 653 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
 654
 655 Custom Attributes:
 656
 657
 658 Name                    | Description
 659 ------------------------|--------------
 660 snmp_address            | **Optional.** The host's address. Defaults to "$address$".
 661 snmp_nocrypt            | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to "false".
 662 snmp_community          | **Optional.** The SNMP community. Defaults to "public".
 663 snmp_port               | **Optional.** The SNMP port connection.
 664 snmp_v2                 | **Optional.** SNMP version to 2c. Defaults to "false".
 665 snmp_v3                 | **Optional.** SNMP version to 3. Defaults to "false".
 666 snmp_login              | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
 667 snmp_password           | **Required.** SNMP version 3 password. No value defined as default.
 668 snmp_v3_use_privpass    | **Optional.** Define to use SNMP version 3 priv password. Defaults to "false".
 669 snmp_authprotocol       | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
 670 snmp_privpass           | **Required.** SNMP version 3 priv password. No value defined as default.
 671 snmp_warn               | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
 672 snmp_crit               | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
 673 snmp_load_type          | **Optional.** Load type. Defaults to "stand". Check all available types in the [snmp load](http://nagios.manubulon.com/snmp_load.html) documentation.
 674 snmp_perf               | **Optional.** Enable perfdata values. Defaults to "true".
 675 snmp_timeout            | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
 676
 677 ### <a id="plugin-check-command-snmp-memory"></a> snmp-memory
 678
 679 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
 680
 681 Custom Attributes:
 682
 683 Name                    | Description
 684 ------------------------|--------------
 685 snmp_address            | **Optional.** The host's address. Defaults to "$address$".
 686 snmp_nocrypt            | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to "false".
 687 snmp_community          | **Optional.** The SNMP community. Defaults to "public".
 688 snmp_port               | **Optional.** The SNMP port connection.
 689 snmp_v2                 | **Optional.** SNMP version to 2c. Defaults to "false".
 690 snmp_v3                 | **Optional.** SNMP version to 3. Defaults to "false".
 691 snmp_login              | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
 692 snmp_password           | **Required.** SNMP version 3 password. No value defined as default.
 693 snmp_v3_use_privpass    | **Optional.** Define to use SNMP version 3 priv password. Defaults to "false".
 694 snmp_authprotocol       | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
 695 snmp_privpass           | **Required.** SNMP version 3 priv password. No value defined as default.
 696 snmp_warn               | **Optional.** The warning threshold.
 697 snmp_crit               | **Optional.** The critical threshold.
 698 snmp_perf               | **Optional.** Enable perfdata values. Defaults to "true".
 699 snmp_timeout            | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
 700
 701 ### <a id="plugin-check-command-snmp-storage"></a> snmp-storage
 702
 703 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
 704
 705 Custom Attributes:
 706
 707 Name                    | Description
 708 ------------------------|--------------
 709 snmp_address            | **Optional.** The host's address. Defaults to "$address$".
 710 snmp_nocrypt            | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to "false".
 711 snmp_community          | **Optional.** The SNMP community. Defaults to "public".
 712 snmp_port               | **Optional.** The SNMP port connection.
 713 snmp_v2                 | **Optional.** SNMP version to 2c. Defaults to "false".
 714 snmp_v3                 | **Optional.** SNMP version to 3. Defaults to "false".
 715 snmp_login              | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
 716 snmp_password           | **Required.** SNMP version 3 password. No value defined as default.
 717 snmp_v3_use_privpass    | **Optional.** Define to use SNMP version 3 priv password. Defaults to "false".
 718 snmp_authprotocol       | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
 719 snmp_privpass           | **Required.** SNMP version 3 priv password. No value defined as default.
 720 snmp_warn               | **Optional.** The warning threshold.
 721 snmp_crit               | **Optional.** The critical threshold.
 722 snmp_storage_name       | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
 723 snmp_perf               | **Optional.** Enable perfdata values. Defaults to "true".
 724 snmp_timeout            | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
 725
 726 ### <a id="plugin-check-command-snmp-interface"></a> snmp-interface
 727
 728 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
 729
 730 Custom Attributes:
 731
 732 Name                        | Description
 733 ----------------------------|--------------
 734 snmp_address                | **Optional.** The host's address. Defaults to "$address$".
 735 snmp_nocrypt                | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to "false".
 736 snmp_community              | **Optional.** The SNMP community. Defaults to "public".
 737 snmp_port                   | **Optional.** The SNMP port connection.
 738 snmp_v2                     | **Optional.** SNMP version to 2c. Defaults to "false".
 739 snmp_v3                     | **Optional.** SNMP version to 3. Defaults to "false".
 740 snmp_login                  | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
 741 snmp_password               | **Required.** SNMP version 3 password. No value defined as default.
 742 snmp_v3_use_privpass        | **Optional.** Define to use SNMP version 3 priv password. Defaults to "false".
 743 snmp_authprotocol           | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
 744 snmp_privpass               | **Required.** SNMP version 3 priv password. No value defined as default.
 745 snmp_warn                   | **Optional.** The warning threshold.
 746 snmp_crit                   | **Optional.** The critical threshold.
 747 snmp_interface              | **Optional.** Network interface name. Default to regex "eth0".
 748 snmp_interface_perf         | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to "true".
 749 snmp_interface_label        | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc...
 750 snmp_interface_bits_bytes   | **Optional.** Output performance data in bits/s or Bytes/s. **Depends** on snmp_interface_kbits set to "true". Defaults to "true".
 751 snmp_interface_percent      | **Optional.** Output performance data in % of max speed. Defaults to "false".
 752 snmp_interface_kbits        | **Optional.** Make the warning and critical levels in KBits/s. Defaults to "true".
 753 snmp_interface_megabytes    | **Optional.** Make the warning and critical levels in Mbps or MBps. **Depends** on snmp_interface_kbits set to "true". Defaults to "true".
 754 snmp_interface_64bit        | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to "false".
 755 snmp_interface_errors       | **Optional.** Add error & discard to Perfparse output. Defaults to "true".
 756 snmp_interface_noregexp     | **Optional.** Do not use regexp to match interface name in description OID. Defaults to "false".
 757 snmp_interface_delta        | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
 758 snmp_warncrit_percent       | **Optional.** Make the warning and critical levels in % of reported interface speed. If set **snmp_interface_megabytes** needs to be set to "false". Defaults to "false".
 759 snmp_perf                   | **Optional.** Enable perfdata values. Defaults to "true".
 760 snmp_timeout                | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
 761
 762 ### <a id="plugin-check-command-snmp-process"></a> snmp-process
 763
 764 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
 765
 766 Custom Attributes:
 767
 768 Name                    | Description
 769 ------------------------|--------------
 770 snmp_address            | **Optional.** The host's address. Defaults to "$address$".
 771 snmp_nocrypt            | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to "false".
 772 snmp_community          | **Optional.** The SNMP community. Defaults to "public".
 773 snmp_port               | **Optional.** The SNMP port connection.
 774 snmp_v2                 | **Optional.** SNMP version to 2c. Defaults to "false".
 775 snmp_v3                 | **Optional.** SNMP version to 3. Defaults to "false".
 776 snmp_login              | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
 777 snmp_password           | **Required.** SNMP version 3 password. No value defined as default.
 778 snmp_v3_use_privpass    | **Optional.** Define to use SNMP version 3 priv password. Defaults to "false".
 779 snmp_authprotocol       | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
 780 snmp_privpass           | **Required.** SNMP version 3 priv password. No value defined as default..
 781 snmp_warn               | **Optional.** The warning threshold.
 782 snmp_crit               | **Optional.** The critical threshold.
 783 snmp_process_name       | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
 784 snmp_perf               | **Optional.** Enable perfdata values. Defaults to "true".
 785 snmp_timeout            | **Optional.** The command timeout in seconds. Defaults to 5 seconds.