entity – Manage Sensu entities

Create, update or delete Sensu entity.

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

New in version 1.0.0.

Requirements

The below requirements are needed on the host that executes this module:

  • python >= 2.7

Examples

- name: Create an entity
  sensu.sensu_go.entity:
    auth:
      url: http://localhost:8080
    name: entity
    entity_class: proxy
    subscriptions:
      - web
      - prod
    system:
      hostname: playbook-entity
      os: linux
      platform: ubutntu
      network:
        interfaces:
          - name: lo
            addresses:
              - 127.0.0.1/8
              - ::1/128
          - name: eth0
            mac: 52:54:00:20:1b:3c
            addresses:
              - 93.184.216.34/24
    last_seen: 1522798317
    deregister: yes
    deregistration_handler: email-handler
    redact:
      - password
      - pass
      - api_key
    user: agent

- name: Delete an entity
  sensu.sensu_go.entity:
    name: entity
    state: absent

See Also

See also

Parameters

annotations (optional)

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
auth (optional)

Authentication parameters. Can define each of them with ENV as well.

type: dict
api_key (optional)

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 auth.user and auth.password parameters.

For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.

type: str
ca_path (optional)

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 SENSU_CA_PATH environment variable.

type: path
password (optional)

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 auth.api_key parameter is set.

type: str
default: P@ssw0rd!
url (optional)

Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.

type: str
default: http://localhost:8080
user (optional)

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 auth.api_key parameter is set.

type: str
default: admin
verify (optional)

Flag that controls the certificate validation.

If you are using self-signed certificates, you can set this parameter to false.

ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter.

It is also possible to set this parameter via the SENSU_VERIFY environment variable.

type: bool
default: True
deregister (optional)

If the entity should be removed when it stops sending keepalive messages.

type: bool
deregistration_handler (optional)

The name of the handler to be called when an entity is deregistered.

type: str
entity_class (optional)

Entity class. Standard classes are proxy and agent, but you can use whatever you want.

Required if state is present.

type: str
labels (optional)

Custom metadata fields that can be accessed within Sensu, as key/value pairs.

type: dict
last_seen (optional)

Timestamp the entity was last seen, in seconds since the Unix epoch.

type: int
name (required)

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 name metadata attribute specification in the upstream docs on https://docs.sensu.io/sensu-go/latest/reference/ for more details about valid names and other restrictions.

type: str
namespace (optional)

RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used.

type: str
default: default
redact (optional)

List of items to redact from log messages. If a value is provided, it overwrites the default list of items to be redacted.

type: list
state (optional)

Target state of the Sensu object.

type: str
default: present
choices: present, absent
subscriptions (optional)

List of subscriptions for the entity.

type: list
system (optional)

System information about the entity, such as operating system and platform. See https://docs.sensu.io/sensu-go/5.13/reference/entities/#system-attributes for more information.

type: dict
user (optional)

Sensu RBAC username used by the entity. Agent entities require get, list, create, update, and delete permissions for events across all namespaces.

type: str

Return Values

object

Object representing Sensu entity.

sample:

deregister: false
deregistration: {}
entity_class: agent
last_seen: 1542667231
metadata:
  annotations: null
  labels: null
  name: webserver01
  namespace: default
redact:
- password
- private_key
- secret
sensu_agent_version: 1.0.0
subscriptions:
- entity:webserver01
system:
  arch: amd64
  cloud_provider: null
  libc_type: glibc
  network:
    interfaces:
    - addresses:
      - 127.0.0.1/8
      - ::1/128
      name: lo
    - addresses:
      - 172.28.128.3/24
      - fe80::a00:27ff:febc:be60/64
      mac: 08:00:27:bc:be:60
      name: enp0s8
  os: linux
  platform: centos
  platform_family: rhel
  platform_version: 7.4.1708
  vm_role: host
  vm_system: kvm
user: agent