Модуль cloudscale_ch.cloud.load_balancer_pool_member — управление участниками пула балансировщика нагрузки в сервисе 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_member.
Добавлено в cloudscale_ch.cloud 2.3.0
Обзор
- Получение, создание, обновление и удаление участников пула в сервисе IaaS cloudscale.ch.
Параметры
Параметр | Комментарии |
|---|---|
address string | IP-адрес, на который направляется трафик. |
api_timeout integer | Тайм-аут в секундах для вызовов API cloudscale.ch. Это значение также можно передать через переменную среды По умолчанию: |
api_token string / обязательный | Токен API cloudscale.ch. Это значение также можно передать через переменную среды |
api_url string добавлено в cloudscale_ch.cloud 1.3.0 | URL API cloudscale.ch. Это значение также можно передать через переменную среды По умолчанию: |
enabled boolean | Если значение равно false, участник пула не будет получать трафик. По умолчанию — true. Варианты:
|
load_balancer_pool string | UUID пула балансировщика нагрузки. |
monitor_port integer | Порт, на который отправляются проверки монитора состояния. Если не указан, используется protocol_port. Значение по умолчанию — null. |
name string | Имя участника пула балансировщика нагрузки. Необходимо указать либо name, либо uuid. |
protocol_port integer | Порт, на который отправляется фактический трафик. |
state string | Состояние участника пула балансировщика нагрузки. Варианты:
|
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 string | IP-адрес, на который направляется трафик Возвращается: при успешном выполнении Пример: |
created_at string | Дата и время создания участника пула балансировщика нагрузки Возвращается: при успешном выполнении, если state != absent Пример: |
enabled boolean | Состояние участника пула балансировщика нагрузки Возвращается: при успешном выполнении Пример: |
href string | URL API для получения сведений об этом балансировщике нагрузки Возвращается: при успешном выполнении, если state != absent Пример: |
monitor_port integer | Порт, на который отправляются проверки монитора состояния Возвращается: при успешном выполнении Пример: |
monitor_status string | Состояние проверки монитора состояния пула для этого участника Возвращается: при успешном выполнении Пример: |
name string | Отображаемое имя участника пула балансировщика нагрузки Возвращается: при успешном выполнении Пример: |
pool dictionary | Пул, к которому относится участник Возвращается: при успешном выполнении Пример: |
protocol_port integer | Порт, на который отправляется фактический трафик Возвращается: при успешном выполнении Пример: |
subnet dictionary | Подсеть частной сети, в которой находится адрес Возвращается: при успешном выполнении Пример: |
tags dictionary | Теги, связанные с балансировщиком нагрузки Возвращается: при успешном выполнении Пример: |
uuid string | Уникальный идентификатор этого участника пула балансировщика нагрузки Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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_member_module.html
