sensu.sensu_go.sensu_go_event (0.3.0) — module

Manages Sensu events

| "added in version" 0.1.0 of sensu.sensu_go"

Authors: Paul Arthur (@flowerysong)

preview | supported by community

Install collection

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


Add to requirements.yml

  collections:
    - name: sensu.sensu_go
      version: 0.3.0

Description

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

Inputs

    
url:
    default: http://localhost:8080
    description:
    - Location of the Sensu backend API. If this is not set the value of the SENSU_BACKEND_URL
      environment variable will be checked.
    type: str

name:
    description:
    - The Sensu object's name.
    required: true
    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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Target state of the Sensu object.
    type: str

entity:
    description:
    - Name of the entity associated with this event.
    required: true
    type: str

labels:
    description:
    - Custom metadata fields that can be accessed within Sensu, as key/value pairs.
    type: dict

output:
    description:
    - Event output.
    type: str

status:
    choices:
    - ok
    - warning
    - critical
    - unknown
    default: ok
    description:
    - Event status.
    type: str

duration:
    default: 0.0
    description:
    - Amount of time the check ran for.
    type: float

handlers:
    default: []
    description:
    - Handlers for this event.
    type: list

interval:
    default: 60
    description:
    - Interval the check runs at. I don't know why this is useful for ad-hoc events, but
      it is required by the API.
    type: int

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

namespace:
    default: default
    description:
    - RBAC namespace to operate in.
    type: str

annotations:
    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

entity_class:
    aliases:
    - class
    default: proxy
    description:
    - Class the entity belongs to.
    - The standard classes are 'proxy' and 'agent'.
    type: str

entity_labels:
    default: {}
    description:
    - C(labels) for the entity associated with this event.
    type: dict

entity_annotations:
    default: {}
    description:
    - C(annotations) for the entity associated with this event.
    type: dict