Модуль cloudscale_ch.cloud.load_balancer_health_monitor — управление балансировщиками нагрузки в сервисе 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_health_monitor.

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

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

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

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

Параметры

Параметр	Комментарии
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"`
delay_s integer	Интервал в секундах между последовательными проверками.
down_threshold integer	Количество неудачных проверок, после которого значение monitor_status участника пула изменится на «down».
http dictionary	Дополнительные параметры проверок состояния типа «http» или «https».
expected_codes list / элементы=string	Коды состояния HTTP, при которых проверка считается успешной. Подробности см. в [документации API](https://www.cloudscale.ch/en/api/v1#http-attribute-specification).
host string	Имя сервера в заголовке HTTP Host, используемое при проверке. Для этого необходимо установить значение version равным «1.1».
method string	Метод HTTP, используемый при проверке.
url_path string	URL, используемый при проверке.
version string	Версия HTTP, используемая при проверке.
pool string	Пул проверки состояния.
state string	Состояние проверки состояния балансировщика нагрузки. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags dictionary	Теги, связанные с балансировщиком нагрузки. Укажите `{}`, чтобы удалить все теги.
timeout_s integer	Максимально допустимое время выполнения отдельной проверки в секундах.
type string	Тип проверки состояния. Допустимые варианты см. в [документации API](https://www.cloudscale.ch/en/api/v1#create-a-health-monitor).
up_threshold integer	Количество успешных проверок, после которого значение monitor_status участника пула изменится на «up».
uuid string	UUID проверки состояния балансировщика нагрузки.

Примечания

Примечание

У проверок состояния нет имён. Для ссылки на проверку используются значения uuid.
Все операции выполняются с помощью публичного API cloudscale.ch v1.
Подробную информацию см. в полной документации API: https://www.cloudscale.ch/en/api/v1.
Для выполнения любых операций необходим действительный токен API. Вы можете создавать любое количество токенов в панели управления cloudscale.ch по адресу https://control.cloudscale.ch.

Примеры

# Create a simple health monitor for a pool
- name: Create a load balancer pool
  cloudscale_ch.cloud.load_balancer_pool:
    name: 'swimming-pool'
    load_balancer: '3d41b118-f95c-4897-ad74-2260fea783fc'
    algorithm: 'round_robin'
    protocol: 'tcp'
    api_token: xxxxxx
  register: load_balancer_pool

- name: Create a load balancer health monitor (ping)
  cloudscale_ch.cloud.load_balancer_health_monitor:
    pool: '{{ load_balancer_pool.uuid }}'
    type: 'ping'
    api_token: xxxxxx
  register: load_balancer_health_monitor

# Craete a udp health monitor for a udp pool
- name: Create a udp load balancer pool
  cloudscale_ch.cloud.load_balancer_pool:
    name: 'udp-pool'
    load_balancer: '3d41b118-f95c-4897-ad74-2260fea783fc'
    algorithm: 'round_robin'
    protocol: 'udp'
    api_token: xxxxxx
  register: udp_load_balancer_pool

- name: Create a udp load balancer health monitor (udp-connect)
  cloudscale_ch.cloud.load_balancer_health_monitor:
    pool: '{{ udp_load_balancer_pool.uuid }}'
    type: 'udp-connect'
    delay_s: 3
    timeout_s: 2
    api_token: xxxxxx
  register: udp_load_balancer_health_monitor

# Get load balancer health monitor facts by UUID
- name: Get facts of a load balancer health monitor by UUID
  cloudscale_ch.cloud.load_balancer_health_monitor:
    uuid: '{{ load_balancer_health_monitor.uuid }}'
    api_token: xxxxxx

# Update a health monitor
- name: Update HTTP method of a load balancer health monitor from GET to CONNECT
  cloudscale_ch.cloud.load_balancer_health_monitor:
    uuid: '{{ load_balancer_health_monitor_http.uuid }}'
    delay_s: 2
    timeout_s: 1
    up_threshold: 2
    down_threshold: 3
    type: 'http'
    http:
      expected_codes:
        - 200
        - 202
      method: 'CONNECT'
      url_path: '/'
      version: '1.1'
      host: 'host1'
    tags:
      project: ansible-test
      stage: production
      sla: 24-7
    api_token: xxxxxx
  register: load_balancer_health_monitor

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

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

Ключ	Описание
created_at string	Дата и время создания проверки состояния балансировщика нагрузки Возвращается: при успехе, если state != absent Пример: `"2023-02-22T09:55:38.285018Z"`
delay_s integer	Интервал в секундах между последовательными проверками Возвращается: при успехе, если state != absent Пример: `2`
down_threshold integer	Количество неудачных проверок, после которого значение monitor_status участника пула изменится на «down» Возвращается: при успехе, если state != absent Пример: `3`
href string	URL API для получения подробной информации об этой проверке состояния балансировщика нагрузки Возвращается: при успехе, если state != absent Пример: `"https://api.cloudscale.ch/v1/load-balancers/health-monitors/ee4952d4-2eba-4dec-8957-7911b3ce245b"`
http dictionary	Дополнительные параметры проверок состояния типа «http» или «https» Возвращается: при успехе, если state != absent Пример: `[{"expected_codes": ["200"], "host": null, "method": "GET", "url_path": "/", "version": "1.0"}]`
pool dictionary	Пул проверки состояния Возвращается: при успехе, если state != absent Пример: `[{"href": "https://api.cloudscale.ch/v1/load-balancers/pools/618a6cc8-d757-4fab-aa10-d49dc47e667b"}, {"uuid": "618a6cc8-d757-4fab-aa10-d49dc47e667b"}, {"name": "swimming pool"}]`
tags dictionary	Теги, связанные с балансировщиком нагрузки Возвращается: при успехе Пример: `{"project": "my project"}`
timeout_s integer	Максимально допустимое время выполнения отдельной проверки в секундах Возвращается: при успехе, если state != absent Пример: `1`
type string	Тип проверки состояния Возвращается: при успехе, если state != absent
up_threshold integer	Количество успешных проверок, после которого значение monitor_status участника пула изменится на «up» Возвращается: при успехе, если state != absent Пример: `2`
uuid string	Уникальный идентификатор этой проверки состояния балансировщика нагрузки Возвращается: при успехе Пример: `"ee4952d4-2eba-4dec-8957-7911b3ce245b"`

Авторы

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_health_monitor_module.html