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 boolean |
| Описывать атрибуты (например, launchPermission) найденных изображений. |
| ec2_url - | 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 boolean Добавлен в 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), если данные об учетных записях не предоставлены. См. 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 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 сложный | всегда | список изображений | ||
| 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 равно yes | Права запуска 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. [community]
Авторы
- 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.7/modules/ec2_ami_facts_module.html