Модуль amazon.aws.ec2_import_image_info – Сбор информации о задачах импорта виртуальных машин

Примечание

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

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

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

Для использования в плейбуке укажите: amazon.aws.ec2_import_image_info.

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

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

Описание

Отображает подробную информацию о задачах импорта виртуальных машин, которые уже созданы.

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	Идентификатор ключа доступа 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` или `EC2_ACCESS_KEY` также могут использоваться в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle path	Расположение пакета CA для использования при проверке SSL-сертификатов. Переменная среды `AWS_CA_BUNDLE` также может использоваться.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs boolean	Использовать `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, созданный во время выполнения playbook. Переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS` также может использоваться. Варианты: `false` ← (по умолчанию) `true`
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды `AWS_URL` или `EC2_URL` также могут использоваться в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
filters list / elements=dictionary	Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImportImageTasks.html для возможных фильтров.
import_task_ids aliases: ids list / elements=string	Идентификаторы задач импорта образов.
profile aliases: aws_profile string	Именованный профиль AWS для использования при аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Переменная среды `AWS_PROFILE` также может использоваться. Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token.
region aliases: aws_region, ec2_region string	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные среды `AWS_REGION` или `EC2_REGION` также могут использоваться. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01 Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа 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` или `EC2_SECRET_KEY` также могут использоваться в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сессии 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, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры security_token и profile взаимоисключающие.

Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

При установке в false, сертификаты SSL для связи с API AWS не будут проверяться.

Установка validate_certs=false категорически не рекомендуется; вместо этого рассмотрите установку aws_ca_bundle.

Варианты:

false
true ← (по умолчанию)

Примечания

Примечание

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

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Check status of import image
  amazon.aws.ec2_import_image_info:
    filters:
      - Name: "tag:Name"
        Values: ["clone-vm-import-image"]
      - Name: "task-state"
        Values: ["completed", "active"]

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

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

Ключ	Описание
import_image complex	Список задач импорта EC2. Возвращается: всегда
architecture string	Архитектура виртуальной машины. Возвращается: успешно
description string	Строка описания для задачи импорта образа. Возвращается: успешно
encrypted boolean	Указывает, следует ли шифровать результирующий AMI импортированного образа. Возвращается: успешно
hypervisor string	Целевая платформа гипервизора. Возвращается: успешно
image_id string	Идентификатор образа Amazon Machine Image (AMI), созданного задачей импорта. Возвращается: успешно
import_task_id string	Идентификатор задачи импорта образа. Возвращается: успешно
kms_key_id string	Идентификатор симметричного ключа KMS, который использовался для создания зашифрованного AMI. Возвращается: успешно
license_specifications dictionary	ARN конфигураций лицензий. Возвращается: успешно
license_type string	Тип лицензии, который будет использоваться для Amazon Machine Image (AMI) после импорта. Возвращается: успешно
platform string	Операционная система виртуальной машины. Возвращается: успешно
progress string	Прогресс задачи. Возвращается: успешно
role_name string	Имя роли, используемой, если не используется роль по умолчанию, «vmimport». Возвращается: успешно
snapshot_details dictionary	Описание снимка, созданного из импортированного диска. Возвращается: успешно
description string	Описание снимка. Возвращается: успешно
device_name string	Сопоставление блочных устройств для снимка. Возвращается: успешно
disk_image_size float	Размер диска в снимке, в GiB. Возвращается: успешно
format string	Формат образа диска, из которого создан снимок. Возвращается: успешно
progress string	Процент выполнения задачи. Возвращается: успешно
snapshot_id string	Идентификатор снимка импортируемого диска. Возвращается: успешно
status string	Краткое состояние создания снимка. Возвращается: успешно

status_message string	Подробное сообщение о состоянии создания снимка. Возвращается: success
url string	URL для доступа к образу диска. Возвращается: success
user_bucket dictionary	Ведро Amazon S3 для образа диска. Возвращается: success
status string	Краткое состояние задачи. Возвращается: success
status_message string	Подробное сообщение о состоянии задачи импорта. Возвращается: success
tags dictionary	Теги, которые будут применены к задаче импорта образа во время создания. Возвращается: success
task_name string	Имя задачи импорта образа EC2. Возвращается: success
usage_operation dictionary	Значение операции использования. Возвращается: success

Авторы

Alina Buzachis (@alinabuzachis)

Ссылки на сборку

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