Модуль amazon.aws.ec2_vol — создание и подключение тома, возврат идентификатора тома и карты устройств

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_vol.

Добавлено в amazon.aws 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создает том EBS и при необходимости подключает его к экземпляру.
Если указаны оба параметра instance и name, а на экземпляре уже есть устройство с таким именем, том не создается и подключение не выполняется.

Требования

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

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
aws_ca_bundle путь	Путь к пакету центров сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Описание параметров приведено в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их набор в ключ resource_actions в результатах задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в плейбуке. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
delete_on_termination логическое значение	Если значение параметра равно `true`, том будет удален при завершении работы экземпляра. Варианты: `false` ← (по умолчанию) `true`
device_name строка	Идентификатор устройства для переопределения сопоставления устройств. По умолчанию используется /dev/sdf для Linux/UNIX и /dev/xvdf для Windows.
encrypted логическое значение	Включить шифрование этого тома при хранении. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
id строка	Идентификатор тома, если требуется подключить существующий том (необходим экземпляр) или удалить существующий том.
instance строка	Идентификатор экземпляра, если требуется подключить том. Укажите `None`, чтобы отключить том.
iops целое число	Количество подготовленных IOPS, которое требуется связать с этим томом (целое число).
kms_key_id строка	Укажите идентификатор используемого ключа KMS.
modify_volume логическое значение добавлено в amazon.aws 1.4.0	Том не будет изменен, если для этого ключа не задано значение `true`. Варианты: `false` ← (по умолчанию) `true`
multi_attach логическое значение добавлено в amazon.aws 2.0.0	Если задано значение `true`, при создании тома будет включена функция Multi-Attach. При создании нового тома функция Multi-Attach по умолчанию отключена. Этот параметр поддерживается только для томов io1 и io2. Варианты: `false` `true`
name строка	Тег имени тома, если требуется подключить существующий том (необходим экземпляр).
outpost_arn строка добавлено в amazon.aws 3.1.0	Имя ресурса Amazon (ARN) Outpost. Если задано, позволяет создать том в Outpost.
profile псевдоним: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
purge_tags логическое значение	Если задано значение `purge_tags=true` и установлен параметр `tags`, существующие теги ресурса будут удалены, чтобы набор тегов точно соответствовал указанному в параметре `tags`. Если параметр `tags` не задан, теги не будут изменены, даже если задано `purge_tags=True`. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому они будут игнорироваться при обработке параметра `purge_tags`. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
region псевдоним: aws_region строка	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
session_token псевдоним: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
snapshot строка	Идентификатор снимка, на основе которого создается том.
state строка	Указывает, должен ли том присутствовать или отсутствовать. Параметр `state=list` устарел в выпуске 1.1.0 и больше недоступен начиная с выпуска 4.0.0. Функциональность `list` перенесена в отдельный модуль amazon.aws.ec2_vol_info. Варианты: `"absent"` `"present"` ← (по умолчанию)
tags псевдоним: resource_tags словарь	Словарь тегов, которые нужно применить к ресурсу. Если параметр `tags` не задан, теги не будут изменены.
throughput целое число добавлено в amazon.aws 1.4.0	Пропускная способность тома в МБ/с. Этот параметр допустим только для томов gp3. Допустимый диапазон: от 125 до 2000.
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты не будут проверяться при обмене данными с API AWS. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рекомендуется указать параметр aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
volume_initialization_rate целое число добавлено в amazon.aws 11.2.0	Скорость инициализации тома из снимка.
volume_size целое число	Размер создаваемого тома (в ГиБ).
volume_type строка	Тип тома EBS: `standard` (магнитный), `gp2` (SSD), `gp3` (SSD), `io1` (подготовленные IOPS), `io2` (подготовленные IOPS), `st1` (HDD с оптимизированной пропускной способностью), `sc1` (HDD для холодного хранения). `standard` — прежний тип EBS по умолчанию; он по-прежнему используется в Ansible для обеспечения обратной совместимости. Варианты: `"standard"` ← (по умолчанию) `"gp2"` `"io1"` `"st1"` `"sc1"` `"gp3"` `"io2"`
zone псевдонимы: availability_zone, aws_zone, ec2_zone строка	Зона, в которой нужно создать том; если не задана, используется зона экземпляра (если он указан).

Примечания

Примечание

Поддержка purge_tags добавлена в выпуске 1.5.0.
Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «хост». Для подключаемых модулей поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. здесь: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Simple attachment action
- amazon.aws.ec2_vol:
    instance: XXXXXX
    volume_size: 5
    device_name: sdd
    region: us-west-2

# Example using custom iops params
- amazon.aws.ec2_vol:
    instance: XXXXXX
    volume_size: 5
    iops: 100
    device_name: sdd
    region: us-west-2

# Example using snapshot id
- amazon.aws.ec2_vol:
    instance: XXXXXX
    snapshot: "{{ snapshot }}"

# Playbook example combined with instance launch
- amazon.aws.ec2:
    keypair: "{{ keypair }}"
    image: "{{ image }}"
    wait: true
    count: 3
  register: ec2
- amazon.aws.ec2_vol:
    instance: "{{ item.id }}"
    volume_size: 5
  loop: "{{ ec2.instances }}"
  register: ec2_vol

# Example: Launch an instance and then add a volume if not already attached
#   * Volume will be created with the given name if not already created.
#   * Nothing will happen if the volume is already attached.

- amazon.aws.ec2:
    keypair: "{{ keypair }}"
    image: "{{ image }}"
    zone: YYYYYY
    id: my_instance
    wait: true
    count: 1
  register: ec2

- amazon.aws.ec2_vol:
    instance: "{{ item.id }}"
    name: my_existing_volume_Name_tag
    device_name: /dev/xvdf
  loop: "{{ ec2.instances }}"
  register: ec2_vol

# Remove a volume
- amazon.aws.ec2_vol:
    id: vol-XXXXXXXX
    state: absent

# Detach a volume (since 1.9)
- amazon.aws.ec2_vol:
    id: vol-XXXXXXXX
    instance: None
    region: us-west-2

# Create new volume using SSD storage
- amazon.aws.ec2_vol:
    instance: XXXXXX
    volume_size: 50
    volume_type: gp2
    device_name: /dev/xvdf

# Create new volume with multi-attach enabled
- amazon.aws.ec2_vol:
    zone: XXXXXX
    multi_attach: true
    volume_size: 4
    volume_type: io1
    iops: 102

# Attach an existing volume to instance. The volume will be deleted upon instance termination.
- amazon.aws.ec2_vol:
    instance: XXXXXX
    id: XXXXXX
    device_name: /dev/sdf
    delete_on_termination: true

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

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

Ключ	Описание
device string	Имя устройства подключенного тома. Возвращается: при успешном выполнении Пример: `"/dev/sdf"`
volume dictionary	Словарь с подробными атрибутами тома. Возвращается: при успешном выполнении
attachment_set list / elements=dictionary	Информация о подключениях тома. В версии 2.0.0 тип значения изменён со словаря на список словарей. Возвращается: при успешном выполнении Пример: `[{"attach_time": "2015-10-23T00:22:29.000Z", "deleteOnTermination": "false", "device": "/dev/sdf", "instance_id": "i-8356263c", "status": "attached"}]`
create_time string	Временная метка начала создания тома. Возвращается: при успешном выполнении Пример: `"2015-10-21T14:36:08.870Z"`
encrypted boolean	Указывает, зашифрован ли том. Возвращается: при успешном выполнении Пример: `false`
id string	Идентификатор тома. Возвращается: при успешном выполнении Пример: `"vol-35b333d9"`
iops integer	Количество операций ввода-вывода в секунду (IOPS), поддерживаемое томом. Возвращается: при успешном выполнении
size integer	Размер тома в ГиБ. Возвращается: при успешном выполнении Пример: `1`
snapshot_id string	Снимок, на основе которого создан том, если применимо. Возвращается: при успешном выполнении Пример: `""`
status string	Состояние тома. Возвращается: при успешном выполнении Пример: `"in-use"`
tags dictionary	Все теги, назначенные тому. Возвращается: при успешном выполнении Пример: `{"env": "dev"}`
throughput integer	Пропускная способность тома в МиБ/с. Возвращается: при успешном выполнении Пример: `131`
type string	Тип тома. Возможные значения: gp2, io1, st1, sc1 или standard. Возвращается: при успешном выполнении Пример: `"standard"`
zone string	Зона доступности тома. Возвращается: при успешном выполнении Пример: `"us-east-1b"`
volume_id string	Идентификатор тома. Возвращается: при успешном выполнении Пример: `"vol-35b333d9"`
volume_type string	Тип тома. Возвращается: при успешном выполнении Пример: `"standard"`

Авторы

Lester Wade (@lwade)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/ec2_vol_module.html