Модуль community.general.oneandone_load_balancer – Настройка балансировщика нагрузки 1&1

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: community.general.oneandone_load_balancer.

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

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

Создание, удаление, обновление балансировщиков нагрузки. Этот модуль зависит от 1and1 >= 1.0.

Требования

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

1and1

Параметры

Параметр	Комментарии
add_rules list / elements=dictionary	Список правил, которые будут добавлены к существующему балансировщику нагрузки. Синтаксис такой же, как и для параметра rules. Используется в сочетании с состоянием update. Значение по умолчанию: `[]`
add_server_ips list / elements=string	Список идентификаторов серверов (id или имя), которые будут назначены балансировщику нагрузки. Используется в сочетании с состоянием update. Значение по умолчанию: `[]`
api_url string	Пользовательский URL API. Переопределяет переменную среды `ONEANDONE_API_URL`.
auth_token string	Токен аутентификации API, предоставленный 1&1.
datacenter string	ID или код страны центра обработки данных, где будет создан балансировщик нагрузки. Если не указано, используется значение по умолчанию `US`. Варианты: `"US"` `"ES"` `"DE"` `"GB"`
description string	Описание балансировщика нагрузки. maxLength=256
health_check_interval string	Период проверки работоспособности в секундах. minimum=5, maximum=300, multipleOf=1
health_check_parse string	Регулярное выражение для проверки. Обязательно для проверки HTTP. maxLength=64
health_check_path string	URL для вызова проверки. Обязательно для проверки HTTP. maxLength=1000
health_check_test string	Тип проверки работоспособности. На данный момент HTTP недопустим. Варианты: `"NONE"` `"TCP"` `"HTTP"` `"ICMP"`
load_balancer string	Идентификатор (id или имя) балансировщика нагрузки, используемый с состоянием update.
method string	Процедура балансировки. Варианты: `"ROUND_ROBIN"` `"LEAST_CONNECTIONS"`
name string	Имя балансировщика нагрузки, используемое с состоянием present. Используется как идентификатор (id или имя), когда используется с состоянием absent. maxLength=128
persistence boolean	Сохранение состояния. Варианты: `false` `true`
persistence_time string	Время сохранения состояния в секундах. Обязательно, если включено сохранение состояния. minimum=30, maximum=1200, multipleOf=1
remove_rules list / elements=string	Список идентификаторов правил, которые будут удалены из существующего балансировщика нагрузки. Используется в сочетании с состоянием update. Значение по умолчанию: `[]`
remove_server_ips list / elements=string	Список идентификаторов IP-адресов серверов, которые будут отменены назначению для балансировщика нагрузки. Используется в сочетании с состоянием update. Значение по умолчанию: `[]`
rules list / elements=dictionary	Список объектов правил, которые будут установлены для балансировщика нагрузки. Каждое правило должно содержать параметры protocol, port_balancer и port_server, а также необязательный параметр source. Значение по умолчанию: `[]`
state string	Определяет состояние балансировщика нагрузки для создания, удаления или обновления. Варианты: `"present"` ← (по умолчанию) `"absent"` `"update"`
wait boolean	ждать, пока экземпляр не перейдет в состояние «running», прежде чем возвращать результат Варианты: `false` `true` ← (по умолчанию)
wait_interval integer	Определяет количество секунд ожидания при использовании методов _wait_for Значение по умолчанию: `5`
wait_timeout integer	сколько времени ждать, прежде чем ожидание завершится неудачей, в секундах Значение по умолчанию: `600`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в `check_mode` и возвращать прогноз состояния «изменено» без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	Будет возвращать подробную информацию о том, что изменилось (или, возможно, что необходимо изменить в `check_mode`) в режиме diff.

Примеры

- name: Create a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    name: ansible load balancer
    description: Testing creation of load balancer with ansible
    health_check_test: TCP
    health_check_interval: 40
    persistence: true
    persistence_time: 1200
    method: ROUND_ROBIN
    datacenter: US
    rules:
     -
       protocol: TCP
       port_balancer: 80
       port_server: 80
       source: 0.0.0.0
    wait: true
    wait_timeout: 500

- name: Destroy a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    name: ansible load balancer
    wait: true
    wait_timeout: 500
    state: absent

- name: Update a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    load_balancer: ansible load balancer
    name: ansible load balancer updated
    description: Testing the update of a load balancer with ansible
    wait: true
    wait_timeout: 500
    state: update

- name: Add server to a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    load_balancer: ansible load balancer updated
    description: Adding server to a load balancer with ansible
    add_server_ips:
     - server identifier (id or name)
    wait: true
    wait_timeout: 500
    state: update

- name: Remove server from a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    load_balancer: ansible load balancer updated
    description: Removing server from a load balancer with ansible
    remove_server_ips:
     - B2504878540DBC5F7634EB00A07C1EBD (server's ip id)
    wait: true
    wait_timeout: 500
    state: update

- name: Add rules to a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    load_balancer: ansible load balancer updated
    description: Adding rules to a load balancer with ansible
    add_rules:
     -
       protocol: TCP
       port_balancer: 70
       port_server: 70
       source: 0.0.0.0
     -
       protocol: TCP
       port_balancer: 60
       port_server: 60
       source: 0.0.0.0
    wait: true
    wait_timeout: 500
    state: update

- name: Remove rules from a load balancer
  community.general.oneandone_load_balancer:
    auth_token: oneandone_private_api_key
    load_balancer: ansible load balancer updated
    description: Adding rules to a load balancer with ansible
    remove_rules:
     - rule_id #1
     - rule_id #2
     - ...
    wait: true
    wait_timeout: 500
    state: update

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

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

Ключ	Описание
load_balancer dictionary	Информация о обработанном балансировщике нагрузки Возвращается: всегда Пример: `{"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Balancer"}`

Авторы

Amel Ajdinovic (@aajdinov)
Ethan Devenport (@edevenport)

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

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