Spec-Zone.ru › Ansible 2.10

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
логическое значение
    Варианты:
  • no
  • да ←
Включить или отключить автоматическую распространение маршрутов в таблицу маршрутизации по умолчанию.
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'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации 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.
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 security token. Если не задан, то используется значение переменной окружения 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.

Пример:
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/ec2_transit_gateway_module.html

Spec-Zone.ru

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