amazon.aws.ec2_vpc_nat_gateway_info 模块 – 使用 AWS 方法检索 AWS VPC 托管 NAT 网关详细信息

注意

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

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

要安装它，请使用： ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

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

amazon.aws 1.0.0 中的新增功能

摘要

• 获取与 AWS VPC 托管 NAT 网关相关的各种详细信息。

要求

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

• 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 字典	要应用的过滤器字典。每个字典项都包含一个过滤器键和一个过滤器值。有关可能的过滤器，请参见 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNatGateways.html。 默认值： {}
nat_gateway_ids 列表 / 元素=字符串	要为其获取详细信息的特定 nat 网关 ID 列表。 默认值： []
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 保持一致，别名 aws_secret_access_key 在 5.1.0 版本中添加。 别名 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 之后的一个版本中移除。
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。

示例

# Simple example of listing all nat gateways
- name: List all managed nat gateways in ap-southeast-2
  amazon.aws.ec2_vpc_nat_gateway_info:
    region: ap-southeast-2
  register: all_ngws

- name: Debugging the result
  ansible.builtin.debug:
    msg: "{{ all_ngws.result }}"

- name: Get details on specific nat gateways
  amazon.aws.ec2_vpc_nat_gateway_info:
    nat_gateway_ids:
      - nat-1234567891234567
      - nat-7654321987654321
    region: ap-southeast-2
  register: specific_ngws

- name: Get all nat gateways with specific filters
  amazon.aws.ec2_vpc_nat_gateway_info:
    region: ap-southeast-2
    filters:
      state: ['pending']
  register: pending_ngws

- name: Get nat gateways with specific filter
  amazon.aws.ec2_vpc_nat_gateway_info:
    region: ap-southeast-2
    filters:
      subnet-id: subnet-12345678
      state: ['available']
  register: existing_nat_gateways

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键	描述
changed 布尔值	如果成功列出互联网网关，则为 True。 返回值：始终 示例： false
result 列表 / 元素=字符串	描述的结果，转换为 Ansible 蛇形命名风格。 另请参见 http://boto3.readthedocs.io/en/latest/reference/services/ec2.html#EC2.Client.describe_nat_gateways。 返回值：成功
connectivity_type 字符串	指示 NAT 网关是否支持公共或私有连接。 返回值：始终 示例： "public"
create_time 字符串	创建 NAT 网关的日期和时间。 返回值：始终 示例： "2021-03-11T22:43:25+00:00"
delete_time 字符串	删除 NAT 网关的日期和时间。 返回值：当 NAT 网关已被删除时 示例： "2021-03-11T22:43:25+00:00"
nat_gateway_addresses 字典	包含一个字典的列表，其中包含与 NAT 网关关联的 IP 地址和网络接口。 返回值：始终
allocation_id 字符串	与 NAT 网关关联的弹性 IP 地址的分配 ID。 返回值：始终 示例： "eipalloc-0853e66a40803da76"
association_id 字符串	与 NAT 网关关联的弹性 IP 地址的关联 ID。 返回值：始终 示例： "eipassoc-0d6365c7eeb7d4932"
is_primary 布尔值	定义 IP 地址是否为主地址。 返回值：始终 示例： true
network_interface_id 字符串	与 NAT 网关关联的网络接口的 ID。 返回值：始终 示例： "eni-0a37acdbe306c661c"
private_ip 字符串	与弹性 IP 地址关联的私有 IP 地址。 返回值：始终 示例： "10.0.238.227"
public_ip 字符串	与 NAT 网关关联的弹性 IP 地址。 返回值：始终 示例： "34.204.123.52"
status 字符串	地址状态。 返回值：始终 示例： "succeeded"
nat_gateway_id 字符串	NAT 网关的 ID。 返回值：始终 示例： "nat-0c242a2397acf6173"
state 字符串	NAT 网关的状态。 返回值：始终 示例： "available"
subnet_id 字符串	NAT 网关所在的子网的 ID。 返回值：始终 示例： "subnet-098c447465d4344f9"
tags 字典	应用于 NAT 网关的标签。 返回值：始终 示例： {"Tag1": "tag1", "Tag_2": "tag_2"}
vpc_id 字符串	NAT 网关所在的 VPC 的 ID。 返回值：始终 示例： "vpc-02f37f48438ab7d4c"

作者

• Karen Cheng (@Etherdaemon)

资源链接

• 问题追踪
• 代码仓库
• 通信