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

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

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

Псевдонимы: efs_facts

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs логический тип добавлено в 2.8	Варианты: нет ← да	Использование логгера botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», сделанных во время задачи, вывода набора в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения плейбука. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковое имеется.
id -		ID файловой системы Amazon EFS.
name -		Токен создания файловой системы Amazon EFS. Псевдонимы: creation_token
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0.
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. Псевдонимы: access_token
tags -		Список тегов файловой системы Amazon EFS. Должен быть определен как словарь.
targets -		Список целевых объектов, на которых следует отфильтровать возвращаемые результаты. Результат должен соответствовать всем указанным целевым объектам, каждый из которых может быть идентификатором группы безопасности, идентификатором подсети или IP-адресом.
validate_certs логический тип	Варианты: нет да ←	При значении "нет" сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, 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
Ansible использует конфигурационный файл boto (обычно ~/.boto), если данные аутентификации не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это требуется, но это также можно настроить в конфигурационном файле boto

Примеры

- name: Find all existing efs
  efs_info:
  register: result

- name: Find efs using id
  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'
  efs_info:
    tags:
        name: myTestNameTag
    targets:
        - subnet-1a2b3c4d
        - sg-4d3c2b1a
  register: result

- 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 строка	всегда	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 Пример: {'name': 'my-efs', 'key': 'Value'}
throughput_mode строка	при botocore >= 1.10.57	режим пропускной способности для файловой системы Пример: bursting

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.9/modules/efs_info_module.html