sensu.sensu_go.secret_info – Список доступных секретов Sensu Go
Примечание
Этот плагин входит в коллекцию sensu.sensu_go (версия 1.8.0).
Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.
Для использования в книге задач укажите: sensu.sensu_go.secret_info.
Новое в версии 1.6.0: из sensu.sensu_go
Обзор
- Получение информации о секретах Sensu Go.
- Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets/.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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.secret
-
Официальная документация по модулю sensu.sensu_go.secret.
- sensu.sensu_go.secrets_provider_env
-
Официальная документация по модулю sensu.sensu_go.secrets_provider_env.
- sensu.sensu_go.secrets_provider_vault
-
Официальная документация по модулю sensu.sensu_go.secrets_provider_vault.
- sensu.sensu_go.secrets_provider_info
-
Официальная документация по модулю sensu.sensu_go.secrets_provider_info.
Примеры
- 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. Пример: [{'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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/sensu/sensu_go/secret_info_module.html