amazon.aws.ec2_vpc_subnet – Управление подсетями в виртуальных частных облаках AWS

Примечание

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

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

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

Введено в версии 1.0.0: из amazon.aws

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

Описание

Управление подсетями в виртуальных частных облаках AWS.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
assign_instances_ipv6 boolean	Варианты: нет ← да	Укажите `yes`, чтобы указать, что экземплярам, запущенным в подсети, автоматически будет назначен IPv6-адрес.
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 Bundle для проверки сертификатов SSL. Используется только для модулей, основанных на boto3. Примечание: CA Bundle считывается со стороны 'модуля' и, возможно, потребует явного копирования с контроллера, если не выполняется локально.
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
az строка		Зона доступности для подсети.
cidr строка / обязательно		Блок CIDR для подсети. Например, 192.0.2.0/24.
debug_botocore_endpoint_logs boolean	Варианты: нет ← да	Использование регистратора botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action" во время задачи, выводящего набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая имеется. псевдонимы: aws_endpoint_url, endpoint_url
ipv6_cidr строка		Блок IPv6 CIDR для подсети. VPC должен иметь назначенный блок /56, и это значение должно быть допустимым IPv6 /64, который попадает в диапазон VPC. Требуется, если assign_instances_ipv6=true
map_public boolean	Варианты: нет ← да	Укажите `yes`, чтобы указать, что экземплярам, запущенным в подсети, по умолчанию должен быть назначен общедоступный IP-адрес.
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
purge_tags boolean	Варианты: нет да ←	Удалить теги, отсутствующие в списке tags.
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. Если установлен параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка	Варианты: present ← absent	Создать или удалить подсеть.
tags словарь		Словарь тегов для применения к подсети. Любые теги, текущие примененные к подсети и отсутствующие здесь, будут удалены. псевдонимы: resource_tags
validate_certs boolean	Варианты: нет да ←	При установке в "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
vpc_id строка / обязательно		ID VPC, в котором нужно создать или удалить подсеть.
wait boolean	Варианты: нет да ←	При wait=true и state=present, модуль подождет, пока подсеть не перейдет в состояние доступности, прежде чем продолжить.
wait_timeout целое число	По умолчанию: 300	Количество секунд ожидания, пока подсеть станет доступной при wait=True.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета 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.

- name: Create subnet for database servers
  amazon.aws.ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28
    tags:
      Name: Database Subnet
  register: database_subnet

- name: Remove subnet for database servers
  amazon.aws.ec2_vpc_subnet:
    state: absent
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28

- name: Create subnet with IPv6 block assigned
  amazon.aws.ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.1.100.0/24
    ipv6_cidr: 2001:db8:0:102::/64

- name: Remove IPv6 block assigned to subnet
  amazon.aws.ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.1.100.0/24
    ipv6_cidr: ''

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ				Возвращённое значение	Описание
subnet сложный				state=present	Словарь значений подсети
	assign_ipv6_address_on_creation булево			state=present	присваивается ли IPv6-адрес новым экземплярам автоматически
	availability_zone строка			state=present	Доступная зона подсети Пример: us-east-1a
	available_ip_address_count строка			state=present	количество доступных IPv4-адресов Пример: 251
	cidr_block строка			state=present	IPv4 CIDR подсети Пример: 10.0.0.0/16
	default_for_az булево			state=present	указывает, является ли эта подсеть стандартной для данной зоны доступности
	id строка			state=present	Идентификатор ресурса подсети Пример: subnet-b883b2c4
	ipv6_association_id строка			state=present	Идентификатор ассоциации IPv6 для текущего связанного CIDR Пример: subnet-cidr-assoc-b85c74d2
	ipv6_cidr_block строка			state=present	Активно связанный IPv6-блок CIDR с подсетью Пример: 2001:db8:0:102::/64
	ipv6_cidr_block_association_set сложный			state=present	Массив сведений о наборе ассоциаций IPv6-блоков CIDR.
		association_id строка		всегда	Идентификатор ассоциации
		ipv6_cidr_block строка		всегда	Блок IPv6 CIDR, связанный с подсетью.
		ipv6_cidr_block_state словарь		всегда	Хеш-таблица/словарь, содержащий один элемент. Состояние ассоциации блока CIDR.
			state строка	всегда	Состояние ассоциации блока CIDR.
	map_public_ip_on_launch булево			state=present	присваивается ли общедоступный IP-адрес новым экземплярам автоматически
	state строка			state=present	состояние подсети Пример: доступно
	tags словарь			state=present	метки, прикреплённые к подсети, включая имя Пример: {'Name': 'Моя подсеть', 'env': 'этап тестирования'}
	vpc_id строка			state=present	идентификатор VPC, в котором существует эта подсеть Пример: vpc-67236184

Авторы

Robert Estelle (@erydo)
Brad Davidson (@brandond)

© 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_module.html