Spec-Zone.ru › Ansible

Модуль amazon.aws.ec2_transit_gateway — создание и удаление транзитных шлюзов AWS

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.ec2_transit_gateway.

Добавлено в community.aws 1.0.0

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

Обзор

  • Создает транзитные шлюзы AWS.
  • Удаляет транзитные шлюзы AWS.
  • Обновляет теги существующих транзитных шлюзов.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key

строка

Идентификатор ключа доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные окружения AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

asn

целое число

Частный номер автономной системы (ASN) для стороны Amazon в сеансе BGP.

Диапазон составляет от 64512 до 65534 для 16-разрядных ASN и от 4200000000 до 4294967294 для 32-разрядных ASN.

auto_associate

логический

Включить или отключить автоматическую привязку к таблице маршрутизации ассоциаций по умолчанию.

Варианты:

  • false
  • true ← (по умолчанию)

auto_attach

логический

Включить или отключить автоматическое принятие запросов на подключение.

Варианты:

  • false ← (по умолчанию)
  • true

auto_propagate

логический

Включить или отключить автоматическое распространение маршрутов в таблицу маршрутизации распространения по умолчанию.

Варианты:

  • false
  • true ← (по умолчанию)

aws_ca_bundle

путь

Расположение пакета центров сертификации, используемого для проверки SSL-сертификатов.

Также можно использовать переменную окружения AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Список параметров доступен в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

логический

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных в рамках плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

description

строка

Описание транзитного шлюза.

dns_support

логический

Включить ли поддержку DNS AWS.

Варианты:

  • false
  • true ← (по умолчанию)

endpoint_url

псевдонимы: aws_endpoint_url

строка

URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

multicast_support

логический

добавлено в amazon.aws 8.1.0

Включить ли поддержку многоадресной рассылки AWS. Допустимо только при создании транзитного шлюза.

Варианты:

  • false
  • true

profile

псевдонимы: aws_profile

строка

Именованный профиль AWS для аутентификации.

Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную окружения AWS_PROFILE.

Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и session_token.

purge_tags

логический

Если установлено значение purge_tags=true и задан параметр tags, существующие теги ресурса будут удалены, чтобы набор тегов точно соответствовал значению параметра tags.

Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому они не учитываются при обработке параметра purge_tags. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

  • false
  • true ← (по умолчанию)

region

псевдонимы: aws_region

строка

Регион AWS.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

строка

Секретный ключ доступа AWS.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные окружения AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

session_token

псевдонимы: aws_session_token

строка

Токен сеанса AWS STS для временных учетных данных.

Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную окружения AWS_SESSION_TOKEN.

Параметры session_token и profile являются взаимоисключающими.

state

строка

present — обеспечить создание ресурса.

absent — удалить ресурс.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

псевдонимы: resource_tags

словарь

Словарь тегов, которые нужно применить к ресурсу.

Если параметр tags не задан, теги не будут изменены.

transit_gateway_id

строка

Идентификатор транзитного шлюза.

validate_certs

логический

Если установлено значение false, SSL-сертификаты при обмене данными с API AWS проверяться не будут.

Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность задания aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

vpn_ecmp_support

логический

Включить или отключить поддержку протокола многопутевой передачи с равной стоимостью (ECMP).

Варианты:

  • false
  • true ← (по умолчанию)

wait

логический

Ожидать ли изменения состояния.

Варианты:

  • false
  • true ← (по умолчанию)

wait_timeout

целое число

Количество секунд ожидания изменения состояния.

По умолчанию: 300

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и файлы конфигурации считываются в контексте «узла» Ansible, а не «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключений переменные окружения и файлы конфигурации считываются в контексте «контроллера» Ansible, а не «узла».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать учетные данные по умолчанию и другие настройки, например регион, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. по адресу https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

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

- name: Create a new transit gateway with options
  amazon.aws.ec2_transit_gateway:
    asn: 64514
    auto_associate: false
    auto_propagate: false
    multicast_support: true
    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
  amazon.aws.ec2_transit_gateway:
    state: absent
    region: us-east-1
    description: personal-testing

- name: Remove a transit gateway by id
  amazon.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"

multicast_support

строка

добавлено в amazon.aws 7.3.0

Указывает, включена ли поддержка многоадресной рассылки.

Возвращается: всегда

Пример: "enable"

propagation_default_route_table_id

строка

Идентификатор таблицы маршрутизации распространения по умолчанию.

Возвращается: если существует

Пример: "tgw-rtb-def456777"

vpn_ecmp_support

строка

Указывает, включена ли поддержка протокола многопутевой маршрутизации с равной стоимостью (ECMP).

Возвращается: всегда

Пример: "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"

Авторы

  • Bob Boldin (@BobBoldin)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API