sensu.sensu_go.entity_info – Список сущностей Sensu
Примечание
Этот плагин входит в коллекцию sensu.sensu_go (версия 1.8.0).
Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.
Для использования в книге задач укажите: sensu.sensu_go.entity_info.
Новое в версии 1.0.0: плагина sensu.sensu_go
Описание
- Получение информации о сущностях Sensu.
- Дополнительную информацию см. в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/entities/.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth словарь | Параметры аутентификации. Также можно задать каждый из них с помощью переменной среды. | ||
| api_key строка добавлено в версии 1.3.0 sensu.sensu_go | Ключ API, который следует использовать при аутентификации. Если он не задан, будет проверено значение переменной среды SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/. | ||
| ca_path путь добавлено в версии 1.5.0 sensu.sensu_go | Путь к пакету сертификатов CA, который следует использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль использует пакет CA, используемый Python. Также можно задать этот параметр через переменную среды SENSU_CA_PATH. | ||
| password строка | Значение по умолчанию: "P@ssw0rd!" | Пароль пользователя Sensu. Если он не задан, будет проверено значение переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key. | |
| url строка | Значение по умолчанию: "http://localhost:8080" | Расположение API бэкенда Sensu. Если он не задан, будет проверено значение переменной среды SENSU_URL. | |
| user строка | Значение по умолчанию: "admin" | Имя пользователя для подключения к API Sensu. Если он не задан, будет проверено значение переменной среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. | |
| verify логическое добавлено в версии 1.5.0 sensu.sensu_go |
| Флаг, контролирующий проверку сертификатов. Если вы используете самозаверенные сертификаты, вы можете установить этот параметр в false. Используйте этот параметр ТОЛЬКО в сценариях разработки! При использовании самозаверенных сертификатов в продакшене, см. параметр auth.ca_path. Также можно задать этот параметр через переменную среды SENSU_VERIFY. | |
| name строка | Получение информации об этом конкретном объекте вместо перечисления всех объектов. | ||
| namespace строка | Значение по умолчанию: "default" | Пространство имён RBAC для работы. Если не задано, используется значение переменной среды SENSU_NAMESPACE. | |
См. также
См. также
- sensu.sensu_go.entity
-
Официальная документация по модулю sensu.sensu_go.entity.
Примеры
- 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': 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'}] |
Авторы
- Paul Arthur (@flowerysong)
- Aljaz Kosir (@aljazkosir)
- Miha Plesko (@miha-plesko)
- Tadej Borovsak (@tadeboro)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/entity_info_module.html