amazon.aws.elb_classic_lb_info 模块 – 收集 AWS 中 EC2 Classic 弹性负载均衡器信息

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要 

收集有关 AWS 中 EC2 Classic 弹性负载均衡器的信息。

要求 

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

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 后的某个版本中删除。
names 列表 / 元素=字符串	要收集信息的 ELB 名称列表。传递此选项以收集有关一组 ELB 的信息，否则将返回所有 ELB。默认值： `[]`
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保持一致，在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之后的一个版本中移除。
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.
# Output format tries to match amazon.aws.elb_classic_lb module input parameters

- name: Gather information about all ELBs
  amazon.aws.elb_classic_lb_info:
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ item.dns_name }}"
  loop: "{{ elb_info.elbs }}"

- name: Gather information about a particular ELB
  amazon.aws.elb_classic_lb_info:
    names: frontend-prod-elb
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ elb_info.elbs.0.dns_name }}"

- name: Gather information about a set of ELBs
  amazon.aws.elb_classic_lb_info:
    names:
      - frontend-prod-elb
      - backend-prod-elb
  register: elb_info

- ansible.builtin.debug:
    msg: "{{ item.dns_name }}"
  loop: "{{ elb_info.elbs }}"

返回值 

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

键	描述
elbs 列表 / 元素=字典	负载均衡器的列表。返回：始终
attributes 字典	关于负载均衡器属性的信息。返回：始终
access_log 字典	关于是否启用了访问日志的信息。返回：成功示例：`{"enabled": false}`
additional_attributes 列表 / 元素=字典	关于附加负载均衡器属性的信息。返回：成功示例：`[{"key": "elb.http.desyncmitigationmode", "value": "defensive"}]`
connection_draining 字典	关于弹性负载均衡器的连接排空配置的信息。返回：成功示例：`{"enabled": true, "timeout": 300}`
enabled 布尔值	是否启用了连接排空。返回：始终
timeout 整数	在注销实例之前保持现有连接打开的最长时间（以秒为单位）。返回：始终
connection_settings 字典	关于连接设置的信息。返回：成功示例：`{"idle_timeout": 60}`
cross_zone_load_balancing 字典	关于是否启用了跨区域负载均衡的信息。返回：成功示例：`{"enabled": true}`
availability_zones 列表 / 元素=字符串	负载均衡器的可用区。返回：始终示例：`["us-west-2a"]`
backend_server_descriptions 列表 / 元素=字典	关于您的EC2实例的信息。返回：始终示例：`[{"instance_port": 8085, "policy_names": ["MyPolicy1"]}]`
canonical_hosted_zone_name 字符串	负载均衡器的DNS名称。返回：始终示例：`"test-123456789.us-west-2.elb.amazonaws.com"`
canonical_hosted_zone_name_id 字符串	负载均衡器的Amazon Route 53托管区的ID。返回：始终示例：`"Z1Z1ZZ5HABSF5"`
created_time 字符串	创建负载均衡器的日期和时间。返回：始终示例：`"2024-09-04T17:52:22.270000+00:00"`
dns_name 字符串	负载均衡器的DNS名称。返回：始终示例：`"test-123456789.us-west-2.elb.amazonaws.com"`
health_check 字典	关于对负载均衡器进行的健康检查的信息。返回：始终示例：`{"healthy_threshold": 10, "interval": 5, "target": "HTTP:80/index.html", "timeout": 2, "unhealthy_threshold": 2}`
healthy_threshold 整数	将实例移至“健康”状态所需连续的健康检查成功次数。返回：始终
interval 整数	单个实例的健康检查之间的大致间隔（以秒为单位）。返回：始终
target 字符串	正在检查的实例。协议为TCP、HTTP、HTTPS或SSL。有效端口范围为1到65535。返回：始终
timeout 整数	无响应表示健康检查失败的时间量（以秒为单位）。返回：始终
unhealthy_threshold 整数	将实例移至“不健康”状态所需连续的健康检查失败次数。返回：始终
instances 列表 / 元素=字典	负载均衡器的实例ID。返回：始终示例：`[{"instance_id": "i-11d1f111ea111111b"}]`
instances_inservice 列表 / 元素=字符串	关于状态为“InService”的负载均衡器实例的信息。返回：始终示例：`["i-11d1f111ea111111b"]`
instances_inservice_count 整数	状态为“InService”的负载均衡器实例总数。返回：始终示例：`1`
instances_outofservice 列表 / 元素=字符串	关于状态为“OutOfService”的负载均衡器实例的信息。返回：始终示例：`["i-11d1f111ea111111b"]`
instances_outofservice_count 整数	状态为“OutOfService”的负载均衡器实例总数。返回：始终示例：`0`
instances_unknownservice 列表 / 元素=字符串	关于状态为“Unknown”的负载均衡器实例的信息。返回：始终示例：`["i-11d1f111ea111111b"]`
instances_unknownservice_count 整数	状态为“Unknown”的负载均衡器实例总数。返回：始终示例：`1`
listener_descriptions 列表 / 元素=字典	关于负载均衡器侦听器的信息。返回：始终示例：`[{"listener": {"instance_port": 80, "instance_protocol": "HTTP", "load_balancer_port": 80, "protocol": "HTTP"}, "policy_names": []}]`
load_balancer_name 字符串	弹性负载均衡器的名称。返回：始终示例：`"MyLoadBalancer"`
policies 字典	关于为负载均衡器定义的策略的信息。返回：始终示例：`{"app_cookie_stickiness_policies": [], "lb_cookie_stickiness_policies": [], "other_policies": []}`
app_cookie_stickiness_policies 列表 / 元素=字符串	使用CreateAppCookieStickinessPolicy创建的粘性策略。返回：始终
lb_cookie_stickiness_policies 列表 / 元素=字符串	使用CreateLBCookieStickinessPolicy创建的粘性策略。返回：始终
other_policies 列表 / 元素=字符串	除粘性策略之外的其他策略。返回：始终
scheme 字符串	负载均衡器的类型。返回：始终示例：`"internet-facing"`
security_groups 列表 / 元素=字符串	负载均衡器的安全组。返回：始终示例：`["sg-111111af1111cb111"]`
source_security_group 字典	负载均衡器的安全组，用作已注册实例的入站规则的一部分。返回：始终示例：`{"group_name": "default", "owner_alias": "721111111111"}`
group_name 字符串	安全组的名称。返回：始终
owner_alias 字符串	安全组的所有者。返回：始终
subnets 列表 / 元素=字符串	负载均衡器的子网ID。返回：始终示例：`["subnet-111111af1111cb111"]`
tags 字典	与负载均衡器关联的标签。返回：始终示例：`{"Env": "Dev", "Owner": "Dev001"}`
vpc_id 字符串	负载均衡器的VPC ID。返回：始终示例：`"vpc-0cc28c9e20d111111"`

作者

Michael Schultz (@mjschultz)
Fernando Jose Pando (@nand0p)