f5networks.f5_modules.bigip_gtm_pool – Управляет пулами F5 BIG-IP GTM

Примечание

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

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

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

Добавлена в версии 1.0.0: модуля f5networks.f5_modules

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
alternate_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	Режим балансировки нагрузки, к которому система обращается, если `preferred_lb_method` не удается выбрать пул.
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'.
fallback_ip строка			Указывает IPv4 или IPv6 адрес сервера, на который система перенаправляет запросы, если не может использовать один из своих пулов. Обратите внимание, что система использует резервный IP-адрес только если выбран метод балансировки нагрузки `fallback_ip`.
fallback_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	Режим балансировки нагрузки, к которому система обращается, если оба `preferred_lb_method` и `alternate_lb_method` не смогли выбрать пул.
max_answers_returned целое число			Указывает максимальное количество доступных виртуальных серверов, которые система перечисляет в ответе. Максимальное значение - 500.
members список / элементы=словарь			Члены, которые нужно назначить пулу. Порядок членов в этом списке - порядок их отображения в пуле.
	server строка / обязательно		Имя сервера, частью которого является член пула.
	virtual_server строка / обязательно		Имя виртуального сервера, связанного с сервером, частью которого является член пула.
monitors список / элементы=строка			Указывает мониторы работоспособности, которые система в настоящее время использует для мониторинга этого ресурса. Когда `availability_requirements.type` `require`, вы можете иметь только один монитор в списке `monitors`.
name строка / обязательно			Имя пула GTM.
partition строка		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
preferred_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	Режим балансировки нагрузки, который система пытается использовать в первую очередь.
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`.
state строка		Варианты: present ← absent enabled disabled	Состояние пула. При значении `present`, гарантирует создание и включение пула. При значении `absent`, гарантирует удаление пула из системы. При значениях `enabled` или `disabled`, гарантирует включение или отключение (соответственно) пула на удалённом устройстве.
ttl целое число			Указывает количество секунд, в течение которого IP-адрес, после нахождения, считается действительным.
type строка		Варианты: a aaaa cname mx naptr srv	Тип пула GTM, который вы хотите создать. В версиях BIG-IP до версии 12 этот параметр не требуется. В более поздних версиях BIG-IP это обязательный параметр.

Примечания

Примечание

Поддержка версий TMOS ниже v12.x для данного модуля устарела и будет удалена в f5_modules 1.4.
Дополнительную информацию об использовании 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
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Disable pool
  bigip_gtm_pool:
    state: disabled
    name: my_pool
    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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_gtm_pool_module.html