efs_facts – Получение информации о файловых системах Amazon EFS
Новая версия 2.2.
Обзор
- Этот модуль может использоваться для поиска файловых систем Amazon EFS.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 для вывода в общий список, созданный во время выполнения playbook. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. | |
| 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 - | Список целей для фильтрации возвращаемых результатов. Результат должен соответствовать всем указанным целям, каждая из которых может быть ID группы безопасности, ID подсети или 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_facts:
register: result
- name: Find efs using id
efs_facts:
id: fs-1234abcd
- name: Searching all EFS instances with tag Name = 'myTestNameTag', in subnet 'subnet-1a2b3c4d' and with security group 'sg-4d3c2b1a'
efs_facts:
tags:
name: myTestNameTag
targets:
- subnet-1a2b3c4d
- sg-4d3c2b1a
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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 Пример: creating, available, deleting, deleted |
| 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" | пропускная способность, выделенная в Mibps Пример: 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.8/modules/efs_facts_module.html