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

Новая версия с 2.0.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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, также см. примечания.
domain		Домен, к которому относится правило.
ip_address		Общедоступный IP-адрес, с которого будет выполняться балансировка сетевого трафика. Необходим только для поиска правила, если `name` не уникален. Псевдонимы: public_ip
name обязательно		Имя правила балансировки нагрузки.
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.
Этот модуль поддерживает режим проверки.

Примеры

# Add VMs to an existing load balancer
- local_action:
    module: cs_loadbalancer_rule_member
    name: balance_http
    vms:
      - web01
      - web02

# Remove a VM from an existing load balancer
- local_action:
    module: 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
      local_action:
        module: cs_loadbalancer_rule_member
        name: balance_http
        vm: "{{ ansible_hostname }}"
        state: absent
  tasks:
    # Perform update
  post_tasks:
    - name: Add to load balancer
      local_action:
        module: cs_loadbalancer_rule_member
        name: balance_http
        vm: "{{ ansible_hostname }}"
        state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
account строка	успех	Аккаунт, к которому относится правило. Пример: example account
algorithm строка	успех	Используемый алгоритм балансировки нагрузки. Пример: source
cidr строка	успех	CIDR для перенаправления трафика.
description строка	успех	Описание правила. Пример: правило балансировки нагрузки HTTP
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

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики гарантируют, что не будут вноситься несовместимые изменения в интерфейс.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/cs_loadbalancer_rule_member_module.html