Модуль sensu.sensu_go.secrets_provider_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.secrets_provider_info.

Впервые в sensu.sensu_go 1.6.0

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

Обзор

Получение информации о поставщиках секретов Sensu Go.
Для получения дополнительной информации см. документацию Sensu по адресу https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets-providers/.

Требования

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

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 строка	Получение информации об этом конкретном объекте вместо перечисления всех объектов.

См. также

sensu.sensu_go.secrets_provider_env: Управление поставщиком секретов Sensu Env.
sensu.sensu_go.secrets_provider_vault: Управление поставщиками секретов Sensu VaultProvider.
sensu.sensu_go.secret: Управление секретами Sensu Go.
sensu.sensu_go.secret_info: Список доступных секретов Sensu Go.

Примеры

- name: List all Sensu secrets providers
  sensu.sensu_go.secrets_provider_info:
  register: result

- name: List the selected Sensu secrets provider
  sensu.sensu_go.secrets_provider_info:
    name: my_provider
  register: result

- name: Do something with result
  ansible.builtin.debug:
    msg: "{{ result.objects.0.metadata.name }}"

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
objects список / элементы=словарь	Список поставщиков секретов Sensu. Возвращается: успех Пример: `[{"client": {"address": "https://vaultserver.example.com:8200", "max_retries": 2, "rate_limiter": {"burst": 100, "limit": 10}, "timeout": "20s", "tls": {"ca_cert": "/etc/ssl/certs/vault_ca_cert.pem"}, "token": "VAULT_TOKEN", "version": "v1"}, "metadata": {"name": "vault"}}]`

Авторы

Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Miha Dolinar (@mdolin)
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/secrets_provider_info_module.html