community.aws.efs_info – Получение информации о файловых системах Amazon EFS

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в playbook укажите: community.aws.efs_info.

Новое в версии 1.0.0: коллекции community.aws

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Этот модуль может использоваться для поиска файловых систем Amazon EFS.
Этот модуль назывался efs_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль community.aws.efs_info больше не возвращает ansible_facts!

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_access_key и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла сертификата CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл сертификата CA считывается со стороны модуля и, возможно, потребует явного копирования с контроллера, если он не выполняется локально.
aws_config словарь		Словарь для модификации конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров aws_secret_key и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs логический тип	Варианты: нет ← да	Используйте логирование botocore.endpoint для анализа уникальных (а не полных) вызовов API "ресурс:действие" во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время выполнения playbook. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url
id строка		ID файловой системы Amazon EFS.
name строка		Маркер создания файловой системы Amazon EFS. псевдонимы: creation_token
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка их одновременного указания с profile устарела. aws_access_key, aws_secret_key и security_token станут взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
region строка		Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное указание параметров security_token и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
tags словарь		Список тегов Amazon EFS. Должен быть определен как словарь.
targets список / элементы=строка		Список целей для фильтрации возвращаемых результатов. Результат должен соответствовать всем указанным целям, каждая из которых может быть идентификатором группы безопасности, идентификатором подсети или IP-адресом.
validate_certs логический тип	Варианты: нет да ←	При значении "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета: AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION могут использоваться для указания региона AWS, если требуется, но это также можно настроить в файле конфигурации boto

Примеры

- 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 строка	всегда	временная метка даты создания Пример: 2015-11-16 07:30:57-05:00
creation_token строка	всегда	токен создания EFS Пример: console-88609e04-9a0e-4a2e-912c-feaa99509961
file_system_id строка	всегда	Идентификатор файловой системы Пример: fs-xxxxxxxx
filesystem_address строка	всегда	URL файловой системы Пример: fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
life_cycle_state строка	всегда	состояние файловой системы EFS Пример: создание, доступно, удаление, удалено
mount_point строка	всегда	URL файловой системы с ведущей точкой, начиная с момента, когда AWS EFS потребовалось добавить сетевой суффикс к адресу EFS Пример: .fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/
mount_targets список / элементы=строка	всегда	список целевых точек монтирования Пример: [{'file_system_id': 'fs-a7ad440e', 'ip_address': '172.31.17.173', 'life_cycle_state': 'available', 'mount_target_id': 'fsmt-d8907871', 'network_interface_id': 'eni-6e387e26', 'owner_id': '740748460359', 'security_groups': ['sg-a30b22c6'], 'subnet_id': 'subnet-e265c895'}, '...']
name строка	всегда	имя файловой системы Пример: my-efs
number_of_mount_targets целое число	всегда	количество смонтированных целевых точек Пример: 3
owner_id строка	всегда	Идентификатор AWS учётной записи владельца EFS Пример: XXXXXXXXXXXX
performance_mode строка	всегда	режим производительности файловой системы Пример: generalPurpose
provisioned_throughput_in_mibps вещественное число	когда botocore >= 1.10.57 и throughput_mode установлен в "provisioned"	пропускная способность, выделенная в Мбит/с Пример: 15.0
size_in_bytes словарь	всегда	размер файловой системы в байтах по состоянию на временную метку Пример: {'timestamp': '2015-12-21 13:59:59-05:00', 'value': 12288}
tags словарь	всегда	метки экземпляра efs Пример: {'key': 'Значение', 'name': 'my-efs'}
throughput_mode строка	когда botocore >= 1.10.57	режим пропускной способности для файловой системы Пример: bursting

Авторы

Ryan Sydnor (@ryansydnor)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/efs_info_module.html