Модуль community.general.scaleway_lb — модуль управления балансировщиками нагрузки Scaleway

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.scaleway_lb.

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

Обзор

Этот модуль управляет балансировщиками нагрузки в Scaleway.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

PyYAML (если используется profile)

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout integer	Тайм-аут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token string	Токен OAuth Scaleway. Этот параметр обязателен, если не указан `profile`.
api_url псевдонимы: base_url string	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
description string / обязательный	Описание балансировщика нагрузки.
name string / обязательный	Имя балансировщика нагрузки.
organization_id string / обязательный	Идентификатор организации.
profile псевдонимы: scw_profile string добавлено в community.general 12.2.0	Профиль конфигурации из файла конфигурации, из которого загружается токен OAuth Scaleway; используется вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
query_parameters dictionary	Список параметров, передаваемых в строке запроса. По умолчанию: `{}`
region string / обязательный	Зона Scaleway. Варианты: `"nl-ams"` `"fr-par"` `"pl-waw"`
state string	Указывает желаемое состояние экземпляра. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags list / элементы типа string	Список тегов, которые нужно применить к балансировщику нагрузки. По умолчанию: `[]`
validate_certs boolean	Проверять SSL-сертификаты API Scaleway. Варианты: `false` `true` ← (по умолчанию)
wait boolean	Дождаться, пока балансировщик нагрузки достигнет желаемого состояния, прежде чем возвращать управление. Варианты: `false` ← (по умолчанию) `true`
wait_sleep_time integer	Время ожидания перед каждой попыткой проверить состояние балансировщика нагрузки. По умолчанию: `3`
wait_timeout integer	Время ожидания достижения балансировщиком нагрузки ожидаемого состояния. По умолчанию: `300`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.scaleway добавлено в community.general 11.3.0	Используйте `group/community.general.scaleway` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примечания

Примечание

См. также документацию API на сайте https://developer.scaleway.com/.
Если api_token не задан в модуле, можно использовать следующие переменные среды в порядке убывания приоритета: SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN или SCW_API_TOKEN.
Чтобы использовать другой api_url, можно также задать переменную среды SCW_API_URL.

Примеры

- name: Create a load-balancer
  community.general.scaleway_lb:
    name: foobar
    state: present
    organization_id: 951df375-e094-4d26-97c1-ba548eeb9c42
    region: fr-par
    tags:
      - hello

- name: Delete a load-balancer
  community.general.scaleway_lb:
    name: foobar
    state: absent
    organization_id: 951df375-e094-4d26-97c1-ba548eeb9c42
    region: fr-par

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

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

Ключ	Описание
scaleway_lb dictionary	Объект балансировщика нагрузки. Возвращается: при успехе Пример: {"backend_count": 0, "description": "Description of my load-balancer", "frontend_count": 0, "id": "00000000-0000-0000-0000-000000000000", "instances": [{"id": "00000000-0000-0000-0000-000000000000", "ip_address": "10.0.0.1", "region": "fr-par", "status": "ready"}, {"id": "00000000-0000-0000-0000-000000000000", "ip_address": "10.0.0.2", "region": "fr-par", "status": "ready"}], "ip": [{"id": "00000000-0000-0000-0000-000000000000", "ip_address": "192.168.0.1", "lb_id": "00000000-0000-0000-0000-000000000000", "organization_id": "00000000-0000-0000-0000-000000000000", "region": "fr-par", "reverse": ""}], "name": "lb_ansible_test", "organization_id": "00000000-0000-0000-0000-000000000000", "region": "fr-par", "status": "ready", "tags": ["first_tag", "second_tag"]}

Ключ

Описание

scaleway_lb

dictionary

Объект балансировщика нагрузки.

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

Пример: {"backend_count": 0, "description": "Description of my load-balancer", "frontend_count": 0, "id": "00000000-0000-0000-0000-000000000000", "instances": [{"id": "00000000-0000-0000-0000-000000000000", "ip_address": "10.0.0.1", "region": "fr-par", "status": "ready"}, {"id": "00000000-0000-0000-0000-000000000000", "ip_address": "10.0.0.2", "region": "fr-par", "status": "ready"}], "ip": [{"id": "00000000-0000-0000-0000-000000000000", "ip_address": "192.168.0.1", "lb_id": "00000000-0000-0000-0000-000000000000", "organization_id": "00000000-0000-0000-0000-000000000000", "region": "fr-par", "reverse": ""}], "name": "lb_ansible_test", "organization_id": "00000000-0000-0000-0000-000000000000", "region": "fr-par", "status": "ready", "tags": ["first_tag", "second_tag"]}

Авторы

Remy Leone (@remyleone)

Ссылки на коллекцию

© 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/community/general/scaleway_lb_module.html