sensu.sensu_go.entity – Manage Sensu entities¶

Note

This plugin is part of the sensu.sensu_go collection (version 1.9.4).

To install it use: ansible-galaxy collection install sensu.sensu_go.

To use it in a playbook, specify: sensu.sensu_go.entity.

New in version 1.0.0: of sensu.sensu_go

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

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

Requirements ¶

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

python >= 2.7

Parameters ¶

Parameter		Choices/Defaults	Comments
annotations dictionary			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.
auth dictionary			Authentication parameters. Can define each of them with ENV as well.
	api_key string added in 1.3.0 of sensu.sensu_go		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/.
	ca_path path added in 1.5.0 of sensu.sensu_go		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.
	password string	Default: "P@ssw0rd!"	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.
	url string	Default: "http://localhost:8080"	Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.
	user string	Default: "admin"	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.
	verify boolean added in 1.5.0 of sensu.sensu_go	Choices: no yes ←	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.
deregister boolean		Choices: no yes	If the entity should be removed when it stops sending keepalive messages.
deregistration_handler string			The name of the handler to be called when an entity is deregistered.
entity_class string			Entity class. Standard classes are `proxy` and `agent`, but you can use whatever you want. Required if state is `present`.
labels dictionary			Custom metadata fields that can be accessed within Sensu, as key/value pairs.
last_seen integer			Timestamp the entity was last seen, in seconds since the Unix epoch.
name string / 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.
namespace string		Default: "default"	RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used.
redact list / elements=string			List of items to redact from log messages. If a value is provided, it overwrites the default list of items to be redacted.
state string		Choices: present ← absent	Target state of the Sensu object.
subscriptions list / elements=string			List of subscriptions for the entity.
system dictionary			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.
user string			Sensu RBAC username used by the entity. Agent entities require get, list, create, update, and delete permissions for events across all namespaces.

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

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
object dictionary	success	Object representing Sensu entity. Sample: {'deregister': False, 'deregistration': {}, 'entity_class': 'agent', 'last_seen': 1542667231, 'metadata': {'annotations': None, 'labels': None, 'name': 'webserver01', 'namespace': 'default'}, 'redact': ['password', 'private_key', 'secret'], 'sensu_agent_version': '1.0.0', 'subscriptions': ['entity:webserver01'], 'system': {'arch': 'amd64', 'cloud_provider': None, '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'}

Authors¶

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

sensu.sensu_go.entity – Manage Sensu entities¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶