Spec-Zone.ru › Ansible

Модуль cloudscale_ch.cloud.load_balancer_pool — Управление пулами балансировщиков нагрузки на сервисе cloudscale.ch IaaS

Примечание

Этот модуль входит в коллекцию cloudscale_ch.cloud (версия 2.4.0).

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

Для установки используйте: ansible-galaxy collection install cloudscale_ch.cloud.

Для использования в playbook укажите: cloudscale_ch.cloud.load_balancer_pool.

Добавлен в cloudscale_ch.cloud 2.3.0

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Получение, создание, обновление и удаление пулов на сервисе cloudscale.ch IaaS.

Параметры

Параметр

Комментарии

algorithm

строка

Алгоритм распределения входящего трафика между членами пула.

См. [документацию API](https://www.cloudscale.ch/ru/api/v1#pool-algorithms) для поддерживаемых алгоритмов распределения.

api_timeout

целое число

Таймаут в секундах для обращений к API cloudscale.ch.

Также может быть передан в переменной среды CLOUDSCALE_API_TIMEOUT.

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

api_token

строка / обязательно

Токен API cloudscale.ch.

Также может быть передан в переменной среды CLOUDSCALE_API_TOKEN.

api_url

строка

Добавлен в cloudscale_ch.cloud 1.3.0

URL API cloudscale.ch.

Также может быть передан в переменной среды CLOUDSCALE_API_URL.

По умолчанию: "https://api.cloudscale.ch/v1"

load_balancer

строка

UUID балансировщика нагрузки для данного пула.

name

строка

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

protocol

строка

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

См. [документацию API](https://www.cloudscale.ch/ru/api/v1#pool-protocols) для поддерживаемых протоколов.

state

строка

Состояние пула балансировщика нагрузки.

Варианты:

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

tags

словарь

Теги, связанные с балансировщиком нагрузки. Установите значение {} для удаления всех тегов.

uuid

строка

UUID пула балансировщика нагрузки.

Требуется либо name, либо uuid.

Примечания

Примечание

  • Если указан параметр uuid, он имеет приоритет над name при выборе пула. Это позволяет обновить имя пула балансировщика нагрузки.
  • Если параметр uuid не указан, используется name для выбора пула. Если существует более одного пула с этим именем, выполнение прерывается.
  • Все операции выполняются с использованием публичного API v1 cloudscale.ch.
  • Для получения подробностей обратитесь к полной документации API: https://www.cloudscale.ch/ru/api/v1.
  • Для всех операций необходим действительный токен API. Вы можете создать любое количество токенов с помощью панели управления cloudscale.ch по адресу https://control.cloudscale.ch.

Примеры

# Create a pool for a load balancer using registered variables
- name: Create a running load balancer
  cloudscale_ch.cloud.load_balancer:
    name: 'lb1'
    flavor: 'lb-standard'
    zone: 'lpg1'
    tags:
      project: ansible-test
      stage: production
      sla: 24-7
    api_token: xxxxxx
  register: load_balancer

- name: Create a load balancer pool
  cloudscale_ch.cloud.load_balancer_pool:
    name: 'swimming-pool'
    load_balancer: '{{ load_balancer.uuid }}'
    algorithm: 'round_robin'
    protocol: 'tcp'
    tags:
      project: ansible-test
      stage: production
      sla: 24-7
    api_token: xxxxxx
  register: load_balancer_pool

# Create a load balancer pool with algorithm: round_robin and protocol: tcp
- name: Create a load balancer pool
  cloudscale_ch.cloud.load_balancer_pool:
    name: 'cloudscale-loadbalancer-pool1'
    load_balancer: '3766c579-3012-4a85-8192-2bbb4ef85b5f'
    algorithm: 'round_robin'
    protocol: 'tcp'
    tags:
      project: ansible-test
      stage: production
      sla: 24-7
    api_token: xxxxxx

# Get load balancer pool facts by name
- name: Get facts of a load balancer pool
  cloudscale_ch.cloud.load_balancer_pool:
    name: cloudscale-loadbalancer-pool1
    api_token: xxxxxx

Значения возврата

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

Ключ

Описание

algorithm

строка

Алгоритм распределения входящего трафика между членами пула.

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

Пример: "round_robin"

created_at

строка

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

Возвращается: успех, когда state != absent

Пример: "2023-02-07T15:32:02.308041Z"

href

строка

API-адрес для получения подробной информации о балансировщике нагрузки.

Возвращается: успех, когда state != absent

Пример: "https://api.cloudscale.ch/v1/load-balancers/pools/"

load_balancer

список / элементы=строка

Балансировщик нагрузки, к которому подключен этот пул.

Возвращается: успех, когда state != absent

Пример: {"href": "https://api.cloudscale.ch/v1/load-balancers/15264769-ac69-4809-a8e4-4d73f8f92496", "name": "web-lb", "uuid": "15264769-ac69-4809-a8e4-4d73f8f92496"}

name

строка

Отображаемое имя пула балансировщика нагрузки.

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

Пример: "web-lb-pool1"

protocol

строка

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

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

Пример: "tcp"

state

строка

Текущее состояние пула балансировщика нагрузки.

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

Пример: "present"

tags

словарь

Теги, связанные с балансировщиком.

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

Пример: {"project": "my project"}

uuid

строка

Уникальный идентификатор этого пула балансировщика нагрузки.

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

Пример: "3766c579-3012-4a85-8192-2bbb4ef85b5f"

Авторы

  • Gaudenz Steinlin (@gaudenz)
  • Kenneth Joss (@k-304)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cloudscale_ch/cloud/load_balancer_pool_module.html

Spec-Zone.ru

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