amazon.aws.ec2_vpc_subnet_info – Сбор информации о подсетях ec2 VPC в AWS

Примечание

Этот плагин является частью коллекции amazon.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install amazon.aws.

Для использования в книге задач укажите: amazon.aws.ec2_vpc_subnet_info.

Новое в версии 1.0.0: для amazon.aws

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Сбор информации о подсетях ec2 VPC в AWS
Этот модуль назывался ec2_vpc_subnet_facts до Ansible 2.9. Использование не изменилось.

Требования

Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.

boto
boto3
botocore
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 строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если она есть. алиасы: aws_endpoint_url, endpoint_url
filters словарь		Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html для возможных фильтров.
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 security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если параметр profile установлен, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела, и эти параметры будут сделаны взаимоисключающими после 2022-06-01. алиасы: aws_security_token, access_token
subnet_ids список / элементы=строка		Список идентификаторов подсетей для сбора информации. алиасы: subnet_id
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 VPC subnets
- amazon.aws.ec2_vpc_subnet_info:

# Gather information about a particular VPC subnet using ID
- amazon.aws.ec2_vpc_subnet_info:
    subnet_ids: subnet-00112233

# Gather information about any VPC subnet with a tag key Name and value Example
- amazon.aws.ec2_vpc_subnet_info:
    filters:
      "tag:Name": Example

# Gather information about any VPC subnet within VPC with ID vpc-abcdef00
- amazon.aws.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.

- amazon.aws.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 булево			всегда	Истина/Ложь в зависимости от настройки атрибута для назначения адреса IPv6.
	availability_zone строка			всегда	Зона доступности, в которой существует подсеть.
	available_ip_address_count строка			всегда	Количество доступных IP-адресов в подсети.
	cidr_block строка			всегда	Блок CIDR IPv4, назначенный подсети.
	default_for_az булево			всегда	Истина, если это основная подсеть для зоны доступности.
	id строка			всегда	Идентификатор подсети (для обратной совместимости).
	ipv6_cidr_block_association_set сложный			всегда	Массив данных о наборе ассоциаций блока IPv6.
		association_id строка		всегда	Идентификатор ассоциации
		ipv6_cidr_block строка		всегда	Блок CIDR IPv6, связанный с подсетью.
		ipv6_cidr_block_state словарь		всегда	Хэш/словарь, содержащий один элемент. Состояние ассоциации блока cidr.
			state строка	всегда	Состояние ассоциации блока CIDR.
	map_public_ip_on_launch булево			всегда	Истина/Ложь в зависимости от настройки атрибута для отображения общедоступного IP-адреса.
	state строка			всегда	Состояние подсети.
	subnet_id строка			всегда	Идентификатор подсети.
	tags словарь			всегда	Словарь тегов, связанных с подсетью.
	vpc_id строка			всегда	Идентификатор VPC.

Авторы

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_vpc_subnet_info_module.html