community.aws.ec2_transit_gateway_info – Сбор информации о шлюзах EC2 Transit Gateway в 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 Gateway в 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. Только ключ 'user_agent' используется для модулей boto. См. 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:action", сделанных во время задачи, выводит набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы вывести в список всех вызовов, сделанных во время плейбука. |
| ec2_url строка | 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. Пример: включено | ||
| owner_id строка | всегда | Идентификатор номера AWS-аккаунта, которому принадлежит транзитный шлюз. Пример: 1234567654323 | ||
| state строка | всегда | Состояние транзитного шлюза. Пример: доступно | ||
| tags словарь | всегда | Словарь тегов, связанных с транзитным шлюзом. Пример: { "Название": "Пример ТШ" } | ||
| 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ec2_transit_gateway_info_module.html