[[TracNav(TracNav/CC|nocollapse|noreorder)]]
[[PageOutline]]
= CheckHelpers =
Various helper function to extend other checks.

== Queries (Overview) ==
A list of all avalible queries (check commands)

 * [[CheckHelpers/check_always_warning|check_always_warning]]
   Run another check and regardless of its return code return WARNING.
 * [[CheckHelpers/check_always_critical|check_always_critical]]
   Run another check and regardless of its return code return CRITICAL.
 * [[CheckHelpers/check_always_ok|check_always_ok]]
   Run another check and regardless of its return code return OK.
 * [[CheckHelpers/check_multi|check_multi]]
   Run more then one check and return the worst state.
 * [[CheckHelpers/check_timeout|check_timeout]]
   Run a check and timeout after a given amount of time if the check has not returned.
 * [[CheckHelpers/check_ok|check_ok]]
   Just return OK (anything passed along will be used as a message).
 * [[CheckHelpers/check_critical|check_critical]]
   Just return CRITICAL (anything passed along will be used as a message).
 * [[CheckHelpers/check_warning|check_warning]]
   Just return WARNING (anything passed along will be used as a message).
 * [[CheckHelpers/check_version|check_version]]
   Just return the NSClient++ version.
 * [[CheckHelpers/check_negate|check_negate]]
   Run a check and alter the return status codes according to arguments.
== Aliases ==
A list of all avalible aliases for queries and check commands

 * [[CheckHelpers/check_always_warning|CheckAlwaysWARNING]]
   Alternative name for: check_always_warning
   Run another check and regardless of its return code return WARNING.
 * [[CheckHelpers/check_negate|negate]]
   Alternative name for: check_negate
   Run a check and alter the return status codes according to arguments.
 * [[CheckHelpers/check_always_ok|CheckAlwaysOK]]
   Alternative name for: check_always_ok
   Run another check and regardless of its return code return OK.
 * [[CheckHelpers/check_warning|CheckWARNING]]
   Alternative name for: check_warning
   Just return WARNING (anything passed along will be used as a message).
 * [[CheckHelpers/check_critical|CheckCRITICAL]]
   Alternative name for: check_critical
   Just return CRITICAL (anything passed along will be used as a message).
 * [[CheckHelpers/check_ok|CheckOK]]
   Alternative name for: check_ok
   Just return OK (anything passed along will be used as a message).
 * [[CheckHelpers/check_version|CheckVersion]]
   Alternative name for: check_version
   Just return the NSClient++ version.
 * [[CheckHelpers/check_multi|CheckMultiple]]
   Alternative name for: check_multi
   Run more then one check and return the worst state.
 * [[CheckHelpers/check_always_critical|CheckAlwaysCRITICAL]]
   Alternative name for: check_always_critical
   Run another check and regardless of its return code return CRITICAL.
 * [[CheckHelpers/check_timeout|timeout]]
   Alternative name for: check_timeout
   Run a check and timeout after a given amount of time if the check has not returned.


== Commands (executable) ==
'''TODO:''' Add command list


== Configuration ==
''No configuration avalible for CheckHelpers''

== Queries (Reference) ==
A quick reference for all avalible queries (check commands) in the CheckHelpers module.

=== check_always_warning ===
Run another check and regardless of its return code return WARNING.

For details on this command go to the [wiki:CheckHelpers/check_always_warning check_always_warning] page

'''Usage:''' (Click any option to go to the description page for that option)
||= '''Option''' =||= '''Default value''' =||= '''Description''' 
|| [wiki:CheckHelpers/check_always_warning#help_ help] ||N/A ||Show help screen (this screen)
|| [wiki:CheckHelpers/check_always_warning#help-csv help-csv] ||N/A ||Show help screen as a comma separated list. 
=== check_always_critical ===
Run another check and regardless of its return code return CRITICAL.

For details on this command go to the [wiki:CheckHelpers/check_always_critical check_always_critical] page

'''Usage:''' (Click any option to go to the description page for that option)
||= '''Option''' =||= '''Default value''' =||= '''Description''' 
|| [wiki:CheckHelpers/check_always_critical#help_ help] ||N/A ||Show help screen (this screen)
|| [wiki:CheckHelpers/check_always_critical#help-csv help-csv] ||N/A ||Show help screen as a comma separated list. 
=== check_always_ok ===
Run another check and regardless of its return code return OK.

For details on this command go to the [wiki:CheckHelpers/check_always_ok check_always_ok] page

'''Usage:''' (Click any option to go to the description page for that option)
||= '''Option''' =||= '''Default value''' =||= '''Description''' 
|| [wiki:CheckHelpers/check_always_ok#help_ help] ||N/A ||Show help screen (this screen)
|| [wiki:CheckHelpers/check_always_ok#help-csv help-csv] ||N/A ||Show help screen as a comma separated list. 
=== check_multi ===
Run more then one check and return the worst state.

For details on this command go to the [wiki:CheckHelpers/check_multi check_multi] page

'''Usage:''' (Click any option to go to the description page for that option)
||= '''Option''' =||= '''Default value''' =||= '''Description''' 
|| [wiki:CheckHelpers/check_multi#help_ help] ||N/A ||Show help screen (this screen)
|| [wiki:CheckHelpers/check_multi#help-csv help-csv] ||N/A ||Show help screen as a comma separated list. 
|| [wiki:CheckHelpers/check_multi#arguments arguments] || ||List of commands with arguments to run
=== check_timeout ===
Run a check and timeout after a given amount of time if the check has not returned.

For details on this command go to the [wiki:CheckHelpers/check_timeout check_timeout] page

'''Usage:''' (Click any option to go to the description page for that option)
||= '''Option''' =||= '''Default value''' =||= '''Description''' 
|| [wiki:CheckHelpers/check_timeout#help_ help] ||N/A ||Show help screen (this screen)
|| [wiki:CheckHelpers/check_timeout#help-csv help-csv] ||N/A ||Show help screen as a comma separated list. 
|| [wiki:CheckHelpers/check_timeout#timeout timeout] || ||The timeout value
|| [wiki:CheckHelpers/check_timeout#command command] || ||Wrapped command to execute
|| [wiki:CheckHelpers/check_timeout#arguments arguments] || ||List of arguments (for wrapped command)
|| [wiki:CheckHelpers/check_timeout#return return] || ||The return status
=== check_ok ===
Just return OK (anything passed along will be used as a message).

For details on this command go to the [wiki:CheckHelpers/check_ok check_ok] page

'''Usage:''' (Click any option to go to the description page for that option)
||= '''Option''' =||= '''Default value''' =||= '''Description''' 
|| [wiki:CheckHelpers/check_ok#help_ help] ||N/A ||Show help screen (this screen)
|| [wiki:CheckHelpers/check_ok#help-csv help-csv] ||N/A ||Show help screen as a comma separated list. 
=== check_critical ===
Just return CRITICAL (anything passed along will be used as a message).

For details on this command go to the [wiki:CheckHelpers/check_critical check_critical] page

'''Usage:''' (Click any option to go to the description page for that option)
||= '''Option''' =||= '''Default value''' =||= '''Description''' 
|| [wiki:CheckHelpers/check_critical#help_ help] ||N/A ||Show help screen (this screen)
|| [wiki:CheckHelpers/check_critical#help-csv help-csv] ||N/A ||Show help screen as a comma separated list. 
=== check_warning ===
Just return WARNING (anything passed along will be used as a message).

For details on this command go to the [wiki:CheckHelpers/check_warning check_warning] page

'''Usage:''' (Click any option to go to the description page for that option)
||= '''Option''' =||= '''Default value''' =||= '''Description''' 
|| [wiki:CheckHelpers/check_warning#help_ help] ||N/A ||Show help screen (this screen)
|| [wiki:CheckHelpers/check_warning#help-csv help-csv] ||N/A ||Show help screen as a comma separated list. 
=== check_version ===
Just return the NSClient++ version.

For details on this command go to the [wiki:CheckHelpers/check_version check_version] page

'''Usage:''' (Click any option to go to the description page for that option)
||= '''Option''' =||= '''Default value''' =||= '''Description''' 
|| [wiki:CheckHelpers/check_version#0 0] ||2 ||1 2012-08-08
=== check_negate ===
Run a check and alter the return status codes according to arguments.

For details on this command go to the [wiki:CheckHelpers/check_negate check_negate] page

'''Usage:''' (Click any option to go to the description page for that option)
||= '''Option''' =||= '''Default value''' =||= '''Description''' 
|| [wiki:CheckHelpers/check_negate#help_ help] ||N/A ||Show help screen (this screen)
|| [wiki:CheckHelpers/check_negate#help-csv help-csv] ||N/A ||Show help screen as a comma separated list. 
|| [wiki:CheckHelpers/check_negate#ok ok] || ||The state to return instead of OK
|| [wiki:CheckHelpers/check_negate#warning warning] || ||The state to return instead of WARNING
|| [wiki:CheckHelpers/check_negate#critical critical] || ||The state to return instead of CRITICAL
|| [wiki:CheckHelpers/check_negate#unknown unknown] || ||The state to return instead of UNKNOWN
|| [wiki:CheckHelpers/check_negate#command command] || ||Wrapped command to execute
|| [wiki:CheckHelpers/check_negate#arguments arguments] || ||List of arguments (for wrapped command)