ec2_vpc_subnet_info – Сбор информации о подсетях VPC ec2 в AWS
Описание
- Сбор информации о подсетях VPC ec2 в AWS
- Этот модуль назывался
ec2_vpc_subnet_factsдо Ansible 2.9. Использование не изменилось.
Псевдонимы: ec2_vpc_subnet_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- 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 | |
| debug_botocore_endpoint_logs логический тип добавлено в 2.8 |
| Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action» во время выполнения задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения плейбука. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL, если она существует. | |
| filters - | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html для возможных фильтров. | |
| profile строка | Использует профиль 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 строка | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| subnet_ids - добавлено в 2.5 | Список идентификаторов подсетей для сбора информации. Псевдонимы: subnet_id | |
| validate_certs логический тип |
| Если установлено значение "нет", сертификаты 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 information about all VPC subnets
- ec2_vpc_subnet_info:
# Gather information about a particular VPC subnet using ID
- ec2_vpc_subnet_info:
subnet_ids: subnet-00112233
# Gather information about any VPC subnet with a tag key Name and value Example
- ec2_vpc_subnet_info:
filters:
"tag:Name": Example
# Gather information about any VPC subnet within VPC with ID vpc-abcdef00
- ec2_vpc_subnet_info:
filters:
vpc-id: vpc-abcdef00
# Gather information about a set of VPC subnets, publicA, publicB and publicC within a
# VPC with ID vpc-abcdef00 and then use the jinja map function to return the
# subnet_ids as a list.
- ec2_vpc_subnet_info:
filters:
vpc-id: vpc-abcdef00
"tag:Name": "{{ item }}"
loop:
- publicA
- publicB
- publicC
register: subnet_info
- set_fact:
subnet_ids: "{{ subnet_info.subnets|map(attribute='id')|list }}"
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое | Описание | |||
|---|---|---|---|---|---|
| subnets сложный | успех | Возвращает массив сложных объектов, как описано ниже. | |||
| assign_ipv6_address_on_creation логический тип | всегда | True/False в зависимости от настройки атрибута для назначения адресов IPv6. | |||
| availability_zone строка | всегда | Зона доступности, в которой существует подсеть. | |||
| available_ip_address_count строка | всегда | Количество доступных IP-адресов в подсети. | |||
| cidr_block строка | всегда | Блок IPv4 CIDR, назначенный подсети. | |||
| default_for_az логический тип | всегда | True, если это основная подсеть для зоны доступности. | |||
| id строка | всегда | Идентификатор подсети (для обратной совместимости). | |||
| ipv6_cidr_block_association_set сложный | всегда | Массив данных о наборе ассоциации блоков IPv6 CIDR. | |||
| association_id строка | всегда | Идентификатор ассоциации | |||
| ipv6_cidr_block строка | всегда | Блок IPv6 CIDR, связанный с подсетью. | |||
| ipv6_cidr_block_state словарь | всегда | Хэш/словарь, содержащий один элемент. Состояние ассоциации блока CIDR. | |||
| state строка | всегда | Состояние ассоциации блока CIDR. | |||
| map_public_ip_on_launch логический тип | всегда | True/False в зависимости от настройки атрибута для отображения публичного IP. | |||
| state строка | всегда | Состояние подсети. | |||
| subnet_id строка | всегда | Идентификатор подсети. | |||
| tags словарь | всегда | Словарь тегов, связанных с подсетью. | |||
| vpc_id строка | всегда | Идентификатор VPC. | |||
Статус
- Этот модуль гарантированно будет иметь обратную совместимость при будущих изменениях интерфейса. [stableinterface]
- Этот модуль поддерживается командой Ansible Core. [core]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- 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.9/modules/ec2_vpc_subnet_info_module.html