Note
This plugin is part of the sensu.sensu_go collection (version 1.8.0).
To install it use: ansible-galaxy collection install sensu.sensu_go.
To use it in a playbook, specify: sensu.sensu_go.socket_handler.
New in version 1.0.0: of sensu.sensu_go
The below requirements are needed on the host that executes this module.
| 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 |
| 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. | |
| filters list / elements=string | List of filters to use when determining whether to pass the check result to this handler. | ||
| host string | The socket host address (IP or hostname) to connect to. Required if state is present. | ||
| labels dictionary | Custom metadata fields that can be accessed within Sensu, as key/value pairs. | ||
| mutator string | Mutator to call for transforming the check result before passing it to this handler. | ||
| 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. | |
| port integer | The socket port to connect to. Required if state is present. | ||
| state string |
| Target state of the Sensu object. | |
| timeout integer | Timeout for handler execution. | ||
| type string |
| The handler type. Required if state is present. | |
See also
The official documentation on the sensu.sensu_go.handler_info module.
The official documentation on the sensu.sensu_go.pipe_handler module.
The official documentation on the sensu.sensu_go.handler_set module.
- name: TCP handler
sensu.sensu_go.socket_handler:
name: tcp_handler
type: tcp
host: 10.0.1.99
port: 4444
- name: UDP handler
sensu.sensu_go.socket_handler:
name: udp_handler
type: udp
host: 10.0.1.99
port: 4444
- name: Delete a handler
sensu.sensu_go.socket_handler:
name: udp_handler
state: absent
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| object dictionary | success | Object representing Sensu socket handler. Sample: [{'metadata': {'name': 'udp_handler', 'namespace': 'default'}, 'socket': {'host': '10.0.1.99', 'port': 4444}, 'type': 'udp'}] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/socket_handler_module.html