Spec-Zone.ru › Ansible 2.9

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

Новая версия с 2.8.

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

Обзор

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

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
asn
-
Частный номер автономной системы (ASN) для стороны Amazon сессии BGP. Диапазон составляет от 64512 до 65534 для 16-битных ASN и от 4200000000 до 4294967294 для 32-битных ASN.
auto_associate
boolean
    Варианты:
  • нет
  • да ←
Включить или выключить автоматическое подключение к таблице маршрутизации по умолчанию.
auto_attach
boolean
    Варианты:
  • нет ←
  • да
Включить или выключить автоматическое принятие запросов на подключение.
auto_propagate
boolean
    Варианты:
  • нет
  • да ←
Включить или выключить автоматическую передачу маршрутов в таблицу маршрутизации по умолчанию.
aws_access_key
string
Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

псевдонимы: ec2_access_key, access_key
aws_secret_key
string
Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
добавлено в 2.8
    Варианты:
  • нет ←
  • да
Использовать журналирование botocore.endpoint для анализа уникальных (а не суммарных) API-вызовов «resource:action» во время задачи, выводит множество в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы вывести полный список, созданный во время выполнения пьесы. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
description
string
Описание шлюза транзита.
dns_support
boolean
    Варианты:
  • нет
  • да ←
Включить или выключить поддержку DNS AWS.
ec2_url
string
URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковое имеется.
profile
string
Использует профиль boto. Работает только с boto >= 2.24.0.
purge_tags
boolean
    Варианты:
  • нет
  • да ←
Удалить существующие метки, не включенные в аргумент tags.
region
string
Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковое имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
security_token
string
Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

псевдонимы: access_token
state
-
    Варианты:
  • present ←
  • absent
present для обеспечения создания ресурса.
absent для удаления ресурса.
tags
-
Словарь меток ресурса.
transit_gateway_id
string
Идентификатор шлюза транзита.
validate_certs
boolean
    Варианты:
  • нет
  • да ←
Если установлено значение "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
vpn_ecmp_support
boolean
    Варианты:
  • нет
  • да ←
Включить или выключить поддержку Equal Cost Multipath Protocol.
wait
-
По умолчанию:
"да"
Ожидать статуса
wait_timeout
-
По умолчанию:
300
количество секунд ожидания статуса

Примечания

Примечание

  • Если параметры не установлены в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, 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
  • 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
  ec2_transit_gateway:
    state: present
    region: us-east-1
    description: personal-testing
  register: created_tgw

- name: Create a new transit gateway with options
  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
  ec2_transit_gateway:
    state: absent
    region: us-east-1
    description: personal-testing

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

Возвращаемые значения

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

Ключ Возвращённое Описание
transit_gateway
complex
state=present
Атрибуты шлюза транзита.
creation_time
string
всегда
Время создания шлюза транзита.

Пример:
2019-03-06T17:13:51+00:00
description
string
всегда
Описание шлюза транзита.

Пример:
my test tgw
options
complex
всегда
Атрибуты параметров шлюза транзита
amazon_side_asn
string
всегда
Приватный номер автономной системы (ASN) для стороны Amazon в сессии BGP. Диапазон от 64512 до 65534 для 16-битных ASN и от 4200000000 до 4294967294 для 32-битных ASN.

Пример:
64512
association_default_route_table_id
string
при наличии
Идентификатор таблицы маршрутизации по умолчанию.

Пример:
tgw-rtb-abc123444
auto_accept_shared_attachements
string
всегда
Указывает, принимаются ли запросы на подключение автоматически.

Пример:
disable
default_route_table_association
string
всегда
Указывает, подключаются ли ресурсы автоматически к таблице маршрутизации по умолчанию.

Пример:
enable
default_route_table_propagation
string
всегда
Указывает, распространяются ли маршруты ресурсов автоматически в таблицу маршрутизации по умолчанию.

Пример:
disable
dns_support
string
всегда
Указывает, включена ли поддержка DNS.

Пример:
enable
propagation_default_route_table_id
string
при наличии
Идентификатор таблицы маршрутизации по умолчанию.

Пример:
tgw-rtb-def456777
vpn_ecmp_support
string
всегда
Указывает, включена ли поддержка Equal Cost Multipath Protocol.

Пример:
enable
owner_id
string
всегда
Аккаунт, владеющий шлюзом транзита.

Пример:
123456789012
state
string
всегда
Состояние шлюза транзита.

Пример:
pending
tags
dictionary
всегда
Словарь тегов ресурсов

Пример:
{'tags': {'Name': 'nonprod_tgw'}}
transit_gateway_arn
string
всегда
Идентификатор transit_gateway.

Пример:
tgw-3a9aa123
transit_gateway_id
string
всегда
Идентификатор transit_gateway.

Пример:
tgw-3a9aa123


Статус

  • Данный модуль не гарантирует обратной совместимости интерфейса. [preview]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Bob Boldin (@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.9/modules/ec2_transit_gateway_module.html

Spec-Zone.ru

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