efs_facts - Получение информации о файловых системах Amazon EFS
Новое в версии 2.2.
Обзор
- Модуль ищет файловые системы Amazon EFS
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Значение по умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key |
| ec2_url | Значение по умолчанию: None | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. |
| id | Значение по умолчанию: None | Идентификатор Amazon EFS. |
| name | Значение по умолчанию: None | Маркер создания файловой системы Amazon EFS. |
| profile (добавлен в 1.6) | Значение по умолчанию: None | Использует профиль 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 (добавлен в 1.6) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token |
| tags | Значение по умолчанию: None | Список тегов Amazon EFS. Должен быть определен как словарь |
| targets | Значение по умолчанию: None | список целей, по которым следует отфильтровать возвращаемые результаты результат должен соответствовать всем указанным целям, каждая из которых может быть идентификатором группы безопасности, идентификатором подсети или IP-адресом |
| validate_certs (добавлен в 1.5) |
| При установке в значение "нет", сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это требуется, но это также можно настроить в конфигурационном файле boto
Примеры
# find all existing efs
- efs_facts:
register: result
- efs_facts:
name: myTestNameTag
- efs_facts:
id: fs-1234abcd
# 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 str | всегда | временная метка даты создания Пример: 2015-11-16 07:30:57-05:00 |
| creation_token str | всегда | Маркер создания EFS Пример: console-88609e04-9a0e-4a2e-912c-feaa99509961 |
| file_system_id str | всегда | Идентификатор файловой системы Пример: fs-xxxxxxxx |
| life_cycle_state str | всегда | состояние файловой системы EFS Пример: создание, доступно, удаление, удалено |
| mount_point str | всегда | URL файловой системы Пример: .fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/ |
| mount_targets list | всегда | список целевых точек подключения Пример: [{'mount_target_id': 'fsmt-d8907871', 'life_cycle_state': 'available', 'file_system_id': 'fs-a7ad440e', 'subnet_id': 'subnet-e265c895', 'network_interface_id': 'eni-6e387e26', 'ip_address': '172.31.17.173', 'security_groups': ['sg-a30b22c6'], 'owner_id': '740748460359'}, '...'] |
| name str | всегда | название файловой системы Пример: my-efs |
| number_of_mount_targets int | всегда | количество подключенных целей Пример: 3 |
| owner_id str | всегда | Идентификатор учетной записи AWS владельца EFS Пример: XXXXXXXXXXXX |
| performance_mode str | всегда | режим производительности файловой системы Пример: generalPurpose |
| size_in_bytes dict | всегда | размер файловой системы в байтах на момент временной метки Пример: {'timestamp': '2015-12-21 13:59:59-05:00', 'value': 12288} |
| tags dict | всегда | теги экземпляра efs Пример: {'name': 'my-efs', 'key': 'Value'} |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- 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.5/modules/efs_facts_module.html