Spec-Zone.ru › Ansible 2.4

efs - создание и обслуживание файловых систем 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
Идентификатор Amazon EFS. Для удаления необходимы либо имя, либо ID.
name
нет None
Токен создания файловой системы Amazon EFS. Требуется для создания. Для удаления необходимы либо имя, либо ID.
performance_mode
нет general_purpose
  • general_purpose
  • max_io
Режим производительности файловой системы. Действует только при создании.
profile
(добавлен в 1.6)
нет
Использует профиль boto. Работает только с boto >= 2.24.0.
security_token
(добавлен в 1.6)
нет
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
псевдонимы: access_token
state
нет present
  • present
  • absent
Позволяет создавать, искать и удалять файловые системы Amazon EFS
tags
нет None
Список тегов Amazon EFS. Должен быть определен как словарь. В случае состояния 'present' со списком тегов и существующей файловой системой EFS (сопоставленной по 'name'), теги EFS будут заменены предоставленными данными.
targets
нет None
Список подключенных целевых узлов. Должен быть списком словарей, каждый словарь должен содержать следующие атрибуты: - subnet_id - Обязательный. Идентификатор подсети, в которой нужно добавить целевой узел подключения. - ip_address - Необязательный. Действительный IPv4-адрес в диапазоне адресов указанной подсети. - security_groups - Необязательный. Список идентификаторов групп безопасности в формате 'sg-xxxxxxxx'. Они должны относиться к той же VPC, что и указанная подсеть. Эти данные могут быть изменены для существующей файловой системы EFS с помощью состояния 'present' и нового списка целевых узлов подключения.
validate_certs
(добавлен в 1.5)
нет да
  • да
  • нет
При значении "нет" сертификаты SSL не будут проверены для версий boto >= 2.6.0.
wait
нет нет
  • да
  • нет
В случае состояния 'present' следует ожидать состояния жизненного цикла 'available' для EFS (разумеется, если текущее состояние не 'deleting' или 'deleted'). В случае состояния 'absent' следует ожидать состояния жизненного цикла 'deleted' для EFS.
wait_timeout
нет
Сколько времени модуль должен ждать (в секундах) для желаемого состояния, прежде чем вернуть результат. Ноль означает ожидание до достижения желаемого состояния.

Примеры

# EFS provisioning
- efs:
    state: present
    name: myTestEFS
    tags:
        name: myTestNameTag
        purpose: file-storage
    targets:
        - subnet_id: subnet-748c5d03
          security_groups: [ "sg-1a2b3c4d" ]

# Modifying EFS data
- efs:
    state: present
    name: myTestEFS
    tags:
        name: myAnotherTestTag
    targets:
        - subnet_id: subnet-7654fdca
          security_groups: [ "sg-4c5d6f7a" ]

# Deleting EFS
- efs:
    state: absent
    name: myTestEFS

Возвращаемые значения

Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:

имя описание возвращается тип пример
creation_time
Дата и время создания
всегда строка 2015-11-16 07:30:57-05:00
creation_token
Токен создания EFS
всегда строка console-88609e04-9a0e-4a2e-912c-feaa99509961
file_system_id
Идентификатор файловой системы
всегда строка fs-xxxxxxxx
life_cycle_state
Состояние файловой системы EFS
всегда строка creating, available, deleting, deleted
mount_point
URL файловой системы
всегда строка .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
Имя файловой системы
всегда строка my-efs
number_of_mount_targets
Количество подключенных целевых узлов
всегда целое число 3
owner_id
Идентификатор учетной записи AWS владельца EFS
всегда строка XXXXXXXXXXXX
performance_mode
Режим производительности файловой системы
всегда строка 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

Статус

Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратная совместимость.

Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Документацию сообщества и вклад, Тестирование 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API