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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: cloudscale_ch.cloud.load_balancer_pool.

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

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

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

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

Параметры

Параметр	Комментарии
algorithm string	Алгоритм распределения входящего трафика между участниками пула. Список поддерживаемых алгоритмов распределения см. в [документации API](https://www.cloudscale.ch/en/api/v1#pool-algorithms).
api_timeout integer	Время ожидания в секундах для вызовов API cloudscale.ch. Это значение также можно передать в переменной окружения `CLOUDSCALE_API_TIMEOUT`. По умолчанию: `45`
api_token string / обязательный	Токен API cloudscale.ch. Это значение также можно передать в переменной окружения `CLOUDSCALE_API_TOKEN`.
api_url string добавлено в cloudscale_ch.cloud 1.3.0	URL API cloudscale.ch. Это значение также можно передать в переменной окружения `CLOUDSCALE_API_URL`. По умолчанию: `"https://api.cloudscale.ch/v1"`
load_balancer string	UUID балансировщика нагрузки для этого пула.
name string	Имя пула балансировщика нагрузки.
protocol string	Протокол, используемый для передачи трафика между балансировщиком нагрузки и участниками пула. Список поддерживаемых протоколов см. в [документации API](https://www.cloudscale.ch/en/api/v1#pool-protocols).
state string	Состояние пула балансировщика нагрузки. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags dictionary	Теги, связанные с балансировщиком нагрузки. Установите значение `{}`, чтобы удалить все теги.
uuid string	UUID пула балансировщика нагрузки. Необходимо указать либо name, либо uuid.

Примечания

Примечание

Если задан параметр uuid, он имеет приоритет над name при выборе пула. Это позволяет изменить имя пула балансировщика нагрузки.
Если параметр uuid не задан, для выбора пула используется name. Если существует несколько пулов с таким именем, выполнение прерывается.
Все операции выполняются с использованием публичного API cloudscale.ch v1.
Подробную информацию см. в полной документации API: https://www.cloudscale.ch/en/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 string	Алгоритм распределения входящего трафика между участниками пула Возвращается: при успешном выполнении Пример: `"round_robin"`
created_at string	Дата и время создания пула балансировщика нагрузки Возвращается: при успешном выполнении, если state != absent Пример: `"2023-02-07T15:32:02.308041Z"`
href string	URL API для получения подробной информации об этом балансировщике нагрузки Возвращается: при успешном выполнении, если state != absent Пример: `"https://api.cloudscale.ch/v1/load-balancers/pools/"`
load_balancer list / элементы=string	Балансировщик нагрузки, к которому подключён этот пул Возвращается: при успешном выполнении, если 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 string	Отображаемое имя пула балансировщика нагрузки Возвращается: при успешном выполнении Пример: `"web-lb-pool1"`
protocol string	Протокол, используемый для передачи трафика между балансировщиком нагрузки и участниками пула Возвращается: при успешном выполнении Пример: `"tcp"`
state string	Текущее состояние пула балансировщика нагрузки Возвращается: при успешном выполнении Пример: `"present"`
tags dictionary	Теги, связанные с балансировщиком нагрузки Возвращается: при успешном выполнении Пример: `{"project": "my project"}`
uuid string	Уникальный идентификатор этого пула балансировщика нагрузки Возвращается: при успешном выполнении Пример: `"3766c579-3012-4a85-8192-2bbb4ef85b5f"`

Авторы

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

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

© 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/cloudscale_ch/cloud/load_balancer_pool_module.html