Spec-Zone.ru › Ansible 2.9

ec2_ami_info – Сбор информации об ec2 AMIs

Новое в версии 2.5.

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

Описание

  • Сбор информации об ec2 AMIs
  • Этот модуль назывался ec2_ami_facts до Ansible 2.9. Использование не изменилось.

Псевдонимы: ec2_ami_facts

Требования

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

  • 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
debug_botocore_endpoint_logs
логический тип
добавлен в 2.8
    Варианты:
  • нет ←
  • да
Используйте журнал botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», сделанных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения книги задач.
Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
describe_image_attributes
логический тип
    Варианты:
  • нет ←
  • да
Описывать атрибуты (например, launchPermission) найденных изображений.
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
executable_users
-
Фильтрация изображений по пользователям с явными правами запуска. Допустимые значения: идентификатор учетной записи AWS, self или all (общедоступные AMI).

Псевдонимы: executable_user
filters
-
Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра.
См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html для возможных фильтров.
Имена и значения фильтров чувствительны к регистру.
image_ids
-
Один или несколько идентификаторов изображений.

Псевдонимы: image_id
owners
-
Фильтрация изображений по владельцу. Допустимые значения: идентификатор учетной записи AWS, self или псевдоним владельца AWS ( amazon | aws-marketplace | microsoft ).

Псевдонимы: owner
profile
строка
Использование профиля boto. Работает только с boto >= 2.24.0.
region
строка
Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

Псевдонимы: aws_region, ec2_region
security_token
строка
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
validate_certs
логический тип
    Варианты:
  • нет
  • да ←
Если установлено «нет», сертификаты SSL для версий boto >= 2.6.0 не будут проверяться.

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета 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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: gather information about an AMI using ami-id
  ec2_ami_info:
    image_ids: ami-5b488823

- name: gather information about all AMIs with tag key Name and value webapp
  ec2_ami_info:
    filters:
      "tag:Name": webapp

- name: gather information about an AMI with 'AMI Name' equal to foobar
  ec2_ami_info:
    filters:
      name: foobar

- name: gather information about Ubuntu 17.04 AMIs published by Canonical (099720109477)
  ec2_ami_info:
    owners: 099720109477
    filters:
      name: "ubuntu/images/ubuntu-zesty-17.04-*"

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

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

Ключ Возвращаемое значение Описание
images
сложный
всегда
список изображений

architecture
строка
всегда
Архитектура изображения

Пример:
x86_64
block_device_mappings
сложный
всегда
Любые записи отображения блочных устройств

device_name
строка
всегда
Имя устройства, доступное для экземпляра

Пример:
/dev/sda1
ebs
сложный
всегда
Тома EBS

creation_date
строка
всегда
Дата и время создания изображения

Пример:
2017-10-16T19:22:13.000Z
description
строка
всегда
Описание AMI

ena_support
булево
всегда
включено ли расширенное сетевое взаимодействие с ENA

Пример:
True
hypervisor
строка
всегда
Тип гипервизора изображения

Пример:
xen
image_id
строка
всегда
Идентификатор AMI

Пример:
ami-5b466623
image_location
строка
всегда
Расположение AMI

Пример:
408466080000/Webapp
image_type
строка
всегда
Тип изображения

Пример:
machine
launch_permissions
сложный
при условии, что изображение принадлежит вызывающей учетной записи и describe_image_attributes — да
разрешения на запуск AMI

Пример:
[{'group': 'all'}, {'user_id': '408466080000'}]
name
строка
всегда
Имя AMI, предоставленное при создании изображения

Пример:
Webapp
owner_id
строка
всегда
Идентификатор AWS учетной записи владельца изображения

Пример:
408466080000
public
булево
всегда
имеет ли изображение общедоступные разрешения на запуск

Пример:
True
root_device_name
строка
всегда
Имя устройства корневого устройства

Пример:
/dev/sda1
root_device_type
строка
всегда
Тип корневого устройства, используемого AMI

Пример:
ebs
sriov_net_support
строка
всегда
включено ли расширенное сетевое взаимодействие

Пример:
simple
state
строка
всегда
Текущее состояние AMI

Пример:
available
tags
сложный
всегда
Присвоенные изображению метки

virtualization_type
строка
всегда
Тип виртуализации AMI

Пример:
hvm


Статус

  • Для данного модуля не гарантируется обратная совместимость. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Prasad Katti (@prasadkatti)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ec2_ami_info_module.html

Spec-Zone.ru

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