ec2_vpc_subnet_facts – Сбор фактов о подсетях ec2 VPC в AWS
Новая версия 2.1.
Описание
- Сбор фактов о подсетях ec2 VPC в AWS
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 | |
| ec2_url - | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию используются конечные точки EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть. | |
| filters - | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.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 | |
| subnet_ids - добавлен в 2.5 | Список идентификаторов подсетей для сбора фактов. Псевдонимы: subnet_id | |
| 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 VPC subnets
- ec2_vpc_subnet_facts:
# Gather facts about a particular VPC subnet using ID
- ec2_vpc_subnet_facts:
subnet_ids: subnet-00112233
# Gather facts about any VPC subnet with a tag key Name and value Example
- ec2_vpc_subnet_facts:
filters:
"tag:Name": Example
# Gather facts about any VPC subnet within VPC with ID vpc-abcdef00
- ec2_vpc_subnet_facts:
filters:
vpc-id: vpc-abcdef00
# Gather facts 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_facts:
filters:
vpc-id: vpc-abcdef00
"tag:Name": "{{ item }}"
with_items:
- publicA
- publicB
- publicC
register: subnet_facts
- set_fact:
subnet_ids: "{{ subnet_facts.subnets|map(attribute='id')|list }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание | |||
|---|---|---|---|---|---|
| subnets сложный | успех | Возвращает массив сложных объектов, как описано ниже. | |||
| assign_ipv6_address_on_creation boolean | всегда | True/False в зависимости от настроек атрибута для назначения адресов IPv6. | |||
| availability_zone строка | всегда | Зона доступности, в которой существует подсеть. | |||
| available_ip_address_count строка | всегда | Количество доступных IP-адресов в подсети. | |||
| cidr_block строка | всегда | Блок IPv4 CIDR, назначенный подсети. | |||
| default_for_az boolean | всегда | 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 boolean | всегда | True/False в зависимости от настроек атрибута для сопоставления публичного IP-адреса. | |||
| state строка | всегда | Состояние подсети. | |||
| subnet_id строка | всегда | Идентификатор подсети. | |||
| tags словарь | всегда | Словарь тегов, связанных с подсетью. | |||
| vpc_id строка | всегда | Идентификатор VPC. | |||
Статус
- Этот модуль гарантированно не будет иметь изменений интерфейса, несовместимых с предыдущими версиями. [stableinterface]
- Этот модуль поддерживается основной командой Ansible. [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.7/modules/ec2_vpc_subnet_facts_module.html