amazon.aws.ec2_eni_info – Сбор информации о интерфейсах ec2 ENI в AWS
Примечание
Этот плагин входит в коллекцию amazon.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install amazon.aws.
Для использования в плейбуке укажите: amazon.aws.ec2_eni_info.
Новый в версии 1.0.0: из amazon.aws
Обзор
- Сбор информации об интерфейсах ec2 ENI в AWS.
- Этот модуль назывался
ec2_eni_factsдо Ansible 2.9. Использование не изменилось.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и будет сделано взаимоисключающим после 2022-06-01. алиасы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла с сертификатом CA, используемого при проверке SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл с сертификатом CA считывается со стороны 'модуля' и может потребоваться его явное копирование с контроллера, если модуль не выполняется локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Подробнее о конфигурации boto см. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и будет сделано взаимоисключающим после 2022-06-01. алиасы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический тип |
| Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, сделанного во время плейбука. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | Адрес для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. алиасы: aws_endpoint_url, endpoint_url | |
| eni_id строка добавлен в 1.3.0 amazon.aws | Идентификатор ENI. Этот параметр взаимоисключает параметр filters. | |
| filters словарь | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkInterfaces.html для возможных фильтров. Этот параметр взаимоисключает параметр eni_id. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token. Поддержка одновременного использования с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. алиасы: aws_profile | |
| region строка | Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
алиасы: aws_region, ec2_region | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающим после 2022-06-01. алиасы: aws_security_token, access_token | |
| validate_certs логический тип |
| При значении "нет", SSL-сертификаты не будут проверяться для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,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,AWS_CA_BUNDLE - 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 information about all ENIs
- amazon.aws.ec2_eni_info:
# Gather information about a particular ENI
- amazon.aws.ec2_eni_info:
filters:
network-interface-id: eni-xxxxxxx
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| network_interfaces complex | всегда | Список сопоставленных эластичных сетевых интерфейсов | |
| association словарь | При ассоциации ENI с EIP | Информация об ассоциированном эластичном IP-адресе (EIP) Пример: {'allocation_id': 'eipalloc-5sdf123', 'association_id': 'eipassoc-8sdf123', 'ip_owner_id': '4415120123456', 'public_dns_name': 'ec2-52-1-0-63.compute-1.amazonaws.com', 'public_ip': '52.1.0.63'} | |
| attachment словарь | При подключении ENI к экземпляру ec2 | Информация о подключенном экземпляре ec2 Пример: {'attach_time': '2017-08-05T15:25:47+00:00', 'attachment_id': 'eni-attach-149d21234', 'delete_on_termination': False, 'device_index': 1, 'instance_id': 'i-15b8d3cadbafa1234', 'instance_owner_id': '4415120123456', 'status': 'attached'} | |
| availability_zone строка | всегда | Доступная зона ENI Пример: us-east-1b | |
| description строка | всегда | Текстовое описание ENI Пример: Мой любимый сетевой интерфейс | |
| groups список / элементы=строка | всегда | Список прикрепленных групп безопасности Пример: [{'group_id': 'sg-26d0f1234', 'group_name': 'my_ec2_security_group'}] | |
| id строка | всегда | Идентификатор ENI (псевдоним для network_interface_id) Пример: eni-392fsdf | |
| interface_type строка | всегда | Тип сетевого интерфейса Пример: интерфейс | |
| ipv6_addresses список / элементы=строка | всегда | Список IPv6-адресов для данного интерфейса | |
| mac_address строка | всегда | MAC-адрес сетевого интерфейса Пример: 0a:f8:10:2f:ab:a1 | |
| name строка Добавлен в 1.3.0 amazon.aws | При установленном теге Name | Тег Name ENI, часто отображается в AWS UIs как Name | |
| network_interface_id строка | всегда | Идентификатор ENI Пример: eni-392fsdf | |
| owner_id строка | всегда | AWS-ID владельца ENI Пример: 4415120123456 | |
| private_dns_name строка | всегда | Приватное имя DNS для ENI Пример: ip-172-16-1-180.ec2.internal | |
| private_ip_address строка | всегда | Приватный IP-адрес для ENI Пример: 172.16.1.180 | |
| private_ip_addresses список / элементы=строка | всегда | Список приватных IP-адресов, прикрепленных к ENI | |
| requester_id строка | всегда | Идентификатор сущности, запустившей ENI Пример: AIDAIONYVJQNIAZFT3ABC | |
| requester_managed логическое значение | всегда | Указывает, управляется ли сетевой интерфейс AWS-сервисом. | |
| source_dest_check логическое значение | всегда | Указывает, выполняет ли сетевой интерфейс проверку источника/назначения. | |
| status строка | всегда | Указывает, подключен ли сетевой интерфейс к экземпляру или нет Пример: в использовании | |
| subnet_id строка | всегда | Идентификатор подсети, в которой находится ENI Пример: subnet-7bbf01234 | |
| tag_set словарь | всегда | Словарь тегов, добавленных к ENI | |
| tags словарь Добавлен в 1.3.0 amazon.aws | всегда | Словарь тегов, добавленных к ENI | |
| vpc_id строка | всегда | Идентификатор VPC, к которому принадлежит сетевой интерфейс Пример: vpc-b3f1f123 | |
Авторы
- Rob White (@wimnat)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/amazon/aws/ec2_eni_info_module.html