ec2_vpc_subnet_facts - Сбор фактов о подсетях VPC ec2 в AWS
Новая версия с 2.1.
Обзор
- Сбор фактов о подсетях VPC ec2 в 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 bool (добавлено в 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), если данные учетных данных не предоставлены. См. 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 сложное | успех | Возвращает массив сложных объектов, как описано ниже. | |||
| subnet_id строка | всегда | Идентификатор подсети. | |||
| id строка | всегда | Идентификатор подсети (для обратной совместимости). | |||
| vpc_id строка | всегда | Идентификатор VPC. | |||
| state строка | всегда | Состояние подсети. | |||
| tags словарь | всегда | Словарь тегов, связанных с подсетью. | |||
| map_public_ip_on_launch булево | всегда | True/False в зависимости от настроек атрибута для присвоения общедоступного IP. | |||
| default_for_az булево | всегда | True, если это основная подсеть для AZ. | |||
| cidr_block строка | всегда | Блок CIDR IPv4, назначенный подсети. | |||
| available_ip_address_count строка | всегда | Количество доступных IP-адресов в подсети. | |||
| availability_zone строка | всегда | Зона доступности, в которой расположена подсеть. | |||
| assign_ipv6_address_on_creation булево | всегда | True/False в зависимости от настроек атрибута для присвоения адресов IPv6. | |||
| ipv6_cidr_block_association_set сложное | всегда | Массив данных об ассоциации блоков CIDR IPv6. | |||
| association_id строка | всегда | Идентификатор ассоциации | |||
| ipv6_cidr_block строка | всегда | Блок CIDR IPv6, связанный с подсетью. | |||
| ipv6_cidr_block_state словарь | всегда | Словарь/хеш с одним элементом. Состояние ассоциации блоков CIDR. | |||
| state строка | всегда | Состояние ассоциации блоков CIDR. | |||
Статус
Этот модуль помечен как stableinterface, что означает, что поддерживающие его разработчики гарантируют отсутствие изменений интерфейса, несовместимых с предыдущими версиями.
Техническое обслуживание
Этот модуль помечен как core, что означает, что он поддерживается Командой Ansible Core. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются Командой Ansible Core, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.6/modules/ec2_vpc_subnet_facts_module.html