openstack.cloud.lb_pool 模块 – 管理 OpenStack 云中的负载均衡池。

注意

此模块是 openstack.cloud 集合（版本 2.3.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install openstack.cloud。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 Playbook 中使用它，请指定：openstack.cloud.lb_pool。

概要

  • 从 OpenStack 云添加、更新或删除负载均衡池。

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

套接字层在 API 调用超时之前应等待多长时间。如果省略此项，则不会将任何内容传递给 requests 库。

auth

字典

包含云的身份验证插件策略所需的身份验证信息的字典。对于默认的password插件，这将包含auth_url、username、password、project_name 以及有关域的任何信息（例如，如果云支持域，则为 user_domain_name 或 project_domain_name）。对于其他插件，此参数将需要包含该身份验证插件所需的任何参数。如果提供了命名云或存在 OpenStack OS_* 环境变量，则不需要此参数。

auth_type

字符串

要使用的身份验证插件的名称。如果云使用密码身份验证以外的身份验证，则应在此处指示插件的名称，并且应相应地更新 auth 参数的内容。

ca_cert

别名：cacert

字符串

可用作验证 SSL API 请求一部分的 CA 证书捆绑包的路径。

client_cert

别名：cert

字符串

用作 SSL 事务一部分的客户端证书的路径。

client_key

别名：key

字符串

用作 SSL 事务一部分的客户端密钥的路径。

cloud

任意

要操作的命名云或云配置。如果 cloud 是字符串，则它引用在 OpenStack clouds.yaml 文件中定义的命名云配置。提供 auth 和 auth_type 的默认值。如果提供了 auth 或存在 OpenStack OS_* 环境变量，则不需要此参数。如果 cloud 是字典，则它包含一个完整的云配置，就像 clouds.yaml 的一部分一样。

description

字符串

负载均衡池的人类可读描述。

interface

别名：endpoint_type

字符串

要从服务目录中获取的端点 URL 类型。

选项

  • "admin"

  • "internal"

  • "public" ←（默认）

lb_algorithm

字符串

池的负载均衡算法。

例如，lb_algorithm 可以是 LEAST_CONNECTIONS、ROUND_ROBIN、SOURCE_IP 或 SOURCE_IP_PORT。

默认： "ROUND_ROBIN"

listener

字符串

此池所属的侦听器的名称或 ID。

必须为池创建指定 listener 或 loadbalancer。

此属性无法更新。

loadbalancer

字符串

此池所属的负载均衡器的名称或 ID。

必须为池创建指定 listener 或 loadbalancer。

此属性无法更新。

name

字符串 / 必需

必须为池指定的名称。

此属性无法更新。

protocol

字符串

池的协议。

例如，protocol 可以是 HTTP、HTTPS、PROXY、PROXYV2、SCTP、TCP 和 UDP。

此属性无法更新。

默认： "HTTP"

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选项

  • "INFO" ←（默认）

  • "DEBUG"

sdk_log_path

字符串

OpenStackSDK 日志文件的路径。如果为空，则不写入任何日志

state

字符串

资源应存在还是不存在。

选项

  • "present" ←（默认）

  • "absent"

timeout

整数

Ansible 应等待请求的资源多长时间。

默认： 180

validate_certs

别名: verify

布尔值

是否应验证 SSL API 请求。

在 Ansible 2.3 之前，此项默认为 true。

选项

  • false

  • true

等待

布尔值

Ansible 是否应等待直到请求的资源完成。

选项

  • false

  • true ← (默认)

备注

注意

  • 可以使用标准的 OpenStack 环境变量，例如 OS_USERNAME，而无需提供显式值。

  • 身份验证信息由 openstacksdk 驱动，这意味着值可以来自 /etc/ansible/openstack.yaml、/etc/openstack/clouds.yaml 或 ~/.config/openstack/clouds.yaml 中的 yaml 配置文件，然后来自标准环境变量，最后来自 playbook 中的显式参数。更多信息请访问 https://docs.openstack.org/openstacksdk/

示例

- name: Create a load-balancer pool
  openstack.cloud.lb_pool:
    cloud: mycloud
    lb_algorithm: ROUND_ROBIN
    loadbalancer: test-loadbalancer
    name: test-pool
    protocol: HTTP
    state: present

- name: Delete a load-balancer pool
  openstack.cloud.lb_pool:
    cloud: mycloud
    name: test-pool
    state: absent

返回值

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

键

描述

池

字典

描述负载均衡器池的字典。

返回: 当 state 为 present 时，成功返回。

alpn_protocols

列表 / 元素=字符串

ALPN 协议列表。

返回: 成功

created_at

字符串

池创建时的时间戳。

返回: 成功

description

字符串

池的描述。

返回: 成功

health_monitor_id

字符串

健康监控 ID。

返回: 成功

id

字符串

唯一 UUID。

返回: 成功

is_admin_state_up

布尔值

池的管理状态。

返回: 成功

lb_algorithm

字符串

池的负载均衡算法。

返回: 成功

listener_id

字符串

池所属的监听器 ID。

返回: 成功

listeners

列表 / 元素=字符串

监听器 ID 列表。

返回: 成功

loadbalancer_id

字符串

池所属的负载均衡器 ID。当池不属于负载均衡器中的任何监听器时，将设置此字段。

返回: 成功

loadbalancers

列表 / 元素=字符串

负载均衡器 ID 列表。

返回: 成功

members

列表 / 元素=字符串

成员 ID 列表。

返回: 成功

name

字符串

赋予池的名称。

返回: 成功

operating_status

字符串

池的运行状态。

返回: 成功

project_id

字符串

项目的 ID。

返回: 成功

protocol

字符串

池的协议。

返回: 成功

provisioning_status

字符串

池的配置状态。

返回: 成功

session_persistence

字典

一个 JSON 对象，指定池的会话持久性。

返回: 成功

tags

列表 / 元素=字符串

关联标签列表。

返回: 成功

tls_ciphers

字符串

以 OpenSSL 格式存储密码字符串。

返回: 成功

tls_enabled

布尔值

对后端成员服务器的连接使用 TLS。

返回: 成功

tls_versions

列表 / 元素=字符串

池使用的 TLS 协议版本列表。

返回: 成功

updated_at

字符串

池更新时的时间戳。

返回: 成功

作者

  • OpenStack Ansible SIG