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

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