`CheckHelpers`
Various helper function to extend other checks.

# `CheckHelpers` — CheckHelpers

Various helper function to extend other checks.

Queries (Overview):

A list of all available queries (check commands)

Command | Description
--- | ---
`check_always_critical` | Run another check and regardless of its return code return CRITICAL.
`check_always_ok` | Run another check and regardless of its return code return OK.
`check_always_warning` | Run another check and regardless of its return code return WARNING.
`check_critical` | Just return CRITICAL (anything passed along will be used as a message).
`check_multi` | Run more then one check and return the worst state.
`check_negate` | Run a check and alter the return status codes according to arguments.
`check_ok` | Just return OK (anything passed along will be used as a message).
`check_timeout` | Run a check and timeout after a given amount of time if the check has not returned.
`check_version` | Just return the NSClient++ version.
`check_warning` | Just return WARNING (anything passed along will be used as a message).
`filter_perf` | Run a check and filter performance data.
`render_perf` | Run a check and render the performance data as output message.
`xform_perf` | Run a check and transform the performance data in various (currently one) way.

Aliases (Overview):

A list of all short hand aliases for queries (check commands)

Command | Description
--- | ---
checkalwayscritical | Alias for: `check_always_critical`
checkalwaysok | Alias for: `check_always_ok`
checkalwayswarning | Alias for: `check_always_warning`
checkcritical | Alias for: `check_critical`
checkmultiple | Alias for: `check_multi`
checkok | Alias for: `check_ok`
checkversion | Alias for: `check_version`
checkwarning | Alias for: `check_warning`
negate | Alias for: `check_negate`
timeout | Alias for: `check_timeout`

Commands (Overview):

TODO: Add a list of all external commands (this is not check commands)

## Queries

A quick reference for all available queries (check commands) in the CheckHelpers module.

### `check_always_critical`

`CheckHelpers` `check_always_critical`
Run another check and regardless of its return code return CRITICAL.

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).

#### Arguments

`help` (CheckHelpers, check_always_critical)
  Show help screen (this screen)

`help-pb` (CheckHelpers, check_always_critical)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, check_always_critical)
  Show default values for a given command

`help-short` (CheckHelpers, check_always_critical)
  Show help screen (short format).

### `check_always_ok`

`CheckHelpers` `check_always_ok`
Run another check and regardless of its return code return OK.

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).

#### Arguments

`help` (CheckHelpers, check_always_ok)
  Show help screen (this screen)

`help-pb` (CheckHelpers, check_always_ok)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, check_always_ok)
  Show default values for a given command

`help-short` (CheckHelpers, check_always_ok)
  Show help screen (short format).

### `check_always_warning`

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

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).

#### Arguments

`help` (CheckHelpers, check_always_warning)
  Show help screen (this screen)

`help-pb` (CheckHelpers, check_always_warning)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, check_always_warning)
  Show default values for a given command

`help-short` (CheckHelpers, check_always_warning)
  Show help screen (short format).

### `check_critical`

`CheckHelpers` `check_critical`
Just return CRITICAL (anything passed along will be used as a message).

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).
`message` | No message | Message to return

#### Arguments

`help` (CheckHelpers, check_critical)
  Show help screen (this screen)

`help-pb` (CheckHelpers, check_critical)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, check_critical)
  Show default values for a given command

`help-short` (CheckHelpers, check_critical)
  Show help screen (short format).

`message` (CheckHelpers, check_critical)
  Message to return

### `check_multi`

`CheckHelpers` `check_multi`
Run more then one check and return the worst state.

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).
`command` |  | Commands to run (can be used multiple times)
`arguments` |  | Deprecated alias for command
`separator` | , | Separator between messages
`prefix` |  | Message prefix
`suffix` |  | Message suffix

#### Arguments

`help` (CheckHelpers, check_multi)
  Show help screen (this screen)

`help-pb` (CheckHelpers, check_multi)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, check_multi)
  Show default values for a given command

`help-short` (CheckHelpers, check_multi)
  Show help screen (short format).

`command` (CheckHelpers, check_multi)
  Commands to run (can be used multiple times)

`arguments` (CheckHelpers, check_multi)
  Deprecated alias for command

`separator` (CheckHelpers, check_multi)
  Separator between messages

`prefix` (CheckHelpers, check_multi)
  Message prefix

`suffix` (CheckHelpers, check_multi)
  Message suffix

### `check_negate`

`CheckHelpers` `check_negate`
Run a check and alter the return status codes according to arguments.

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).
`ok` |  | The state to return instead of OK
`warning` |  | The state to return instead of WARNING
`critical` |  | The state to return instead of CRITICAL
`unknown` |  | The state to return instead of UNKNOWN
`command` |  | Wrapped command to execute
`arguments` |  | List of arguments (for wrapped command)

#### Arguments

`help` (CheckHelpers, check_negate)
  Show help screen (this screen)

`help-pb` (CheckHelpers, check_negate)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, check_negate)
  Show default values for a given command

`help-short` (CheckHelpers, check_negate)
  Show help screen (short format).

`ok` (CheckHelpers, check_negate)
  The state to return instead of OK

`warning` (CheckHelpers, check_negate)
  The state to return instead of WARNING

`critical` (CheckHelpers, check_negate)
  The state to return instead of CRITICAL

`unknown` (CheckHelpers, check_negate)
  The state to return instead of UNKNOWN

`command` (CheckHelpers, check_negate)
  Wrapped command to execute

`arguments` (CheckHelpers, check_negate)
  List of arguments (for wrapped command)

### `check_ok`

`CheckHelpers` `check_ok`
Just return OK (anything passed along will be used as a message).

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).
`message` | No message | Message to return

#### Arguments

`help` (CheckHelpers, check_ok)
  Show help screen (this screen)

`help-pb` (CheckHelpers, check_ok)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, check_ok)
  Show default values for a given command

`help-short` (CheckHelpers, check_ok)
  Show help screen (short format).

`message` (CheckHelpers, check_ok)
  Message to return

### `check_timeout`

`CheckHelpers` `check_timeout`
Run a check and timeout after a given amount of time if the check has not returned.

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).
`timeout` |  | The timeout value
`command` |  | Wrapped command to execute
`arguments` |  | List of arguments (for wrapped command)
`return` |  | The return status

#### Arguments

`help` (CheckHelpers, check_timeout)
  Show help screen (this screen)

`help-pb` (CheckHelpers, check_timeout)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, check_timeout)
  Show default values for a given command

`help-short` (CheckHelpers, check_timeout)
  Show help screen (short format).

`timeout` (CheckHelpers, check_timeout)
  The timeout value

`command` (CheckHelpers, check_timeout)
  Wrapped command to execute

`arguments` (CheckHelpers, check_timeout)
  List of arguments (for wrapped command)

`return` (CheckHelpers, check_timeout)
  The return status

### `check_version`

`CheckHelpers` `check_version`
Just return the NSClient++ version.

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).

#### Arguments

`help` (CheckHelpers, check_version)
  Show help screen (this screen)

`help-pb` (CheckHelpers, check_version)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, check_version)
  Show default values for a given command

`help-short` (CheckHelpers, check_version)
  Show help screen (short format).

### `check_warning`

`CheckHelpers` `check_warning`
Just return WARNING (anything passed along will be used as a message).

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).
`message` | No message | Message to return

#### Arguments

`help` (CheckHelpers, check_warning)
  Show help screen (this screen)

`help-pb` (CheckHelpers, check_warning)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, check_warning)
  Show default values for a given command

`help-short` (CheckHelpers, check_warning)
  Show help screen (short format).

`message` (CheckHelpers, check_warning)
  Message to return

### `filter_perf`

`CheckHelpers` `filter_perf`
Run a check and filter performance data.

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).
`sort` | none | The sort order to use: none, normal or reversed
`limit` | 0 | The maximum number of items to return (0 returns all items)
`command` |  | Wrapped command to execute
`arguments` |  | List of arguments (for wrapped command)

#### Arguments

`help` (CheckHelpers, filter_perf)
  Show help screen (this screen)

`help-pb` (CheckHelpers, filter_perf)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, filter_perf)
  Show default values for a given command

`help-short` (CheckHelpers, filter_perf)
  Show help screen (short format).

`sort` (CheckHelpers, filter_perf)
  The sort order to use: none, normal or reversed

`limit` (CheckHelpers, filter_perf)
  The maximum number of items to return (0 returns all items)

`command` (CheckHelpers, filter_perf)
  Wrapped command to execute

`arguments` (CheckHelpers, filter_perf)
  List of arguments (for wrapped command)

### `render_perf`

`CheckHelpers` `render_perf`
Run a check and render the performance data as output message.

Usage:

:class: contentstable :delim: | :header: “Option”, “Default Value”, “Description”
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).
`debug` | N/A | Show debugging information in the log
`show-all` | N/A | Show debugging information in the log
`filter` | | Filter which marks interesting items.
`warning` | | Filter which marks items which generates a warning state.
`warn` | | Short alias for warning
`critical` | | Filter which marks items which generates a critical state.
`crit` | | Short alias for critical.
`ok` | | Filter which marks items which generates an ok state.
`empty-state` | unknown | Return status to use when nothing matched filter.
`perf-config` | | Performance data generation configuration
`top-syntax` | %(status): %(message) %(list) | Top level syntax.
`ok-syntax` | | ok syntax.
`empty-syntax` | | Empty syntax.
`detail-syntax` | %(key) %(value) %(unit) %(warn) %(crit) %(min) %(max)
Detail level syntax.
`perf-syntax` | %(key) | Performance alias syntax.
`command` | | Wrapped command to execute
`arguments` | | List of arguments (for wrapped command)
`remove-perf` | N/A | List of arguments (for wrapped command)

#### Arguments

`help` (CheckHelpers, render_perf)
  Show help screen (this screen)

`help-pb` (CheckHelpers, render_perf)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, render_perf)
  Show default values for a given command

`help-short` (CheckHelpers, render_perf)
  Show help screen (short format).

`debug` (CheckHelpers, render_perf)
  Show debugging information in the log

`show-all` (CheckHelpers, render_perf)
  Show debugging information in the log

`filter` (CheckHelpers, render_perf)
  Filter which marks interesting items.
  Interesting items are items which will be included in the check.
  They do not denote warning or critical state but they are checked use this to filter out unwanted items.
  Available options:

  Key | Value
  crit | Major version number
  key | Major version number
  max | Major version number
  message | Major version number
  min | Major version number
  unit | Major version number
  value | Major version number
  warn | Major version number
  count | Number of items matching the filter
  total | Total number of items
  ok_count | Number of items matched the ok criteria
  warn_count | Number of items matched the warning criteria
  crit_count | Number of items matched the critical criteria
  problem_count | Number of items matched either warning or critical criteria
  list | A list of all items which matched the filter
  ok_list | A list of all items which matched the ok criteria
  warn_list | A list of all items which matched the warning criteria
  crit_list | A list of all items which matched the critical criteria
  problem_list | A list of all items which matched either the critical or the warning criteria
  detail_list | A special list with critical, then warning and fainally ok
  status | The returned status (OK/WARN/CRIT/UNKNOWN)

`warning` (CheckHelpers, render_perf)
  Filter which marks items which generates a warning state.
  If anything matches this filter the return status will be escalated to warning.
  Available options:

  Key | Value
  crit | Major version number
  key | Major version number
  max | Major version number
  message | Major version number
  min | Major version number
  unit | Major version number
  value | Major version number
  warn | Major version number
  count | Number of items matching the filter
  total | Total number of items
  ok_count | Number of items matched the ok criteria
  warn_count | Number of items matched the warning criteria
  crit_count | Number of items matched the critical criteria
  problem_count | Number of items matched either warning or critical criteria
  list | A list of all items which matched the filter
  ok_list | A list of all items which matched the ok criteria
  warn_list | A list of all items which matched the warning criteria
  crit_list | A list of all items which matched the critical criteria
  problem_list | A list of all items which matched either the critical or the warning criteria
  detail_list | A special list with critical, then warning and fainally ok
  status | The returned status (OK/WARN/CRIT/UNKNOWN)

`warn` (CheckHelpers, render_perf)
  Short alias for warning

`critical` (CheckHelpers, render_perf)
  Filter which marks items which generates a critical state.
  If anything matches this filter the return status will be escalated to critical.
  Available options:

  Key | Value
  crit | Major version number
  key | Major version number
  max | Major version number
  message | Major version number
  min | Major version number
  unit | Major version number
  value | Major version number
  warn | Major version number
  count | Number of items matching the filter
  total | Total number of items
  ok_count | Number of items matched the ok criteria
  warn_count | Number of items matched the warning criteria
  crit_count | Number of items matched the critical criteria
  problem_count | Number of items matched either warning or critical criteria
  list | A list of all items which matched the filter
  ok_list | A list of all items which matched the ok criteria
  warn_list | A list of all items which matched the warning criteria
  crit_list | A list of all items which matched the critical criteria
  problem_list | A list of all items which matched either the critical or the warning criteria
  detail_list | A special list with critical, then warning and fainally ok
  status | The returned status (OK/WARN/CRIT/UNKNOWN)

`crit` (CheckHelpers, render_perf)
  Short alias for critical.

`ok` (CheckHelpers, render_perf)
  Filter which marks items which generates an ok state.
  If anything matches this any previous state for this item will be reset to ok.
  Available options:

  Key | Value
  crit | Major version number
  key | Major version number
  max | Major version number
  message | Major version number
  min | Major version number
  unit | Major version number
  value | Major version number
  warn | Major version number
  count | Number of items matching the filter
  total | Total number of items
  ok_count | Number of items matched the ok criteria
  warn_count | Number of items matched the warning criteria
  crit_count | Number of items matched the critical criteria
  problem_count | Number of items matched either warning or critical criteria
  list | A list of all items which matched the filter
  ok_list | A list of all items which matched the ok criteria
  warn_list | A list of all items which matched the warning criteria
  crit_list | A list of all items which matched the critical criteria
  problem_list | A list of all items which matched either the critical or the warning criteria
  detail_list | A special list with critical, then warning and fainally ok
  status | The returned status (OK/WARN/CRIT/UNKNOWN)

`empty-state` (CheckHelpers, render_perf)
  Return status to use when nothing matched filter.
  If no filter is specified this will never happen unless the file is empty.

`perf-config` (CheckHelpers, render_perf)
  Performance data generation configuration
  TODO: obj ( key: value; key: value) obj (key:valuer;key:value)

`top-syntax` (CheckHelpers, render_perf)
  Top level syntax.
  Used to format the message to return can include strings as well as special keywords such as:

  Key | Value
  %(crit) | Major version number
  %(key) | Major version number
  %(max) | Major version number
  %(message) | Major version number
  %(min) | Major version number
  %(unit) | Major version number
  %(value) | Major version number
  %(warn) | Major version number
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`ok-syntax` (CheckHelpers, render_perf)
  ok syntax.
  DEPRECATED! This is the syntax for when an ok result is returned.
  This value will not be used if your syntax contains %(list) or %(count).

`empty-syntax` (CheckHelpers, render_perf)
  Empty syntax.
  DEPRECATED! This is the syntax for when nothing matches the filter.
  Possible values are:

  Key | Value
  %(crit) | Major version number
  %(key) | Major version number
  %(max) | Major version number
  %(message) | Major version number
  %(min) | Major version number
  %(unit) | Major version number
  %(value) | Major version number
  %(warn) | Major version number
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`detail-syntax` (CheckHelpers, render_perf)
  Detail level syntax.
  This is the syntax of each item in the list of top-syntax (see above).
  Possible values are:

  Key | Value
  %(crit) | Major version number
  %(key) | Major version number
  %(max) | Major version number
  %(message) | Major version number
  %(min) | Major version number
  %(unit) | Major version number
  %(value) | Major version number
  %(warn) | Major version number
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`perf-syntax` (CheckHelpers, render_perf)
  Performance alias syntax.
  This is the syntax for the base names of the performance data.
  Possible values are:

  Key | Value
  %(crit) | Major version number
  %(key) | Major version number
  %(max) | Major version number
  %(message) | Major version number
  %(min) | Major version number
  %(unit) | Major version number
  %(value) | Major version number
  %(warn) | Major version number
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`command` (CheckHelpers, render_perf)
  Wrapped command to execute

`arguments` (CheckHelpers, render_perf)
  List of arguments (for wrapped command)

`remove-perf` (CheckHelpers, render_perf)
  List of arguments (for wrapped command)

### `xform_perf`

`CheckHelpers` `xform_perf`
Run a check and transform the performance data in various (currently one) way.

Usage:

:class: contentstable :delim: | :header: “Option”, “Default Value”, “Description”
`help` | N/A | Show help screen (this screen) |  |  |  |
`help-pb` | N/A | Show help screen as a protocol buffer payload |  |  |  |
`show-default` | N/A | Show default values for a given command |  |  |  |
`help-short` | N/A | Show help screen (short format). |  |  |  |
`debug` | N/A | Show debugging information in the log |  |  |  |
`show-all` | N/A | Show debugging information in the log |  |  |  |
`filter` | | Filter which marks interesting items. |  |  |  |
`warning` | | Filter which marks items which generates a warning state. |  |  |  |
`warn` | | Short alias for warning |  |  |  |
`critical` | | Filter which marks items which generates a critical state. |  |  |  |
`crit` | | Short alias for critical. |  |  |  |
`ok` | | Filter which marks items which generates an ok state. |  |  |  |
`empty-state` | unknown | Return status to use when nothing matched filter. |  |  |  |
`perf-config` | | Performance data generation configuration |  |  |  |
`top-syntax` | %(status): %(message) %(list) | Top level syntax. |  |  |  |
`ok-syntax` | | ok syntax. |  |  |  |
`empty-syntax` | | Empty syntax. |  |  |  |
`detail-syntax` | %(key) %(value) %(unit) %(warn) %(crit) %(min) %(max) |  |  |  |
Detail level syntax. |  |  |  |
`perf-syntax` | %(key) | Performance alias syntax. |  |  |  |
`command` | | Wrapped command to execute |  |  |  |
`arguments` | | List of arguments (for wrapped command) |  |  |  |
`mode` | | Transformation mode (currently only supports extract) |  |  |  |
`field` | | Field to work with (value | warn | crit | max | min)
`replace` | | Replace expression for the alias |  |  |  |

#### Arguments

`help` (CheckHelpers, xform_perf)
  Show help screen (this screen)

`help-pb` (CheckHelpers, xform_perf)
  Show help screen as a protocol buffer payload

`show-default` (CheckHelpers, xform_perf)
  Show default values for a given command

`help-short` (CheckHelpers, xform_perf)
  Show help screen (short format).

`debug` (CheckHelpers, xform_perf)
  Show debugging information in the log

`show-all` (CheckHelpers, xform_perf)
  Show debugging information in the log

`filter` (CheckHelpers, xform_perf)
  Filter which marks interesting items.
  Interesting items are items which will be included in the check.
  They do not denote warning or critical state but they are checked use this to filter out unwanted items.
  Available options:

  Key | Value
  crit | Major version number
  key | Major version number
  max | Major version number
  message | Major version number
  min | Major version number
  unit | Major version number
  value | Major version number
  warn | Major version number
  count | Number of items matching the filter
  total | Total number of items
  ok_count | Number of items matched the ok criteria
  warn_count | Number of items matched the warning criteria
  crit_count | Number of items matched the critical criteria
  problem_count | Number of items matched either warning or critical criteria
  list | A list of all items which matched the filter
  ok_list | A list of all items which matched the ok criteria
  warn_list | A list of all items which matched the warning criteria
  crit_list | A list of all items which matched the critical criteria
  problem_list | A list of all items which matched either the critical or the warning criteria
  detail_list | A special list with critical, then warning and fainally ok
  status | The returned status (OK/WARN/CRIT/UNKNOWN)

`warning` (CheckHelpers, xform_perf)
  Filter which marks items which generates a warning state.
  If anything matches this filter the return status will be escalated to warning.
  Available options:

  Key | Value
  crit | Major version number
  key | Major version number
  max | Major version number
  message | Major version number
  min | Major version number
  unit | Major version number
  value | Major version number
  warn | Major version number
  count | Number of items matching the filter
  total | Total number of items
  ok_count | Number of items matched the ok criteria
  warn_count | Number of items matched the warning criteria
  crit_count | Number of items matched the critical criteria
  problem_count | Number of items matched either warning or critical criteria
  list | A list of all items which matched the filter
  ok_list | A list of all items which matched the ok criteria
  warn_list | A list of all items which matched the warning criteria
  crit_list | A list of all items which matched the critical criteria
  problem_list | A list of all items which matched either the critical or the warning criteria
  detail_list | A special list with critical, then warning and fainally ok
  status | The returned status (OK/WARN/CRIT/UNKNOWN)

`warn` (CheckHelpers, xform_perf)
  Short alias for warning

`critical` (CheckHelpers, xform_perf)
  Filter which marks items which generates a critical state.
  If anything matches this filter the return status will be escalated to critical.
  Available options:

  Key | Value
  crit | Major version number
  key | Major version number
  max | Major version number
  message | Major version number
  min | Major version number
  unit | Major version number
  value | Major version number
  warn | Major version number
  count | Number of items matching the filter
  total | Total number of items
  ok_count | Number of items matched the ok criteria
  warn_count | Number of items matched the warning criteria
  crit_count | Number of items matched the critical criteria
  problem_count | Number of items matched either warning or critical criteria
  list | A list of all items which matched the filter
  ok_list | A list of all items which matched the ok criteria
  warn_list | A list of all items which matched the warning criteria
  crit_list | A list of all items which matched the critical criteria
  problem_list | A list of all items which matched either the critical or the warning criteria
  detail_list | A special list with critical, then warning and fainally ok
  status | The returned status (OK/WARN/CRIT/UNKNOWN)

`crit` (CheckHelpers, xform_perf)
  Short alias for critical.

`ok` (CheckHelpers, xform_perf)
  Filter which marks items which generates an ok state.
  If anything matches this any previous state for this item will be reset to ok.
  Available options:

  Key | Value
  crit | Major version number
  key | Major version number
  max | Major version number
  message | Major version number
  min | Major version number
  unit | Major version number
  value | Major version number
  warn | Major version number
  count | Number of items matching the filter
  total | Total number of items
  ok_count | Number of items matched the ok criteria
  warn_count | Number of items matched the warning criteria
  crit_count | Number of items matched the critical criteria
  problem_count | Number of items matched either warning or critical criteria
  list | A list of all items which matched the filter
  ok_list | A list of all items which matched the ok criteria
  warn_list | A list of all items which matched the warning criteria
  crit_list | A list of all items which matched the critical criteria
  problem_list | A list of all items which matched either the critical or the warning criteria
  detail_list | A special list with critical, then warning and fainally ok
  status | The returned status (OK/WARN/CRIT/UNKNOWN)

`empty-state` (CheckHelpers, xform_perf)
  Return status to use when nothing matched filter.
  If no filter is specified this will never happen unless the file is empty.

`perf-config` (CheckHelpers, xform_perf)
  Performance data generation configuration
  TODO: obj ( key: value; key: value) obj (key:valuer;key:value)

`top-syntax` (CheckHelpers, xform_perf)
  Top level syntax.
  Used to format the message to return can include strings as well as special keywords such as:

  Key | Value
  %(crit) | Major version number
  %(key) | Major version number
  %(max) | Major version number
  %(message) | Major version number
  %(min) | Major version number
  %(unit) | Major version number
  %(value) | Major version number
  %(warn) | Major version number
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`ok-syntax` (CheckHelpers, xform_perf)
  ok syntax.
  DEPRECATED! This is the syntax for when an ok result is returned.
  This value will not be used if your syntax contains %(list) or %(count).

`empty-syntax` (CheckHelpers, xform_perf)
  Empty syntax.
  DEPRECATED! This is the syntax for when nothing matches the filter.
  Possible values are:

  Key | Value
  %(crit) | Major version number
  %(key) | Major version number
  %(max) | Major version number
  %(message) | Major version number
  %(min) | Major version number
  %(unit) | Major version number
  %(value) | Major version number
  %(warn) | Major version number
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`detail-syntax` (CheckHelpers, xform_perf)
  Detail level syntax.
  This is the syntax of each item in the list of top-syntax (see above).
  Possible values are:

  Key | Value
  %(crit) | Major version number
  %(key) | Major version number
  %(max) | Major version number
  %(message) | Major version number
  %(min) | Major version number
  %(unit) | Major version number
  %(value) | Major version number
  %(warn) | Major version number
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`perf-syntax` (CheckHelpers, xform_perf)
  Performance alias syntax.
  This is the syntax for the base names of the performance data.
  Possible values are:

  Key | Value
  %(crit) | Major version number
  %(key) | Major version number
  %(max) | Major version number
  %(message) | Major version number
  %(min) | Major version number
  %(unit) | Major version number
  %(value) | Major version number
  %(warn) | Major version number
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`command` (CheckHelpers, xform_perf)
  Wrapped command to execute

`arguments` (CheckHelpers, xform_perf)
  List of arguments (for wrapped command)

`mode` (CheckHelpers, xform_perf)
  Transformation mode (currently only supports extract)

`field` (CheckHelpers, xform_perf)
  Field to work with (value, warn, crit, max, min)

`replace` (CheckHelpers, xform_perf)
  Replace expression for the alias

comments powered by Disqus