diff --git a/doc/1-about.md b/doc/1-about.md index 823c5ee19..db13e1bf9 100644 --- a/doc/1-about.md +++ b/doc/1-about.md @@ -2,8 +2,9 @@ ## What is Icinga 2? -Icinga 2 is an open source monitoring system which checks the availability of your -network resources, notifies users of outages, and generates performance data for reporting. +Icinga 2 is an open source monitoring system which checks the availability of +your network resources, notifies users of outages, and generates performance +data for reporting. Scalable and extensible, Icinga 2 can monitor large, complex environments across multiple locations. @@ -21,9 +22,9 @@ the [support overview page](https://support.icinga.org). ## Contribute -There are many ways to contribute to Icinga - whether it be sending patches, testing, -reporting bugs, or reviewing and updating the documentation. Every contribution -is appreciated! +There are many ways to contribute to Icinga - whether it be sending patches, +testing, reporting bugs, or reviewing and updating the documentation. Every +contribution is appreciated! Please get in touch with the Icinga team at https://www.icinga.org/community/. diff --git a/doc/2-getting-started.md b/doc/2-getting-started.md index 2d9a43e51..f3746e42c 100644 --- a/doc/2-getting-started.md +++ b/doc/2-getting-started.md @@ -52,7 +52,7 @@ Fedora: # curl -o /etc/yum.repos.d/ICINGA-release.repo http://packages.icinga.org/fedora/ICINGA-release.repo # yum makecache -SLES 11 +SLES 11: # zypper ar http://packages.icinga.org/SUSE/ICINGA-release-11.repo # zypper ref @@ -106,8 +106,9 @@ Icinga 2 installation: * `notification` for sending notifications * `mainlog` for writing the `icinga2.log` file -You can verify that by calling `icinga2 feature list` [CLI command](7-cli-commands.md#cli-command-feature) -to see which features are enabled and disabled. +You can verify that by calling `icinga2 feature list` +[CLI command](7-cli-commands.md#cli-command-feature) to see which features are +enabled and disabled. # icinga2 feature list Disabled features: api command compatlog debuglog graphite icingastatus ido-mysql ido-pgsql livestatus notification perfdata statusdata syslog @@ -189,7 +190,8 @@ using the init script. Using Debian packages the user and group are set to Some distributions (e.g. Fedora, openSUSE and RHEL/CentOS 7) use systemd. The Icinga 2 packages automatically install the necessary systemd unit files. -The Icinga 2 systemd service can be (re-)started, reloaded, stopped and also queried for its current status. +The Icinga 2 systemd service can be (re-)started, reloaded, stopped and also +queried for its current status. # systemctl status icinga2 icinga2.service - Icinga host/service/network monitoring system @@ -228,7 +230,8 @@ Examples: # systemctl restart icinga2 Job for icinga2.service failed. See 'systemctl status icinga2.service' and 'journalctl -xn' for details. -If you're stuck with configuration errors, you can manually invoke the [configuration validation](7-cli-commands.md#config-validation). +If you're stuck with configuration errors, you can manually invoke the +[configuration validation](7-cli-commands.md#config-validation). ## Setting up Icinga Web 2 @@ -238,10 +241,11 @@ This chapter explains how to set up Icinga Web 2. The chapter can be used as a starting point for installing some of the other web interfaces which are also available. -The DB IDO (Database Icinga Data Output) modules for Icinga 2 take care of exporting -all configuration and status information into a database. The IDO database is used -by a number of projects including [Icinga Web 2](2-getting-started.md#setting-up-icingaweb2), -Icinga Reporting or Icinga Web 1.x. +The DB IDO (Database Icinga Data Output) modules for Icinga 2 take care of +exporting all configuration and status information into a database. The IDO +database is used by a number of projects including +[Icinga Web 2](2-getting-started.md#setting-up-icingaweb2), Icinga Reporting +or Icinga Web 1.x. There is a separate module for each database backend. At present support for both MySQL and PostgreSQL is implemented. @@ -320,9 +324,11 @@ The package provides a new configuration file that is installed in update the database credentials in this file. All available attributes are explained in the -[IdoMysqlConnection object](5-object-types.md#objecttype-idomysqlconnection) chapter. +[IdoMysqlConnection object](5-object-types.md#objecttype-idomysqlconnection) +chapter. -You can enable the `ido-mysql` feature configuration file using `icinga2 feature enable`: +You can enable the `ido-mysql` feature configuration file using +`icinga2 feature enable`: # icinga2 feature enable ido-mysql Module 'ido-mysql' was enabled. @@ -398,7 +404,7 @@ Set up a PostgreSQL database for Icinga 2: > **Note** > -> Using PostgreSQL 9.x you can omit the `createlang` command. +> When using PostgreSQL 9.x you can omit the `createlang` command. Locate your pg_hba.conf (Debian: `/etc/postgresql/*/main/pg_hba.conf`, RHEL/SUSE: `/var/lib/pgsql/data/pg_hba.conf`), add the icinga user with md5 @@ -421,8 +427,8 @@ authentication method and restart the postgresql server. # /etc/init.d/postgresql restart -After creating the database and permissions you can import the Icinga 2 IDO schema -using the following command: +After creating the database and permissions you can import the Icinga 2 IDO +schema using the following command: # export PGPASSWORD=icinga # psql -U icinga -d icinga < /usr/share/icinga2-ido-pgsql/schema/pgsql.sql @@ -435,9 +441,11 @@ The package provides a new configuration file that is installed in the database credentials in this file. All available attributes are explained in the -[IdoPgsqlConnection object](5-object-types.md#objecttype-idopgsqlconnection) chapter. +[IdoPgsqlConnection object](5-object-types.md#objecttype-idopgsqlconnection) +chapter. -You can enable the `ido-pgsql` feature configuration file using `icinga2 feature enable`: +You can enable the `ido-pgsql` feature configuration file using +`icinga2 feature enable`: # icinga2 feature enable ido-pgsql Module 'ido-pgsql' was enabled. @@ -510,31 +518,35 @@ RHEL/CentOS 7 and Fedora: # systemctl restart icinga2 -By default the command pipe file is owned by the group `icingacmd` with read/write -permissions. Add your webserver's user to the group `icingacmd` to +By default the command pipe file is owned by the group `icingacmd` with +read/write permissions. Add your webserver's user to the group `icingacmd` to enable sending commands to Icinga 2 through your web interface: # usermod -a -G icingacmd www-data -Debian packages use `nagios` as the default user and group name. Therefore change `icingacmd` to -`nagios`. -The webserver's user is different between distributions so you might have to change `www-data` to -`wwwrun`, `www`, or `apache`. +Debian packages use `nagios` as the default user and group name. Therefore +change `icingacmd` to `nagios`. + +The webserver's user is different between distributions so you might have to +change `www-data` to `wwwrun`, `www`, or `apache`. Change "www-data" to the user you're using to run queries. -You can verify that the user has been successfully added to the `icingacmd` group using the `id` command: +You can verify that the user has been successfully added to the `icingacmd` +group using the `id` command: - id + $ id ### Installing up Icinga Web 2 -Please consult the [installation documentation](https://github.com/Icinga/icingaweb2/blob/master/doc/installation.md) for further instructions on how to install Icinga Web 2. +Please consult the [installation documentation](https://github.com/Icinga/icingaweb2/blob/master/doc/installation.md) +for further instructions on how to install Icinga Web 2. ## Addons -A number of additional features are available in the form of addons. A list of popular -addons is available in the [Addons and Plugins](9-addons-plugins.md#addons-plugins) chapter. +A number of additional features are available in the form of addons. A list of +popular addons is available in the +[Addons and Plugins](9-addons-plugins.md#addons-plugins) chapter. diff --git a/doc/5-object-types.md b/doc/5-object-types.md index 0cff0c405..12a202913 100644 --- a/doc/5-object-types.md +++ b/doc/5-object-types.md @@ -1,5 +1,8 @@ # Object Types +This chapter provides an overview of all available object types which can be +instantiated using the `object` keyword. + ## Host A host. @@ -1224,7 +1227,6 @@ Attributes: ## Zone Zone objects are used to specify which Icinga 2 instances are located in a zone. -All zone endpoints elect one active master instance among them (required for High-Availability setups). Example: diff --git a/doc/6-icinga-template-library.md b/doc/6-icinga-template-library.md index a8020a9bb..bcf1821f6 100644 --- a/doc/6-icinga-template-library.md +++ b/doc/6-icinga-template-library.md @@ -71,54 +71,121 @@ file: The plugin check commands assume that there's a global constant named `PluginDir` which contains the path of the plugins from the Monitoring Plugins project. +### apt -### ping4 +Check command for the `check_apt` plugin. -Check command object for the `check_ping` plugin. +The `apt` check command does not support any vars. + + +### by_ssh + +Check command object for the `check_by_ssh` plugin. Custom Attributes: Name | Description ----------------|-------------- -ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$". -ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. -ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. -ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. -ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. -ping_packets | **Optional.** The number of packets to send. Defaults to 5. -ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). +by_ssh_address | **Optional.** The host's address. Defaults to "$address$". +by_ssh_port | **Optional.** The SSH port. Defaults to 22. +by_ssh_command | **Optional.** The command that should be executed. +by_ssh_logname | **Optional.** The SSH username. +by_ssh_identity | **Optional.** The SSH identity. +by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false. +by_ssh_warn | **Optional.** The warning threshold. +by_ssh_crit | **Optional.** The critical threshold. +by_ssh_timeout | **Optional.** The timeout in seconds. -### ping6 -Check command object for the `check_ping` plugin. +### dhcp + +Check command object for the `check_dhcp` plugin. Custom Attributes: Name | Description ----------------|-------------- -ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$". -ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. -ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. -ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. -ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. -ping_packets | **Optional.** The number of packets to send. Defaults to 5. -ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). +dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from. +dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server. +dhcp_timeout | **Optional.** The timeout in seconds. +dhcp_interface | **Optional.** The interface to use. +dhcp_mac | **Optional.** The MAC address to use in the DHCP request. +dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false. -### hostalive -Check command object for the `check_ping` plugin with host check default values. +### dig + +Check command object for the `check_dig` plugin. + +Custom Attributes: + +Name | Description +---------------------|-------------- +dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1". +dig_lookup | **Optional.** The address that should be looked up. + + +### disk + +Check command object for the `check_disk` plugin. + +Custom Attributes: + +Name | Description +------------------------|------------------------ +disk_wfree | **Optional.** The free space warning threshold in %. Defaults to 20. +disk_cfree | **Optional.** The free space critical threshold in %. Defaults to 10. +disk_inode_wfree | **Optional.** The free inode warning threshold. +disk_inode_cfree | **Optional.** The free inode critical threshold. +disk_partition | **Optional.** The partition. **Deprecated in 2.3.** +disk_partition_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.** +disk_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array. +disk_partitions_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array. +disk_clear | **Optional.** Clear thresholds. +disk_exact_match | **Optional.** For paths or partitions specified with -p, only check for exact paths. +disk_errors_only | **Optional.** Display only devices/mountpoints with errors. May be true or false. +disk_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together +disk_kilobytes | **Optional.** Same as --units kB. May be true or false. +disk_local | **Optional.** Only check local filesystems. May be true or false. +disk_stat_remote_fs | **Optional.** Only check local filesystems against thresholds. Yet call stat on remote filesystems to test if they are accessible (e.g. to detect Stale NFS Handles). Myy be true or false +disk_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false. +disk_megabytes | **Optional.** Same as --units MB. May be true or false. +disk_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.*'. May be true or false. +disk_eregi_path | **Optional.** Case insensitive regular expression for path/partition (may be repeated). +disk_ereg_path | **Optional.** Regular expression for path or partition (may be repeated). +disk_ignore_eregi_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive) (may be repeated). +disk_ignore_ereg_path | **Optional.** Regular expression to ignore selected path or partition (may be repeated). +disk_timeout | **Optional.** Seconds before connection times out (default: 10). +disk_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB). +disk_exclude_type | **Optional.** Ignore all filesystems of indicated type (may be repeated). + + +### dns + +Check command object for the `check_dns` plugin. + +Custom Attributes: + +Name | Description +---------------------|-------------- +dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to $host_name$. +dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS. +dns_expected_answer | **Optional.** The answer to look for. A hostname must end with a dot. **Deprecated in 2.3.** +dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array. +dns_authoritative | **Optional.** Expect the server to send an authoritative answer. + + +### dummy + +Check command object for the `check_dummy` plugin. Custom Attributes: Name | Description ----------------|-------------- -ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$". -ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000. -ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80. -ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000. -ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100. -ping_packets | **Optional.** The number of packets to send. Defaults to 5. -ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). +dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0. +dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.". + ### fping4 @@ -140,6 +207,7 @@ fping_target_timeout | **Optional.** The target timeout in milli-seconds. fping_source_ip | **Optional.** The name or ip address of the source ip. fping_source_interface | **Optional.** The source interface name. + ### fping6 Check command object for the `check_fping` plugin. @@ -161,63 +229,46 @@ fping_source_ip | **Optional.** The name or ip address of the source ip. fping_source_interface | **Optional.** The source interface name. -### dummy +### ftp -Check command object for the `check_dummy` plugin. +Check command object for the `check_ftp` plugin. + +Custom Attributes: + +Name | Description +-------------------|-------------- +ftp_address | **Optional.** The host's address. Defaults to "$address$". + + +### hostalive + +Check command object for the `check_ping` plugin with host check default values. Custom Attributes: Name | Description ----------------|-------------- -dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0. -dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.". +ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$". +ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000. +ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80. +ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000. +ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100. +ping_packets | **Optional.** The number of packets to send. Defaults to 5. +ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). -### passive -Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values. +### hpjd + +Check command object for the `check_hpjd` plugin. Custom Attributes: Name | Description ----------------|-------------- -dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3. -dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.". +hpjd_address | **Optional.** The host's address. Defaults to "$address$". +hpjd_port | **Optional.** The host's SNMP port. Defaults to 161. +hpjd_community | **Optional.** The SNMP community. Defaults to "public". -### tcp - -Check command object for the `check_tcp` plugin. - -Custom Attributes: - -Name | Description -----------------|-------------- -tcp_address | **Optional.** The host's address. Defaults to "$address$". -tcp_port | **Required.** The port that should be checked. - -### ssl - -Check command object for the `check_tcp` plugin, using ssl-related options. - -Custom Attributes: - -Name | Description -------------------------------|-------------- -ssl_address | **Optional.** The host's address. Defaults to "$address$". -ssl_port | **Required.** The port that should be checked. -ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds. -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. -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. - -### udp - -Check command object for the `check_udp` plugin. - -Custom Attributes: - -Name | Description -----------------|-------------- -udp_address | **Optional.** The host's address. Defaults to "$address$". -udp_port | **Required.** The port that should be checked. ### http @@ -260,38 +311,27 @@ http_pagesize | **Optional.** Minimum page size required:Maximum page http_timeout | **Optional.** Seconds before connection times out. -### ftp +### icmp -Check command object for the `check_ftp` plugin. - -Custom Attributes: - -Name | Description --------------------|-------------- -ftp_address | **Optional.** The host's address. Defaults to "$address$". - -### smtp - -Check command object for the `check_smtp` plugin. - -Custom Attributes: - -Name | Description ----------------------|-------------- -smtp_address | **Optional.** The host's address. Defaults to "$address$". -smtp_port | **Optional.** The port that should be checked. Defaults to 25. -smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address. - -### ssmtp - -Check command object for the `check_ssmtp` plugin. +Check command object for the `check_icmp` plugin. Custom Attributes: Name | Description ----------------|-------------- -ssmtp_address | **Required.** The host's address. Defaults to "$address$". -ssmtp_port | **Optional.** The port that should be checked. Defaults to 465. +icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$". +icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. +icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. +icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. +icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. +icmp_source | **Optional.** The source IP address to send packets from. +icmp_packets | **Optional.** The number of packets to send. Defaults to 5. +icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds). +icmp_target_interval | **Optional.** The maximum target interval. +icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed. +icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8. +icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds). + ### imap @@ -304,16 +344,113 @@ Name | Description imap_address | **Optional.** The host's address. Defaults to "$address$". imap_port | **Optional.** The port that should be checked. Defaults to 143. -### simap -Check command object for the `check_simap` plugin. +### load + +Check command object for the `check_load` plugin. Custom Attributes: Name | Description ----------------|-------------- -simap_address | **Optional.** The host's address. Defaults to "$address$". -simap_port | **Optional.** The host's port. +load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5. +load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4. +load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3. +load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10. +load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6. +load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4. + + +### nrpe + +Check command object for the `check_nrpe` plugin. + +Custom Attributes: + +Name | Description +----------------|-------------- +nrpe_address | **Optional.** The host's address. Defaults to "$address$". +nrpe_port | **Optional.** The NRPE port. Defaults to 5668. +nrpe_command | **Optional.** The command that should be executed. +nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`. +nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`. +nrpe_timeout | **Optional.** The timeout in seconds. +nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array. + + +### nscp + +Check command object for the `check_nt` plugin. + +Custom Attributes: + +Name | Description +----------------|-------------- +nscp_address | **Optional.** The host's address. Defaults to "$address$". +nscp_port | **Optional.** The NSClient++ port. Defaults to 12489. +nscp_password | **Optional.** The NSClient++ password. +nscp_variable | **Required.** The variable that should be checked. +nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array. +nscp_warn | **Optional.** The warning threshold. +nscp_crit | **Optional.** The critical threshold. +nscp_timeout | **Optional.** The query timeout in seconds. + + +### ntp_time + +Check command object for the `check_ntp_time` plugin. + +Custom Attributes: + +Name | Description +----------------|-------------- +ntp_address | **Optional.** The host's address. Defaults to "$address$". + + +### passive + +Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values. + +Custom Attributes: + +Name | Description +----------------|-------------- +dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3. +dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.". + + +### ping4 + +Check command object for the `check_ping` plugin. + +Custom Attributes: + +Name | Description +----------------|-------------- +ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$". +ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. +ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. +ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. +ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. +ping_packets | **Optional.** The number of packets to send. Defaults to 5. +ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). + +### ping6 + +Check command object for the `check_ping` plugin. + +Custom Attributes: + +Name | Description +----------------|-------------- +ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$". +ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. +ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. +ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. +ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. +ping_packets | **Optional.** The number of packets to send. Defaults to 5. +ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). + ### pop @@ -326,83 +463,6 @@ Name | Description pop_address | **Optional.** The host's address. Defaults to "$address$". pop_port | **Optional.** The port that should be checked. Defaults to 110. -### spop - -Check command object for the `check_spop` plugin. - -Custom Attributes: - -Name | Description -----------------|-------------- -spop_address | **Optional.** The host's address. Defaults to "$address$". -spop_port | **Optional.** The host's port. - -### ntp_time - -Check command object for the `check_ntp_time` plugin. - -Custom Attributes: - -Name | Description -----------------|-------------- -ntp_address | **Optional.** The host's address. Defaults to "$address$". - -### ssh - -Check command object for the `check_ssh` plugin. - -Custom Attributes: - -Name | Description -----------------|-------------- -ssh_address | **Optional.** The host's address. Defaults to "$address$". -ssh_port | **Optional.** The port that should be checked. Defaults to 22. -ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10. - -### disk - -Check command object for the `check_disk` plugin. - -Custom Attributes: - -Name | Description -------------------------|------------------------ -disk_wfree | **Optional.** The free space warning threshold in %. Defaults to 20. -disk_cfree | **Optional.** The free space critical threshold in %. Defaults to 10. -disk_inode_wfree | **Optional.** The free inode warning threshold. -disk_inode_cfree | **Optional.** The free inode critical threshold. -disk_partition | **Optional.** The partition. **Deprecated in 2.3.** -disk_partition_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.** -disk_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array. -disk_partitions_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array. -disk_clear | **Optional.** Clear thresholds. -disk_exact_match | **Optional.** For paths or partitions specified with -p, only check for exact paths. -disk_errors_only | **Optional.** Display only devices/mountpoints with errors. May be true or false. -disk_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together -disk_kilobytes | **Optional.** Same as --units kB. May be true or false. -disk_local | **Optional.** Only check local filesystems. May be true or false. -disk_stat_remote_fs | **Optional.** Only check local filesystems against thresholds. Yet call stat on remote filesystems to test if they are accessible (e.g. to detect Stale NFS Handles). Myy be true or false -disk_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false. -disk_megabytes | **Optional.** Same as --units MB. May be true or false. -disk_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.*'. May be true or false. -disk_eregi_path | **Optional.** Case insensitive regular expression for path/partition (may be repeated). -disk_ereg_path | **Optional.** Regular expression for path or partition (may be repeated). -disk_ignore_eregi_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive) (may be repeated). -disk_ignore_ereg_path | **Optional.** Regular expression to ignore selected path or partition (may be repeated). -disk_timeout | **Optional.** Seconds before connection times out (default: 10). -disk_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB). -disk_exclude_type | **Optional.** Ignore all filesystems of indicated type (may be repeated). - -### users - -Check command object for the `check_users` plugin. - -Custom Attributes: - -Name | Description -----------------|-------------- -users_wgreater | **Optional.** The user count warning threshold. Defaults to 20. -users_cgreater | **Optional.** The user count critical threshold. Defaults to 50. ### procs @@ -428,31 +488,39 @@ procs_argument_regex | **Optional.** Only scan for processes with args that cont procs_command | **Optional.** Only scan for exact matches of COMMAND (without path). procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to "false". -### swap -Check command object for the `check_swap` plugin. +### running_kernel + +Check command object for the `check_running_kernel` plugin +provided by the `nagios-plugins-contrib` package on Debian. + +The `running_kernel` check command does not support any vars. + + +### simap + +Check command object for the `check_simap` plugin. Custom Attributes: Name | Description ----------------|-------------- -swap_wfree | **Optional.** The free swap space warning threshold in %. Defaults to 50. -swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25. +simap_address | **Optional.** The host's address. Defaults to "$address$". +simap_port | **Optional.** The host's port. -### load -Check command object for the `check_load` plugin. +### smtp + +Check command object for the `check_smtp` plugin. Custom Attributes: -Name | Description -----------------|-------------- -load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5. -load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4. -load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3. -load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10. -load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6. -load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4. +Name | Description +---------------------|-------------- +smtp_address | **Optional.** The host's address. Defaults to "$address$". +smtp_port | **Optional.** The port that should be checked. Defaults to 25. +smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address. + ### snmp @@ -506,80 +574,94 @@ snmp_address | **Optional.** The host's address. Defaults to "$address$". snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0". snmp_community | **Optional.** The SNMP community. Defaults to "public". -### dns -Check command object for the `check_dns` plugin. +### spop -Custom Attributes: - -Name | Description ----------------------|-------------- -dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to $host_name$. -dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS. -dns_expected_answer | **Optional.** The answer to look for. A hostname must end with a dot. **Deprecated in 2.3.** -dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array. -dns_authoritative | **Optional.** Expect the server to send an authoritative answer. - -### dig - -Check command object for the `check_dig` plugin. - -Custom Attributes: - -Name | Description ----------------------|-------------- -dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1". -dig_lookup | **Optional.** The address that should be looked up. - -### dhcp - -Check command object for the `check_dhcp` plugin. +Check command object for the `check_spop` plugin. Custom Attributes: Name | Description ----------------|-------------- -dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from. -dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server. -dhcp_timeout | **Optional.** The timeout in seconds. -dhcp_interface | **Optional.** The interface to use. -dhcp_mac | **Optional.** The MAC address to use in the DHCP request. -dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false. +spop_address | **Optional.** The host's address. Defaults to "$address$". +spop_port | **Optional.** The host's port. -### nscp -Check command object for the `check_nt` plugin. +### ssh + +Check command object for the `check_ssh` plugin. Custom Attributes: Name | Description ----------------|-------------- -nscp_address | **Optional.** The host's address. Defaults to "$address$". -nscp_port | **Optional.** The NSClient++ port. Defaults to 12489. -nscp_password | **Optional.** The NSClient++ password. -nscp_variable | **Required.** The variable that should be checked. -nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array. -nscp_warn | **Optional.** The warning threshold. -nscp_crit | **Optional.** The critical threshold. -nscp_timeout | **Optional.** The query timeout in seconds. +ssh_address | **Optional.** The host's address. Defaults to "$address$". +ssh_port | **Optional.** The port that should be checked. Defaults to 22. +ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10. -### by_ssh -Check command object for the `check_by_ssh` plugin. +### ssl + +Check command object for the `check_tcp` plugin, using ssl-related options. + +Custom Attributes: + +Name | Description +------------------------------|-------------- +ssl_address | **Optional.** The host's address. Defaults to "$address$". +ssl_port | **Required.** The port that should be checked. +ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds. +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. +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. + + +### ssmtp + +Check command object for the `check_ssmtp` plugin. Custom Attributes: Name | Description ----------------|-------------- -by_ssh_address | **Optional.** The host's address. Defaults to "$address$". -by_ssh_port | **Optional.** The SSH port. Defaults to 22. -by_ssh_command | **Optional.** The command that should be executed. -by_ssh_logname | **Optional.** The SSH username. -by_ssh_identity | **Optional.** The SSH identity. -by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false. -by_ssh_warn | **Optional.** The warning threshold. -by_ssh_crit | **Optional.** The critical threshold. -by_ssh_timeout | **Optional.** The timeout in seconds. +ssmtp_address | **Required.** The host's address. Defaults to "$address$". +ssmtp_port | **Optional.** The port that should be checked. Defaults to 465. + + +### swap + +Check command object for the `check_swap` plugin. + +Custom Attributes: + +Name | Description +----------------|-------------- +swap_wfree | **Optional.** The free swap space warning threshold in %. Defaults to 50. +swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25. + + +### tcp + +Check command object for the `check_tcp` plugin. + +Custom Attributes: + +Name | Description +----------------|-------------- +tcp_address | **Optional.** The host's address. Defaults to "$address$". +tcp_port | **Required.** The port that should be checked. + + +### udp + +Check command object for the `check_udp` plugin. + +Custom Attributes: + +Name | Description +----------------|-------------- +udp_address | **Optional.** The host's address. Defaults to "$address$". +udp_port | **Required.** The port that should be checked. + ### ups @@ -593,69 +675,16 @@ ups_address | **Optional.** The host's address. Defaults to "$address$". ups_name | **Optional.** The UPS name. Defaults to `ups`. -### nrpe +### users -Check command object for the `check_nrpe` plugin. +Check command object for the `check_users` plugin. Custom Attributes: Name | Description ----------------|-------------- -nrpe_address | **Optional.** The host's address. Defaults to "$address$". -nrpe_port | **Optional.** The NRPE port. Defaults to 5668. -nrpe_command | **Optional.** The command that should be executed. -nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`. -nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`. -nrpe_timeout | **Optional.** The timeout in seconds. -nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array. - -### apt - -Check command for the `check_apt` plugin. - -The `apt` check command does not support any vars. - -### hpjd - -Check command object for the `check_hpjd` plugin. - -Custom Attributes: - -Name | Description -----------------|-------------- -hpjd_address | **Optional.** The host's address. Defaults to "$address$". -hpjd_port | **Optional.** The host's SNMP port. Defaults to 161. -hpjd_community | **Optional.** The SNMP community. Defaults to "public". - - -### icmp - -Check command object for the `check_icmp` plugin. - -Custom Attributes: - -Name | Description -----------------|-------------- -icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$". -icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. -icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. -icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. -icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. -icmp_source | **Optional.** The source IP address to send packets from. -icmp_packets | **Optional.** The number of packets to send. Defaults to 5. -icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds). -icmp_target_interval | **Optional.** The maximum target interval. -icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed. -icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8. -icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds). - - -### running_kernel - -Check command object for the `check_running_kernel` plugin -provided by the `nagios-plugins-contrib` package on Debian. - -The `running_kernel` check command does not support any vars. +users_wgreater | **Optional.** The user count warning threshold. Defaults to 20. +users_cgreater | **Optional.** The user count critical threshold. Defaults to 50. # SNMP Manubulon Plugin Check Commands