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

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

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

Обзор

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account	Значение по умолчанию: None	Аккаунт, к которому относится правило.
algorithm	Варианты: source ← roundrobin leastconn	Алгоритм балансировки нагрузки Требуется при использовании `state=present`.
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		Секретный ключ 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, см. также примечания.
cidr	Значение по умолчанию: None	CIDR (полная запись), используемый для правила брандмауэра, если требуется.
description	Значение по умолчанию: None	Описание правила балансировки нагрузки.
domain	Значение по умолчанию: None	Домен, к которому относится правило.
ip_address обязательно		Общедоступный IP-адрес, с которого будет осуществляться балансировка сетевого трафика. Псевдонимы: public_ip
name обязательно		Имя правила балансировки нагрузки.
open_firewall	Значение по умолчанию: no	Создавать ли правило брандмауэра для общедоступного порта при создании нового правила. Для управления правилами брандмауэра используйте cs_firewall.
private_port	Значение по умолчанию: None	Приватный порт приватного IP-адреса/виртуальной машины, на который будет осуществляться балансировка сетевого трафика. Требуется при использовании `state=present`. Не может быть изменен после создания правила из-за ограничений API.
project	Значение по умолчанию: None	Название проекта, к которому относится IP-адрес балансировки нагрузки.
protocol	Значение по умолчанию: None	Протокол, используемый для балансировки нагрузки.
public_port обязательно	Значение по умолчанию: None	Общедоступный порт, с которого будет осуществляться балансировка сетевого трафика. Требуется при использовании `state=present`. Не может быть изменен после создания правила из-за ограничений API.
state обязательно	Варианты: present ← absent	Состояние правила.
zone	Значение по умолчанию: None	Имя зоны, в которой должно быть создано правило. Если не задано, используется зона по умолчанию.

Примечания

Примечание

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.
Этот модуль поддерживает режим проверки.

Примеры

# Create a load balancer rule
- local_action:
    module: cs_loadbalancer_rule
    name: balance_http
    public_ip: 1.2.3.4
    algorithm: leastconn
    public_port: 80
    private_port: 8080

# update algorithm of an existing load balancer rule
- local_action:
    module: cs_loadbalancer_rule
    name: balance_http
    public_ip: 1.2.3.4
    algorithm: roundrobin
    public_port: 80
    private_port: 8080

# Delete a load balancer rule
- local_action:
    module: cs_loadbalancer_rule
    name: balance_http
    public_ip: 1.2.3.4
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
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" } ]
zone строка	успех	Название зоны, к которой относится правило. Пример: ch-gva-2

Статус

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

Автор

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.5/modules/cs_loadbalancer_rule_module.html