openstack.cloud.lb_member 模块 – 管理 OpenStack 负载均衡池中的成员

注意

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

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

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

要在 playbook 中使用它，请指定：openstack.cloud.lb_member。

概要

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

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

address

字符串

成员的 IP 地址。

当 state 为 present 时是必需的。

此属性无法更新。

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 的一个部分中一样。

interface

别名：endpoint_type

字符串

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

选择

  • "admin"

  • "internal"

  • "public" ← (默认)

monitor_address

字符串

用于监视此成员的 IP 地址。

monitor_port

整数

用于监视此成员的端口。

name

字符串 / 必需

必须给成员的名称。

pool

字符串 / 必需

此成员所属的池的名称或 ID。

此属性无法更新。

protocol_port

整数

成员的协议端口号。

当 state 为 present 时是必需的。

此属性无法更新。

region_name

字符串

区域的名称。

sdk_log_level

字符串

OpenStackSDK 的日志级别

选择

  • "INFO" ← (默认)

  • "DEBUG"

sdk_log_path

字符串

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

state

字符串

资源应该是 present 还是 absent。

选择

  • "present" ← (默认)

  • "absent"

subnet_id

字符串

成员服务可访问的子网 ID。

此属性无法更新。

timeout

整数

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

默认值: 180

validate_certs

别名：verify

布尔值

是否应该验证 SSL API 请求。

在 Ansible 2.3 之前，默认为 true。

选择

  • false

  • true

wait

布尔值

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

选择

  • false

  • true ← (默认)

weight

整数

成员的权重决定了它与其他池成员相比所服务的请求或连接的比例。

例如，权重为 10 的成员接收的请求是权重为 2 的成员的五倍。值为 0 表示成员不接收新连接，但继续服务现有连接。有效值介于 0 到 256 之间。

Octavia 的 weight 默认值为 1。

说明

注意

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

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

示例

- name: Create member in a load-balancer pool
  openstack.cloud.lb_member:
    address: 192.168.10.3
    cloud: mycloud
    name: test-member
    pool: test-pool
    protocol_port: 8080
    state: present

- name: Delete member from a load-balancer pool
  openstack.cloud.lb_member:
    cloud: mycloud
    name: test-member
    pool: test-pool
    state: absent

返回值

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

键

描述

成员

字典

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

返回：当state为present时成功返回。

address

字符串

后端成员服务器的 IP 地址。

返回：成功

备份

布尔值

一个布尔值，指示该成员是否为备份成员。只有当所有非备份成员都关闭时，备份成员才会接收流量。

返回：成功

created_at

字符串

成员创建的时间戳。

返回：成功

id

字符串

唯一的 UUID。

返回：成功

is_admin_state_up

布尔值

成员的管理状态。

返回：成功

monitor_address

字符串

用于监视此成员的 IP 地址。

返回：成功

monitor_port

整数

用于监视此成员的端口。

返回：成功

name

字符串

给予成员的名称。

返回：成功

operating_status

字符串

成员的运行状态。

返回：成功

project_id

字符串

此成员所属的项目的 ID。

返回：成功

protocol_port

整数

成员的协议端口号。

返回：成功

provisioning_status

字符串

成员的配置状态。

返回：成功

subnet_id

字符串

成员服务可访问的子网 ID。

返回：成功

tags

列表 / 元素=字符串

关联标签的列表。

返回：成功

updated_at

字符串

成员上次更新的时间戳。

返回：成功

weight

整数

一个正整数值，指示此成员应从池接收的相对流量比例。例如，权重为 10 的成员接收的流量是权重为 2 的成员的五倍。

返回：成功

pool

字典

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

返回：当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