sensu.sensu_go.silence_info module – List Sensu silence entries

Note

This module is part of the sensu.sensu_go collection (version 1.13.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install sensu.sensu_go.

To use it in a playbook, specify: sensu.sensu_go.silence_info.

New in version 1.0.0: of sensu.sensu_go

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

Parameters

Parameter

Comments

auth

dictionary

Authentication parameters. Can define each of them with ENV as well.

api_key

string

added in 1.3.0 of sensu.sensu_go

The API key that should be used when authenticating. If this is not set, the value of the SENSU_API_KEY environment variable will be checked.

This replaces auth.user and auth.password parameters.

For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.

ca_path

path

added in 1.5.0 of sensu.sensu_go

Path to the CA bundle that should be used to validate the backend certificate.

If this parameter is not set, module will use the CA bundle that python is using.

It is also possible to set this parameter via the SENSU_CA_PATH environment variable.

password

string

The Sensu user’s password. If this is not set the value of the SENSU_PASSWORD environment variable will be checked.

This parameter is ignored if the auth.api_key parameter is set.

Default: “P@ssw0rd!”

url

string

Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.

Default: “http://localhost:8080”

user

string

The username to use for connecting to the Sensu API. If this is not set the value of the SENSU_USER environment variable will be checked.

This parameter is ignored if the auth.api_key parameter is set.

Default: “admin”

verify

boolean

added in 1.5.0 of sensu.sensu_go

Flag that controls the certificate validation.

If you are using self-signed certificates, you can set this parameter to false.

ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter.

It is also possible to set this parameter via the SENSU_VERIFY environment variable.

Choices:

  • no

  • yes ← (default)

check

string

The name of the check the entry should match. If left empty a silencing entry will contain an asterisk in the check position.

namespace

string

RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used.

Default: “default”

subscription

string

The name of the subscription the entry should match. If left empty a silencing entry will contain an asterisk in the subscription position.

See Also

See also

sensu.sensu_go.silence

The official documentation on the sensu.sensu_go.silence module.

Examples

- name: List all Sensu silence entries
  sensu.sensu_go.silence_info:
  register: result

- name: Fetch a specific silence with name proxy:awesome_check
  sensu.sensu_go.silence_info:
    subscription: proxy
    check: awesome_check
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

objects

list / elements=dictionary

List of Sensu silence entries.

Returned: success

Sample: [{“begin”: 1542671205, “check”: null, “creator”: “admin”, “expire”: -1, “expire_on_resolve”: false, “metadata”: {“annotations”: null, “labels”: null, “name”: “entity:i-424242:*”, “namespace”: “default”}, “reason”: null, “subscription”: “entity:i-424242”}]

Authors

  • Paul Arthur (@flowerysong)

  • Aljaz Kosir (@aljazkosir)

  • Manca Bizjak (@mancabizjak)

  • Tadej Borovsak (@tadeboro)