Spec-Zone.ru › Ansible

f5networks.f5_modules.bigip_gtm_pool модуль — Управление пулами 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_pool.

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

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

Обзор

  • Управляет пулами F5 BIG-IP GTM (теперь BIG-IP DNS).

Параметры

Параметр

Комментарии

alternate_lb_method

строка

Режим балансировки нагрузки, к которому система прибегает, если preferred_lb_method не удаётся выбрать пул.

Выбор:

  • "round-robin"
  • "return-to-dns"
  • "none"
  • "ratio"
  • "topology"
  • "static-persistence"
  • "global-availability"
  • "virtual-server-capacity"
  • "packet-rate"
  • "drop-packet"
  • "fallback-ip"
  • "virtual-server-score"

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

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

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

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

Выбор:

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

fallback_ip

строка

Указывает IPv4 или IPv6 адрес сервера, на который система перенаправляет запросы, если не может использовать один из своих пулов. Обратите внимание, что система использует резервный IP-адрес только если выбран метод балансировки нагрузки fallback_ip.

fallback_lb_method

строка

Режим балансировки нагрузки, к которому система прибегает, если оба preferred_lb_method и alternate_lb_method не могут выбрать пул.

Выбор:

  • "round-robin"
  • "return-to-dns"
  • "ratio"
  • "topology"
  • "static-persistence"
  • "global-availability"
  • "virtual-server-capacity"
  • "least-connections"
  • "lowest-round-trip-time"
  • "fewest-hops"
  • "packet-rate"
  • "cpu"
  • "completion-rate"
  • "quality-of-service"
  • "kilobytes-per-second"
  • "drop-packet"
  • "fallback-ip"
  • "virtual-server-score"
  • "none"

max_answers_returned

целое число

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

Максимум 500.

members

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

Члены, которые нужно назначить пулу.

Порядок членов в этом списке — порядок их отображения в пуле.

server

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

Имя сервера, частью которого является член пула.

virtual_server

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

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

monitors

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

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

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

name

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

Имя пула GTM.

partition

строка

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

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

END_OF_DOCUMENT_MARKER

preferred_lb_method

string

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

Варианты:

  • "round-robin"
  • "return-to-dns"
  • "ratio"
  • "topology"
  • "static-persistence"
  • "global-availability"
  • "virtual-server-capacity"
  • "least-connections"
  • "lowest-round-trip-time"
  • "fewest-hops"
  • "packet-rate"
  • "cpu"
  • "completion-rate"
  • "quality-of-service"
  • "kilobytes-per-second"
  • "drop-packet"
  • "fallback-ip"
  • "virtual-server-score"

provider

dictionary

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

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

auth_provider

string

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

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

no_f5_teem

boolean

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

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

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

Варианты:

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

password

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

string / обязательно

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

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

server

string / обязательно

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

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

server_port

целое число

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

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

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

timeout

целое число

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

transport

string

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

Варианты:

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

user

string / обязательно

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

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

validate_certs

boolean

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

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

Варианты:

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

state

string

Состояние пула. При present, гарантирует создание и включение пула. При absent, гарантирует удаление пула из системы. При enabled или disabled, гарантирует включение или выключение пула (соответственно) на удалённом устройстве.

Варианты:

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

ttl

целое число

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

type

string / обязательно

Тип пула GTM, который вы хотите создать.

Варианты:

  • "a"
  • "aaaa"
  • "cname"
  • "mx"
  • "naptr"
  • "srv"

Примечания

Примечание

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

Примеры

- name: Create a GTM pool
  bigip_gtm_pool:
    name: my_pool
    type: a
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Disable pool
  bigip_gtm_pool:
    state: disabled
    name: my_pool
    type: a
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ

Описание

alternate_lb_method

строка

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

Возвращено: изменено

Пример: "drop-packet"

fallback_ip

строка

Новый резервный IP-адрес, используемый при балансировке нагрузки с помощью метода fallback_ip.

Возвращено: изменено

Пример: "10.10.10.10"

fallback_lb_method

строка

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

Возвращено: изменено

Пример: "fewest-hops"

max_answers_returned

целое число

Новое значение Максимального количества возвращенных ответов.

Возвращено: изменено

Пример: 25

members

сложное

Список членов пула.

Возвращено: изменено

server

строка

Имя части сервера члена.

Возвращено: изменено

virtual_server

строка

Имя части виртуального сервера члена.

Возвращено: изменено

monitors

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

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

Возвращено: изменено

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

preferred_lb_method

строка

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

Возвращено: изменено

Пример: "topology"

Авторы

  • 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_pool_module.html

Spec-Zone.ru

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