tyler.durden/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2025-07-25 06:34:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

Reword documentation for check_address

Browse Source 
fixes #8879

Signed-off-by: Gunnar Beutner <gunnar@beutner.name>
This commit is contained in:
Louis Sautier 2015-03-27 12:27:10 +01:00 committed by Gunnar Beutner
parent ec7224e3ed
commit 419ab0061c
1 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
doc/7-icinga-template-library.md
View File

@ -105,7 +105,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
by_ssh_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. by_ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
by_ssh_port | **Optional.** The SSH port. Defaults to 22. by_ssh_port | **Optional.** The SSH port. Defaults to 22.
by_ssh_command | **Optional.** The command that should be executed. by_ssh_command | **Optional.** The command that should be executed.
by_ssh_logname | **Optional.** The SSH username. by_ssh_logname | **Optional.** The SSH username.
@ -261,7 +261,7 @@ Custom Attributes:
Name | Description Name | Description
-------------------|-------------- -------------------|--------------
ftp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
## <a id="plugin-check-command-hostalive"></a> hostalive ## <a id="plugin-check-command-hostalive"></a> hostalive
@ -274,7 +274,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
ping_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000. 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_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000. ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
@ -327,7 +327,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
hpjd_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
hpjd_port | **Optional.** The host's SNMP port. Defaults to 161. hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
hpjd_community | **Optional.** The SNMP community. Defaults to "public". hpjd_community | **Optional.** The SNMP community. Defaults to "public".
@ -340,7 +340,7 @@ Custom Attributes:
Name | Description Name | Description
-------------------------|-------------- -------------------------|--------------
http_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
http_vhost | **Optional.** The virtual host that should be sent in the "Host" header. http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
http_uri | **Optional.** The request URI. http_uri | **Optional.** The request URI.
http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise. http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
@ -403,7 +403,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
imap_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
imap_port | **Optional.** The port that should be checked. Defaults to 143. imap_port | **Optional.** The port that should be checked. Defaults to 143.
@ -431,7 +431,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
nrpe_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
nrpe_port | **Optional.** The NRPE port. Defaults to 5668. nrpe_port | **Optional.** The NRPE port. Defaults to 5668.
nrpe_command | **Optional.** The command that should be executed. nrpe_command | **Optional.** The command that should be executed.
nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`. nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
@ -448,7 +448,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
nscp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
nscp_port | **Optional.** The NSClient++ port. Defaults to 12489. nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
nscp_password | **Optional.** The NSClient++ password. nscp_password | **Optional.** The NSClient++ password.
nscp_variable | **Required.** The variable that should be checked. nscp_variable | **Required.** The variable that should be checked.
@ -466,7 +466,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
ntp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
## <a id="plugin-check-command-passive"></a> passive ## <a id="plugin-check-command-passive"></a> passive
@ -491,7 +491,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
ping_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. 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_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
@ -541,7 +541,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
pop_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
pop_port | **Optional.** The port that should be checked. Defaults to 110. pop_port | **Optional.** The port that should be checked. Defaults to 110.
@ -586,7 +586,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
simap_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
simap_port | **Optional.** The host's port. simap_port | **Optional.** The host's port.
@ -598,7 +598,7 @@ Custom Attributes:
Name | Description Name | Description
---------------------|-------------- ---------------------|--------------
smtp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
smtp_port | **Optional.** The port that should be checked. Defaults to 25. 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. smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
@ -611,7 +611,7 @@ Custom Attributes:
Name | Description Name | Description
--------------------|-------------- --------------------|--------------
snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
snmp_oid | **Required.** The SNMP OID. snmp_oid | **Required.** The SNMP OID.
snmp_community | **Optional.** The SNMP community. Defaults to "public". snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_warn | **Optional.** The warning threshold. snmp_warn | **Optional.** The warning threshold.
@ -637,7 +637,7 @@ Custom Attributes:
Name | Description Name | Description
------------------|-------------- ------------------|--------------
snmpv3_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
snmpv3_user | **Required.** The username to log in with. snmpv3_user | **Required.** The username to log in with.
snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA. snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
snmpv3_auth_key | **Required.** The authentication key. snmpv3_auth_key | **Required.** The authentication key.
@ -656,7 +656,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0". 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". snmp_community | **Optional.** The SNMP community. Defaults to "public".
@ -669,7 +669,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
spop_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
spop_port | **Optional.** The host's port. spop_port | **Optional.** The host's port.
@ -681,7 +681,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
ssh_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
ssh_port | **Optional.** The port that should be checked. Defaults to 22. ssh_port | **Optional.** The port that should be checked. Defaults to 22.
ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10. ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
@ -694,7 +694,7 @@ Custom Attributes:
Name | Description Name | Description
------------------------------|-------------- ------------------------------|--------------
ssl_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
ssl_port | **Required.** The port that should be checked. 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_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_warn | **Optional.** Warning threshold for days before the certificate will expire. When used, ssl_cert_valid_days_critical must also be set.
@ -709,7 +709,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
ssmtp_address | **Required.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. ssmtp_address | **Required.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
ssmtp_port | **Optional.** The port that should be checked. Defaults to 465. ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
@ -733,7 +733,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
tcp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
tcp_port | **Required.** The port that should be checked. tcp_port | **Required.** The port that should be checked.
@ -745,7 +745,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
udp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
udp_port | **Required.** The port that should be checked. udp_port | **Required.** The port that should be checked.
udp_send | **Required.** The payload to send in the UDP datagram. udp_send | **Required.** The payload to send in the UDP datagram.
udp_expect | **Required.** The payload to expect in the response datagram. udp_expect | **Required.** The payload to expect in the response datagram.
@ -760,7 +760,7 @@ Custom Attributes:
Name | Description Name | Description
----------------|-------------- ----------------|--------------
ups_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. ups_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
ups_name | **Optional.** The UPS name. Defaults to `ups`. ups_name | **Optional.** The UPS name. Defaults to `ups`.
@ -1099,7 +1099,7 @@ Custom Attributes:
Name | Description Name | Description
------------------------|-------------- ------------------------|--------------
snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false. snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
snmp_community | **Optional.** The SNMP community. Defaults to "public". snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_port | **Optional.** The SNMP port connection. snmp_port | **Optional.** The SNMP port connection.
@ -1124,7 +1124,7 @@ Custom Attributes:
Name | Description Name | Description
------------------------|-------------- ------------------------|--------------
snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false. snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
snmp_community | **Optional.** The SNMP community. Defaults to "public". snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_port | **Optional.** The SNMP port connection. snmp_port | **Optional.** The SNMP port connection.
@ -1148,7 +1148,7 @@ Custom Attributes:
Name | Description Name | Description
------------------------|-------------- ------------------------|--------------
snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false. snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
snmp_community | **Optional.** The SNMP community. Defaults to "public". snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_port | **Optional.** The SNMP port connection. snmp_port | **Optional.** The SNMP port connection.
@ -1173,7 +1173,7 @@ Custom Attributes:
Name | Description Name | Description
----------------------------|-------------- ----------------------------|--------------
snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false. snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
snmp_community | **Optional.** The SNMP community. Defaults to "public". snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_port | **Optional.** The SNMP port connection. snmp_port | **Optional.** The SNMP port connection.
@ -1209,7 +1209,7 @@ Custom Attributes:
Name | Description Name | Description
------------------------|-------------- ------------------------|--------------
snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false. snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
snmp_community | **Optional.** The SNMP community. Defaults to "public". snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_port | **Optional.** The SNMP port connection. snmp_port | **Optional.** The SNMP port connection.