cs_loadbalancer_rule - Управляет правилами балансировщика нагрузки на облаках на основе Apache CloudStack.
Новое в версии 2.0.
- Обзор
- Требования (на хосте, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Добавление, обновление и удаление правил балансировщика нагрузки.
Требования (на хосте, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательно | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| account | нет | Аккаунт, к которому относится правило. | ||
| algorithm | нет | source |
| Алгоритм балансировщика нагрузки Требуется при использовании state=present. |
| api_http_method | нет | get |
| Используемый HTTP-метод. |
| api_key | нет | Ключ API CloudStack API. | ||
| api_region | нет | cloudstack | Имя раздела ini в файле cloustack.ini. | |
| api_secret | нет | Секретный ключ CloudStack API. | ||
| api_timeout | нет | 10 | Таймаут HTTP. | |
| api_url | нет | URL CloudStack API, например, https://cloud.example.com/client/api. | ||
| cidr | нет | CIDR (полная запись) для использования в правиле брандмауэра, если требуется. | ||
| description | нет | Описание правила балансировщика нагрузки. | ||
| domain | нет | Домен, к которому относится правило. | ||
| ip_address | да | Общедоступный IP-адрес, с которого будет происходить балансировка сетевого трафика. алиасы: public_ip | ||
| name | да | Имя правила балансировщика нагрузки. | ||
| open_firewall | нет | Создавать ли правило брандмауэра для общедоступного порта при создании нового правила? Используйте cs_firewall для управления правилами брандмауэра. | ||
| private_port | нет | Приватный порт приватного IP-адреса/виртуальной машины, к которому будет направляться сетевой трафик. Требуется при использовании state=present.Не может быть изменен после создания правила из-за ограничения API. | ||
| project | нет | Название проекта, к которому относится IP-адрес балансировщика. | ||
| protocol | нет | Используемый протокол на балансировщике. | ||
| public_port | да | Общедоступный порт, с которого будет происходить балансировка сетевого трафика. Требуется при использовании state=present.Не может быть изменен после создания правила из-за ограничения API. | ||
| state | да | present |
| Состояние правила. |
| zone | нет | Имя зоны, в которой должно быть создано правило. Если не задано, используется зона по умолчанию. |
Примеры
# 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 | Аккаунт, к которому относится правило. | успех | строка | пример аккаунта |
| algorithm | Используемый алгоритм балансировщика нагрузки. | успех | строка | source |
| cidr | CIDR для перенаправления трафика. | успех | строка | |
| 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 |
Примечания
Примечание
- 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 можно найти на http://docs.ansible.com/ansible/guide_cloudstack.html
- Этот модуль поддерживает режим проверки.
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет внесено обратных несовместимых изменений в интерфейс.
Для помощи в разработке модулей, если вы так захотите, пожалуйста, ознакомьтесь с Справочной информацией сообщества и участием в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_loadbalancer_rule_module.html
