amazon.aws.ec2_transit_gateway_info 模块 – 在 AWS 中检索有关 EC2 Transit Gateways 的信息

注意

此模块是 amazon.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：amazon.aws.ec2_transit_gateway_info。

社区 aws 1.0.0 中的新增功能

概要

• 收集有关 AWS 中 EC2 Transit Gateways 的信息。

要求

执行此模块的主机需要满足以下要求。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id、aws_access_key、ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 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 或 EC2_ACCESS_KEY 环境变量，优先级依次降低。 aws_access_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 已弃用对 EC2_ACCESS_KEY 环境变量的支持，将在 2024-12-01 之后的版本中删除。
aws_ca_bundle 路径	用于验证 SSL 证书的 CA 包的位置。 也可以使用 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 记录器来解析任务期间进行的唯一（而不是总共）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出 playbook 期间创建的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选择 false ← (默认) true
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url 字符串	要连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他 AWS 兼容服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次降低。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。 已弃用对 EC2_URL 环境变量的支持，将在 2024-12-01 之后的版本中删除。
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 和 security_token 选项互斥。
region 别名：aws_region、ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。 也可以使用 AWS_REGION 或 EC2_REGION 环境变量。 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 ec2_region 别名已弃用，将在 2024-12-01 之后的版本中删除 已弃用对 EC2_REGION 环境变量的支持，并将在 2024-12-01 之后的版本中移除。
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_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 或 EC2_SECRET_KEY 环境变量，优先级依次降低。 secret_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已被弃用，并将在 2024-12-01 之后的版本中移除。 已弃用对 EC2_SECRET_KEY 环境变量的支持，并将在 2024-12-01 之后的版本中移除。
session_token 别名：aws_session_token, security_token, aws_security_token, access_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、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量，优先级依次降低。 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已被弃用，并将在 2024-12-01 之后的版本中移除。 已弃用对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持，并将在 2024-12-01 之后的版本中移除。
transit_gateway_ids 别名：transit_gateway_id list / elements=string	要收集信息的传输网关 ID 列表。 默认值： []
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 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 list / elements=dictionary	与提供的过滤器匹配的传输网关。 每个元素都由一个字典组成，其中包含与该传输网关相关的所有信息。 返回：成功时
creation_time 字符串	创建时间。 返回：总是 示例： "2019-02-05T16:19:58+00:00"
description 字符串	传输网关的描述。 返回：总是 示例： "一个传输网关"
options 字典	传输网关选项的字典。 返回：总是
amazon_side_asn 整数	BGP 会话的 Amazon 端私有自治系统号 (ASN)。 16 位 ASN 的范围是 64512 到 65534，32 位 ASN 的范围是 4200000000 到 4294967294。 返回：总是 示例： 64512
association_default_route_table_id 字符串	默认关联路由表的 ID。 返回：存在时 示例： "tgw-rtb-0fd332c911223344"
auto_accept_shared_attachments 字符串	指示是否自动接受附件请求。 返回：总是 示例： "启用"
default_route_table_association 字符串	指示资源附件是否自动与默认关联路由表关联。 返回：总是 示例： "禁用"
default_route_table_propagation 字符串	指示资源附件是否自动将路由传播到默认传播路由表。 返回：总是 示例： "禁用"
dns_support 字符串	指示是否启用 DNS 支持。 返回：总是 示例： "启用"
multicast_support 字符串 在 amazon.aws 7.3.0 中添加	指示是否启用多播支持。 返回：总是 示例： "启用"
propagation_default_route_table_id 字符串	默认传播路由表的 ID。 返回：存在时 示例： "rtb-11223344"
vpn_ecmp_support 字符串	指示是否启用等价多路径协议支持。 返回：总是 示例： "启用"
owner_id 字符串	拥有传输网关的 AWS 账户号码 ID。 返回：总是 示例： "123456789012"
state 字符串	传输网关的状态。 返回：总是 示例： "可用"
tags 字典	与传输网关关联的标签字典。 返回：总是 示例： {"Env": "Dev", "Name": "一个示例 TGW"}
transit_gateway_arn 字符串	传输网关的 Amazon 资源名称 (ARN)。 返回：总是 示例： "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-02c42332e6b7da829"
transit_gateway_id 字符串	传输网关的 ID。 返回：总是 示例： "tgw-02c42332e6b7da829"

作者

• Bob Boldin (@BobBoldin)

集合链接

• 问题跟踪器
• 存储库（源）
• 沟通