ngine_io.cloudstack.cs_loadbalancer_rule_member 模块 – 管理基于 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_member

ngine_io.cloudstack 0.1.0 中的新功能

概要

  • 添加和删除负载均衡规则成员。

要求

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

  • python >= 2.6

  • cs >= 0.9.0

参数

参数

注释

account

字符串

规则所属的帐户。

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 环境变量。

domain

字符串

规则所属的域。

ip_address

别名:public_ip

字符串

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

仅当 *name* 不唯一时才需要查找规则。

name

字符串 / 必需

负载均衡规则的名称。

poll_async

布尔值

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

选项

  • false

  • true ← (默认)

project

字符串

防火墙规则所属的项目的名称。

state

字符串

虚拟机应在规则中存在还是不存在。

选项

  • "present" ← (默认)

  • "absent"

validate_certs

布尔值

在 ngine_io.cloudstack 2.4.0 中添加

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

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

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

选项

  • false

  • true ← (默认)

vms

别名:vm

列表 / elements=string / 必需

要分配给规则或从规则中删除的虚拟机列表。

zone

字符串

规则所在的区域的名称。

当 LB 提供商为 ElasticLoadBalancerVm 时必需

备注

注意

  • 有关 cloudstack 模块的详细指南,请参阅 CloudStack 云指南

  • 此模块支持检查模式。

示例

- name: Add VMs to an existing load balancer
  ngine_io.cloudstack.cs_loadbalancer_rule_member:
    name: balance_http
    vms:
      - web01
      - web02

- name: Remove a VM from an existing load balancer
  ngine_io.cloudstack.cs_loadbalancer_rule_member:
    name: balance_http
    vms:
      - web01
      - web02
    state: absent


# Rolling upgrade of hosts
- hosts: webservers
  serial: 1
  pre_tasks:
    - name: Remove from load balancer
      ngine_io.cloudstack.cs_loadbalancer_rule_member:
        name: balance_http
        vm: "{{ ansible_hostname }}"
        state: absent
  tasks:
    # Perform update
  post_tasks:
    - name: Add to load balancer
      ngine_io.cloudstack.cs_loadbalancer_rule_member:
        name: balance_http
        vm: "{{ ansible_hostname }}"
        state: present

返回值

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

描述

account

字符串

规则所属的帐户。

已返回: 成功

示例: "example account"

algorithm

字符串

使用的负载均衡算法。

已返回: 成功

示例: "source"

cidr

字符串

从中转发流量的 CIDR。

已返回: 成功

示例: "0.0.0.0/0"

description

字符串

规则的描述。

已返回: 成功

示例: "http load balancer rule"

domain

字符串

规则所属的域。

已返回: 成功

示例: "example domain"

id

字符串

规则的 UUID。

已返回: 成功

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

name

字符串

规则的名称。

已返回: 成功

示例: "http-lb"

private_port

整数

私有 IP 地址。

已返回: 成功

示例: 80

project

字符串

规则所属项目的名称。

已返回: 成功

示例: "Production"

protocol

字符串

规则的协议。

已返回: 成功

示例: "tcp"

public_ip

字符串

公共 IP 地址。

已返回: 成功

示例: "1.2.3.4"

public_port

整数

公共端口。

已返回: 成功

示例: 80

state

字符串

规则的状态。

已返回: 成功

示例: "Add"

tags

列表 / 元素=字符串

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

已返回: 成功

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

vms

列表 / 元素=字符串

规则成员。

已返回: 成功

示例: ["[ \"web01\"", " \"web02\" ]"]

zone

字符串

规则所属区域的名称。

已返回: 成功

示例: "ch-gva-2"

作者

  • Darren Worrall (@dazworrall)

  • René Moser (@resmo)