Модуль sensu.sensu_go.asset_info – Список активов Sensu
Примечание
Этот модуль является частью коллекции sensu.sensu_go (версия 1.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.
Для использования в плейбуке укажите: sensu.sensu_go.asset_info.
Введено в sensu.sensu_go 1.0.0
Описание
- Получение информации об активах Sensu Go.
- Дополнительную информацию см. в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/assets/.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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. По умолчанию: |
|
url строка |
Расположение API бэкенда Sensu. Если он не задан, будет проверена переменная окружения SENSU_URL. По умолчанию: |
|
user строка |
Имя пользователя для подключения к API Sensu. Если он не задан, будет проверена переменная окружения SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. По умолчанию: |
|
verify логическое значение добавлен в sensu.sensu_go 1.5.0 |
Флаг, управляющий проверкой сертификата. Если вы используете самозаверенные сертификаты, можно установить этот параметр в значение Используйте этот параметр ТОЛЬКО в сценариях разработки! При использовании самозаверенных сертификатов в рабочей среде обратитесь к параметру auth.ca_path. Также можно установить этот параметр через переменную окружения SENSU_VERIFY. Варианты:
|
name строка | Получение информации об этом конкретном объекте вместо перечисления всех объектов. |
namespace строка | Пространство имён RBAC для работы. Если не задано, будет использовано значение переменной окружения SENSU_NAMESPACE. По умолчанию: |
См. также
См. также
- sensu.sensu_go.asset
-
Управление активами Sensu.
- sensu.sensu_go.bonsai_asset
-
Добавление активов Sensu из Bonsai.
Примеры
- name: List all Sensu assets
sensu.sensu_go.asset_info:
register: result
- name: List the selected Sensu asset
sensu.sensu_go.asset_info:
name: my_asset
register: result
- name: Do something with result
ansible.builtin.debug:
msg: "{{ result.objects.0.metadata.name }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
objects список / элементы=словарь | Список активов Sensu. Возвращается: успех Пример: |
Ссылки на коллекцию
© 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/asset_info_module.html