ec2_ami_facts - Сбор фактов о ec2 AMIs
Новое в версии 2.5.
Обзор
- Сбор фактов о ec2 AMIs
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Значение по умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key |
| describe_image_attributes |
| Описывать атрибуты (например, launchPermission) найденных образов. |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. |
| executable_users | Фильтровать образы по пользователям с явными правами запуска. Допустимые значения: идентификатор учетной записи AWS, self или all (общедоступные AMIs). Псевдонимы: 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 (добавлено в 1.6) | Значение по умолчанию: None | Использует профиль 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 (добавлено в 1.6) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token |
| validate_certs (добавлено в 1.5) |
| При значении "no" сертификаты 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), если данные аутентификации не предоставлены. См. http://boto.readthedocs.org/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 facts about an AMI using ami-id
ec2_ami_facts:
image_ids: ami-5b488823
- name: gather facts about all AMIs with tag key Name and value webapp
ec2_ami_facts:
filters:
"tag:Name": webapp
- name: gather facts about an AMI with 'AMI Name' equal to foobar
ec2_ami_facts:
filters:
name: foobar
- name: gather facts about Ubuntu 17.04 AMIs published by Canonical (099720109477)
ec2_ami_facts:
owners: 099720109477
filters:
name: "ubuntu/images/ubuntu-zesty-17.04-*"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| images сложный | всегда | список изображений | ||
| image_location строка | всегда | Расположение AMI Пример: 408466080000/Webapp | ||
| root_device_type строка | всегда | Тип корневого устройства AMI Пример: ebs | ||
| description строка | всегда | Описание AMI | ||
| tags сложный | всегда | Присвоенные теги изображения | ||
| launch_permissions сложный | при условии, что изображение принадлежит вызывающей учётной записи и describe_image_attributes равно yes | разрешения на запуск ami Пример: [{'group': 'all'}, {'user_id': '408466080000'}] | ||
| creation_date строка | всегда | Дата и время создания изображения Пример: 2017-10-16T19:22:13.000Z | ||
| image_id строка | всегда | Идентификатор AMI Пример: ami-5b466623 | ||
| block_device_mappings сложный | всегда | Записи сопоставления блочных устройств | ||
| device_name строка | всегда | Имя устройства, доступное экземпляру Пример: /dev/sda1 | ||
| ebs сложный | всегда | Тома EBS | ||
| name строка | всегда | Имя AMI, предоставленное при создании изображения Пример: Webapp | ||
| image_type строка | всегда | Тип изображения Пример: machine | ||
| ena_support логическое | всегда | Включена ли расширенная сеть с ENA Пример: True | ||
| public логическое | всегда | Настроены ли публичные разрешения на запуск изображения Пример: True | ||
| state строка | всегда | Текущее состояние AMI Пример: available | ||
| root_device_name строка | всегда | Имя устройства корневого устройства Пример: /dev/sda1 | ||
| hypervisor строка | всегда | Тип гипервизора изображения Пример: xen | ||
| owner_id строка | всегда | AWS идентификатор учётной записи владельца изображения Пример: 408466080000 | ||
| virtualization_type строка | всегда | Тип виртуализации AMI Пример: hvm | ||
| sriov_net_support строка | всегда | Включена ли расширенная сеть Пример: simple | ||
| architecture строка | всегда | Архитектура изображения Пример: x86_64 | ||
Статус
Этот модуль помечен как превью, что означает, что интерфейс не гарантируется обратной совместимостью.
Автор
- 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.5/modules/ec2_ami_facts_module.html