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

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

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

Обзор

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

Требования

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

python >= 2.6
cs >= 0.6.10

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
account строка		Аккаунт, к которому относится правило.
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, см. примечания.
domain строка		Домен, к которому относится правило.
ip_address строка		Публичный IP-адрес, с которого будет осуществляться балансировка сетевого трафика. Необходим только для поиска правила, если name не уникален. псевдонимы: public_ip
name строка / обязательно		Имя правила балансировки нагрузки.
poll_async логическое значение	Варианты: нет да ←	Ожидать завершения асинхронных задач.
project строка		Имя проекта, к которому относится правило брандмауэра.
state строка	Варианты: present ← absent	Виртуальные машины должны быть присутствовать или отсутствовать в правиле.
vms список / обязательно		Список ВМ для назначения или удаления из правила. псевдонимы: vm
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: Add VMs to an existing load balancer
  cs_loadbalancer_rule_member:
    name: balance_http
    vms:
      - web01
      - web02
  delegate_to: localhost

- name: Remove a VM from an existing load balancer
  cs_loadbalancer_rule_member:
    name: balance_http
    vms:
      - web01
      - web02
    state: absent
  delegate_to: localhost

# Rolling upgrade of hosts
- hosts: webservers
  serial: 1
  pre_tasks:
    - name: Remove from load balancer
      cs_loadbalancer_rule_member:
        name: balance_http
        vm: "{{ ansible_hostname }}"
        state: absent
      delegate_to: localhost
  tasks:
    # Perform update
  post_tasks:
    - name: Add to load balancer
      cs_loadbalancer_rule_member:
        name: balance_http
        vm: "{{ ansible_hostname }}"
        state: present
      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 строка	успех	Название проекта, к которому относится правило. Пример: Производство
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

Статус

В этом модуле гарантируется отсутствие несовместимых с предыдущими версиями изменений интерфейса в дальнейшем. [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.8/modules/cs_loadbalancer_rule_member_module.html