Spec-Zone.ru › Ansible

Модуль community.hashi_vault.vault_database_roles_list — Возвращает список доступных (динамических) ролей

Примечание

Этот модуль входит в коллекцию community.hashi_vault (версия 6.2.0).

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

Для установки используйте: ansible-galaxy collection install community.hashi_vault. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. Требования.

Для использования в плейбуке укажите: community.hashi_vault.vault_database_roles_list.

Введено в community.hashi_vault 6.2.0

  • Обзор
  • Требования
  • Параметры
  • Атрибуты
  • Примечания
  • Примеры
  • Значения возврата

Обзор

  • Возвращает список доступных (динамических) ролей.

Требования

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

  • hvac (Библиотека Python)
  • Подробные требования см. на странице требований к коллекции: на странице требований к коллекции.

Параметры

Параметр

Комментарии

auth_method

строка

Метод аутентификации для использования.

none метод аутентификации был добавлен в версии коллекции 1.2.0.

cert метод аутентификации был добавлен в версии коллекции 1.4.0.

aws_iam_login был переименован в aws_iam в версии коллекции 2.1.0 и был удалён в 3.0.0.

azure метод аутентификации был добавлен в версии коллекции 3.2.0.

Варианты:

  • "token" ← (по умолчанию)
  • "userpass"
  • "ldap"
  • "approle"
  • "aws_iam"
  • "azure"
  • "jwt"
  • "cert"
  • "none"

aws_access_key

псевдонимы: aws_access_key_id

строка

Используемый ключ доступа AWS.

aws_iam_server_id

строка

добавлен в community.hashi_vault 0.2.0

Если указано, задаёт значение для заголовка X-Vault-AWS-IAM-Server-ID в рамках запроса GetCallerIdentity.

aws_profile

псевдонимы: boto_profile

строка

Профиль AWS

aws_secret_key

псевдонимы: aws_secret_access_key

строка

Секретный ключ AWS, соответствующий ключу доступа.

aws_security_token

строка

Токен безопасности AWS при использовании временных ключей доступа и секретных ключей.

azure_client_id

строка

добавлен в community.hashi_vault 3.2.0

Идентификатор клиента (также известный как идентификатор приложения) принципала службы Azure AD или управляемой идентичности. Должен быть UUID.

Если не указано, будет использоваться назначенная система управляемой идентичности.

azure_client_secret

строка

добавлен в community.hashi_vault 3.2.0

Секретный ключ клиента принципала службы Azure AD.

azure_resource

строка

добавлен в community.hashi_vault 3.2.0

URL ресурса для приложения, зарегистрированного в Azure Active Directory. Обычно не следует изменять значение по умолчанию.

По умолчанию: "https://management.azure.com/"

azure_tenant_id

строка

добавлен в community.hashi_vault 3.2.0

Идентификатор аренды Azure Active Directory (также известный как идентификатор каталога) принципала службы. Должен быть UUID.

Требуется при использовании принципала службы для аутентификации в Vault, например, когда заданы как azure_client_id, так и azure_client_secret.

Необязательно при использовании управляемой идентичности для аутентификации в Vault.

ca_cert

псевдонимы: cacert

строка

Путь к сертификату для использования при аутентификации.

Если не указано другим способом, будет использована переменная среды VAULT_CACERT.

cert_auth_private_key

путь

добавлен в community.hashi_vault 1.4.0

Для cert аутентификации путь к файлу закрытого ключа для аутентификации в формате PEM.

cert_auth_public_key

путь

добавлен в community.hashi_vault 1.4.0

Для cert аутентификации путь к файлу сертификата для аутентификации в формате PEM.

engine_mount_point

строка

Путь, где смонтирован секретный бэкенд.

jwt

строка

JSON Web Token (JWT) для использования при аутентификации JWT в Vault.

mount_point

строка

Точка монтирования Vault.

Если не указано, используется точка монтирования по умолчанию для данного метода аутентификации.

Не применяется к аутентификации по токену.

namespace

строка

Пространство имён Vault, где хранятся секреты. Этот параметр требует HVAC 0.7.0+ и Vault 0.11+.

Необязательно, это можно сделать, добавив префикс к точке монтирования аутентификации и/или пути к секретам (например, mynamespace/secret/mysecret).

Если переменная среды VAULT_NAMESPACE задана, её значение будет использовано в последнюю очередь по сравнению со всеми другими способами указания namespace.

password

строка

Пароль аутентификации.
END_OF_DOCUMENT_MARKER

proxies

any

added in community.hashi_vault 1.1.0

URL(ы) прокси, используемых для доступа к службе Vault.

Может быть строкой или словарем.

Если это словарь, укажите схему (например, http или https) в качестве ключа, а URL — в качестве значения.

Если это строка, укажите единственный URL, который будет использоваться в качестве прокси для схем http и https.

Строка, которая может быть интерпретирована как словарь, будет преобразована в словарь (см. примеры).

Вы можете указать разные прокси для ресурсов HTTP и HTTPS.

Если не указано, используются переменные среды из библиотеки Requests https://requests.readthedocs.io/en/master/user/advanced/#proxies.

region

string

AWS регион для создания подключения.

retries

any

added in community.hashi_vault 1.3.0

Позволяет повторно пытаться при ошибках, используя класс Retry в библиотеке urllib3.

Этот сборник определяет рекомендуемые значения по умолчанию для повторных подключений к Vault.

Этот параметр может быть задан как положительное число (целое) или словарь.

Если этот параметр не указан или число равно 0, то попытки повтора отключены.

Число задает общее количество попыток повтора и использует значения по умолчанию сборника для других настроек.

Значение в виде словаря используется напрямую для инициализации класса Retry, поэтому оно может быть использовано для полной настройки повтора.

Подробную информацию о повторных попытках см. в руководстве пользователя сборника.

retry_action

string

added in community.hashi_vault 1.3.0

Управляет отображением сообщений при повторных попытках.

Это не влияет, если запрос не повторяется.

Варианты:

  • "ignore"
  • "warn" ← (по умолчанию)

role_id

string

Идентификатор или имя роли Vault. Используется в approle, aws_iam, azure и cert методах аутентификации.

Для метода аутентификации cert, если role_id не указан, по умолчанию пытаются все роли сертификатов и возвращается любая подходящая роль.

Для метода аутентификации azure role_id требуется.

secret_id

string

Идентификатор секрета, используемый для аутентификации Vault AppRole.

timeout

integer

added in community.hashi_vault 1.3.0

Устанавливает тайм-аут подключения в секундах.

Если не указано, используется значение по умолчанию библиотеки hvac.

token

string

Токен Vault. Токен может быть указан явно, через перечисленные переменные [env], а также через переменную среды VAULT_TOKEN.

Если токен не указан явно или через переменные среды, плагин проверит файл токена, как определено token_path и token_file.

Порядок загрузки токенов (первый найденный используется) token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file.

token_file

string

Если токен не указан, попытается прочитать токен из этого файла в token_path.

По умолчанию: ".vault-token"

token_path

string

Если токен не указан, попытается прочитать token_file из этого пути.

token_validate

boolean

added in community.hashi_vault 0.2.0

Для аутентификации по токену выполнит операцию lookup-self для определения валидности токена перед его использованием.

Отключить, если у токена нет возможности lookup-self.

Варианты:

  • false ← (по умолчанию)
  • true

url

string

URL службы Vault.

Если не указано другими способами, используется значение переменной среды VAULT_ADDR.

Если VAULT_ADDR также не определено, будет выведено сообщение об ошибке.

username

string

Имя пользователя для аутентификации.

validate_certs

boolean

Управляет проверкой SSL-сертификатов. Чаще всего вы будете отключать её только для самозаверенных сертификатов.

Будет установлено обратное значение VAULT_SKIP_VERIFY, если оно установлено, а validate_certs не указано явно.

Будет установлено значение true, если ни validate_certs, ни VAULT_SKIP_VERIFY не установлены.

Варианты:

  • false
  • true

Атрибуты

Атрибут

Поддержка

Описание

action_group

Группа действий: community.hashi_vault.vault

Используйте group/community.hashi_vault.vault в module_defaults для установки значений по умолчанию для данного модуля.

check_mode

Поддержка: полная

Этот модуль является «только для чтения» и работает одинаково независимо от режима проверки.

Может работать в режиме check_mode и возвращать прогноз состояния изменений без изменения целевого объекта.

Примечания

Примечание

  • Этот API возвращает элемент с именем keys.
  • В Ansible доступ к data.keys или raw.data.keys не будет работать, потому что объект dict содержит метод с именем keys.
  • Вместо этого используйте roles для доступа к списку ролей или используйте синтаксис data["keys"] или raw.data["keys"] для доступа к списку через элемент dict.

Примеры

- name: List all roles with the default mount point
  community.hashi_vault.vault_database_roles_list:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
  register: result

- name: Display the result of the operation
  ansible.builtin.debug:
    msg: "{{ result }}"

- name: List all roles with a custom mount point
  community.hashi_vault.vault_database_roles_list:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    engine_mount_point: db1
  register: result

- name: Display the result of the operation
  ansible.builtin.debug:
    msg: "{{ result }}"

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

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

Ключ

Описание

data

словарь

Поле data результата в сыром виде. К нему также можно получить доступ через raw.data.

Возвращается при: успехе

Пример: {"keys": ["dyn_role1", "dyn_role2", "dyn_role3"]}

keys

список / элементы=строка

Список имен динамических ролей.

Возвращается при: успехе

Пример: ["dyn_role1", "dyn_role2", "dyn_role3"]

raw

словарь

Результат операции в сыром виде.

Возвращается при: успехе

Пример: {"auth": null, "data": {"keys": ["dyn_role1", "dyn_role2", "dyn_role3"]}, "lease_duration\"": 0, "lease_id": "", "renewable": false, "request_id": "123456", "username": "SomeUser", "warnings": null, "wrap_info": null}

data

словарь

Поле данных в ответе API.

Возвращается при: успехе

keys

список / элементы=строка

Список имен динамических ролей.

Возвращается при: успехе

Пример: ["dyn_role1", "dyn_role2", "dyn_role3"]

roles

список / элементы=строка

Список динамических ролей или пустой список. К нему также можно получить доступ через data.keys или raw.data.keys.

Возвращается при: успехе

Пример: ["dyn_role1", "dyn_role2", "dyn_role3"]

Авторы

  • Martin Chmielewski (@M4rt1nCh)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Обсуждение, вопросы и ответы, устранение неполадок
  • Общение

© 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/community/hashi_vault/vault_database_roles_list_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API