Spec-Zone.ru › Ansible

Модуль ngine_io.cloudstack.lb_rule — управление правилами балансировки нагрузки в облаках на базе Apache CloudStack.

Примечание

Этот модуль входит в коллекцию ngine_io.cloudstack (версия 3.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для работы с этим модулем необходимы дополнительные требования. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: ngine_io.cloudstack.lb_rule.

Добавлено в ngine_io.cloudstack 0.1.0

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

Краткое описание

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

Псевдонимы: cs_loadbalancer_rule

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр

Комментарии

account

string

Учетная запись, к которой относится правило.

algorithm

string

Алгоритм балансировки нагрузки

Обязателен при использовании state=present.

Варианты:

  • "source" ← (по умолчанию)
  • "roundrobin"
  • "leastconn"

api_http_method

string

Метод HTTP, используемый для запроса конечной точки API.

Если параметр не указан, используется переменная среды CLOUDSTACK_METHOD.

Варианты:

  • "get" ← (по умолчанию)
  • "post"

api_key

string / обязательный

Ключ API CloudStack.

Если параметр не указан, используется переменная среды CLOUDSTACK_KEY.

api_secret

string / обязательный

Секретный ключ API CloudStack.

Если параметр не задан, используется переменная среды CLOUDSTACK_SECRET.

api_timeout

integer

Тайм-аут HTTP в секундах.

Если параметр не указан, используется переменная среды CLOUDSTACK_TIMEOUT.

По умолчанию: 10

api_url

string / обязательный

URL API CloudStack, например https://cloud.example.com/client/api.

Если параметр не указан, используется переменная среды CLOUDSTACK_ENDPOINT.

api_verify_ssl_cert

string

Проверка файла сертификата центра сертификации.

Если параметр не указан, используется переменная среды CLOUDSTACK_VERIFY.

cidr

string

Сеть в полной CIDR-нотации, используемая для правила межсетевого экрана, если это необходимо.

description

string

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

domain

string

Домен, к которому относится правило.

ip_address

псевдонимы: public_ip

string / обязательный

Публичный IP-адрес, с которого будет распределяться сетевой трафик.

name

string / обязательный

Имя правила балансировки нагрузки.

network

string

Имя сети.

open_firewall

boolean

Следует ли создать правило межсетевого экрана для публичного порта при создании нового правила.

Для управления правилами межсетевого экрана используйте ngine_io.cloudstack.cs_firewall.

Варианты:

  • false ← (по умолчанию)
  • true

poll_async

boolean

Опрос асинхронных заданий до их завершения.

Варианты:

  • false
  • true ← (по умолчанию)

private_port

integer

Приватный порт приватного IP-адреса или виртуальной машины, на который будет направляться сетевой трафик.

Обязателен при использовании state=present.

После создания правила значение нельзя изменить из-за ограничения API.

project

string

Имя проекта, к которому относится IP-адрес балансировщика нагрузки.

protocol

string

Протокол, используемый балансировщиком нагрузки

public_port

integer

Публичный порт, с которого будет распределяться сетевой трафик.

Обязателен при использовании state=present.

После создания правила значение нельзя изменить из-за ограничения API.

state

string

Состояние правила.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

псевдонимы: tag

list / elements=dictionary

Список тегов. Теги представляют собой список словарей с ключами key и value.

Чтобы удалить все теги, задайте пустой список, например tags: [].

validate_certs

boolean

добавлено в ngine_io.cloudstack 2.4.0

Если значение false, сертификаты SSL не проверяются.

Если параметр не указан, используется переменная среды CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY.

Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами.

Варианты:

  • false
  • true ← (по умолчанию)

vpc

string

Имя VPC.

zone

string

Имя зоны, в которой следует создать правило.

Обязателен, если поставщик балансировки нагрузки — ElasticLoadBalancerVm

Примечания

Примечание

  • Подробное руководство по модулям CloudStack см. в руководстве по облаку CloudStack.
  • Этот модуль поддерживает режим проверки.

Примеры

- name: Create a load balancer rule
  ngine_io.cloudstack.lb_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.lb_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.lb_rule:
    name: balance_http
    public_ip: 1.2.3.4
    state: absent

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

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

Ключ

Описание

account

string

Учетная запись, к которой относится правило.

Возвращается: при успехе

Пример: "example account"

algorithm

string

Используемый алгоритм балансировки нагрузки.

Возвращается: при успехе

Пример: "source"

cidr

string

CIDR, из которой перенаправляется трафик.

Возвращается: при успехе

Пример: "0.0.0.0/0"

description

string

Описание правила.

Возвращается: при успехе

Пример: "http load balancer rule"

domain

string

Домен, к которому относится правило.

Возвращается: при успехе

Пример: "example domain"

id

string

UUID правила.

Возвращается: при успехе

Пример: "a6f7a5fc-43f8-11e5-a151-feff819cdc9f"

name

string

Имя правила.

Возвращается: при успехе

Пример: "http-lb"

private_port

integer

Приватный IP-адрес.

Возвращается: при успехе

Пример: 80

project

string

Имя проекта, к которому относится правило.

Возвращается: при успехе

Пример: "Production"

protocol

string

Протокол правила.

Возвращается: при успехе

Пример: "tcp"

public_ip

string

Публичный IP-адрес.

Возвращается: при успехе

Пример: "1.2.3.4"

public_port

integer

Публичный порт.

Возвращается: при успехе

Пример: 80

state

string

Состояние правила.

Возвращается: при успехе

Пример: "Add"

tags

list / elements=string

Список тегов ресурса, связанных с правилом.

Возвращается: при успехе

Пример: ["[ { \"key\": \"foo\"", " \"value\": \"bar\" } ]"]

zone

string

Имя зоны, к которой относится правило.

Возвращается: при успехе

Пример: "ch-gva-2"

Авторы

  • Darren Worrall (@dazworrall)
  • René Moser (@resmo)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ngine_io/cloudstack/lb_rule_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API