community.aws.elb_network_lb 模块 – 管理网络负载均衡器

注意

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

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

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

要在 playbook 中使用它，请指定：community.aws.elb_network_lb。

community.aws 1.0.0 中的新增功能

概要

• 管理 AWS 网络弹性负载均衡器。有关详细信息，请参阅 https://aws.amazon.com/blogs/aws/new-network-load-balancer-effortless-scaling-to-millions-of-requests-per-second/。

要求

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

• 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。
cross_zone_load_balancing 布尔值	指示是否启用跨区域负载均衡。 默认为 false。 选项 false true
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。 还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
deletion_protection 布尔值	指示是否为 ELB 启用删除保护。 默认为 false。 选项 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 之后的一个版本中移除。
ip_address_type 字符串	设置指定应用程序负载均衡器的子网使用的 IP 地址类型。 选项 "ipv4" "dualstack"
listeners 列表 / 元素=字典	包含要附加到 ELB 的侦听器的字典列表。有关所需字典的详细信息，请参见示例。请注意，侦听器键采用驼峰式命名法。
AlpnPolicy 字符串 在 community.aws 7.1.0 中添加	应用程序层协议协商 (ALPN) 策略的名称。 选项 "HTTP1Only" "HTTP2Only" "HTTP2Optional" "HTTP2Preferred" "None"
证书 列表 / 元素=字典	SSL 服务器证书。
CertificateArn 字符串	证书的 Amazon 资源名称 (ARN)。
DefaultActions 列表 / 元素=字典 / 必需	侦听器的默认操作。
TargetGroupArn 字符串	目标组的 Amazon 资源名称 (ARN)。 与 TargetGroupName 互斥。
TargetGroupName 字符串	目标组的名称。 与 TargetGroupArn 互斥。
Type 字符串	操作类型。
Port 整数 / 必需	负载均衡器正在侦听的端口。
Protocol 字符串 / 必需	客户端到负载均衡器的连接协议。
SslPolicy 字符串	定义支持哪些密码和协议的安全策略。
name 字符串 / 必需	负载均衡器的名称。此名称在您的 AWS 账户中必须唯一，最多可包含 32 个字符，只能包含字母数字字符或连字符，并且不能以连字符开头或结尾。
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 选项互斥。
purge_listeners 布尔值	如果 purge_listeners=true，则将从 ELB 中清除现有侦听器，以完全匹配 listeners 参数中定义的内容。 如果未设置 listeners 参数，则侦听器将不会被修改。 选项 false true ← (默认)
purge_tags 布尔值	如果 purge_tags=true 且 tags 已设置，则将从资源中清除现有标签，以完全匹配 tags 参数中定义的内容。 如果未设置 tags 参数，则即使 purge_tags=True，标签也不会被修改。 以 aws: 开头的标签键由 Amazon 保留，不能修改。因此，在 purge_tags 参数中将忽略它们。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 false true ← (默认)
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 之后的一个版本中删除。
scheme 字符串	面向互联网的或内部负载均衡器。创建 ELB 方案后无法修改。 选项 "internet-facing" ← (默认) "internal"
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 之后的一个版本中删除。
state 字符串	创建或销毁负载均衡器。 默认值在 4.0.0 版本中从 'absent' 更改为 'present'。 选项 "present" ← (默认) "absent"
subnet_mappings 列表 / 元素=字典	包含要附加到负载均衡器的子网 ID 的字典列表。您还可以指定要附加到负载均衡器的弹性 IP 的分配 ID 或内部负载均衡器的内部 IP 地址。每个子网可以指定一个弹性 IP 地址或内部地址。 此参数与 subnets 互斥。
subnets 列表 / 元素=字符串	要附加到负载均衡器的子网 ID 列表。每个可用区只能指定一个子网。您必须至少指定来自两个可用区的子网。 当 state=present 时必需。 此参数与 subnet_mappings 互斥。
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则标签不会被修改。
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方法，请考虑改为设置 aws_ca_bundle。 选项 false true ← (默认)
wait 布尔值	是否等待网络负载均衡器达到所需状态。 选项 false true
wait_timeout 整数	要等待的持续时间（以秒为单位），与 wait 结合使用。

注释

注意

• 侦听器基于端口进行匹配。如果更改了侦听器的端口，则将创建一个新的侦听器。

• 侦听器规则基于优先级进行匹配。如果更改了规则的优先级，则将创建一个新的规则。

• 警告：对于模块，环境变量和配置文件是从 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: Create an ELB and attach a listener
  community.aws.elb_network_lb:
    name: myelb
    subnets:
      - subnet-012345678
      - subnet-abcdef000
    listeners:
      - Protocol: TCP # Required. The protocol for connections from clients to the load balancer (TCP, TLS, UDP or TCP_UDP) (case-sensitive).
        Port: 80 # Required. The port on which the load balancer is listening.
        DefaultActions:
          - Type: forward # Required. Only 'forward' is accepted at this time
            TargetGroupName: mytargetgroup # Required. The name of the target group
    state: present

- name: Create an ELB with an attached Elastic IP address
  community.aws.elb_network_lb:
    name: myelb
    subnet_mappings:
      - SubnetId: subnet-012345678
        AllocationId: eipalloc-aabbccdd
    listeners:
      - Protocol: TCP # Required. The protocol for connections from clients to the load balancer (TCP, TLS, UDP or TCP_UDP) (case-sensitive).
        Port: 80 # Required. The port on which the load balancer is listening.
        DefaultActions:
          - Type: forward # Required. Only 'forward' is accepted at this time
            TargetGroupName: mytargetgroup # Required. The name of the target group
    state: present

- name: Create an internal ELB with a specified IP address
  community.aws.elb_network_lb:
    name: myelb
    scheme: internal
    subnet_mappings:
      - SubnetId: subnet-012345678
        PrivateIPv4Address: 192.168.0.1 # Must be an address from within the CIDR of the subnet.
    listeners:
      - Protocol: TCP # Required. The protocol for connections from clients to the load balancer (TCP, TLS, UDP or TCP_UDP) (case-sensitive).
        Port: 80 # Required. The port on which the load balancer is listening.
        DefaultActions:
          - Type: forward # Required. Only 'forward' is accepted at this time
            TargetGroupName: mytargetgroup # Required. The name of the target group
    state: present

- name: Remove an ELB
  community.aws.elb_network_lb:
    name: myelb
    state: absent

返回值

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

键	描述
load_balancer 字典 在 community.aws 5.0.0 中添加	网络负载均衡器的表示。 返回：当 state 为 present 时
availability_zones 列表 / 元素=字符串	负载均衡器的可用区。 返回：当 state 为 present 时 示例： ["[{'subnet_id': 'subnet-aabbccddff'", " 'zone_name': 'ap-southeast-2a'", " 'load_balancer_addresses': []}]"]
canonical_hosted_zone_id 字符串	与负载均衡器关联的 Amazon Route 53 托管区域的 ID。 返回：当 state 为 present 时 示例： "ABCDEF12345678"
created_time 字符串	创建负载均衡器的日期和时间。 返回：当 state 为 present 时 示例： "2015-02-12T02:14:02+00:00"
deletion_protection_enabled 字符串	指示是否启用了删除保护。 返回：当 state 为 present 时 示例： "True"
dns_name 字符串	负载均衡器的公共 DNS 名称。 返回：当 state 为 present 时 示例： "internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com"
idle_timeout_timeout_seconds 字符串	空闲超时值（以秒为单位）。 返回：当 state 为 present 时 示例： "60"
ip_address_type 字符串	负载均衡器子网使用的IP地址类型。 返回：当 state 为 present 时 示例： "ipv4"
listeners 复杂	监听器信息。 返回：当 state 为 present 时
alpn_policy 列表 / 元素=字符串 在 community.aws 7.1.0 中添加	应用程序层协议协商 (ALPN) 策略的名称。 返回：当 state 为 present 时 示例： ["HTTP1Only", "HTTP2Only"]
证书 复杂	SSL 服务器证书。 返回：当 state 为 present 时
certificate_arn 字符串	证书的 Amazon 资源名称 (ARN)。 返回：当 state 为 present 时 示例： ""
default_actions 字符串	侦听器的默认操作。 返回：当 state 为 present 时
target_group_arn 字符串	目标组的 Amazon 资源名称 (ARN)。 返回：当 state 为 present 时 示例： ""
类型 字符串	操作类型。 返回：当 state 为 present 时 示例： ""
listener_arn 字符串	监听器的Amazon资源名称 (ARN)。 返回：当 state 为 present 时 示例： ""
load_balancer_arn 字符串	负载均衡器的Amazon资源名称 (ARN)。 返回：当 state 为 present 时 示例： ""
端口 整数	负载均衡器正在侦听的端口。 返回：当 state 为 present 时 示例： 80
协议 字符串	客户端到负载均衡器的连接协议。 返回：当 state 为 present 时 示例： "HTTPS"
ssl_policy 字符串	定义支持哪些密码和协议的安全策略。 返回：当 state 为 present 时 示例： ""
load_balancer_arn 字符串	负载均衡器的Amazon资源名称 (ARN)。 返回：当 state 为 present 时 示例： "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-elb/001122334455"
load_balancer_name 字符串	负载均衡器的名称。 返回：当 state 为 present 时 示例： "my-elb"
load_balancing_cross_zone_enabled 字符串	指示是否启用跨区域负载均衡。 返回：当 state 为 present 时 示例： "True"
scheme 字符串	面向互联网或内部负载均衡器。 返回：当 state 为 present 时 示例： "internal"
state 字典	负载均衡器的状态。 返回：当 state 为 present 时 示例： {"code": "active"}
标签 字典	附加到负载均衡器的标签。 返回：当 state 为 present 时 示例： {"Tag": "Example"}
类型 字符串	负载均衡器的类型。 返回：当 state 为 present 时 示例： "network"
vpc_id 字符串	负载均衡器的VPC ID。 返回：当 state 为 present 时 示例： "vpc-0011223344"

作者

• Rob White (@wimnat)

资源链接

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