Spec-Zone.ru › Ansible

модуль amazon.aws.ec2_import_image_info — сбор сведений о задачах импорта виртуальных машин

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.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 SDK botocore.

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 результатов задачи. Чтобы вывести общий список вызовов, выполненных во время плейбука, используйте обратный вызов aws_resource_action.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

endpoint_url

псевдонимы: aws_endpoint_url

строка

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную среды AWS_URL.

filters

список / элементы=словарь

Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра.

Возможные фильтры см. в документации: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImportImageTasks.html.

import_task_ids

псевдонимы: ids

список / элементы=строка

Идентификаторы задач импорта образов.

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.

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 SDK botocore.

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 являются взаимоисключающими.

validate_certs

логическое значение

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

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» 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

сложный тип

Список задач импорта EC2.

Возвращается: всегда

architecture

строка

Архитектура виртуальной машины.

Возвращается: при успешном выполнении

description

строка

Строка с описанием задачи импорта образа.

Возвращается: при успешном выполнении

encrypted

логическое значение

Указывает, должен ли целевой AMI импортированного образа быть зашифрован.

Возвращается: при успешном выполнении

hypervisor

строка

Целевая платформа гипервизора.

Возвращается: при успешном выполнении

image_id

строка

Идентификатор Amazon Machine Image (AMI), созданного задачей импорта.

Возвращается: при успешном выполнении

import_task_id

строка

Идентификатор задачи импорта образа.

Возвращается: при успешном выполнении

kms_key_id

строка

Идентификатор симметричного ключа KMS, использованного для создания зашифрованного AMI.

Возвращается: при успешном выполнении

license_specifications

словарь

ARN конфигураций лицензий.

Возвращается: при успешном выполнении

license_type

строка

Тип лицензии, используемый для Amazon Machine Image (AMI) после импорта.

Возвращается: при успешном выполнении

platform

строка

Операционная система виртуальной машины.

Возвращается: при успешном выполнении

progress

строка

Ход выполнения задачи.

Возвращается: при успешном выполнении

role_name

строка

Имя роли, используемой вместо роли по умолчанию «vmimport».

Возвращается: при успешном выполнении

snapshot_details

словарь

Сведения о снимке, созданном на основе импортированного диска.

Возвращается: при успешном выполнении

description

строка

Описание снимка.

Возвращается: при успешном выполнении

device_name

строка

Сопоставление блочного устройства для снимка.

Возвращается: при успешном выполнении

disk_image_size

число с плавающей точкой

Размер диска в снимке в ГиБ.

Возвращается: при успешном выполнении

format

строка

Формат образа диска, из которого создан снимок.

Возвращается: при успешном выполнении

progress

строка

Процент выполнения задачи.

Возвращается: при успешном выполнении

snapshot_id

строка

Идентификатор снимка импортируемого диска.

Возвращается: при успешном выполнении

status

строка

Краткий статус создания снимка.

Возвращается: при успешном выполнении

status_message

строка

Подробное сообщение о статусе создания снимка.

Возвращается: при успешном выполнении

url

строка

URL для доступа к образу диска.

Возвращается: при успешном выполнении

user_bucket

словарь

Бакет Amazon S3 для образа диска.

Возвращается: при успешном выполнении

status

строка

Краткий статус задачи.

Возвращается: при успешном выполнении

status_message

строка

Подробное сообщение о статусе задачи импорта.

Возвращается: при успешном выполнении

tags

словарь

Теги, применяемые к задаче импорта образа при ее создании.

Возвращается: при успешном выполнении

task_name

строка

Имя задачи импорта образа EC2.

Возвращается: при успешном выполнении

usage_operation

словарь

Значение операции использования.

Возвращается: при успешном выполнении

Авторы

  • Alina Buzachis (@alinabuzachis)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

© 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_import_image_info_module.html

Spec-Zone.ru

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