Модуль community.hashi_vault.vault_list – Выполнение операции списка против HashiCorp Vault
Примечание
Этот модуль является частью коллекции community.hashi_vault (версия 6.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install community.hashi_vault. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в книге задач укажите: community.hashi_vault.vault_list.
Впервые в community.hashi_vault 4.1.0
Описание
- Выполняет общую операцию списка для заданного пути в HashiCorp Vault.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
-
hvac(Библиотека Python) - Для подробных требований, см. страницу требований коллекции.
Параметры
Параметр | Комментарии |
|---|---|
auth_method string | Метод аутентификации, который будет использоваться.
Варианты:
|
aws_access_key aliases: aws_access_key_id string | Ключ доступа AWS для использования. |
aws_iam_server_id string added in community.hashi_vault 0.2.0 | Если указано, устанавливает значение для использования в заголовке |
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. Обычно не следует изменять значение по умолчанию. По умолчанию: |
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 | Путь к сертификату, который будет использоваться для аутентификации. Если не указано иными способами, будет использоваться переменная окружения |
cert_auth_private_key path added in community.hashi_vault 1.4.0 | Для аутентификации |
cert_auth_public_key path added in community.hashi_vault 1.4.0 | Для аутентификации |
jwt string | JSON Web Token (JWT), который будет использоваться для JWT-аутентификации в Vault. |
mount_point string | Точка монтирования Vault. Если не указано, используется точка монтирования по умолчанию для данного метода аутентификации. Не применяется к токенной аутентификации. |
namespace string | Пространство имен Vault, где находятся секреты. Этот параметр требует HVAC 0.7.0+ и Vault 0.11+. Дополнительно, это может быть достигнуто путем добавления префикса к точке монтирования аутентификации и/или пути к секрету с помощью пространства имен (например, Если установлена переменная окружения |
password string | Пароль аутентификации. |
path string / required | Путь Vault, который будет выведен. |
proxies any added in community.hashi_vault 1.1.0 | URL(s) to the proxies used to access the Vault service. It can be a string or a dict. If it’s a dict, provide the scheme (eg. If it’s a string, provide a single URL that will be used as the proxy for both A string that can be interpreted as a dictionary will be converted to one (see examples). You can specify a different proxy for HTTP and HTTPS resources. If not specified, environment variables from the Requests library are used. |
region string | The AWS region for which to create the connection. |
retries any added in community.hashi_vault 1.3.0 | Allows for retrying on errors, based on the Retry class in the urllib3 library. This collection defines recommended defaults for retrying connections to Vault. This option can be specified as a positive number (integer) or dictionary. If this option is not specified or the number is A number sets the total number of retries, and uses collection defaults for the other settings. A dictionary value is used directly to initialize the For detailed information on retries, see the collection User Guide. |
retry_action string added in community.hashi_vault 1.3.0 | Controls whether and how to show messages on retries. This has no effect if a request is not retried. Choices:
|
role_id string | Vault Role ID or name. Used in For For |
secret_id string | Secret ID to be used for Vault AppRole authentication. |
timeout integer added in community.hashi_vault 1.3.0 | Sets the connection timeout in seconds. If not set, then the |
token string | Vault token. Token may be specified explicitly, through the listed [env] vars, and also through the If no token is supplied, explicitly or through env, then the plugin will check for a token file, as determined by token_path and token_file. The order of token loading (first found wins) is |
token_file string | If no token is specified, will try to read the token from this file in token_path. Default: |
token_path string | If no token is specified, will try to read the token_file from this path. |
token_validate boolean added in community.hashi_vault 0.2.0 | For token auth, will perform a Disable if your token does not have the Choices:
|
url string | URL to the Vault service. If not specified by any other means, the value of the If |
username string | Authentication user name. |
validate_certs boolean | Controls verification and validation of SSL certificates, mostly you only want to turn off with self signed ones. Will be populated with the inverse of Will default to Choices:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группа действий: community.hashi_vault.vault | Используйте |
check_mode | Поддержка: полная Этот модуль является «только для чтения» и работает одинаково независимо от режима проверки. | Может работать в режиме |
См. также
См. также
- community.hashi_vault.vault_list поиск
-
Официальная документация плагина поиска
community.hashi_vault.vault_list.
Примеры
- name: List kv2 secrets from Vault via the remote host with userpass auth
community.hashi_vault.vault_list:
url: https://vault:8201
path: secret/metadata
# For kv2, the path needs to follow the pattern 'mount_point/metadata' or 'mount_point/metadata/path' to list all secrets in that path
auth_method: userpass
username: user
password: '{{ passwd }}'
register: secret
- name: Display the secrets found at the path provided above
ansible.builtin.debug:
msg: "{{ secret.data.data['keys'] }}"
# Note that secret.data.data.keys won't work as 'keys' is a built-in method
- name: List access policies from Vault via the remote host
community.hashi_vault.vault_list:
url: https://vault:8201
path: sys/policies/acl
register: policies
- name: Display the policy names
ansible.builtin.debug:
msg: "{{ policies.data.data['keys'] }}"
# Note that secret.data.data.keys won't work as 'keys' is a built-in method
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
data словарь | Необработанный результат списка по заданному пути. Возвращаемое значение: успех |
Ссылки на сборки
© 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_list_module.html