cs_loadbalancer_rule_member - Управляет членами правил балансировки нагрузки на облаках на основе Apache CloudStack.
Новое в версии 2.0.
- Обзор
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Добавление и удаление членов правил балансировки нагрузки.
Требования (для хоста, на котором выполняется модуль)
- python >= 2.6
- cs >= 0.6.10
Параметры
| параметр | обязательный | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| account | нет | Аккаунт, к которому относится правило. | ||
| 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. | ||
| domain | нет | Домен, к которому относится правило. | ||
| ip_address | нет | Общедоступный IP-адрес, с которого будет осуществляться балансировка сетевого трафика. Необходим только для поиска правила, если name не уникален.псевдонимы: public_ip | ||
| name | да | Имя правила балансировки. | ||
| project | нет | Имя проекта, к которому относится правило брандмауэра. | ||
| state | нет | present |
| Виртуальные машины должны присутствовать или отсутствовать в правиле. |
| vms | да | Список ВМ для назначения или удаления из правила. псевдонимы: vm | ||
| zone | нет | Имя зоны, в которой должно находиться правило. Если не задано, используется зона по умолчанию. |
Примеры
# 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 | Аккаунт, к которому относится правило. | успех | строка | примерный аккаунт |
| algorithm | Используемый алгоритм балансировки. | успех | строка | источник |
| 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" } ] |
| vms | Члены правила. | успех | список | [ "web01", "web02" ] |
| 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_member_module.html