ec2_ami_facts - Сбор фактов об ec2 AMIs
Новое в версии 2.5.
Обзор
- Сбор фактов об ec2 AMIs
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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 | |
| describe_image_attributes bool |
| Описывать атрибуты (например, launchPermission) найденных образов. |
| ec2_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) | Использует профиль 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) | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| validate_certs bool (добавлено в 1.5) |
| При установке в "нет", сертификаты 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 complex | всегда | список изображений | ||
| architecture string | всегда | Архитектура изображения Пример: x86_64 | ||
| block_device_mappings complex | всегда | Записи сопоставления блочных устройств | ||
| device_name string | всегда | Имя устройства, экспонированное для экземпляра Пример: /dev/sda1 | ||
| ebs complex | всегда | Тома EBS | ||
| creation_date string | всегда | Дата и время создания изображения Пример: 2017-10-16T19:22:13.000Z | ||
| description string | всегда | Описание AMI | ||
| ena_support bool | всегда | Включена ли расширенная сеть с ENA Пример: True | ||
| hypervisor string | всегда | Тип гипервизора изображения Пример: xen | ||
| image_id string | всегда | Идентификатор AMI Пример: ami-5b466623 | ||
| image_location string | всегда | Расположение AMI Пример: 408466080000/Webapp | ||
| image_type string | всегда | Тип изображения Пример: machine | ||
| launch_permissions complex | при условии, что изображение принадлежит вызывающей учетной записи и describe_image_attributes равно yes | Права запуска AMI Пример: [{'group': 'all'}, {'user_id': '408466080000'}] | ||
| name string | всегда | Имя AMI, предоставленное при создании изображения Пример: Webapp | ||
| owner_id string | всегда | Идентификатор AWS учетной записи владельца изображения Пример: 408466080000 | ||
| public bool | всегда | Наличие общедоступных прав запуска для изображения Пример: True | ||
| root_device_name string | всегда | Имя устройства корневого устройства Пример: /dev/sda1 | ||
| root_device_type string | всегда | Тип корневого устройства, используемого AMI Пример: ebs | ||
| sriov_net_support string | всегда | Включена ли расширенная сеть Пример: simple | ||
| state string | всегда | Текущее состояние AMI Пример: available | ||
| tags complex | всегда | Присвоенные теги изображения | ||
| virtualization_type string | всегда | Тип виртуализации AMI Пример: hvm | ||
Статус
Этот модуль помечен как превью, что означает, что его обратная совместимость не гарантируется.
Техническое обслуживание
Этот модуль помечен как общественный, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/ec2_ami_facts_module.html