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

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

Синопсис

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится правило.
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 строка		CIDR (полный формат) для использования в правиле брандмауэра, если необходимо.
description строка		Описание правила балансировки нагрузки.
domain строка		Домен, к которому относится правило.
ip_address строка / обязательно		Общедоступный IP-адрес, с которого будет осуществляться балансировка сетевого трафика. Псевдонимы: public_ip
name строка / обязательно		Название правила балансировки нагрузки.
network строка добавлено в 2.9		Имя сети.
open_firewall логическое значение	Варианты: нет ← да	Создавать ли правило брандмауэра для публичного порта при создании нового правила. Используйте cs_firewall для управления правилами брандмауэра.
poll_async логическое значение	Варианты: нет да ←	Выполнять опрос асинхронных задач до завершения.
private_port целое число		Приватный порт приватного IP-адреса/виртуальной машины, на который будет балансироваться сетевой трафик. Требуется при использовании state=present. Не может быть изменён после создания правила из-за ограничений API.
project строка		Имя проекта, к которому относится IP-адрес балансировщика.
protocol строка		Протокол, используемый балансировщиком.
public_port целое число / обязательно		Общедоступный порт, с которого будет осуществляться балансировка сетевого трафика. Требуется при использовании state=present. Не может быть изменён после создания правила из-за ограничений API.
state строка	Варианты: present ← absent	Состояние правила.
tags список		Список тегов. Теги — список словарей с ключами key и value. Для удаления всех тегов установите пустой список, например, tags: []. Псевдонимы: tag
vpc строка добавлено в 2.9		Имя VPC.
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: Create a load balancer rule
  cs_loadbalancer_rule:
    name: balance_http
    public_ip: 1.2.3.4
    algorithm: leastconn
    public_port: 80
    private_port: 8080
  delegate_to: localhost

- name: Update algorithm of an existing load balancer rule
  cs_loadbalancer_rule:
    name: balance_http
    public_ip: 1.2.3.4
    algorithm: roundrobin
    public_port: 80
    private_port: 8080
  delegate_to: localhost

- name: Delete a load balancer rule
  cs_loadbalancer_rule:
    name: balance_http
    public_ip: 1.2.3.4
    state: absent
  delegate_to: localhost

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

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

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

Авторы

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