Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Сбор сведений о транзитных шлюзах EC2 в 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 для единообразия с SDK AWS botocore.

aws_ca_bundle

путь

Путь к пакету сертификатов CA, используемому для проверки 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 результатов задачи. Используйте обработчик aws_resource_action, чтобы вывести общий список вызовов, выполненных в рамках плейбука.

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

Варианты:

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

endpoint_url

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

строка

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

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

filters

словарь

Словарь фильтров, применяемых к запросу. Каждая пара «ключ — значение» задаёт ключ фильтра и соответствующее ему значение.

Полный список доступных фильтров см. в документации AWS: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html.

По умолчанию: {}

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.

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 для единообразия с SDK AWS 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 являются взаимоисключающими.

transit_gateway_ids

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

список / элементы=строка

Список идентификаторов транзитных шлюзов, сведения о которых необходимо собрать.

По умолчанию: []

validate_certs

логическое значение

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

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

Варианты:

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

Примечания

Примечание

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

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Gather info about all transit gateways
  amazon.aws.ec2_transit_gateway_info:

- name: Gather info about a particular transit gateway using filter transit gateway ID
  amazon.aws.ec2_transit_gateway_info:
    filters:
      transit-gateway-id: tgw-02c42332e6b7da829

- name: Gather info about a particular transit gateway using multiple option filters
  amazon.aws.ec2_transit_gateway_info:
    filters:
      options.dns-support: enable
      options.vpn-ecmp-support: enable

- name: Gather info about multiple transit gateways using module param
  amazon.aws.ec2_transit_gateway_info:
    transit_gateway_ids:
      - tgw-02c42332e6b7da829
      - tgw-03c53443d5a8cb716

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

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

Ключ

Описание

transit_gateways

список / элементы=словарь

Транзитные шлюзы, соответствующие заданным фильтрам.

Каждый элемент представляет собой словарь со всеми сведениями о соответствующем транзитном шлюзе.

Возвращается: при успешном выполнении

creation_time

строка

Время создания.

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

Пример: "2019-02-05T16:19:58+00:00"

description

строка

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

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

Пример: "A transit gateway"

options

словарь

Словарь параметров транзитного шлюза.

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

amazon_side_asn

целое число

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

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

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

Пример: 64512

association_default_route_table_id

строка

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

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

Пример: "tgw-rtb-0fd332c911223344"

auto_accept_shared_attachments

строка

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

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

Пример: "enable"

default_route_table_association

строка

Указывает, связываются ли подключения ресурсов автоматически с таблицей маршрутизации ассоциаций по умолчанию.

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

Пример: "disable"

default_route_table_propagation

строка

Указывает, автоматически ли распространяются маршруты подключений ресурсов в таблицу маршрутизации распространения по умолчанию.

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

Пример: "disable"

dns_support

строка

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

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

Пример: "enable"

multicast_support

строка

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

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

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

Пример: "enable"

propagation_default_route_table_id

строка

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

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

Пример: "rtb-11223344"

vpn_ecmp_support

строка

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

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

Пример: "enable"

owner_id

строка

Идентификатор номера учётной записи AWS, которой принадлежит транзитный шлюз.

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

Пример: "123456789012"

state

строка

Состояние транзитного шлюза.

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

Пример: "available"

tags

словарь

Словарь тегов, связанных с транзитным шлюзом.

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

Пример: {"Env": "Dev", "Name": "A sample TGW"}

transit_gateway_arn

строка

Имя ресурса Amazon (ARN) транзитного шлюза.

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

Пример: "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-02c42332e6b7da829"

transit_gateway_id

строка

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

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

Пример: "tgw-02c42332e6b7da829"

Авторы

  • 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_info_module.html

Spec-Zone.ru

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