amazon.aws.ec2_ami_facts – Сбор информации об ec2 AMI

Примечание

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

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

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

Новый в версии 1.0.0: из amazon.aws

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

Обзор

Сбор информации об ec2 AMI
Этот модуль назывался 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 Bundle для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: CA Bundle считывается со стороны модуля и может потребоваться явное копирование с контроллера, если запуск не локальный.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Дополнительные настройки boto можно найти по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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 список / элементы=строка		Фильтрует образы по пользователям с явными правами запуска. Допустимые значения — идентификатор учетной записи 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. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка одновременного их использования с profile устарела. 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. Если не задан, используется значение переменной окружения 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 строка		всегда	Идентификатор 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/amazon/aws/ec2_ami_facts_module.html