ec2_vpc_subnet_facts - Сбор фактов о подсетях VPC ec2 в AWS
Новое в версии 2.1.
Обзор
- Сбор фактов о подсетях VPC ec2 в AWS
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Значение по умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. |
| filters | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html для возможных фильтров. | |
| profile (добавлено в 1.6) | Значение по умолчанию: None | Использует профиль 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) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token |
| subnet_ids (добавлено в 2.5) | Список идентификаторов подсетей для сбора фактов. псевдонимы: subnet_id | |
| validate_certs (добавлено в 1.5) |
| Если установлено «no», сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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 сложный | успешно | Возвращает массив сложных объектов, как описано ниже. | |||
| tags словарь | всегда | Словарь тегов, связанных с подсетью. | |||
| subnet_id строка | всегда | Идентификатор подсети. | |||
| assign_ipv6_address_on_creation булево | всегда | True/False в зависимости от настроек атрибута для назначения адреса IPv6. | |||
| default_for_az булево | всегда | True, если это основная подсеть для зоны доступности. | |||
| state строка | всегда | Состояние подсети. | |||
| ipv6_cidr_block_association_set сложный | всегда | Массив информации о наборе ассоциаций блоков IPv6 CIDR. | |||
| association_id строка | всегда | Идентификатор ассоциации. | |||
| ipv6_cidr_block строка | всегда | Блок IPv6 CIDR, связанный с подсетью. | |||
| ipv6_cidr_block_state словарь | всегда | Хэш/словарь, содержащий один элемент. Состояние ассоциации блока CIDR. | |||
| state строка | всегда | Состояние ассоциации блока CIDR. | |||
| availability_zone строка | всегда | Зона доступности, где существует подсеть. | |||
| vpc_id строка | всегда | Идентификатор VPC. | |||
| cidr_block строка | всегда | Блок IPv4 CIDR, назначенный подсети. | |||
| available_ip_address_count строка | всегда | Количество доступных IP-адресов в подсети. | |||
| id строка | всегда | Идентификатор подсети (для обратной совместимости). | |||
| map_public_ip_on_launch булево | всегда | True/False в зависимости от настроек атрибута для сопоставления публичного IP-адреса. | |||
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики данного модуля гарантируют отсутствие несовместимых с предыдущими версиями изменений интерфейса.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/ec2_vpc_subnet_facts_module.html