Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции 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_member.

Новое в cloudscale_ch.cloud 2.3.0

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

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

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

Параметры

Параметр

Комментарии

address

string

IP-адрес, на который отправляется трафик.

api_timeout

integer

Тайм-аут в секундах для вызовов API cloudscale.ch.

Это также может быть передано в переменной окружения CLOUDSCALE_API_TIMEOUT.

Значение по умолчанию: 45

api_token

string / required

Токен 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"

enabled

boolean

Член пула не будет получать трафик, если значение false. По умолчанию true.

Варианты:

  • false
  • true ← (по умолчанию)

load_balancer_pool

string

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

monitor_port

integer

Порт, на который отправляются проверки монитора работоспособности.

Если не указан, будет использован protocol_port. По умолчанию null.

name

string

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

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

protocol_port

integer

Порт, на который отправляется фактический трафик.

state

string

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

Варианты:

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

subnet

string

Подсеть адреса должна быть указана здесь.

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 member for a load balancer pool using registered variables
- name: Create a load balancer pool
  cloudscale_ch.cloud.load_balancer_pool:
    name: 'swimming-pool'
    load_balancer: '514064c2-cfd4-4b0c-8a4b-c68c552ff84f'
    algorithm: 'round_robin'
    protocol: 'tcp'
    tags:
      project: ansible-test
      stage: production
      sla: 24-7
    api_token: xxxxxx
  register: load_balancer_pool

- name: Create a load balancer pool member
  cloudscale_ch.cloud.load_balancer_pool_member:
    name: 'my-shiny-swimming-pool-member'
    load_balancer_pool: '{{ load_balancer_pool.uuid }}'
    enabled: true
    protocol_port: 8080
    monitor_port: 8081
    subnet: '70d282ab-2a01-4abb-ada5-34e56a5a7eee'
    address: '172.16.0.100'
    tags:
      project: ansible-test
      stage: production
      sla: 24-7
    api_token: xxxxxx

# Get load balancer pool member facts by name
- name: Get facts of a load balancer pool member by name
  cloudscale_ch.cloud.load_balancer_pool_member:
    name: 'my-shiny-swimming-pool-member'
    api_token: xxxxxx

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

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

Ключ

Описание

address

строка

IP-адрес, на который отправляется трафик

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

Пример: "10.11.12.3"

created_at

строка

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

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

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

enabled

булево

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

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

Пример: true

href

строка

URL API для получения деталей о данном балансировщике нагрузки

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

Пример: "https://api.cloudscale.ch/v1/load-balancers/pools/20a7eb11-3e17-4177-b46d-36e13b101d1c/members/b9991773-857d-47f6-b20b-0a03709529a9"

monitor_port

целое число

Порт, на который отправляются проверки мониторинга работоспособности

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

Пример: 8081

monitor_status

строка

Состояние проверки мониторинга работоспособности пула для данного члена

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

Пример: "up"

name

строка

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

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

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

pool

словарь

Пул, к которому принадлежит член

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

Пример: {"href": "https://api.cloudscale.ch/v1/load-balancers/pools/20a7eb11-3e17-4177-b46d-36e13b101d1c", "name": "web-lb-pool", "uuid": "20a7eb11-3e17-4177-b46d-36e13b101d1c"}

protocol_port

целое число

Порт, на который отправляется фактический трафик

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

Пример: 8080

subnet

словарь

Подсеть в частной сети, в которой находится адрес

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

Пример: {"cidr": "10.11.12.0/24", "href": "https://api.cloudscale.ch/v1/subnets/70d282ab-2a01-4abb-ada5-34e56a5a7eee", "uuid": "70d282ab-2a01-4abb-ada5-34e56a5a7eee"}

tags

словарь

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

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

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

uuid

строка

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

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

Пример: "cfde831a-4e87-4a75-960f-89b0148aa2cc"

Авторы

  • 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_member_module.html

Spec-Zone.ru

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