ec2_transit_gateway_info – Сбор информации о шлюзах EC2 Transit в AWS
Новое в версии 2.8.
Описание
- Сбор информации о шлюзах EC2 Transit в AWS
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический тип добавлено в 2.8 |
| Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы выводить полный список, созданный во время выполнения книги сценариев. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. | |
| filters словарь | Словарь фильтров для применения. Каждый элемент словаря состоит из ключа фильтра и значения фильтра. См. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html для фильтров. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| 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. псевдонимы: access_token | |
| transit_gateway_ids список добавлено в 2.8 | Список идентификаторов шлюзов Transit для сбора информации. псевдонимы: transit_gateway_id | |
| validate_certs логический тип |
| Если установлено значение "нет", сертификаты SSL для boto версии >= 2.6.0 не будут проверяться. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Gather info about all transit gateways
- ec2_transit_gateway_info:
# Gather info about a particular transit gateway using filter transit gateway ID
- ec2_transit_gateway_info:
filters:
transit-gateway-id: tgw-02c42332e6b7da829
# Gather info about a particular transit gateway using multiple option filters
- ec2_transit_gateway_info:
filters:
options.dns-support: enable
options.vpn-ecmp-support: enable
# Gather info about multiple transit gateways using module param
- 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 словарь | всегда | Словарь тегов, связанных с транзитным шлюзом. Пример: { "Имя": "Пример транзитного шлюза" } | ||
| transit_gateway_arn строка | всегда | Amazon Resource Name (ARN) транзитного шлюза. Пример: arn:aws:ec2:us-west-2:1234567654323:transit-gateway/tgw-02c42332e6b7da829 | ||
| transit_gateway_id строка | всегда | Идентификатор транзитного шлюза. Пример: tgw-02c42332e6b7da829 | ||
Статус
- Данному модулю не гарантируется обратная совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Боб Болдин (@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_info_module.html