sensu.sensu_go.entity_info 模块 – 列出 Sensu 实体

注意

此模块是 sensu.sensu_go 集合 (版本 1.14.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install sensu.sensu_go。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定： sensu.sensu_go.entity_info。

注意

由于违反了 Ansible 包含要求，sensu.sensu_go 集合将在 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。

sensu.sensu_go 1.0.0 中的新增功能

概要

要求

执行此模块的主机需要以下要求。

  • python >= 2.7

参数

参数

注释

auth

字典

身份验证参数。也可以使用 ENV 定义每个参数。

api_key

字符串

sensu.sensu_go 1.3.0 中新增

进行身份验证时应使用的 API 密钥。如果未设置此项，则将检查 SENSU_API_KEY 环境变量的值。

此参数替换了 *auth.user* 和 *auth.password* 参数。

有关 API 密钥的更多信息，请参阅 Sensu 官方文档：https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.

ca_path

路径

sensu.sensu_go 1.5.0 中新增

应用于验证后端证书的 CA 证书包的路径。

如果未设置此参数，模块将使用 python 使用的 CA 证书包。

也可以通过 *SENSU_CA_PATH* 环境变量设置此参数。

password

字符串

Sensu 用户的密码。如果未设置此项，则将检查 SENSU_PASSWORD 环境变量的值。

如果设置了 *auth.api_key* 参数，则忽略此参数。

默认值： "P@ssw0rd!"

url

字符串

Sensu 后端 API 的位置。如果未设置此项，则将检查 SENSU_URL 环境变量的值。

默认值： "https://127.0.0.1:8080"

user

字符串

用于连接到 Sensu API 的用户名。如果未设置此项，则将检查 SENSU_USER 环境变量的值。

如果设置了 *auth.api_key* 参数，则忽略此参数。

默认值： "admin"

verify

布尔值

sensu.sensu_go 1.5.0 中新增

控制证书验证的标志。

如果您使用的是自签名证书，可以将此参数设置为 false。

仅在开发场景中使用此参数！如果您在生产环境中使用自签名证书，请参阅 *auth.ca_path* 参数。

也可以通过 *SENSU_VERIFY* 环境变量设置此参数。

选项

  • false

  • true ← (默认值)

name

字符串

检索有关此特定对象的信息，而不是列出所有对象。

namespace

字符串

要在其中操作的 RBAC 命名空间。如果未设置此项，则将使用 SENSU_NAMESPACE 环境变量的值。

默认值： "default"

另请参阅

另请参阅

sensu.sensu_go.entity

管理 Sensu 实体。

示例

- name: List all Sensu entities
  sensu.sensu_go.entity_info:
  register: result

- name: Retrieve a specific Sensu entity
  sensu.sensu_go.entity_info:
    name: my-entity
  register: result

返回值

公共返回值已在此处记录 此处，以下是此模块独有的字段

键

描述

objects

列表 / 元素=字典

Sensu 实体列表。

返回：成功

示例： [{"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"}]

作者

  • Paul Arthur (@flowerysong)

  • Aljaz Kosir (@aljazkosir)

  • Miha Plesko (@miha-plesko)

  • Tadej Borovsak (@tadeboro)