sensu.sensu_go.sensu_go_entity (0.7.2) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: sensu.sensu_go
      version: 0.7.2

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a proxy entity
  sensu_go_entity:
    name: api.example.com
    subscriptions:
      - tls
    metadata:
      labels:
        Status: production

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Modify an agent entity
  sensu_go_entity:
    name: api-server-01.example.com
    entity_class: agent
    labels:
      Status: outofservice

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

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

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

deregister:
    default: false
    description:
    - Whether automatic deregistration should be enabled.
    type: bool

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:
    default: proxy
    description:
    - Entity class. Standard classes are 'proxy' and 'agent', but you can use whatever
      you want.
    type: str

subscriptions:
    default: []
    description:
    - List of subscriptions for the entity.
    type: list

deregistration_handler:
    description:
    - Handler to call for deregistration events.
    type: str