Skip to content

nzlosh/stackstorm_livestatus

Repository files navigation

livestatus integration pack v0.2.0

Shinken/Nagios LiveStatus integration. Carlos nzlosh@yahoo.com

Configuration

The following options are required to be configured for the pack to work correctly.

Option Type Required Secret Description
host string True False Livestatus host address
port integer True False Livestatus listening port

Actions

The pack provides the following actions:

execute_command

Execute an external command using the LiveStatus API. Reference: https://mathias-kettner.de/checkmk_livestatus.html

Parameter Type Required Secret Description
host_name string True default The table to be queried.
sticky boolean False default Cause the command to apply until the state changes to OK.
notify boolean default default Send a notification message.
persistent boolean False default Apply operation to persist between monitoring daemon restarts.
author string True default the name of the person who ran the command.
comment string True default the comment to apply to the operation.

host_to_address

Get the host address from the configuration by using the host name.

Parameter Type Required Secret Description
host string True default Unavailable

get

Retrieve data using the LiveStatus API. Reference: https://mathias-kettner.de/checkmk_livestatus.html

Parameter Type Required Secret Description
table string True default The table to be queried.
columns array False default A list of columns to retrieve in the result set.
filters array False default A list of filters to use as criterion for the result set.
stats array False default A list of basic statistical operations to run.
limit string False default Limit the number of rows being displayed in the result set.
output_format string False default Result format, JSON, Python or CSV. (Only JSON is implemented)
query_max_retries integer False default The number of times a query should be retried before abandoning the request.
query_duration integer False default The amount of time in seconds for a query to run before cancelling it.
query_retry_delay integer False default The amount of time to wait for retrying the query.
allow_empty_list boolean False default True: empty lists allowed, False: empty lists are treated as an error.

state_overview

Return the count of service checks by state (OK, WARNING, CRITICAL or UNKNOWN).

Parameter Type Required Secret Description
skip_notify n/a default default Unavailable

host_services_overview

Get the a hosts services state.

Parameter Type Required Secret Description
host string True default Host name to query.

contact_email

Get the contact name's email address.

Parameter Type Required Secret Description
name string True default Unavailable

Sensors

There are no sensors available for this pack.

Limitations

  • The query limit isn't supported under Shinken's LiveStatus implementation.
  • The author only has access to test against Shinken's LiveStatus implementation. While this should work for Nagios users, there is not testing performed against it.

References

Legal

This packs icon was kindly provided by https://icons8.com.

About

A pack to allow StackStorm to use LiveStatus API

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages