Spec-Zone.ru › Ansible 2.10

community.aws.ec2_transit_gateway_info – Сбор информации о шлюзах EC2 transit в AWS

Примечание

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

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

Для использования в плейбуке укажите: community.aws.ec2_transit_gateway_info.

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

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

Обзор

  • Сбор информации о шлюзах EC2 transit в AWS

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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.
ec2_url
строка
Адрес, используемый для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она присутствует.

алиасы: aws_endpoint_url, endpoint_url
filters
словарь
Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html для получения информации о фильтрах.
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
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
transit_gateway_ids
список / элементы=строка
Список идентификаторов шлюзов Transit Gateway для сбора информации.

алиасы: transit_gateway_id
validate_certs
логическое значение
    Варианты:
  • нет
  • да ←
При значении "нет" SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

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

Примеры

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

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

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

- name: Gather info about a particular transit gateway using multiple option filters
  community.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
  community.aws.ec2_transit_gateway_info:
    transit_gateway_ids:
      - tgw-02c42332e6b7da829
      - tgw-03c53443d5a8cb716

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

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

Ключ Возвращаемое значение Описание
transit_gateways
сложный
при успехе
Транзитные шлюзы, соответствующие заданным фильтрам. Каждый элемент состоит из словаря со всей информацией, относящейся к этому транзитному шлюзу.
creation_time
строка
всегда
Время создания.

Пример:
2019-02-05T16:19:58+00:00
description
строка
всегда
Описание транзитного шлюза.

Пример:
Транзитный шлюз
options
сложный
всегда
Словарь параметров транзитного шлюза.
amazon_side_asn
целое число
всегда
Приватный автономный системный номер (ASN) для стороны Amazon сессии BGP. Диапазон составляет от 64512 до 65534 для 16-битных ASN и от 4200000000 до 4294967294 для 32-битных ASN.

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

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

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

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

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

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

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

Пример:
включено
owner_id
строка
всегда
Номер учетной записи AWS, которая владеет транзитным шлюзом.

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

Пример:
доступно
tags
словарь
всегда
Словарь тегов, связанных с транзитным шлюзом.

Пример:
{ "Имя": "Образцовый TGW" }
transit_gateway_arn
строка
всегда
Amazon Resource Name (ARN) транзитного шлюза.

Пример:
arn:aws:ec2:us-west-2:1234567654323:transit-gateway/tgw-02c42332e6b7da829
transit_gateway_id
строка
всегда
Идентификатор транзитного шлюза.

Пример:
tgw-02c42332e6b7da829


Авторы

  • Боб Болдин (@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_info_module.html

Spec-Zone.ru

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