sensu.sensu_go.silence_info (0.9.0) — module

Lists Sensu silence entries

Authors: Paul Arthur (@flowerysong), Aljaz Kosir (@aljazkosir), Manca Bizjak (@mancabizjak), Tadej Borovsak (@tadeboro)

preview | supported by XLAB Steampunk

Install collection

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


Add to requirements.yml

  collections:
    - name: sensu.sensu_go
      version: 0.9.0

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List Sensu silence entries
  silence_info:
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Fetch specific silence with name proxy:awesome_check
  silence_info:
    subscription: proxy
    check: awesome_check
  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

check:
    description:
    - The name of the check the entry should match. If left empty a silencing entry will
      contain an asterisk in the check position.
    type: str

subscription:
    description:
    - The name of the subscription the entry should match. If left empty a silencing entry
      will contain an asterisk in the subscription position.
    type: str

Outputs

objects:
  description: list of Sensu silence entries
  returned: always
  type: list