ec2_ami_find - Поиск AMIs для получения идентификатора AMI и другой информации
Новая версия 2.0.
УСТЕРЕЛО
| Удалено в Ansible: | |
|---|---|
| версия: 2.9 | |
| Почему: | Различные модули AWS были объединены и заменены на ec2_ami_facts. |
| Альтернатива: | Используйте ec2_ami_facts вместо этого. |
Описание
- Возвращает список соответствующих AMIs с идентификатором AMI и другой полезной информацией
- Может искать AMIs с разными владельцами
- Может искать по совпадению тега(ов), имени AMI и/или другим критериям
- Результаты могут быть отсортированы и разделены
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ami_id | Значение по умолчанию: None | Идентификатор AMI для поиска. |
| ami_tags | Значение по умолчанию: None | Хэш/словарь тегов для поиска AMI. |
| architecture | Значение по умолчанию: None | Тип архитектуры для поиска (например, x86_64). |
| 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 |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. |
| hypervisor | Значение по умолчанию: None | Тип гипервизора для поиска (например, xen). |
| is_public |
None | Является ли образ(ы) общедоступным(и). |
| name | Значение по умолчанию: None | Имя AMI для поиска. |
| no_result_action |
| Действие при отсутствии результатов. 'success' сообщает об успехе и возвращает пустой массив 'fail' приводит к сообщению об ошибке модуля |
| owner | Значение по умолчанию: None | Поиск AMIs, принадлежащих указанному владельцу Можно указать идентификатор учетной записи AWS или один из специальных идентификаторов 'self', 'amazon' или 'aws-marketplace' Если не указано, будут просматриваться все AMI EC2 в указанном регионе. Вы можете включать подстановочные знаки во многие параметры поиска. Звездочка (*) соответствует нулю или более символам, а знак вопроса (?) соответствует ровно одному символу. Вы можете экранировать специальные символы с помощью обратной косой черты (\) перед символом. Например, значение \*amazon\?\\ ищет строку *amazon?\. |
| platform | Значение по умолчанию: None | Тип платформы для поиска. |
| product_code (добавлено в 2.3) | Значение по умолчанию: None | Код продукта Marketplace для поиска. |
| profile (добавлено в 1.6) | Значение по умолчанию: None | Использует профиль boto. Работает только с boto >= 2.24.0. |
| region необходимо | Регион AWS для использования. алиасы: aws_region, ec2_region | |
| root_device_type (добавлено в 2.5) | Значение по умолчанию: None | Тип корневого устройства для поиска (например, ebs, instance-store). |
| security_token (добавлено в 1.6) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. алиасы: access_token |
| sort |
None | Необязательное атрибут для сортировки результатов. Если задан 'tag', требуется параметр 'tag_name'. Начиная с версии 2.1, поддерживаются дополнительные варианты сортировки architecture, block_device_mapping, creationDate, hypervisor, is_public, location, owner_id, platform, root_device_name, root_device_type, state и virtualization_type. |
| sort_end | Значение по умолчанию: None | Результат, которым нужно завершить сортировку. Соответствует синтаксису срезов в Python. |
| sort_order |
| Порядок сортировки результатов. Используется только при указании параметра 'sort'. |
| sort_start | Значение по умолчанию: None | Результат, с которого нужно начать сортировку. Соответствует синтаксису срезов в Python. |
| sort_tag | Значение по умолчанию: None | Имя тега, по которому сортировать результаты. Требуется при указании 'sort=tag'. |
| state | Значение по умолчанию: available | Состояние AMI для поиска. |
| validate_certs (добавлено в 1.5) |
| При установке в "нет", сертификаты SSL не будут проверяться для версий boto >= 2.6.0. |
| virtualization_type | Значение по умолчанию: None | Тип виртуализации для поиска (например, hvm). |
Примечания
Примечание
- Этот модуль несовместим со старой версией модуля ec2_search_ami, который работал только для AMIs Ubuntu, указанных на cloud-images.ubuntu.com.
- Смотрите пример ниже для рекомендации по поиску по дистрибутиву/релизу.
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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.
# Search for the AMI tagged "project:website"
- ec2_ami_find:
owner: self
ami_tags:
project: website
no_result_action: fail
register: ami_find
# Search for the latest Ubuntu 14.04 AMI
- ec2_ami_find:
name: "ubuntu/images/ebs/ubuntu-trusty-14.04-amd64-server-*"
owner: 099720109477
sort: name
sort_order: descending
sort_end: 1
register: ami_find
# Launch an EC2 instance
- ec2:
image: "{{ ami_find.results[0].ami_id }}"
instance_type: m3.medium
key_name: mykey
wait: yes
Значения возврата
Общие значения возврата описаны в здесь, ниже перечислены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ami_id строка | при обнаружении AMI | идентификатор найденной amazon-образа Пример: ami-e9095e8c |
| architecture строка | при обнаружении AMI | архитектура образа Пример: x86_64 |
| block_device_mapping словарь | при обнаружении AMI | отображение блочных устройств, связанных с образом Пример: { '/dev/xvda': { 'delete_on_termination': true, 'encrypted': false, 'size': 8, 'snapshot_id': 'snap-ca0330b8', 'volume_type': 'gp2' } |
| creationDate строка | при обнаружении AMI | дата создания образа Пример: 2015-10-15T22:43:44.000Z |
| description строка | при обнаружении AMI | описание образа Пример: test-server01 |
| hypervisor строка | при обнаружении AMI | тип гипервизора Пример: xen |
| is_public логическое | при обнаружении AMI | является ли образ общедоступным |
| location строка | при обнаружении AMI | местоположение образа Пример: 435210894375/test-server01-20151015-234343 |
| name строка | при обнаружении AMI | имя AMI образа Пример: test-server01-20151015-234343 |
| owner_id строка | при обнаружении AMI | владелец образа Пример: 435210894375 |
| platform строка | при обнаружении AMI | платформа образа |
| root_device_name строка | при обнаружении AMI | имя корневого устройства образа Пример: /dev/xvda |
| root_device_type строка | при обнаружении AMI | тип корневого устройства образа Пример: ebs |
| state строка | при обнаружении AMI | состояние образа Пример: available |
| tags словарь | при обнаружении AMI | теги, назначенные образу Пример: { 'Environment': 'devel', 'Name': 'test-server01', 'Role': 'web' } |
| virtualization_type строка | при обнаружении AMI | тип виртуализации образа Пример: hvm |
Статус
Этот модуль помечен как устаревший и будет удалён в версии 2.9. Дополнительная информация см. в разделе УСТАРЕВШИЙ.
Автор
- Tom Bamford (@tombamford)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_find_module.html