sensu.sensu_go.hook module – Manage Sensu hooks
Note
This module is part of the sensu.sensu_go collection (version 1.13.2).
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.hook
.
New in sensu.sensu_go 1.0.0
Synopsis
Create, update or delete Sensu hook.
For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/reference/hooks/.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
Parameters
Parameter |
Comments |
---|---|
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. Default: |
|
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:
|
|
Command to run when the hook is triggered. Required if state is |
|
Custom metadata fields that can be accessed within Sensu, as key/value pairs. Default: |
|
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. |
|
RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used. Default: |
|
List of runtime assets required to run the check. |
|
Target state of the Sensu object. Choices:
|
|
Controls whether Sensu writes serialized JSON data to the process’s stdin. Choices:
|
|
The hook execution duration timeout in seconds (hard stop). Required if state is |
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 |
Description |
---|---|
Object representing Sensu hook. Returned: success Sample: |