Spec-Zone.ru › Ansible

Модуль community.hashi_vault.vault_database_static_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_static_roles_list.

Добавлена в community.hashi_vault 6.2.0

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

Обзор

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

Требования

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

  • hvac (Библиотека Python)
  • Для получения подробных требований обратитесь к странице требований к коллекции.

Параметры

Параметр

Комментарии

auth_method

string

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

none auth method was added in collection version 1.2.0.

cert auth method was added in collection version 1.4.0.

aws_iam_login was renamed aws_iam in collection version 2.1.0 and was removed in 3.0.0.

azure auth method was added in collection version 3.2.0.

Варианты:

  • "token" ← (default)
  • "userpass"
  • "ldap"
  • "approle"
  • "aws_iam"
  • "azure"
  • "jwt"
  • "cert"
  • "none"

aws_access_key

aliases: aws_access_key_id

string

Ключ доступа AWS для использования.

aws_iam_server_id

string

added in community.hashi_vault 0.2.0

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

aws_profile

aliases: boto_profile

string

Профиль AWS

aws_secret_key

aliases: aws_secret_access_key

string

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

aws_security_token

string

Маркер безопасности AWS, если используются временные ключи доступа и секретные ключи.

azure_client_id

string

added in community.hashi_vault 3.2.0

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

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

azure_client_secret

string

added in community.hashi_vault 3.2.0

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

azure_resource

string

added in community.hashi_vault 3.2.0

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

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

azure_tenant_id

string

added in community.hashi_vault 3.2.0

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

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

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

ca_cert

aliases: cacert

string

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

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

cert_auth_private_key

path

added in community.hashi_vault 1.4.0

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

cert_auth_public_key

path

added in community.hashi_vault 1.4.0

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

engine_mount_point

string

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

jwt

string

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

mount_point

string

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

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

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

namespace

string

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

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

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

password

string

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

proxies

any

added in community.hashi_vault 1.1.0

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

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

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

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

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

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

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

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

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

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

Для аутентификации azure, role_id обязателен.

secret_id

string

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

timeout

integer

added in community.hashi_vault 1.3.0

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

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

token

string

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

Если токен не указан явно или через env, плагин проверит наличие файла токена, как определено параметрами 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 не будет работать, потому что объект словаря содержит метод с именем keys.
  • Вместо этого используйте roles для доступа к списку ролей или используйте синтаксис data["keys"] или raw.data["keys"] для доступа к списку через элемент словаря.

Примеры

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

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

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

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

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

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

Ключ

Описание

data

словарь

Поле data исходного результата. К нему также можно обратиться через raw.data.

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

Пример: {"keys": ["role1", "role2", "role3"]}

keys

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

Список имён ролей.

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

Пример: ["role1", "role2", "role3"]

raw

словарь

Исходный результат операции.

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

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

data

словарь

Поле data ответа API.

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

keys

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

Список имён ролей.

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

Пример: ["role1", "role2", "role3"]

roles

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

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

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

Пример: ["role1", "role2", "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_static_roles_list_module.html

Spec-Zone.ru

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