community.aws.elb_target_group_info 模块 – 收集 AWS 中 ELB 目标组信息

注意

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

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

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

要在剧本中使用它，请指定：community.aws.elb_target_group_info。

community.aws 1.0.0 中的新增功能

概要

• 收集 AWS 中 ELB 目标组信息

要求

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

• 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。
collect_targets_health 布尔值	设置为 True 时，输出包含目标健康状况描述 选项 false ← (默认) true
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间发出的唯一（而不是总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到剧本期间发出的总列表。 也可以使用 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 之后的一个版本中删除。
load_balancer_arn 字符串	负载均衡器的 Amazon 资源名称 (ARN)。
names 列表 / 元素=字符串	目标组的名称。
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 等全球服务，将忽略区域。 也可以使用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选项是互斥的。 在 3.2.0 版本中添加了aws_session_token和session_token别名，在 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 之后的一个版本中删除。
target_group_arns 列表 / 元素=字符串	目标组的 Amazon 资源名称 (ARN)。
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 information about all target groups
  community.aws.elb_target_group_info:

- name: Gather information about the target group attached to a particular ELB
  community.aws.elb_target_group_info:
    load_balancer_arn: "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-elb/aabbccddeeff"

- name: Gather information about a target groups named 'tg1' and 'tg2'
  community.aws.elb_target_group_info:
    names:
      - tg1
      - tg2

返回值

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

键	描述
target_groups 复杂	目标组列表 返回：始终
deregistration_delay_timeout_seconds 整数	Elastic Load Balancing 在将注销目标的状态从排空更改为未使用之前等待的时间量（以秒为单位）。 返回：始终 示例：300
health_check_interval_seconds 整数	单个目标健康检查之间的大致时间量（以秒为单位）。 返回：始终 示例：30
health_check_path 字符串	健康检查请求的目标地址。 返回：始终 示例："/index.html"
health_check_port 字符串	用于连接目标的端口。 返回：始终 示例："traffic-port"
health_check_protocol 字符串	用于连接目标的协议。 返回：始终 示例："HTTP"
health_check_timeout_seconds 整数	无响应表示健康检查失败的时间量（以秒为单位）。 返回：始终 示例：5
healthy_threshold_count 整数	在将不健康的目标视为健康之前所需的连续健康检查成功次数。 返回：始终 示例：5
load_balancer_arns 列表 / 元素=字符串	将流量路由到此目标组的负载均衡器的 Amazon 资源名称 (ARN)。 返回：始终 示例：[]
matcher 字典	检查目标成功响应时要使用的 HTTP 代码。 返回：始终 示例：{"http_code": "200"}
port 整数	目标正在侦听的端口。 返回：始终 示例：80
protocol 字符串	用于将流量路由到目标的协议。 返回：始终 示例："HTTP"
stickiness_enabled 布尔值	指示是否启用了粘性会话。 返回：始终 示例：true
stickiness_lb_cookie_duration_seconds 整数	指示是否启用了粘性会话。 返回：始终 示例：86400
stickiness_type 字符串	粘性会话的类型。 返回：始终 示例："lb_cookie"
tags 字典	附加到目标组的标签。 返回：始终 示例：{"Tag": "Example"}
target_group_arn 字符串	目标组的 Amazon 资源名称 (ARN)。 返回：始终 示例："arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/mytargetgroup/aabbccddee0044332211"
target_group_name 字符串	目标组的名称。 返回：始终 示例："mytargetgroup"
targets_health_description 复杂	目标健康状况说明。 返回：启用 collect_targets_health 时
health_check_port 字符串	用于检查目标健康的端口。 返回：始终 示例："80"
target 复杂	目标元数据。 返回：始终
id 字符串	目标的 ID。 返回：始终 示例："i-0123456789"
port 整数	用于连接目标的端口。 返回：始终 示例：80
target_health 复杂	目标健康状况。 返回：始终
state 字符串	目标健康状况。 返回：始终 示例："healthy"
unhealthy_threshold_count 整数	在将目标视为不健康之前所需的连续健康检查失败次数。 返回：始终 示例：2
vpc_id 字符串	目标的 VPC ID。 返回：始终 示例："vpc-0123456"

作者

• Rob White (@wimnat)

资源链接

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