amazon.aws.elb_application_lb_info 模块 – 收集 AWS 中应用程序负载均衡器信息

注意

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

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

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

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

amazon.aws 5.0.0 中的新增功能

概要

• 收集有关 AWS 中应用程序负载均衡器的信息。

• 此模块最初添加到 community.aws 的 1.0.0 版本中。

要求

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

• 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 回调将输出到剧本期间进行的完整列表。 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 后的某个版本中删除。
include_attributes 布尔值 amazon.aws 7.0.0 中新增	是否在响应中包含负载均衡器属性。 选项 false true ← (默认)
include_listener_rules 布尔值 amazon.aws 7.0.0 中新增	是否在响应中包含负载均衡器侦听器规则。 暗示 include_listeners=true 选项 false true ← (默认)
include_listeners 布尔值 amazon.aws 7.0.0 中新增	是否在响应中包含负载均衡器侦听器。 选项 false true ← (默认)
load_balancer_arns 列表 / 元素=字符串	负载均衡器的 Amazon 资源名称 (ARN)。您可以在单个调用中指定最多 20 个负载均衡器。
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 之类的全球服务，将忽略 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_secret_access_key 在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 别名 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。

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Gather information about all ALBs
  amazon.aws.elb_application_lb_info:

# Equivalent to aws elbv2 describe-load-balancers
- name: Gather minimal information about all ALBs
  amazon.aws.elb_application_lb_info:
    include_attributes: false
    include_listeners: false
    include_listener_rules: false

- name: Gather information about a particular ALB given its ARN
  amazon.aws.elb_application_lb_info:
    load_balancer_arns:
      - "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-alb/aabbccddeeff"

- name: Gather information about ALBs named 'alb1' and 'alb2'
  amazon.aws.elb_application_lb_info:
    names:
      - alb1
      - alb2

- name: Gather information about specific ALB
  amazon.aws.elb_application_lb_info:
    names: "alb-name"
    region: "aws-region"
  register: alb_info
- ansible.builtin.debug:
    var: alb_info

返回值

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

键	描述
load_balancers 复杂类型	负载均衡器的列表。 返回：始终
access_logs_s3_bucket 字符串	访问日志的 S3 存储桶名称。 返回：当 include_attributes=true 示例： "mys3bucket"
access_logs_s3_enabled 字符串	指示是否启用了存储在 Amazon S3 中的访问日志。 返回：当 include_attributes=true 示例： "true"
access_logs_s3_prefix 字符串	S3 存储桶中位置的前缀。 返回：当 include_attributes=true 示例： "my/logs"
availability_zones 列表 / 元素=字典	负载均衡器的可用区。 返回：成功 示例： [{"load_balancer_addresses": [], "subnet_id": "subnet-aabbccddff", "zone_name": "ap-southeast-2a"}]
load_balancer_addresses 列表 / 元素=字典	关于负载均衡器静态 IP 地址的信息。 返回：成功
allocation_id 字符串	内部负载均衡器的弹性 IP 地址的分配 ID。 返回：成功
ip_address 字符串	静态 IP 地址。 返回：成功
ipv6_address 字符串	IPv6 地址。 返回：成功
private_ipv4_address 字符串	内部负载均衡器的私有 IPv4 地址。 返回：成功
subnet_id 字符串	子网 ID。 返回：成功
zone_name 字符串	可用区的名称。 返回：成功
canonical_hosted_zone_id 字符串	与负载均衡器关联的 Amazon Route 53 托管区的 ID。 返回：成功 示例： "ABCDEF12345678"
created_time 字符串	创建负载均衡器的日期和时间。 返回：成功 示例： "2015-02-12T02:14:02+00:00"
deletion_protection_enabled 布尔值	指示是否启用了删除保护。 返回：当 include_attributes=true 示例： true
dns_name 字符串	负载均衡器的公共 DNS 名称。 返回：成功 示例： "internal-my-alb-123456789.ap-southeast-2.elb.amazonaws.com"
idle_timeout_timeout_seconds 整数	空闲超时值（以秒为单位）。 返回：当 include_attributes=true 示例： 60
ip_address_type 字符串	负载均衡器子网使用的 IP 地址类型。 返回：成功 示例： "ipv4"
listeners 复杂类型	关于侦听器的信息。 返回：当 include_listeners=true 或 include_listener_rules=true
certificates 列表 / 元素=字典	SSL 服务器证书。 返回：成功
certificate_arn 字符串	证书的 Amazon 资源名称 (ARN)。 返回：成功 示例： "arn:aws:acm:us-east-1:123456789012:certificate/28d2f3d9-cb2f-4033-a9aa-e75e704125a2"
default_actions 字符串	侦听器的默认操作。 返回：成功 示例： "[{'forward_config': {'target_group_stickiness_config': {'enabled': False}, 'target_groups': [{'target_group_arn': 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test/bf43c68602c51c02', 'weight': 1}]}, 'target_group_arn': 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test/bf43c68602c51c02', 'type': 'forward'}]"
forward_config 字典	用于创建在多个目标组之间分配请求的操作的信息。 返回：成功
target_group_stickiness_config 字典	规则的目标组粘性。 返回：成功
enabled 布尔值	指示是否启用了目标组粘性。 返回：成功
target_groups 字典	目标组。 返回：成功
target_groups 字符串	目标组的 Amazon 资源名称 (ARN)。 返回：成功
weight 整数	权重。 返回：成功
target_group_arn 字符串	目标组的 Amazon 资源名称 (ARN)。 返回：成功
type 字符串	操作类型。 返回：成功
listener_arn 字符串	侦听器的 Amazon 资源名称 (ARN)。 返回：成功 示例： ""
load_balancer_arn 字符串	负载均衡器的 Amazon 资源名称 (ARN)。 返回：成功 示例： ""
port 整数	负载均衡器侦听的端口。 返回：成功 示例： 80
protocol 字符串	客户端到负载均衡器的连接协议。 返回：成功 示例： "HTTPS"
rules 列表 / 元素=字典	侦听器规则列表。 返回：当 include_listener_rules=true
actions 列表 / 元素=字典	操作。 返回：成功 示例： [{"forward_config": {"target_group_stickiness_config": {"enabled": false}, "target_groups": [{"target_group_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test/09ba111f8079fb83", "weight": 1}]}, "target_group_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test/09ba111f8079fb83", "type": "forward"}]
forward_config 字典	用于创建在多个目标组之间分配请求的操作的信息。 返回：成功
target_group_stickiness_config 字典	规则的目标组粘性。 返回：成功
enabled 布尔值	指示是否启用了目标组粘性。 返回：成功
target_groups 字典	目标组。 返回：成功
target_group_arn 字符串	目标组的 Amazon 资源名称 (ARN)。 返回：成功
weight 整数	权重。 返回：成功
target_group_arn 字符串	目标组的 Amazon 资源名称 (ARN)。 返回：成功
type 字符串	操作类型。 返回：成功
conditions 列表 / 元素=字符串	条件。 返回：成功 示例： []
is_default 布尔值	指示这是否是默认规则。 返回：成功 示例： false
priority 字符串	优先级。 返回：成功 示例： "default"
rule_arn 字符串	规则的 Amazon 资源名称 (ARN)。 返回：成功 示例： ""
ssl_policy 字符串	定义支持哪些密码和协议的安全策略。 返回：成功 示例： "ELBSecurityPolicy-2016-08"
load_balancer_arn 字符串	负载均衡器的 Amazon 资源名称 (ARN)。 返回：成功 示例： "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-alb/001122334455"
load_balancer_name 字符串	负载均衡器的名称。 返回：成功 示例： "my-alb"
load_balancing_cross_zone_enabled 字符串	指示是否启用了跨区域负载均衡。 返回：当 include_attributes=true 示例： "true"
routing_http2_enabled 字符串	指示是否启用了 HTTP/2。 返回：当 include_attributes=true 示例： "true"
routing_http_desync_mitigation_mode 字符串	确定负载均衡器如何处理可能对应用程序构成安全风险的请求。 返回：当 include_attributes=true 示例： "defensive"
routing_http_drop_invalid_header_fields_enabled 字符串	指示负载均衡器是否删除具有无效标头字段的 HTTP 标头 (true) 或将其路由到目标 (false)。 返回：当 include_attributes=true 示例： "false"
routing_http_x_amzn_tls_version_and_cipher_suite_enabled 字符串	指示在将请求发送到目标之前，是否将这两个标头添加到客户端请求。 返回：当 include_attributes=true 示例： "false"
routing_http_xff_client_port_enabled 字符串	指示 X-Forwarded-For 标头是否应保留客户端用于连接到负载均衡器的源端口。 返回：当 include_attributes=true 示例： "false"
scheme 字符串	面向互联网或内部负载均衡器。 返回：成功 示例： "internal"
security_groups 列表 / 元素=字符串	负载均衡器的安全组 ID。 返回：成功 示例： ["sg-0011223344"]
state 字典	负载均衡器的状态。 返回：成功 示例： {"code": "active"}
code 字符串	状态代码。 返回：成功
reason 字符串	状态描述。 返回： 可用时
tags 字典	附加到负载均衡器的标签。 返回：成功 示例： {"Tag": "Example"}
type 字符串	负载均衡器的类型。 返回：成功 示例： "application"
vpc_id 字符串	负载均衡器的 VPC ID。 返回：成功 示例： "vpc-0011223344"
waf_fail_open_enabled 字符串	指示是否允许启用 AWS WAF 的负载均衡器在无法将请求转发到 AWS WAF 时将请求路由到目标。 返回：当 include_attributes=true 示例： "false"

作者

• Rob White (@wimnat)

收藏链接

• 问题跟踪器
• 代码仓库
• 通信