amazon.aws.ec2_instance_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_instance_info。

amazon.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

string

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

path

用于验证 SSL 证书的 CA 捆绑包的位置。

也可以使用 AWS_CA_BUNDLE 环境变量。

aws_config

dictionary

用于修改 botocore 配置的字典。

参数可以在 AWS 文档 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config 中找到。

debug_botocore_endpoint_logs

boolean

使用 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

string

要连接到的 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

dictionary

要应用的过滤器字典。每个字典项都包含一个过滤器键和一个过滤器值。有关可能的过滤器，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html。过滤器名称和值区分大小写。

默认： {}

include_attributes

别名：attributes

list / elements=string

在 amazon.aws 6.3.0 中添加

描述返回实例的指定属性。

选择

  • "instanceType"

  • "kernel"

  • "ramdisk"

  • "userData"

  • "disableApiTermination"

  • "instanceInitiatedShutdownBehavior"

  • "rootDeviceName"

  • "blockDeviceMapping"

  • "productCodes"

  • "sourceDestCheck"

  • "groupSet"

  • "ebsOptimized"

  • "sriovNetSupport"

  • "enclaveOptions"

  • "disableApiStop"

instance_ids

list / elements=string

如果指定一个或多个实例 ID，则仅返回具有指定 ID 的实例。

默认： []

minimum_uptime

别名：uptime

integer

实例的最短运行时间（以分钟为单位）。例如，如果 uptime 为 60，则返回所有运行时间超过 60 分钟的实例。

profile

别名: aws_profile

string

用于身份验证的已命名 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

string

要使用的 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

string

AWS secret access key。

有关访问令牌的更多信息，请参阅 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

string

用于临时凭证的 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

boolean

设置为 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 information about all instances
  amazon.aws.ec2_instance_info:

- name: Gather information about all instances in AZ ap-southeast-2a
  amazon.aws.ec2_instance_info:
    filters:
      availability-zone: ap-southeast-2a

- name: Gather information about a particular instance using ID
  amazon.aws.ec2_instance_info:
    instance_ids:
      - i-12345678

- name: Gather information about any instance with a tag key Name and value Example
  amazon.aws.ec2_instance_info:
    filters:
      "tag:Name": Example

- name: Gather information about any instance in states "shutting-down", "stopping", "stopped"
  amazon.aws.ec2_instance_info:
    filters:
      instance-state-name: ["shutting-down", "stopping", "stopped"]

- name: Gather information about any instance with Name beginning with RHEL and an uptime of at least 60 minutes
  amazon.aws.ec2_instance_info:
    region: "{{ ec2_region }}"
    uptime: 60
    filters:
      "tag:Name": "RHEL-*"
      instance-state-name: ["running"]
  register: ec2_node_info

- name: Gather information about a particular instance using ID and include kernel attribute
  amazon.aws.ec2_instance_info:
    instance_ids:
      - i-12345678
    include_attributes:
      - kernel

返回值

通用返回值记录在 此处，以下是此模块特有的字段

键

描述

instances

复杂

ec2 实例的列表。

返回: 始终

ami_launch_index

integer

AMI 启动索引，可用于在启动组中查找此实例。

返回: 始终

示例: 0

architecture

string

映像的体系结构。

返回: 始终

示例: "x86_64"

attributes

dictionary

在 amazon.aws 6.3.0 中添加

输入时指定的实例属性的详细信息。

返回: 当指定 include_attributes 时

示例: {"disable_api_termination": {"value": true}, "ebs_optimized": {"value": true}}

block_device_mappings

复杂

实例的任何块设备映射条目。

返回: 始终

device_name

string

暴露给实例的设备名称（例如，/dev/sdh 或 xvdh）。

返回: 始终

示例: "/dev/sdh"

ebs

复杂

用于在启动实例时自动设置 EBS 卷的参数。

返回: 始终

attach_time

string

附件启动时的时间戳。

返回: 始终

示例: "2017-03-23T22:51:24+00:00"

delete_on_termination

boolean

指示是否在实例终止时删除卷。

返回: 始终

示例: true

status

string

附件状态。

返回: 始终

示例: "attached"

volume_id

string

EBS 卷的 ID。

返回: 始终

示例: "vol-12345678"

capacity_reservation_specification

复杂

有关容量预留目标选项的信息。

返回: 成功

capacity_reservation_preference

string

描述容量预留首选项。

返回: 成功

示例: "open"

client_token

string

您在启动实例时提供的幂等令牌（如果适用）。

返回: 始终

示例: "mytoken"

cpu_options

复杂

为实例设置的 CPU 选项。

返回: 始终

core_count

integer

实例的 CPU 内核数。

返回: 始终

示例: 1

threads_per_core

integer

每个 CPU 内核的线程数。在受支持的实例上，值 1 表示禁用 Intel 超线程技术。

返回: 始终

示例: 1

current_instance_boot_mode

string

用于在启动或启动时引导实例的引导模式。

返回: 成功

示例: "legacy-bios"

ebs_optimized

boolean

指示实例是否针对 EBS I/O 进行了优化。

返回: 始终

示例: false

ena_support

boolean

指定是否启用了 ENA 的增强联网。

返回: 始终

示例: true

enclave_options

dictionary

指示是否为 Amazon Web Services Nitro Enclaves 启用了实例。

返回: 成功

enabled

boolean

如果此参数设置为 true，则为 Amazon Web Services Nitro Enclaves 启用实例。

返回: 始终

示例: false

hibernation_options

dictionary

指示是否为休眠启用了实例。

返回: 成功

configured

boolean

如果为 true，则您的实例已启用休眠；否则，未启用休眠。

返回: 始终

示例: false

hypervisor

string

实例的虚拟机管理程序类型。

返回: 始终

示例: "xen"

iam_instance_profile

复杂

与实例关联的 IAM 实例配置文件（如果适用）。

返回: 成功

arn

string

实例配置文件的 Amazon 资源名称 (ARN)。

返回: 始终

示例: "arn:aws:iam::123456789012:instance-profile/myprofile"

id

string

实例配置文件的 ID。

返回: 始终

示例: "JFJ397FDG400FG9FD1N"

image_id

string

用于启动实例的 AMI 的 ID。

返回: 始终

示例: "ami-0011223344"

instance_id

string

实例的 ID。

返回: 始终

示例: "i-012345678"

instance_type

string

正在运行的实例的实例类型大小。

返回: 始终

示例: "t2.micro"

key_name

string

密钥对的名称（如果此实例使用关联的密钥对启动）。

返回: 始终

示例: "my-key"

launch_time

string

实例的启动时间。

返回: 始终

示例: "2017-03-23T22:51:24+00:00"

maintenance_options

dictionary

提供有关您的实例的恢复和维护选项的信息。

返回: 始终

auto_recovery

string

提供有关您的实例当前自动恢复行为的信息。

返回: 成功

示例: "default"

metadata_options

复杂

实例的元数据选项。

返回: 始终

http_endpoint

string

指示您的实例上的 HTTP 元数据端点是启用还是禁用。

返回: 成功

示例: "enabled"

http_protocol_ipv6

string

指示是否为实例元数据服务启用或禁用 IPv6 端点。

返回: 成功

示例: "disabled"

http_put_response_hop_limit

integer

元数据令牌可以传播的最大跃点数。

返回: 成功

示例: 1

http_tokens

string

指示是否需要 IMDSv2。

返回: 成功

示例: "optional"

instance_metadata_tags

string

指示是否允许从实例元数据访问实例标签。

返回: 成功

示例: "disabled"

state

string

元数据选项更改的状态。

返回: 成功

示例: "applied"

monitoring

复杂

实例的监控。

返回: 始终

state

string

指示是否启用详细监控。否则，将启用基本监控。

返回: 始终

示例: "disabled"

network_interfaces

复杂

实例的一个或多个网络接口。

返回: 始终

association

复杂

与网络接口关联的弹性 IPv4 的关联信息。

返回: 始终

ip_owner_id

string

弹性 IP 地址的所有者的 ID。

返回: 始终

示例: "amazon"

public_dns_name

string

公共 DNS 名称。

返回: 始终

示例: ""

public_ip

string

绑定到网络接口的公共 IP 地址或弹性 IP 地址。

返回: 始终

示例: "1.2.3.4"

attachment

复杂

网络接口附件。

返回: 始终

attach_time

string

附件启动时的时间戳。

返回: 始终

示例: "2017-03-23T22:51:24+00:00"

attachment_id

string

网络接口附件的 ID。

返回: 始终

示例: "eni-attach-3aff3f"

delete_on_termination

boolean

指示实例终止时是否删除网络接口。

返回: 始终

示例: true

device_index

integer

网络接口附件的实例上设备的索引。

返回: 始终

示例: 0

network_card_index

integer

网卡的索引。

返回: 始终

示例: 0

status

string

附件状态。

返回: 始终

示例: "attached"

description

string

描述。

返回: 始终

示例: "我的接口"

groups

列表 / 元素=字典

一个或多个安全组。

返回: 始终

group_id

string

安全组的 ID。

返回: 始终

示例: "sg-abcdef12"

group_name

string

安全组的名称。

返回: 始终

示例: "mygroup"

interface_type

string

网络接口的类型。

返回: 始终

示例: "interface"

ipv6_addresses

列表 / 元素=字典

与网络接口关联的一个或多个 IPv6 地址。

返回: 始终

ipv6_address

string

IPv6 地址。

返回: 始终

示例: "2001:0db8:85a3:0000:0000:8a2e:0370:7334"

mac_address

string

MAC 地址。

返回: 始终

示例: "00:11:22:33:44:55"

network_interface_id

string

网络接口的 ID。

返回: 始终

示例: "eni-01234567"

owner_id

string

网络接口所有者的 AWS 账户 ID。

返回: 始终

示例: "01234567890"

private_dns_name

string

分配给实例的私有 DNS 主机名。

返回: 始终

示例: "ip-10-1-0-156.ec2.internal"

private_ip_address

string

子网内网络接口的 IPv4 地址。

返回: 始终

示例: "10.0.0.1"

private_ip_addresses

列表 / 元素=字典

与网络接口关联的私有 IPv4 地址。

返回: 始终

association

复杂

与网络接口关联的弹性 IP 地址（IPv4）的关联信息。

返回: 成功

ip_owner_id

string

弹性 IP 地址的所有者的 ID。

返回: 始终

示例: "amazon"

public_dns_name

string

公共 DNS 名称。

返回: 始终

示例: ""

public_ip

string

绑定到网络接口的公共 IP 地址或弹性 IP 地址。

返回: 始终

示例: "1.2.3.4"

primary

boolean

指示此 IPv4 地址是否为网络接口的主要私有 IP 地址。

返回: 始终

示例: true

private_dns_name

string

分配给实例的私有 DNS 主机名。

返回: 始终

示例: "ip-10-1-0-156.ec2.internal"

private_ip_address

string

网络接口的私有 IPv4 地址。

返回: 始终

示例: "10.0.0.1"

source_dest_check

boolean

指示是否启用源/目标检查。

返回: 始终

示例: true

status

string

网络接口的状态。

返回: 始终

示例: "in-use"

subnet_id

string

网络接口的子网 ID。

返回: 始终

示例: "subnet-0123456"

vpc_id

string

网络接口的 VPC ID。

返回: 始终

示例: "vpc-0123456"

placement

复杂

实例启动的位置（如果适用）。

返回: 始终

availability_zone

string

实例的可用区。

返回: 始终

示例: "ap-southeast-2a"

group_name

string

实例所在的放置组的名称（对于集群计算实例）。

返回: 始终

示例: ""

tenancy

string

实例的租户（如果实例在 VPC 中运行）。

返回: 始终

示例: "default"

platform_details

string

实例的平台详细信息值。

返回: 始终

示例: "Linux/UNIX"

private_dns_name

string

私有 DNS 名称。

返回: 始终

示例: "ip-10-0-0-1.ap-southeast-2.compute.internal"

private_dns_name_options

dictionary

实例主机名的选项。

返回: 成功

enable_resource_name_dns_a_record

boolean

指示是否使用 DNS A 记录响应实例主机名的 DNS 查询。

返回: 成功

示例: false

enable_resource_name_dns_aaaa_record

boolean

指示是否使用 DNS AAAA 记录响应实例主机名的 DNS 查询。

返回: 成功

示例: false

hostname_type

string

要分配给实例的主机名类型。

返回: 成功

示例: "ip-name"

private_ip_address

string

子网内网络接口的 IPv4 地址。

返回: 始终

示例: "10.0.0.1"

product_codes

列表 / 元素=字典

一个或多个产品代码。

返回: 始终

product_code_id

string

产品代码。

返回: 始终

示例: "aw0evgkw8ef3n2498gndfgasdfsd5cce"

product_code_type

string

产品代码的类型。

返回: 始终

示例: "marketplace"

public_dns_name

string

分配给实例的公共 DNS 名称。

返回: 始终

public_ip_address

string

分配给实例的公共 IPv4 地址。

返回: 始终

示例: "52.0.0.1"

root_device_name

string

根设备的设备名称。

返回: 始终

示例: "/dev/sda1"

root_device_type

string

AMI 使用的根设备的类型。

返回: 始终

示例: "ebs"

security_groups

列表 / 元素=字典

实例的一个或多个安全组。

返回: 始终

group_id

string

安全组的 ID。

返回: 始终

示例: "sg-0123456"

group_name

string

安全组的名称。

返回: 始终

示例: "my-security-group"

source_dest_check

boolean

指示是否启用源/目标检查。

返回: 始终

示例: true

state

复杂

实例的当前状态。

返回: 始终

code

integer

低字节表示状态。

返回: 始终

示例: 16

name

string

状态的名称。

返回: 始终

示例: "running"

state_transition_reason

string

最近一次状态转换的原因。

返回: 始终

subnet_id

string

实例正在运行的子网的 ID。

返回: 始终

示例: "subnet-00abcdef"

tags

dictionary

分配给实例的任何标签。

返回: 始终

virtualization_type

string

AMI 的虚拟化类型。

返回: 始终

示例: "hvm"

vpc_id

dictionary

实例所在的 VPC 的 ID。

返回: 始终

示例: "vpc-0011223344"

作者

  • Michael Schuett (@michaeljs1990)

  • Rob White (@wimnat)