openstack.cloud.loadbalancer 模块 – 在 OpenStack 云中管理 Octavia 负载均衡器

注意

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

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

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

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

概要

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

要求

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

参数

参数

注释

api_timeout

整数

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

assign_floating_ip

别名：auto_public_ip

布尔值

自动分配浮动 IP 地址并将其与 VIP 关联。

已弃用，请改用 openstack.cloud.floating_ip。

选项

  • false ← (默认)

  • true

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

delete_floating_ip

别名：delete_public_ip

布尔值

当 *state* 为 present 且 *delete_floating_ip* 为 true 时，将删除与 VIP 关联的任何浮动 IP 地址。

当 *state* 为 absent 且 *delete_floating_ip* 为 true 时，将删除与负载均衡器一起与 VIP 关联的任何浮动 IP 地址。

已弃用，请改用 openstack.cloud.floating_ip。

选项

  • false ← (默认)

  • true

description

字符串

负载均衡器的人工可读描述。

flavor

字符串

负载均衡器的 flavor。

此属性无法更新。

floating_ip_address

别名：public_ip_address

字符串

与 VIP 关联的浮动 IP 地址，又名公有 IP 地址。

已弃用，请改用 openstack.cloud.floating_ip。

floating_ip_network

别名：public_network

字符串

将在其上创建浮动 IP 地址的 Neutron 外部网络的名称或 ID。

已弃用，请改用 openstack.cloud.floating_ip。

interface

别名：endpoint_type

字符串

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

选项

  • "admin"

  • "internal"

  • "public" ← (默认)

name

字符串 / 必填

负载均衡器的名称。

此属性无法更新。

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

vip_address

字符串

负载均衡器虚拟 IP 的 IP 地址。

此属性无法更新。

vip_network

字符串

负载均衡器虚拟 IP 的网络名称或 ID。

必须指定 *vip_network*、*vip_subnet* 或 *vip_port* 之一才能进行创建。

此属性无法更新。

vip_port

字符串

负载均衡器虚拟 IP 端口的名称或 ID。其中之一

必须指定 *vip_network*、*vip_subnet* 或 *vip_port* 之一才能进行创建。

此属性无法更新。

vip_subnet

字符串

负载均衡器虚拟 IP 的子网名称或 ID。

必须指定 *vip_network*、*vip_subnet* 或 *vip_port* 之一才能进行创建。

此属性无法更新。

wait

布尔值

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

选项

  • false

  • true ← (默认)

备注

注意

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

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

示例

- name: Create a load balancer
  openstack.cloud.loadbalancer:
    cloud: devstack
    name: my_lb
    state: present
    vip_subnet: my_subnet

- name: Create another load balancer
  openstack.cloud.loadbalancer:
    cloud: devstack
    name: my_lb
    state: present
    vip_address: 192.168.0.11
    vip_network: my_network

- name: Delete a load balancer and all its related resources
  openstack.cloud.loadbalancer:
    cloud: devstack
    name: my_lb
    state: absent

- name: Delete a load balancer, its related resources and its floating ip
  openstack.cloud.loadbalancer:
    cloud: devstack
    delete_floating_ip: true
    name: my_lb
    state: absent

返回值

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

键

描述

floating_ip

字典

描述附加到负载均衡器的浮动 IP 地址的字典。

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

created_at

字符串

分配浮动 IP 的时间戳。

返回: 成功

description

字符串

浮动 IP 的描述。

返回: 成功

dns_domain

字符串

DNS 域名。

返回: 成功

dns_name

字符串

DNS 名称。

返回: 成功

fixed_ip_address

字符串

与浮动 IP 地址关联的固定 IP 地址。

返回: 成功

floating_ip_address

字符串

浮动 IP 的 IP 地址。

返回: 成功

floating_network_id

字符串

与浮动 IP 关联的网络的 ID。

返回: 成功

id

字符串

浮动 IP 的 ID。

返回: 成功

name

字符串

浮动 IP 的名称。

返回: 成功

port_details

字典

此浮动 IP 与之关联的端口的详细信息。如果加载了 fip-port-details 扩展，则存在。

返回: 成功

port_id

字符串

浮动 IP 关联的端口 ID。

返回: 成功

project_id

字符串

此浮动 IP 关联的项目的 ID。

返回: 成功

qos_policy_id

字符串

附加到浮动 IP 的 QoS 策略的 ID。

返回: 成功

revision_number

字符串

修订号。

返回: 成功

router_id

字符串

浮动 IP 关联的路由器的 ID。

返回: 成功

status

字符串

浮动 IP 的状态，可以是 ‘ACTIVE’ 或 ‘DOWN’。

返回: 成功

subnet_id

字符串

浮动 IP 关联的子网的 ID。

返回: 成功

tags

列表 / 元素=字符串

标签列表。

返回: 成功

updated_at

字符串

上次更新浮动 IP 的时间戳。

返回: 成功

load_balancer

字典

描述负载均衡器的字典。

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

additional_vips

字符串

额外的 VIP。

返回: 成功

availability_zone

字符串

目标 Octavia 可用区的名称。

返回: 成功

created_at

字符串

负载均衡器创建的时间戳。

返回: 成功

description

字符串

负载均衡器的描述。

返回: 成功

flavor_id

字符串

负载均衡器的 flavor ID。

返回: 成功

id

字符串

唯一的 UUID。

返回: 成功

is_admin_state_up

布尔值

负载均衡器的管理状态。

返回: 成功

listeners

列表 / 元素=字符串

关联的监听器 ID（如果有）。

返回: 成功

name

字符串

赋予负载均衡器的名称。

返回: 成功

operating_status

字符串

负载均衡器的运行状态。

返回: 成功

pools

列表 / 元素=字符串

关联的池 ID（如果有）。

返回: 成功

project_id

字符串

此负载均衡器关联的项目的 ID。

返回: 成功

provider

字符串

负载均衡器的提供商名称。

返回: 成功

provisioning_status

字符串

负载均衡器的配置状态。

返回: 成功

tags

字符串

关联的标签列表。

返回: 成功

updated_at

字符串

上次更新负载均衡器的时间戳。

返回: 成功

vip_address

字符串

负载均衡器虚拟 IP 地址。

返回: 成功

vip_network_id

字符串

负载均衡器虚拟 IP 端口所属的网络 ID。

返回: 成功

vip_port_id

字符串

负载均衡器虚拟 IP 端口 ID。

返回: 成功

vip_qos_policy_id

字符串

VIP qos 策略 ID。

返回: 成功

vip_subnet_id

字符串

负载均衡器虚拟 IP 端口所属的子网 ID。

返回: 成功

作者

  • OpenStack Ansible SIG