sensu.sensu_go.event_info – List Sensu events¶
Note
This plugin is part of the sensu.sensu_go collection (version 1.9.4).
To install it use: ansible-galaxy collection install sensu.sensu_go
.
To use it in a playbook, specify: sensu.sensu_go.event_info
.
New in version 1.0.0: of sensu.sensu_go
Synopsis¶
Retrieve recent events that Sensu processed.
For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/reference/events/.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
Parameters¶
Parameter | Choices/Defaults | 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
|
Default: "P@ssw0rd!"
|
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.
|
|
url
string
|
Default: "http://localhost:8080"
|
Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.
|
|
user
string
|
Default: "admin"
|
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.
|
|
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.
|
|
check
string
|
Limit results to a specific check.
entity must also be specified if this parameter is used.
|
||
entity
string
|
Limit results to a specific entity.
|
||
namespace
string
|
Default: "default"
|
RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used.
|
See Also¶
See also
- sensu.sensu_go.event
The official documentation on the sensu.sensu_go.event module.
Examples¶
- name: List Sensu events
sensu.sensu_go.event_info:
register: result
- name: List Sensu events for api.example.com
sensu.sensu_go.event_info:
entity: api.example.com
register: result
- name: Filter events by check and entity
sensu.sensu_go.event_info:
entity: api.example.com
check: check-cpu
register: result
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Tadej Borovsak (@tadeboro)