Модуль cloudscale_ch.cloud.load_balancer – Управление балансировщиками нагрузки на облачной платформе cloudscale.ch IaaS

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет 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

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

Обзор

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

Параметры

Параметр	Комментарии
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/ru/api/v1#vip_addresses-attribute-specification).
address строка	Использовать этот адрес. Должен находиться в том же диапазоне, что и подсеть. Если пусто, будет использован случайный адрес.
subnet строка	Создать VIP-адрес в подсети, идентифицируемой этим UUID.
zone строка	Зона, в которой находится балансировщик нагрузки (например, `lpg1` или `rma1`).

Примечания

Примечание

Если параметр uuid указан, он имеет приоритет над name при выборе балансировщика. Это позволяет обновить имя балансировщика.
Если параметр uuid не указан, используется name для выбора балансировщика. Если существует более одного балансировщика с этим именем, выполнение прервётся.
Все операции выполняются с использованием публичного API v1 cloudscale.ch.
Для получения подробностей обратитесь к полной документации API: https://www.cloudscale.ch/ru/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 строка	API-URL для получения подробностей о балансировщике нагрузки Возвращается: успех, когда 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 для этого балансировщика нагрузки Возвращается: успех, когда 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–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_module.html