sensu.sensu_go.hook_info (0.7.6) — module

Lists Sensu hooks

Authors: Paul Arthur (@flowerysong), Aljaz Kosir (@aljazkosir), Miha Plesko (@miha-plesko), Tadej Borovsak (@tadeboro)

preview | supported by XLAB Steampunk

Install collection

Install with ansible-galaxy collection install sensu.sensu_go:==0.7.6


Add to requirements.yml

  collections:
    - name: sensu.sensu_go
      version: 0.7.6

Description

For more information, refer to the Sensu documentation at U(https://docs.sensu.io/sensu-go/latest/reference/hooks/)

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List Sensu hooks
  hook_info:
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Fetch Sensu hook
  hook_info:
    name: awesome-hook
  register: result

Inputs

    
auth:
    description:
    - Authentication parameters. Can define each of them with ENV as well.
    suboptions:
      namespace:
        default: default
        description:
        - RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE
          environment variable will be checked.
        type: str
      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.
        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.
        type: str
    type: dict

name:
    description:
    - Retrieve information about this specific object instead of listing all objects.
    type: str

Outputs

objects:
  description: list of Sensu hooks
  returned: always
  type: list