Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции f5networks.f5_modules (версия 1.31.0).

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

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

Для использования в книге задач укажите: f5networks.f5_modules.bigip_gtm_virtual_server.

Добавлена в f5networks.f5_modules 1.0.0

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

Описание

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

Параметры

Параметр

Комментарии

адрес

строка

Указывает IP-адрес виртуального сервера.

При создании нового виртуального сервера GTM этот параметр обязателен.

требования_к_доступности

словарь

Если вы активируете более одного монитора работоспособности, указывает количество мониторов работоспособности, которые должны получить успешные ответы, чтобы ссылка считалась доступной.

как_минимум

целое_число

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

Этот параметр актуален только при использовании type at_least.

Этот параметр будет проигнорирован, если используется тип all или require.

количество_зондирующих_агентов

целое_число

Указывает количество зондирующих агентов, которые должны быть использованы при запуске зондирования.

При создании нового виртуального сервера, если этот параметр указан, также должен быть указан параметр number_of_probes.

Значение этого параметра должно всегда быть больше или равно значению number_of_probers.

Этот параметр актуален только при использовании type require.

Этот параметр будет проигнорирован, если используется тип all или at_least.

количество_зондирований

целое_число

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

При создании нового виртуального сервера, если этот параметр указан, также должен быть указан параметр number_of_probers.

Значение этого параметра должно всегда быть меньше или равно значению number_of_probers.

Этот параметр актуален только при использовании type require.

Этот параметр будет проигнорирован, если используется тип all или at_least.

тип

строка / обязательно

Тип правила мониторинга, когда указан monitors.

При создании нового виртуального сервера, если значение не указано, будет использоваться значение по умолчанию all.

Варианты:

  • "all"
  • "at_least"
  • "require"

пределы

словарь

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

При включении одного или нескольких настроек лимитов, система использует эти данные для включения и выключения серверов.

Вы можете определить ограничения для любого или всех настроек лимитов. Однако, когда сервер не соответствует порогу ресурсов, система помечает весь сервер как недоступный и перенаправляет трафик балансировки нагрузки на другой ресурс.

Доступные настройки лимитов зависят от типа сервера.

разрешить_лимит_бит

логическое_значение

Включен ли лимит по битам.

Этот параметр позволяет включить или выключить действие ограничения.

Варианты:

  • false
  • true

лимит_бит

целое_число

Указывает максимальную допустимую скорость передачи данных для виртуальных серверов на сервере в битах в секунду.

Если объем сетевого трафика превысит этот предел, система помечает сервер как недоступный.

разрешить_лимит_соединений

логическое_значение

Включен ли лимит текущих соединений.

Этот параметр позволяет включить или выключить действие ограничения.

Варианты:

  • false
  • true

лимит_соединений

целое_число

Указывает максимальное количество одновременных соединений, в совокупности, для всех виртуальных серверов на сервере.

Если соединения превысят этот предел, система помечает сервер как недоступный.

разрешить_лимит_пакетов

логическое_значение

Включен ли лимит пакетов.

Этот параметр позволяет включить или выключить действие ограничения.

Варианты:

  • false
  • true

лимит_пакетов

целое_число

Указывает максимальную допустимую скорость передачи данных для виртуальных серверов на сервере в пакетах в секунду.

Если объем сетевого трафика превысит этот предел, система помечает сервер как недоступный.

ссылка

строка

Указывает ссылку, которую нужно назначить серверу или виртуальному серверу.

мониторы

список / элементы=строка

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

Когда availability_requirements.type require, в списке monitors может быть только один монитор.

имя

строка / обязательно

Указывает имя виртуального сервера.

раздел

строка

Раздел устройства для управления ресурсами.

По умолчанию: "Common"

port

целое число

Указывает номер порта службы для виртуального сервера или члена пула. Например, служба HTTP обычно использует порт 80.

Для указания всех портов используйте *.

При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию *.

provider

словарь

добавлен в f5networks.f5_modules 1.0.0

Объект словаря, содержащий данные подключения.

auth_provider

строка

Настраивает поставщика авторизации для получения маркеров аутентификации от удаленного устройства.

Этот параметр действительно используется при работе с устройствами BIG-IQ.

no_f5_teem

булево

Если yes, данные телеметрии TEEM не отправляются в F5.

Вы можете опустить этот параметр, установив переменную среды F5_TELEMETRY_OFF.

Предыдущая используемая переменная F5_TEEM устарела, так как ее имя вызывало путаницу.

Варианты:

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

password

псевдонимы: pass, pwd

строка / обязательный

Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

server

строка / обязательный

Хост BIG-IP или хост BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER.

server_port

целое число

Порт сервера BIG-IP.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

целое число

Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.

transport

строка

Настраивает транспортное соединение, используемое при подключении к удаленному устройству.

Варианты:

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

user

строка / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве.

Вы можете опустить этот параметр, установив переменную среды F5_USER.

validate_certs

булево

Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверяющие сертификаты.

Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

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

server_name

строка / обязательный

Указывает имя сервера, с которым связан виртуальный сервер.

state

строка

Когда present, гарантирует существование ресурса.

Когда absent, гарантирует удаление ресурса.

Варианты:

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

translation_address

строка

Указывает IP-адрес трансляции для виртуального сервера.

Для отключения этого параметра используйте пустую строку ("") в качестве значения.

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

translation_port

строка

Указывает номер порта трансляции или имя службы для виртуального сервера.

Для указания всех портов используйте *.

При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию *.

virtual_server_dependencies

список / элементы=словарь

Указывает виртуальные серверы, от которых зависит текущий виртуальный сервер.

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

server

строка / обязательный

Сервер, к которому принадлежит зависимый виртуальный сервер.

virtual_server

строка / обязательно

Виртуальный сервер, от которого зависит.

Примечания

Примечание

  • Дополнительную информацию об использовании 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

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

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

Ключ

Описание

address

строка

Новый адрес ресурса.

Возвращается: изменён

Пример: "1.2.3.4"

availability_requirements

словарь

Новые конфигурации требований доступности для ресурса.

Возвращается: изменён

Пример: {"type": "all"}

limits

словарь

Новые конфигурации ограничений для ресурса.

Возвращается: изменён

Пример: {"bits_enabled": true, "bits_limit": 100}

link

строка

Новое значение связи для ресурса.

Возвращается: изменён

Пример: "/Common/my-link"

monitors

список / элементы=строка

Новый список мониторов для ресурса.

Возвращается: изменён

Пример: ["/Common/monitor1", "/Common/monitor2"]

port

целое число

Новый порт ресурса.

Возвращается: изменён

Пример: 500

server_name

строка

Имя сервера, связанное с виртуальным сервером.

Возвращается: изменён

Пример: "/Common/my-gtm-server"

translation_address

целое число

Новый адрес перевода ресурса.

Возвращается: изменён

Пример: 500

translation_port

целое число

Новый порт перевода ресурса.

Возвращается: изменён

Пример: 500

virtual_server_dependencies

список / элементы=строка

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

Возвращается: изменён

Пример: ["/Common/vs1", "/Common/vs2"]

Авторы

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

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

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (исходники)

© 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/f5networks/f5_modules/bigip_gtm_virtual_server_module.html

Spec-Zone.ru

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