community.aws.ec2_transit_gateway – Создание и удаление шлюзов AWS Transit Gateway

Примечание

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

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

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

Новое в версии 1.0.0: из community.aws

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

Обзор

Создаёт шлюзы AWS Transit Gateway.
Удаляет шлюзы AWS Transit Gateway.
Обновляет метки существующих шлюзов transit gateway.

Требования

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

boto
boto3
botocore
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
asn целое число		Приватный номер автономной системы (ASN) для стороны Amazon в сессии BGP. Диапазон значений: от 64512 до 65534 для 16-битных ASN и от 4200000000 до 4294967294 для 32-битных ASN.
auto_associate логическое значение	Варианты: no да ←	Включение или отключение автоматической ассоциации со стандартной таблицей маршрутизации.
auto_attach логическое значение	Варианты: нет ← да	Включение или отключение автоматического принятия запросов на подключение.
auto_propagate логическое значение	Варианты: нет да ←	Включение или отключение автоматической распространения маршрутов в стандартную таблицу распространения.
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:action» во время задачи, выводя их в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время выполнения книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.
description строка		Описание шлюза transit gateway.
dns_support логическое значение	Варианты: нет да ←	Включить или отключить поддержку AWS DNS.
ec2_url строка		URL-адрес для подключения к EC2 или вашей облачной системе Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url
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 логическое значение	Варианты: нет да ←	Удалить существующие метки, не включенные в аргумент 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	`present` для обеспечения создания ресурса. `absent` для удаления ресурса.
tags словарь		Словарь меток ресурса
transit_gateway_id строка		Идентификатор шлюза transit gateway.
validate_certs логическое значение	Варианты: нет да ←	Если установлено в «нет», SSL-сертификаты не будут проверяться для boto-версий >= 2.6.0.
vpn_ecmp_support логическое значение	Варианты: нет да ←	Включить или отключить поддержку Equal Cost Multipath Protocol.
wait логическое значение	Варианты: нет да ←	Ожидать ли статус
wait_timeout целое число	По умолчанию: 300	Количество секунд ожидания статуса

Примечания

Примечание

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

Примеры

- name: Create a new transit gateway using defaults
  community.aws.ec2_transit_gateway:
    state: present
    region: us-east-1
    description: personal-testing
  register: created_tgw

- name: Create a new transit gateway with options
  community.aws.ec2_transit_gateway:
    asn: 64514
    auto_associate: no
    auto_propagate: no
    dns_support: True
    description: "nonprod transit gateway"
    purge_tags: False
    state: present
    region: us-east-1
    tags:
      Name: nonprod transit gateway
      status: testing

- name: Remove a transit gateway by description
  community.aws.ec2_transit_gateway:
    state: absent
    region: us-east-1
    description: personal-testing

- name: Remove a transit gateway by id
  community.aws.ec2_transit_gateway:
    state: absent
    region: ap-southeast-2
    transit_gateway_id: tgw-3a9aa123
  register: deleted_tgw

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

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

Ключ			Возвращаемое значение	Описание
transit_gateway сложный			state=present	Атрибуты шлюза транзита.
	creation_time строка		всегда	Время создания шлюза транзита. Пример: 2019-03-06T17:13:51+00:00
	description строка		всегда	Описание шлюза транзита. Пример: my test tgw
	options сложный		всегда	Атрибуты опций шлюза транзита
		amazon_side_asn строка	всегда	Приватный автономный номер системы (ASN) для стороны Amazon в сессии BGP. Диапазон составляет от 64512 до 65534 для 16-битных ASN и от 4200000000 до 4294967294 для 32-битных ASN. Пример: 64512
		association_default_route_table_id строка	при наличии	Идентификатор таблицы маршрутов по умолчанию. Пример: tgw-rtb-abc123444
		auto_accept_shared_attachements строка	всегда	Указывает, принимаются ли запросы на присоединение автоматически. Пример: disable
		default_route_table_association строка	всегда	Указывает, ассоциируются ли присоединения ресурсов автоматически с таблицей маршрутов по умолчанию. Пример: enable
		default_route_table_propagation строка	всегда	Указывает, распространяются ли автоматически маршруты присоединений ресурсов в таблицу маршрутов по умолчанию. Пример: disable
		dns_support строка	всегда	Указывает, включена ли поддержка DNS. Пример: enable
		propagation_default_route_table_id строка	при наличии	Идентификатор таблицы маршрутов по умолчанию для распространения. Пример: tgw-rtb-def456777
		vpn_ecmp_support строка	всегда	Указывает, включена ли поддержка Equal Cost Multipath Protocol. Пример: enable
	owner_id строка		всегда	Аккаунт, владеющий шлюзом транзита. Пример: 123456789012
	state строка		всегда	Состояние шлюза транзита. Пример: pending
	tags словарь		всегда	Словарь тегов ресурсов Пример: {'tags': {'Name': 'nonprod_tgw'}}
	transit_gateway_arn строка		всегда	Идентификатор transit_gateway. Пример: tgw-3a9aa123
	transit_gateway_id строка		всегда	Идентификатор transit_gateway. Пример: tgw-3a9aa123

Авторы

Боб Болдин (@BobBoldin)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ec2_transit_gateway_module.html