sensu / sensu.sensu_go / 1.14.0 / module / socket_handler Manage Sensu TCP/UDP handler | "added in version" 1.0.0 of sensu.sensu_go" Authors: Aljaz Kosir (@aljazkosir), Miha Plesko (@miha-plesko), Tadej Borovsak (@tadeboro) stableinterface | supported by certifiedsensu.sensu_go.socket_handler (1.14.0) — module
Install with ansible-galaxy collection install sensu.sensu_go:==1.14.0
collections: - name: sensu.sensu_go version: 1.14.0
Create, update or delete Sensu socket handler.
For more information, refer to the Sensu documentation at U(https://docs.sensu.io/sensu-go/latest/reference/handlers/#tcp-udp-handlers).
- 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
auth: description: - Authentication parameters. Can define each of them with ENV as well. suboptions: api_key: description: - 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 I(auth.user) and I(auth.password) parameters. - For more information about the API key, refer to the official Sensu documentation at U(https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/). type: str version_added: 1.3.0 version_added_collection: sensu.sensu_go ca_path: description: - 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 I(SENSU_CA_PATH) environment variable. type: path version_added: 1.5.0 version_added_collection: sensu.sensu_go password: default: P@ssw0rd! description: - 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 I(auth.api_key) parameter is set. type: str url: default: http://localhost:8080 description: - Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked. type: str user: default: admin description: - 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 I(auth.api_key) parameter is set. type: str verify: default: true description: - Flag that controls the certificate validation. - If you are using self-signed certificates, you can set this parameter to C(false). - ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the I(auth.ca_path) parameter. - It is also possible to set this parameter via the I(SENSU_VERIFY) environment variable. type: bool version_added: 1.5.0 version_added_collection: sensu.sensu_go type: dict host: description: - The socket host address (IP or hostname) to connect to. - Required if I(state) is C(present). type: str name: description: - 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 I(name) metadata attribute specification in the upstream docs on U(https://docs.sensu.io/sensu-go/latest/reference/) for more details about valid names and other restrictions. required: true type: str port: description: - The socket port to connect to. - Required if I(state) is C(present). type: int type: choices: - tcp - udp description: - The handler type. - Required if I(state) is C(present). type: str state: choices: - present - absent default: present description: - Target state of the Sensu object. type: str labels: default: {} description: - Custom metadata fields that can be accessed within Sensu, as key/value pairs. type: dict filters: description: - List of filters to use when determining whether to pass the check result to this handler. elements: str type: list mutator: description: - Mutator to call for transforming the check result before passing it to this handler. type: str timeout: description: - Timeout for handler execution. type: int namespace: default: default description: - RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used. type: str annotations: default: {} description: - 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. type: dict
object: description: Object representing Sensu socket handler. returned: success sample: - metadata: name: udp_handler namespace: default socket: host: 10.0.1.99 port: 4444 type: udp type: dict