ec2_ami_find - Поиск AMIs для получения ID AMI и другой информации
Новое в версии 2.0.
- Описание
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Возвращает список подходящих AMIs с ID AMI и другой полезной информацией
- Может искать AMIs разных владельцев
- Может искать по совпадению тега(ов), имени AMI и другим критериям
- Результаты могут быть отсортированы и ограничены
Требования (для хоста, на котором выполняется модуль)
- python >= 2.6
- boto
Параметры
| параметр | обязательный | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| ami_id | нет | ID AMI для соответствия. | ||
| ami_tags | нет | Хэш/словарь тегов для соответствия AMI. | ||
| architecture | нет | Тип архитектуры для соответствия (например, x86_64). | ||
| hypervisor | нет | Тип гипервизора для соответствия (например, xen). | ||
| is_public | нет |
| Является ли образ(ы) общедоступным. | |
| name | нет | Имя AMI для соответствия. | ||
| no_result_action | нет | success |
| Действие при отсутствии результатов. 'success' сообщает об успехе и возвращает пустой массив 'fail' заставляет модуль сообщить об ошибке |
| owner | нет | Поиск AMIs, принадлежащих указанному владельцу Можно указать ID учетной записи AWS или один из специальных идентификаторов 'self', 'amazon' или 'aws-marketplace' Если не указано, будут перебираться все AMIs EC2 в указанном регионе. Вы можете включать символы подстановки во многие опции поиска. Звездочка (*) соответствует нулю или более символам, а знак вопроса (?) — ровно одному символу. Вы можете экранировать специальные символы, поставив перед ними обратную косую черту (\). Например, значение \*amazon\?\ ищет строку *amazon?\. | ||
| platform | нет | Тип платформы для соответствия. | ||
| product_code (добавлено в 2.3)
| нет | Код продукта Marketplace для соответствия. | ||
| region | да | Регион AWS для использования. псевдонимы: aws_region, ec2_region | ||
| sort | нет |
| Необязательный атрибут для сортировки результатов. При указании '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 | нет | Результат, которым завершить сортировку. Соответствует синтаксису срезов Python. | ||
| sort_order | нет | возрастание |
| Порядок сортировки результатов. Используется только при указании параметра 'sort'. |
| sort_start | нет | Результат, с которого начать сортировку. Соответствует синтаксису срезов Python. | ||
| sort_tag | нет | Имя тега для сортировки результатов. Необходимо при указании 'sort=tag'. | ||
| state | нет | available | Состояние AMI для соответствия. | |
| virtualization_type | нет | Тип виртуализации для соответствия (например, hvm). |
Примеры
# 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 | id найденного образа Amazon | при нахождении AMI | строка | 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 | булево | False |
| location | местоположение образа | при нахождении AMI | строка | 435210894375/test-server01-20151015-234343 |
| name | имя AMI образа | при нахождении AMI | строка | test-server01-20151015-234343 |
| owner_id | владелец образа | при нахождении AMI | строка | 435210894375 |
| platform | платформа образа | при нахождении AMI | строка | None |
| 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 |
Примечания
Примечание
- Этот модуль несовместим со старой версией модуля ec2_search_ami, который работал только с образами Ubuntu, перечисленными на cloud-images.ubuntu.com.
- В примере ниже показано, как искать по дистрибутиву/релизу.
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется как обратной совместимости.
Для получения помощи в разработке модулей, если у вас есть желание, прочитайте Документацию по сообществу и участию в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ec2_ami_find_module.html