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。您需要更多要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:ngine_io.cloudstack.cs_loadbalancer_rule

ngine_io.cloudstack 0.1.0 中的新功能

概要

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

要求

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

  • python >= 2.6

  • cs >= 0.9.0

参数

参数

注释

account

字符串

规则相关的帐户。

algorithm

字符串

负载均衡算法

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

选择

  • "source" ←(默认)

  • "roundrobin"

  • "leastconn"

api_http_method

字符串

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

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

选择

  • "get" ←(默认)

  • "post"

api_key

字符串 / 必需

CloudStack API 的 API 密钥。

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

api_secret

字符串 / 必需

CloudStack API 的密钥。

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

api_timeout

整数

HTTP 超时(以秒为单位)。

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

默认值: 10

api_url

字符串 / 必需

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

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

api_verify_ssl_cert

字符串

验证 CA 授权证书文件。

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

cidr

字符串

如果需要,用于防火墙规则的 CIDR(完整表示法)。

description

字符串

负载均衡规则的描述。

domain

字符串

规则相关的域。

ip_address

别名:public_ip

字符串 / 必需

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

name

字符串 / 必需

负载均衡规则的名称。

network

字符串

网络的名称。

open_firewall

布尔值

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

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

选择

  • false ←(默认)

  • true

poll_async

布尔值

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

选择

  • false

  • true ←(默认)

private_port

整数

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

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

根据 API 限制,规则存在后无法更改。

project

字符串

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

protocol

字符串

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

public_port

整数

网络流量将从中进行负载均衡的公有端口。

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

根据 API 限制,规则存在后无法更改。

state

字符串

规则的状态。

选择

  • "present" ←(默认)

  • "absent"

tags

别名:tag

列表 / elements=dictionary

标记列表。标记是具有键 keyvalue 的字典列表。

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

validate_certs

布尔值

在 ngine_io.cloudstack 2.4.0 中添加

如果为 false,则不会验证 SSL 证书。

如果未给定,则会考虑 CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY 环境变量。

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

选择

  • false

  • true ←(默认)

vpc

字符串

VPC 的名称。

zone

字符串

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

当 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

字符串

规则相关的帐户。

已返回:成功

示例: "example account"

algorithm

字符串

使用的负载均衡算法。

已返回:成功

示例: "source"

cidr

字符串

从中转发流量的 CIDR。

已返回:成功

示例: "0.0.0.0/0"

description

字符串

规则的描述。

已返回:成功

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

domain

字符串

规则相关的域。

已返回:成功

示例: "示例 域名"

id

字符串

规则的 UUID。

已返回:成功

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

name

字符串

规则的名称。

已返回:成功

示例: "http-lb"

private_port

整数

私有 IP 地址。

已返回:成功

示例: 80

project

字符串

规则所属项目的名称。

已返回:成功

示例: "生产"

protocol

字符串

规则的协议。

已返回:成功

示例: "tcp"

public_ip

字符串

公共 IP 地址。

已返回:成功

示例: "1.2.3.4"

public_port

整数

公共端口。

已返回:成功

示例: 80

state

字符串

规则的状态。

已返回:成功

示例: "添加"

tags

列表 / 元素=字符串

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

已返回:成功

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

zone

字符串

规则所属区域的名称。

已返回:成功

示例: "ch-gva-2"

作者

  • Darren Worrall (@dazworrall)

  • René Moser (@resmo)