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
|
||
| ec2_url |
нет |
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
|
||
| id |
нет | None | ID Amazon EFS. |
|
| name |
нет | None | Токен создания файловой системы Amazon EFS. |
|
| profile (добавлено в 1.6)
|
нет | Использует профиль boto. Работает только с boto >= 2.24.0. |
||
| security_token (добавлено в 1.6)
|
нет |
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
псевдонимы: access_token
|
||
| tags |
нет | None | Список тегов Amazon EFS. Должен быть определен как словарь. |
|
| targets |
нет | None |
Список подключенных целей. Должен быть списком словарей, каждый словарь должен включать следующие атрибуты: - SubnetId - Обязательно. ID подсети, в которой добавить целевой монтаж. - IpAddress - Необязательно. Действительный IPv4-адрес в диапазоне адресов указанной подсети. - SecurityGroups - Необязательно. Список идентификаторов групп безопасности в формате 'sg-xxxxxxxx'. Они должны относиться к той же VPC, что и указанная подсеть.
|
|
| validate_certs (добавлено в 1.5)
|
нет | да |
|
При значении "нет" сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
Примеры
# 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 | Токен создания EFS |
всегда | str | console-88609e04-9a0e-4a2e-912c-feaa99509961 |
| file_system_id | ID файловой системы |
всегда | str | fs-xxxxxxxx |
| life_cycle_state | Состояние файловой системы EFS |
всегда | str | создание, доступно, удаление, удалено |
| mount_point | url файловой системы |
всегда | str | .fs-xxxxxxxx.efs.us-west-2.amazonaws.com:/ |
| mount_targets | Список подключенных целей |
всегда | список | [{'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 | ID учетной записи AWS владельца EFS |
всегда | str | XXXXXXXXXXXX |
| performance_mode | режим производительности файловой системы |
всегда | str | generalPurpose |
| size_in_bytes | размер файловой системы в байтах по состоянию на отметку времени |
всегда | словарь | {'timestamp': '2015-12-21 13:59:59-05:00', 'value': 12288} |
| tags | теги на экземпляре efs |
всегда | словарь | {'name': 'my-efs', 'key': 'Value'} |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
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
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей, если вы так расположены, пожалуйста, ознакомьтесь с Справочной информацией сообщества и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/efs_facts_module.html