ngine_io.cloudstack.cs_loadbalancer_rule 模块 – 管理基于 Apache CloudStack 的云上的负载均衡规则。

注意

此模块是 ngine_io.cloudstack 集合 (版本 2.5.0) 的一部分。

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

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

要在剧本中使用它，请指定： ngine_io.cloudstack.cs_loadbalancer_rule。

ngine_io.cloudstack 0.1.0 中的新增功能

概要

  • 添加、更新和删除负载均衡规则。

要求

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

  • python >= 2.6

  • cs >= 0.9.0

参数

参数

注释

account

string

规则与之关联的帐户。

algorithm

string

负载均衡算法

当使用 state=present 时是必需的。

选项

  • "source" ← (默认)

  • "roundrobin"

  • "leastconn"

api_http_method

string

用于查询 API 端点的 HTTP 方法。

如果未给定，则考虑 CLOUDSTACK_METHOD 环境变量。

选项

  • "get" ← (默认)

  • "post"

api_key

string / 必需

CloudStack API 的 API 密钥。

如果未给定，则考虑 CLOUDSTACK_KEY 环境变量。

api_secret

string / 必需

CloudStack API 的密钥。

如果未设置，则考虑 CLOUDSTACK_SECRET 环境变量。

api_timeout

integer

HTTP 超时（以秒为单位）。

如果未给定，则考虑 CLOUDSTACK_TIMEOUT 环境变量。

默认值： 10

api_url

string / 必需

CloudStack API 的 URL，例如 https://cloud.example.com/client/api。

如果未给定，则考虑 CLOUDSTACK_ENDPOINT 环境变量。

api_verify_ssl_cert

string

验证 CA 机构证书文件。

如果未给定，则考虑 CLOUDSTACK_VERIFY 环境变量。

cidr

string

如果需要，用于防火墙规则的 CIDR（完整表示法）。

description

string

负载均衡规则的描述。

domain

string

规则与之关联的域。

ip_address

别名：public_ip

string / 必需

将从其负载均衡网络流量的公有 IP 地址。

name

string / 必需

负载均衡规则的名称。

network

string

网络的名称。

open_firewall

boolean

是否在创建新规则时应创建公共端口的防火墙规则。

使用 ngine_io.cloudstack.cs_firewall 管理防火墙规则。

选项

  • false ← (默认)

  • true

poll_async

boolean

轮询异步作业，直到作业完成。

选项

  • false

  • true ← (默认)

private_port

integer

将网络流量负载均衡到的私有 IP 地址/虚拟机上的私有端口。

当使用 state=present 时是必需的。

由于 API 限制，一旦规则存在，就无法更改。

project

string

负载均衡 IP 地址与之相关的项目的名称。

protocol

string

在负载均衡器上使用的协议

public_port

integer

将从其负载均衡网络流量的公共端口。

当使用 state=present 时是必需的。

由于 API 限制，一旦规则存在，就无法更改。

state

string

规则的状态。

选项

  • "present" ← (默认)

  • "absent"

tags

别名：tag

list / elements=dictionary

标记列表。标记是具有键 key 和 value 的字典列表。

要删除所有标记，请设置一个空列表，例如 tags: []。

validate_certs

boolean

在 ngine_io.cloudstack 2.4.0 版本中添加。

如果设置为 false，则不会验证 SSL 证书。

如果未提供，则会考虑使用 CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY 环境变量。

这仅应用于使用自签名证书的个人控制站点。

选项

  • false

  • true ← (默认)

vpc

string

VPC 的名称。

zone

string

应该在其中创建规则的区域的名称。

当 LB 提供者为 ElasticLoadBalancerVm 时是必需的。

说明

注意

  • 关于 cloudstack 模块的详细指南可以在CloudStack 云指南中找到。

  • 此模块支持检查模式。

示例

- name: Create a load balancer rule
  ngine_io.cloudstack.cs_loadbalancer_rule:
    name: balance_http
    public_ip: 1.2.3.4
    algorithm: leastconn
    public_port: 80
    private_port: 8080

- name: Update algorithm of an existing load balancer rule
  ngine_io.cloudstack.cs_loadbalancer_rule:
    name: balance_http
    public_ip: 1.2.3.4
    algorithm: roundrobin
    public_port: 80
    private_port: 8080

- name: Delete a load balancer rule
  ngine_io.cloudstack.cs_loadbalancer_rule:
    name: balance_http
    public_ip: 1.2.3.4
    state: absent

返回值

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

键

描述

account

string

规则与之关联的帐户。

返回: 成功

示例: "示例账户"

algorithm

string

使用的负载均衡算法。

返回: 成功

示例: "源"

cidr

string

要转发流量的 CIDR。

返回: 成功

示例: "0.0.0.0/0"

description

string

规则的描述。

返回: 成功

示例: "http 负载均衡器规则"

domain

string

规则与之关联的域。

返回: 成功

示例: "示例域名"

id

string

规则的 UUID。

返回: 成功

示例: "a6f7a5fc-43f8-11e5-a151-feff819cdc9f"

name

string

规则的名称。

返回: 成功

示例: "http-lb"

private_port

integer

私有 IP 地址。

返回: 成功

示例: 80

project

string

规则相关的项目名称。

返回: 成功

示例: "生产"

protocol

string

规则的协议。

返回: 成功

示例: "tcp"

public_ip

string

公共 IP 地址。

返回: 成功

示例: "1.2.3.4"

public_port

integer

公共端口。

返回: 成功

示例: 80

state

string

规则的状态。

返回: 成功

示例: "添加"

tags

列表 / 元素=字符串

与该规则关联的资源标签列表。

返回: 成功

示例: ["[ { \"key\": \"foo\"", " \"value\": \"bar\" } ]"]

zone

string

规则相关的区域名称。

返回: 成功

示例: "ch-gva-2"

作者

  • Darren Worrall (@dazworrall)

  • René Moser (@resmo)