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

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

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

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

Получение, создание, обновление и удаление балансировщиков нагрузки в облачной службе IaaS cloudscale.ch.

Параметры

Параметр	Комментарии
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"`
flavor строка	Тип балансировщика нагрузки. По умолчанию: `"lb-standard"`
name строка	Имя балансировщика нагрузки. Необходимо указать либо name, либо uuid.
state строка	Состояние балансировщика нагрузки. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags словарь	Теги, связанные с балансировщиком нагрузки. Укажите `{}`, чтобы удалить все теги.
uuid строка	UUID балансировщика нагрузки. Необходимо указать либо name, либо uuid.
vip_addresses список / элементы=словарь	Подробную информацию об этом параметре см. в [документации API](https://www.cloudscale.ch/en/api/v1#vip_addresses-attribute-specification).
address строка	Использовать этот адрес. Адрес должен принадлежать тому же диапазону, что и подсеть. Если значение не указано, будет использоваться случайный адрес.
subnet строка	Создать VIP-адрес в подсети с указанным UUID.
zone строка	Зона, в которой находится балансировщик нагрузки (например, `lpg1` или `rma1`).

Примечания

Примечание

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

Примеры

# Create and start a load balancer
- name: Start cloudscale.ch load balancer
  cloudscale_ch.cloud.load_balancer:
    name: my-shiny-cloudscale-load-balancer
    flavor: lb-standard
    zone: rma1
    tags:
      project: my project
    api_token: xxxxxx

# Create and start a load balancer with specific subnet
- name: Start cloudscale.ch load balancer
  cloudscale_ch.cloud.load_balancer:
    name: my-shiny-cloudscale-load-balancer
    flavor: lb-standard
    vip_addresses:
      - subnet: d7b82c9b-5900-436c-9296-e94dca01c7a0
        address: 172.25.12.1
    zone: lpg1
    tags:
      project: my project
    api_token: xxxxxx

# Get load balancer facts by name
- name: Get facts of a load balancer
  cloudscale_ch.cloud.load_balancer:
    name: my-shiny-cloudscale-load-balancer
    api_token: xxxxxx

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

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

Ключ	Описание
created_at строка	Дата и время создания балансировщика нагрузки Возвращается: при успешном выполнении, если state != absent Пример: `"2023-02-07T15:32:02.308041Z"`
flavor список / элементы=строка	Тип, использованный для этого балансировщика нагрузки Возвращается: при успешном выполнении, если state != absent Пример: `{"name": "LB-Standard", "slug": "lb-standard"}`
href строка	URL API для получения сведений об этом балансировщике нагрузки Возвращается: при успешном выполнении, если state != absent Пример: `"https://api.cloudscale.ch/v1/load-balancers/0f62e0a7-f459-4fc4-9c25-9e57b6cb4b2f"`
name строка	Отображаемое имя балансировщика нагрузки Возвращается: при успешном выполнении Пример: `"web-lb"`
state строка	Текущее состояние балансировщика нагрузки Возвращается: при успешном выполнении Пример: `"present"`
status строка	Текущий рабочий статус балансировщика нагрузки Возвращается: при успешном выполнении Пример: `"running"`
tags словарь	Теги, связанные с балансировщиком нагрузки Возвращается: при успешном выполнении Пример: `{"project": "my project"}`
uuid строка	Уникальный идентификатор этого балансировщика нагрузки Возвращается: при успешном выполнении Пример: `"cfde831a-4e87-4a75-960f-89b0148aa2cc"`
vip_addresses словарь	Список vip_addresses для этого балансировщика нагрузки Возвращается: при успешном выполнении, если state != absent Пример: `[{"address": "192.0.2.110", "subnet": [{"href": "https://api.cloudscale.ch/v1/subnets/92c70b2f-99cb-4811-8823-3d46572006e4"}, {"uuid": "92c70b2f-99cb-4811-8823-3d46572006e4"}, {"cidr": "192.0.2.0/24"}], "version": "4"}]`
zone словарь	Зона, используемая для этого балансировщика нагрузки Возвращается: при успешном выполнении, если state != absent Пример: `{"slug": "lpg1"}`

Авторы

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