ngine_io.cloudstack.cs_loadbalancer_rule – Управляет правилами балансировки нагрузки в облаках на основе Apache CloudStack.
Примечание
Этот плагин входит в сборку ngine_io.cloudstack (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack
Для использования в книге задач укажите: ngine_io.cloudstack.cs_loadbalancer_rule
В версии 0.1.0: сборки ngine_io.cloudstack
Обзор
- Добавление, обновление и удаление правил балансировки нагрузки.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Учетная запись, к которой относится правило. | |
| algorithm строка |
| Алгоритм балансировки нагрузки Требуется при использовании state=present. |
| api_http_method строка |
| HTTP-метод, используемый для запроса к API-точке. Если не указан, используется переменная среды CLOUDSTACK_METHOD. |
| api_key строка / обязательно | API-ключ CloudStack API. Если не указан, используется переменная среды CLOUDSTACK_KEY. | |
| api_secret строка / обязательно | Секретный ключ CloudStack API. Если не указан, используется переменная среды CLOUDSTACK_SECRET. | |
| api_timeout целое число | По умолчанию: 10 | Таймаут HTTP в секундах. Если не указан, используется переменная среды CLOUDSTACK_TIMEOUT. |
| api_url строка / обязательно | URL CloudStack API, например https://cloud.example.com/client/api. Если не указан, используется переменная среды CLOUDSTACK_ENDPOINT. | |
| api_verify_ssl_cert строка | Проверка сертификата CA. Если не указан, используется переменная среды CLOUDSTACK_VERIFY. | |
| cidr строка | CIDR (полная запись), используемый для правила брандмауэра, если требуется. | |
| description строка | Описание правила балансировки нагрузки. | |
| domain строка | Домен, к которому относится правило. | |
| ip_address строка / обязательно | Общедоступный IP-адрес, с которого будет осуществляться балансировка сетевого трафика. Псевдонимы: public_ip | |
| name строка / обязательно | Название правила балансировки нагрузки. | |
| network строка | Имя сети. | |
| open_firewall булево |
| Создавать ли правило брандмауэра для общедоступного порта при создании нового правила. Для управления правилами брандмауэра используйте cs_firewall. |
| poll_async булево |
| Опрашивать асинхронные задачи до завершения. |
| private_port целое число | Приватный порт приватного IP-адреса/виртуальной машины, на который будет балансироваться сетевой трафик. Требуется при использовании state=present. Не может быть изменён после создания правила из-за ограничений API. | |
| project строка | Имя проекта, к которому относится IP-адрес балансировщика. | |
| protocol строка | Протокол, используемый для балансировщика. | |
| public_port целое число | Общедоступный порт, с которого будет балансироваться сетевой трафик. Требуется при использовании state=present. Не может быть изменён после создания правила из-за ограничений API. | |
| state строка |
| Состояние правила. |
| tags список / элементы=словарь | Список тегов. Теги представляют собой список словарей с ключами key и value. Для удаления всех тегов установите пустой список, например, tags: []. Псевдонимы: tag | |
| vpc строка | Имя VPC. | |
| zone строка | Имя зоны, в которой должно быть создано правило. Требуется, если поставщик балансировщика – ElasticLoadBalancerVm. |
Примечания
Примечание
- Подробное руководство по модулям cloudstack можно найти в руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: Create a load balancer rule
ngine_io.cloudstack.cs_loadbalancer_rule:
name: balance_http
public_ip: 1.2.3.4
algorithm: leastconn
public_port: 80
private_port: 8080
- name: Update algorithm of an existing load balancer rule
ngine_io.cloudstack.cs_loadbalancer_rule:
name: balance_http
public_ip: 1.2.3.4
algorithm: roundrobin
public_port: 80
private_port: 8080
- name: Delete a load balancer rule
ngine_io.cloudstack.cs_loadbalancer_rule:
name: balance_http
public_ip: 1.2.3.4
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| account строка | успех | Учетная запись, к которой относится правило. Пример: пример учетной записи |
| algorithm строка | успех | Используемый алгоритм балансировки нагрузки. Пример: source |
| cidr строка | успех | CIDR для перенаправления трафика. Пример: 0.0.0.0/0 |
| description строка | успех | Описание правила. Пример: правило балансировки http |
| domain строка | успех | Домен, к которому относится правило. Пример: пример домена |
| id строка | успех | UUID правила. Пример: a6f7a5fc-43f8-11e5-a151-feff819cdc9f |
| name строка | успех | Имя правила. Пример: http-lb |
| private_port целое число | успех | Приватный IP-адрес. Пример: 80 |
| project строка | успех | Имя проекта, к которому относится правило. Пример: Производство |
| protocol строка | успех | Протокол правила. Пример: tcp |
| public_ip строка | успех | Общедоступный IP-адрес. Пример: 1.2.3.4 |
| public_port целое число | успех | Общедоступный порт. Пример: 80 |
| state строка | успех | Состояние правила. Пример: Добавление |
| tags список / элементы=строка | успех | Список тегов ресурсов, связанных с правилом. Пример: [ { "key": "foo", "value": "bar" } ] |
| zone строка | успех | Имя зоны, к которой относится правило. Пример: ch-gva-2 |
Авторы
- Darren Worrall (@dazworrall)
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_loadbalancer_rule_module.html
