amazon.aws.ec2_transit_gateway_info 模块 – 获取 AWS 中 EC2 转接网关信息

注意

此模块是 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。

community.aws 1.0.0 中的新增功能

概要

• 收集有关 AWS 中 EC2 转接网关的信息。

要求

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

• 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_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 字符串	连接到非默认 AWS 端点的 URL。虽然这可用于连接到其他与 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月1日后的某个版本中移除。 EC2_REGION环境变量的支持已弃用，将在2024年12月1日后的某个版本中移除。
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月1日后的某个版本中移除。 EC2_SECRET_KEY环境变量的支持已弃用，将在2024年12月1日后的某个版本中移除。
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选项互斥。 在3.2.0版本中添加了aws_session_token和session_token别名，在6.0.0版本中将参数名称从security_token重命名为session_token。 security_token、aws_security_token和access_token别名已弃用，将在2024年12月1日后的某个版本中移除。 EC2_SECRET_KEY和AWS_SECURITY_TOKEN环境变量的支持已弃用，将在2024年12月1日后的某个版本中移除。
transit_gateway_ids 别名：transit_gateway_id 列表 / 元素=字符串	要收集信息的Transit Gateway 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 列表 / 元素=字典	与提供的过滤器匹配的Transit Gateway。 每个元素包含一个字典，其中包含与该Transit Gateway相关的所有信息。 返回：成功时
creation_time 字符串	创建时间。 返回：始终 示例："2019-02-05T16:19:58+00:00"
description 字符串	Transit Gateway的描述。 返回：始终 示例："A transit gateway"
options 字典	Transit Gateway选项的字典。 返回：始终
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 字符串	指示是否自动接受附件请求。 返回：始终 示例："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 字符串	默认传播路由表的ID。 返回：存在时 示例："rtb-11223344"
vpn_ecmp_support 字符串	指示是否启用了等价多路径协议支持。 返回：始终 示例："enable"
owner_id 字符串	拥有Transit Gateway的AWS账户编号ID。 返回：始终 示例："123456789012"
state 字符串	Transit Gateway的状态。 返回：始终 示例："available"
tags 字典	与Transit Gateway关联的标签字典。 返回：始终 示例：{"Env": "Dev", "Name": "A sample TGW"}
transit_gateway_arn 字符串	Transit Gateway的Amazon资源名称 (ARN)。 返回：始终 示例："arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-02c42332e6b7da829"
transit_gateway_id 字符串	Transit Gateway的ID。 返回：始终 示例："tgw-02c42332e6b7da829"

作者

• Bob Boldin (@BobBoldin)

资源链接

• 问题跟踪器
• 代码库（源代码）
• 沟通