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

Примечание

Этот плагин входит в состав коллекции amazon.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install amazon.aws.

Чтобы использовать его в книге задач, укажите: amazon.aws.ec2_ami_info.

Новое в версии 1.0.0: от amazon.aws

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

Обзор

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла с сертификатами CA, используемого для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: файл с сертификатами CA считывается со стороны модуля и может потребоваться его явное копирование с контроллера, если он не выполняется локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs логический	Варианты: нет ← да	Используйте логировщик botocore.endpoint для анализа уникальных (а не общих) API-вызовов "ресурс:действие", выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время книги задач. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
describe_image_attributes логический	Варианты: нет ← да	Описать атрибуты (например, launchPermission) найденных изображений.
ec2_url строка		URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая есть. псевдонимы: aws_endpoint_url, endpoint_url
executable_users список / элементы=строка		Фильтр изображений по пользователям с явными правами запуска. Допустимые значения - ID учетной записи AWS, self или all (общедоступные AMIs). псевдонимы: executable_user
filters словарь		Словарь фильтров для применения. Каждый элемент словаря содержит ключ фильтра и значение фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html для возможных фильтров. Имена и значения фильтров чувствительны к регистру.
image_ids список / элементы=строка		Один или несколько идентификаторов изображений. псевдонимы: image_id
owners список / элементы=строка		Фильтр изображений по владельцу. Допустимые значения - ID учетной записи AWS, self или псевдоним владельца AWS (amazon \| aws-marketplace \| microsoft). псевдонимы: owner
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка одновременного использования с ними устарела. aws_access_key, aws_secret_key и security_token станут взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
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 security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
validate_certs логический	Варианты: нет да ←	При значении "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
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
  amazon.aws.ec2_ami_info:
    image_ids: ami-5b488823

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

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

- name: gather information about Ubuntu 17.04 AMIs published by Canonical (099720109477)
  amazon.aws.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 строка		всегда	ID AMI. Пример: ami-5b466623
	image_location строка		всегда	Расположение AMI. Пример: 408466080000/Webapp
	image_type строка		всегда	Тип изображения. Пример: machine
	launch_permissions список / элементы=словарь		Когда изображение принадлежит вызывающему аккаунту и describe_image_attributes равно да.	Список AWS аккаунтов, которые могут запускать AMI. Пример: [{'group': 'all'}, {'user_id': '408466080000'}]
		group строка	успех	Значение 'all' означает, что AMI является публичным.
		user_id строка	успех	Идентификатор AWS аккаунта с разрешениями на запуск AMI.
	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

Авторы

Prasad Katti (@prasadkatti)

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