Модуль 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.

Добавлена в sensu.sensu_go 1.0.0

Описание
Требования
Параметры
См. также
Примеры
Значения возврата

Описание

Получение информации о сущностях Sensu.
Для получения более подробной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/entities/.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7

Параметры

Параметр	Комментарии
auth словарь	Параметры аутентификации. Каждый из них можно также определить в переменных среды.
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, который следует использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль использует файл CA, используемый python. Этот параметр также можно задать через переменную среды SENSU_CA_PATH.
password строка	Пароль пользователя Sensu. Если не задан, проверяется значение переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: `"P@ssw0rd!"`
url строка	Местоположение API бэкенда Sensu. Если не задан, проверяется значение переменной среды SENSU_URL. По умолчанию: `"http://localhost:8080"`
user строка	Имя пользователя для подключения к API Sensu. Если не задан, проверяется значение переменной среды 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"}]

Ключ

Описание

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)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/entity_info_module.html