Модуль sensu.sensu_go.secret_info – Список доступных секретов Sensu Go

Примечание

Этот модуль входит в состав коллекции sensu.sensu_go (версия 1.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в плейбуке укажите: sensu.sensu_go.secret_info.

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

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

Описание

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

Требования

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

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.secret: Управление секретами Sensu Go.
sensu.sensu_go.secrets_provider_env: Управление поставщиком секретов Sensu Env.
sensu.sensu_go.secrets_provider_vault: Управление поставщиками секретов Sensu VaultProvider.
sensu.sensu_go.secrets_provider_info: Список поставщиков секретов Sensu.

Примеры

- name: List all Sensu Go secrets
  sensu.sensu_go.secret_info:
  register: result

- name: Retrieve the selected Sensu Go secret
  sensu.sensu_go.secret_info:
    name: my-secret
  register: result

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

Возвращаемые значения

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

Ключ	Описание
objects список / элементы=словарь	Список секретов Sensu Go. Возвращается: success Пример: `[{"id": "ANSIBLE_TOKEN", "metadata": {"name": "sensu-ansible-token", "namespace": "default"}, "provider": "env"}, {"id": "secret/database#password", "metadata": {"name": "sensu-ansible", "namespace": "default"}, "provider": "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/secret_info_module.html