ngine_io.cloudstack.cs_loadbalancer_rule_member – Управляет членами правил балансировки нагрузки на облаках на основе Apache CloudStack.

Примечание

Этот плагин является частью коллекции ngine_io.cloudstack (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack.

Для использования в плейбуке укажите: ngine_io.cloudstack.cs_loadbalancer_rule_member.

Новый в версии 0.1.0: плагина ngine_io.cloudstack

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Добавление и удаление членов правил балансировки нагрузки.

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится правило.
api_http_method строка	Варианты: get post	HTTP-метод, используемый для запроса к API-точке. Если не задано, используется переменная среды `CLOUDSTACK_METHOD`. В качестве последней опции значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию - `get`, если не указано.
api_key строка		Ключ API CloudStack API. Если не задано, используется переменная среды `CLOUDSTACK_KEY`. В качестве последней опции значение берется из файла конфигурации ini, см. также примечания.
api_region строка	По умолчанию: "cloudstack"	Имя раздела ini в файле `cloustack.ini`. Если не задано, используется переменная среды `CLOUDSTACK_REGION`.
api_secret строка		Секретный ключ API CloudStack API. Если не задано, используется переменная среды `CLOUDSTACK_SECRET`. В качестве последней опции значение берется из файла конфигурации ini, см. также примечания.
api_timeout целое число		Таймаут HTTP в секундах. Если не задано, используется переменная среды `CLOUDSTACK_TIMEOUT`. В качестве последней опции значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию - 10 секунд, если не указано.
api_url строка		URL CloudStack API, например, https://cloud.example.com/client/api. Если не задано, используется переменная среды `CLOUDSTACK_ENDPOINT`. В качестве последней опции значение берется из файла конфигурации ini, см. также примечания.
api_verify_ssl_cert строка		Файл сертификата CA. Если не задано, используется переменная среды `CLOUDSTACK_VERIFY`. В качестве последней опции значение берется из файла конфигурации ini, см. также примечания. Значение по умолчанию - `null`, если не указано.
domain строка		Домен, к которому относится правило.
ip_address строка		Общедоступный IP-адрес, с которого сетевой трафик будет балансироваться. Требуется только для поиска правила, если name не уникален. Псевдонимы: public_ip
name строка / обязательно		Имя правила балансировки нагрузки.
poll_async логическое значение	Варианты: no да ←	Ожидать завершения асинхронных задач.
project строка		Имя проекта, к которому относится правило брандмауэра.
state строка	Варианты: present ← absent	Виртуальные машины должны быть присутствовать или отсутствовать в правиле.
vms список / элементы=строка / обязательно		Список виртуальных машин для назначения или удаления из правила. Псевдонимы: vm
zone строка		Имя зоны, в которой должно находиться правило. Если не задано, используется зона по умолчанию.

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация считывается из нескольких источников в следующем порядке. CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT переменные окружения. CLOUDSTACK_CONFIG переменная окружения, указывающая на файл .ini. Файл cloudstack.ini в текущей рабочей директории. Файл .cloudstack.ini в домашней директории пользователя. Допускается указание нескольких учетных данных и конечных точек с помощью разделов ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется cloudstack. Более подробную информацию см. на https://github.com/exoscale/cs.
Подробное руководство по модулям 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 строка	success	Аккаунт, к которому относится правило. Пример: примерный аккаунт
algorithm строка	success	Используемый алгоритм балансировки нагрузки. Пример: source
cidr строка	success	CIDR для переадресации трафика. Пример: 0.0.0.0/0
description строка	success	Описание правила. Пример: правило балансировки нагрузки http
domain строка	success	Домен, к которому относится правило. Пример: примерный домен
id строка	success	UUID правила. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f
name строка	success	Имя правила. Пример: http-lb
private_port целое число	success	Приватный IP-адрес. Пример: 80
project строка	success	Имя проекта, к которому относится правило. Пример: Производство
protocol строка	success	Протокол правила. Пример: tcp
public_ip строка	success	Общедоступный IP-адрес. Пример: 1.2.3.4
public_port целое число	success	Общедоступный порт. Пример: 80
state строка	success	Состояние правила. Пример: Добавить
tags список / элементы=строка	success	Список меток ресурсов, связанных с правилом. Пример: [ { "key": "foo", "value": "bar" } ]
vms список / элементы=строка	success	Члены правила. Пример: [ "web01", "web02" ]
zone строка	success	Имя зоны, к которой относится правило. Пример: ch-gva-2

Авторы

Darren Worrall (@dazworrall)
René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ngine_io/cloudstack/cs_loadbalancer_rule_member_module.html