sensu.sensu_go.silence_info module – List Sensu silence entries
Note
This module is part of the sensu.sensu_go collection (version 1.14.0).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: sensu.sensu_go.silence_info.
Note
The sensu.sensu_go collection will be removed from Ansible 12 due to violations of the Ansible inclusion requirements. The collection has unresolved sanity test failures. See the discussion thread for more information.
New in sensu.sensu_go 1.0.0
Synopsis
Retrieve information about Sensu silences.
For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/reference/silencing/.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
Parameters
Parameter |
Comments |
|---|---|
Authentication parameters. Can define each of them with ENV as well. |
|
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/. |
|
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. |
|
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: |
|
Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked. Default: |
|
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: |
|
Flag that controls the certificate validation. If you are using self-signed certificates, you can set this parameter to 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:
|
|
The name of the check the entry should match. If left empty a silencing entry will contain an asterisk in the check position. |
|
RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used. Default: |
|
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
Manage Sensu silences.
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 |
|---|---|
List of Sensu silence entries. Returned: success Sample: |