Spec-Zone.ru › Ansible 2.11

f5networks.f5_modules.bigip_gtm_virtual_server – Управляет виртуальными серверами F5 BIG-IP GTM

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать его в плейбуке, укажите: f5networks.f5_modules.bigip_gtm_virtual_server.

Новый в версии 1.0.0: of f5networks.f5_modules

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

Обзор

  • Управляет виртуальными серверами F5 BIG-IP GTM (сейчас BIG-IP DNS). Один сервер GTM может иметь множество связанных с ним виртуальных серверов. Они организованы примерно так же, как члены пула к пулам.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
address
строка
Указывает IP-адрес виртуального сервера.
При создании нового виртуального сервера GTM этот параметр обязателен.
availability_requirements
словарь
Если активировано более одного монитора работоспособности, указывает количество мониторов работоспособности, которые должны получить успешные ответы, чтобы ссылка считалась доступной.
at_least
целое число
Указывает минимальное количество активных мониторов работоспособности, которые должны предоставить успешные результаты, прежде чем ссылка будет считаться активной.
Этот параметр актуален только при использовании type at_least.
Этот параметр будет проигнорирован, если используется тип all или require.
number_of_probers
целое число
Указывает количество зондирующих агентов, которые должны использоваться при запуске зондирования.
При создании нового виртуального сервера, если этот параметр указан, необходимо также указать параметр number_of_probes.
Значение этого параметра должно всегда быть больше или равно значению number_of_probers.
Этот параметр актуален только при использовании type require.
Этот параметр будет проигнорирован, если используется тип all или at_least.
number_of_probes
целое число
Указывает минимальное количество зондирований, которые должны завершиться успешно, чтобы сервер был объявлен активным.
При создании нового виртуального сервера, если этот параметр указан, необходимо также указать параметр number_of_probers.
Значение этого параметра должно всегда быть меньше или равно значению number_of_probers.
Этот параметр актуален только при использовании type require.
Этот параметр будет проигнорирован, если используется тип all или at_least.
type
строка / обязательно
    Варианты:
  • all
  • at_least
  • require
Тип правила мониторинга, когда указан monitors.
При создании нового виртуального сервера, если это значение не указано, будет использоваться значение по умолчанию all.
limits
словарь
Указывает пороговые значения ресурсов или требования к лимитам на уровне сервера.
При включении одного или нескольких ограничений система использует эти данные для включения/выключения серверов.
Можно определить ограничения для любого или всех настроек лимитов. Однако, если сервер не соответствует требованиям пороговых значений ресурсов, система помечает весь сервер как недоступный и перенаправляет трафик балансировки нагрузки на другой ресурс.
Доступные настройки лимитов зависят от типа сервера.
bits_enabled
булево
    Варианты:
  • no
  • yes
Включено ли ограничение по битам.
Этот параметр позволяет включить или отключить действие ограничения.
bits_limit
целое число
Указывает максимальную допустимую скорость пропускной способности данных для виртуальных серверов на сервере в битах в секунду.
Если объем сетевого трафика превысит этот лимит, система помечает сервер как недоступный.
connections_enabled
булево
    Варианты:
  • no
  • yes
Включено ли текущее ограничение по подключениям.
Этот параметр позволяет включить или отключить действие ограничения.
connections_limit
целое число
Указывает максимальное количество одновременных подключений, суммарно, для всех виртуальных серверов на сервере.
Если количество подключений превысит этот лимит, система помечает сервер как недоступный.
packets_enabled
булево
    Варианты:
  • no
  • yes
Включено ли ограничение по пакетам.
Этот параметр позволяет включить или отключить действие ограничения.
packets_limit
целое число
Указывает максимальную допустимую скорость передачи данных для виртуальных серверов на сервере в пакетах в секунду.
Если объем сетевого трафика превысит этот лимит, система помечает сервер как недоступный.
link
строка
Указывает ссылку, которая должна быть назначена серверу или виртуальному серверу.
monitors
список / элементы=строка
Указывает мониторы работоспособности, которые система в настоящее время использует для мониторинга этого ресурса.
Когда availability_requirements.type require, в списке monitors должен быть только один монитор.
name
строка / обязательно
Указывает имя виртуального сервера.
partition
строка
По умолчанию:
"Common"
Раздел устройства для управления ресурсами.
port
целое число
Указывает номер порта службы для виртуального сервера или члена пула. Например, служба HTTP обычно использует порт 80.
Для указания всех портов используйте *.
При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию *.
provider
словарь
добавлен в 1.0.0 f5networks.f5_modules
Объект словаря, содержащий сведения о подключении.
auth_provider
строка
Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства.
Этот параметр в основном используется при работе с устройствами BIG-IQ.
no_f5_teem
булево
    Варианты:
  • no
  • yes
Если yes, данные телеметрии TEEM не будут отправлены в F5.
Можно опустить этот параметр, установив переменную среды F5_TEEM.
password
строка / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_PASSWORD.

псевдонимы: pass, pwd
server
строка / обязательно
Хост BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_SERVER.
server_port
целое число
По умолчанию:
443
Порт сервера BIG-IP.
Можно опустить этот параметр, установив переменную среды F5_SERVER_PORT.
timeout
целое число
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку.
transport
строка
    Варианты:
  • rest ←
Настраивает транспортное подключение для использования при подключении к удаленному устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве.
Можно опустить этот параметр, установив переменную среды F5_USER.
validate_certs
булево
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами.
Можно опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
server_name
строка / обязательно
Указывает имя сервера, с которым связан виртуальный сервер.
state
строка
    Варианты:
  • present ←
  • absent
  • enabled
  • disabled
Когда present, гарантирует существование ресурса.
Когда absent, гарантирует удаление ресурса.
translation_address
строка
Указывает IP-адрес трансляции для виртуального сервера.
Для отмены этого параметра используйте пустую строку ("") в качестве значения.
При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию ::.
порт_перевода
строка
Указывает номер порта перевода или имя службы для виртуального сервера.
Чтобы указать все порты, используйте *.
При создании нового виртуального сервера GTM, если этот параметр не указан, используется значение по умолчанию *.
зависимости_виртуального_сервера
список / элементы=словарь
Указывает виртуальные серверы, от которых зависит текущий виртуальный сервер.
Если любой из указанных серверов недоступен, текущий виртуальный сервер также будет отображаться как недоступный.
сервер
строка / обязательно
Сервер, к которому относится зависимый виртуальный сервер.
виртуальный_сервер
строка / обязательно
Виртуальный сервер, от которого зависит.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется версия ПО BIG-IP >= 12.
  • Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, необходимо включить хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Enable virtual server
  bigip_gtm_virtual_server:
    server_name: server1
    name: my-virtual-server
    state: enabled
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ Возвращаемое значение Описание
адрес
строка
изменено
Новый адрес ресурса.

Пример:
1.2.3.4
требования_к_доступности
словарь
изменено
Новые конфигурации требований к доступности для ресурса.

Пример:
{'тип': 'все'}
пределы
словарь
изменено
Новые конфигурации ограничений для ресурса.

Пример:
{'разрешены_биты': True, 'предел_битов': 100}
ссылка
строка
изменено
Новое значение ссылки для ресурса.

Пример:
/Общие/моя-ссылка
мониторы
список / элементы=строка
изменено
Новый список мониторов для ресурса.

Пример:
['/Общие/монитор1', '/Общие/монитор2']
порт
целое число
изменено
Новый порт ресурса.

Пример:
500
имя_сервера
строка
изменено
Имя сервера, связанное с виртуальным сервером.

Пример:
/Общие/мой-сервер-gtm
адрес_перевода
целое число
изменено
Новый адрес перевода ресурса.

Пример:
500
порт_перевода
целое число
изменено
Новый порт перевода ресурса.

Пример:
500
зависимости_виртуального_сервера
список / элементы=строка
изменено
Новый список зависимостей виртуального сервера для ресурса.

Пример:
['/Общие/vs1', '/Общие/vs2']


Авторы

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_gtm_virtual_server_module.html

Spec-Zone.ru

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