ec2_remote_facts – Сбор фактов об экземплярах ec2 в AWS
Новое в версии 2.0.
УСТАНОВЛЕНО
| Удалино в Ansible: | |
|---|---|
| версия: 2.8 | |
| Почему: | Заменено на boto3 версию. |
| Альтернатива: | Используйте ec2_instance_facts вместо этого. |
Синопсис
- Сбор фактов об экземплярах ec2 в AWS
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 | |
| ec2_url - | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задано, используется значение переменной окружения EC2_URL, если таковое есть. | |
| filters - | Словарь фильтров для применения. Каждый элемент словаря содержит ключ фильтра и значение фильтра. См. http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html для возможных фильтров. | |
| 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.
# Gather facts about all ec2 instances
- ec2_remote_facts:
# Gather facts about all running ec2 instances with a tag of Name:Example
- ec2_remote_facts:
filters:
instance-state-name: running
"tag:Name": Example
# Gather facts about instance i-123456
- ec2_remote_facts:
filters:
instance-id: i-123456
# Gather facts about all instances in vpc-123456 that are t2.small type
- ec2_remote_facts:
filters:
vpc-id: vpc-123456
instance-type: t2.small
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| instances сложный | если в регионе AWS найдены экземпляры EC2, в противном случае пусто | предоставляет сведения об экземпляре(ах) EC2, найденных в регионе AWS | ||
| ami_launch_index строка | успех | если одновременно запущено более одного экземпляра, это значение указывает порядок запуска экземпляра, значение первого запущенного экземпляра равно 0 Пример: 0 | ||
| architecture строка | успех | архитектура экземпляра Пример: x86_64 | ||
| block_device_mapping сложный | успех | структура, описывающая подключенные тома к экземпляру | ||
| attach_time строка | успех | время подключения для тома EBS, сопоставленного с экземпляром Пример: 2017-01-03T15:19:52.000Z | ||
| delete_on_termination булево | успех | указывает, удаляется ли том EBS при завершении работы экземпляра Пример: true | ||
| device_name строка | успех | имя устройства для тома EBS Пример: /dev/sda1 | ||
| status строка | успех | статус для тома EBS Пример: attaching | ||
| volume_id строка | успех | идентификатор тома EBS Пример: vol-3160f90df06b24080 | ||
| client_token строка | успех | токен идемпотентности, предоставленный при запуске экземпляра Пример: Sample-awsmp-DFNBSML8ZMJ9 | ||
| ebs_optimized булево | успех | указывает, включён ли флаг оптимизации EBS для класса экземпляра Пример: true | ||
| groups сложный | успех | список групп безопасности, к которым принадлежит сетевой интерфейс | ||
| id строка | успех | идентификатор группы безопасности Пример: sg-e203cf94 | ||
| name строка | успех | Пример: Sample-Common-Sg | ||
| hypervisor строка | успех | тип гипервизора экземпляра Пример: xen | ||
| id строка | успех | идентификатор экземпляра Пример: i-09275d68c04c1a16c | ||
| image_id строка | успех | идентификатор образа, используемого для запуска экземпляра Пример: ami-1748d2f5 | ||
| instance_profile сложный | успех | профиль экземпляра, связанный с экземпляром | ||
| arn строка | успех | указание ARN профиля экземпляра Пример: arn:aws:iam::171455704129:instance-profile/Sample-IamProfile | ||
| id строка | успех | идентификатор профиля экземпляра Пример: AIPAD5WIZGNR9TH6LBFE4 | ||
| interfaces сложный | успех | список ENI, связанных с экземпляром | ||
| id строка | успех | идентификатор ENI Пример: eni-cf96b081 | ||
| mac_address строка | успех | MAC-адрес ENI Пример: 06:c4:fd:90:dc:61 | ||
| kernel строка | успех | идентификатор ядра Пример: null | ||
| key_name строка | успех | имя пары ключей, используемой при запуске экземпляра Пример: MyKey | ||
| launch_time" строка | успех | время запуска экземпляра Пример: 2017-06-16T15:44:54.000Z | ||
| monitoring_state строка | успех | указывает, включён ли подробный мониторинг Пример: disabled | ||
| private_dns_name строка | успех | частное имя DNS IPv4 экземпляра Пример: ip-10-21-39-23.ag-net.com | ||
| private_ip_address строка | успех | частный IPv4-адрес экземпляра Пример: 10.216.139.23 | ||
| public_dns_name строка | успех | общественное имя DNS экземпляра Пример: ec2-54-194-252-215.eu-west-1.compute.amazonaws.com | ||
| public_ip_address string | success | публичный IPv4-адрес экземпляра Пример: 54.194.252.215 | ||
| ramdisk string | success | идентификатор RAM-диска Пример: null | ||
| region string | success | AWS-регион, в котором запущен экземпляр Пример: eu-west-1 | ||
| requester_id string | success | идентификатор сущности, которая запустила экземпляр от вашего имени Пример: null | ||
| root_device_type string | success | тип корневого устройства, используемого экземпляром Пример: ebs | ||
| source_destination_check boolean | success | указывает, выполняет ли экземпляр проверку источника/назначения Пример: true | ||
| spot_instance_request_id string | success | идентификатор запроса на экземпляр Spot Пример: null | ||
| state string | success | сообщение, описывающее изменение состояния Пример: running | ||
| tags complex | success | словарь пар ключ/значение, назначенных ресурсу | ||
| key string | success | ключ тега, назначенного ресурсу Пример: Environment | ||
| virtualization_type string | success | тип виртуализации экземпляра Пример: hvm | ||
| vpc_id string | success | идентификатор VPC, в котором запущен экземпляр Пример: vpc-12c9ae4f | ||
Статус
- Этот модуль будет удален в версии 2.8. [устаревший]
- Дополнительную информацию см. в разделе УСТАРЕВШЕЕ.
Авторы
- Michael Schuett (@michaeljs1990)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_remote_facts_module.html