sensu.sensu_go.hook – Manage Sensu hooks

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.hook.

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 Choices/Defaults Comments
annotations
dictionary
Custom metadata fields with fewer restrictions, as key/value pairs.
These are preserved by Sensu but not accessible as tokens or identifiers, and are mainly intended for use with external tools.
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
    Choices:
  • no
  • yes ←
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.
command
string
Command to run when the hook is triggered.
Required if state is present.
labels
dictionary
Custom metadata fields that can be accessed within Sensu, as key/value pairs.
name
string / required
The Sensu resource's name. This name (in combination with the namespace where applicable) uniquely identifies the resource that Ansible operates on.
If the resource with selected name already exists, Ansible module will update it to match the specification in the task.
Consult the name metadata attribute specification in the upstream docs on https://docs.sensu.io/sensu-go/latest/reference/ for more details about valid names and other restrictions.
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.
runtime_assets
list / elements=string
List of runtime assets required to run the check.
state
string
    Choices:
  • present ←
  • absent
Target state of the Sensu object.
stdin
boolean
    Choices:
  • no
  • yes
Controls whether Sensu writes serialized JSON data to the process's stdin.
timeout
integer
The hook execution duration timeout in seconds (hard stop).
Required if state is present.

See Also

See also

sensu.sensu_go.hook_info

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

Examples

- name: Rudimentary auto-remediation hook
  sensu.sensu_go.hook:
    auth:
      url: http://localhost:8080
    name: restart_nginx
    command: sudo systemctl start nginx
    timeout: 60
    stdin: false

- name: Capture the process tree
  sensu.sensu_go.hook:
    auth:
      url: http://localhost:8080
    name: process_tree
    command: ps aux
    timeout: 60
    stdin: false

- name: Delete a hook
  sensu.sensu_go.hook:
    name: process_tree
    state: absent

Return Values

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

Key Returned Description
object
dictionary
success
Object representing Sensu hook.

Sample:
{'command': 'sudo systemctl start nginx', 'metadata': {'annotations': None, 'labels': None, 'name': 'restart_nginx', 'namespace': 'default'}, 'stdin': False, 'timeout': 60}


Authors

  • Paul Arthur (@flowerysong)

  • Aljaz Kosir (@aljazkosir)

  • Miha Plesko (@miha-plesko)

  • Tadej Borovsak (@tadeboro)