Модуль community.aws.efs_info — получение информации о файловых системах Amazon EFS
Примечание
Этот модуль входит в коллекцию community.aws (версия 10.1.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для работы с этим модулем необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.aws.efs_info.
Добавлено в community.aws 1.0.0
Краткое описание
- Этот модуль позволяет выполнять поиск файловых систем Amazon EFS. Обратите внимание, что модуль community.aws.efs_info больше не возвращает
ansible_facts!
Требования
Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.34.0
- botocore >= 1.34.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key string | Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
aws_ca_bundle path | Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url string | URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
id string | Идентификатор Amazon EFS. |
name псевдоним: creation_token string | Токен создания файловой системы Amazon EFS. |
profile псевдоним: aws_profile string | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдоним: aws_region string | Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key string | Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore. |
session_token псевдоним: aws_session_token string | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды Параметры session_token и profile взаимоисключающие. |
tags dictionary | Список тегов Amazon EFS. Следует задать в виде словаря. По умолчанию: |
targets list / элементы=string | Список целей, по которым фильтруются возвращаемые результаты. Результат должен соответствовать всем указанным целям; каждая из них может быть идентификатором группы безопасности, идентификатором подсети или IP-адресом. По умолчанию: |
validate_certs boolean | Если задано значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются в контексте «узла» Ansible, а не в контексте «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются в контексте «контроллера» Ansible, а не в контексте «узла».
- Пакет AWS SDK (boto3), используемый Ansible, также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно
~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
- name: Find all existing efs
community.aws.efs_info:
register: result
- name: Find efs using id
community.aws.efs_info:
id: fs-1234abcd
register: result
- name: Searching all EFS instances with tag Name = 'myTestNameTag', in subnet 'subnet-1a2b3c4d' and with security group 'sg-4d3c2b1a'
community.aws.efs_info:
tags:
Name: myTestNameTag
targets:
- subnet-1a2b3c4d
- sg-4d3c2b1a
register: result
- ansible.builtin.debug:
msg: "{{ result['efs'] }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
creation_time string | временная метка даты создания Возвращается: всегда Пример: |
creation_token string | токен создания EFS Возвращается: всегда Пример: |
file_system_id string | идентификатор файловой системы Возвращается: всегда Пример: |
filesystem_address string | URL файловой системы Возвращается: всегда Пример: |
life_cycle_state string | состояние файловой системы EFS Возвращается: всегда Пример: |
mount_point string | URL файловой системы с точкой в начале; ранее AWS EFS требовала добавлять сетевой суффикс к адресу EFS Возвращается: всегда Пример: |
mount_targets list / элементы=string | список целевых точек монтирования Возвращается: всегда Пример: |
name string | имя файловой системы Возвращается: всегда Пример: |
number_of_mount_targets integer | количество смонтированных целевых точек Возвращается: всегда Пример: |
owner_id string | идентификатор учетной записи AWS владельца EFS Возвращается: всегда Пример: |
performance_mode string | режим производительности файловой системы Возвращается: всегда Пример: |
provisioned_throughput_in_mibps float | предоставленная пропускная способность в Mibps Возвращается: если для throughput_mode задано значение «provisioned» Пример: |
size_in_bytes dictionary | размер файловой системы в байтах на момент указанной временной метки Возвращается: всегда Пример: |
tags dictionary | теги экземпляра EFS Возвращается: всегда Пример: |
throughput_mode string | режим пропускной способности файловой системы Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/efs_info_module.html