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

Новая в версии 2.4.

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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 словарь добавлен в 2.6			Указывает, если вы активируете более одного монитора работоспособности, количество мониторов работоспособности, которые должны получить успешные ответы, чтобы соединение считалось доступным.
	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 целое число добавлен в 2.8			Указывает максимальное количество доступных виртуальных серверов, которые система отображает в ответе. Максимум 500.
members список добавлен в 2.6			Члены для назначения в пул. Порядок членов в этом списке соответствует порядку их отображения в пуле.
	server строка / обязательно		Имя сервера, к которому относится член пула.
	virtual_server строка / обязательно		Имя виртуального сервера, связанного с сервером, к которому относится член пула.
monitors список добавлен в 2.6			Указывает мониторы работоспособности, которые система в данный момент использует для мониторинга данного ресурса. Когда `availability_requirements.type` `require`, в списке `monitors` может быть только один монитор.
name строка / обязательно			Имя пула GTM.
partition строка добавлен в 2.5		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
password строка / обязательно			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
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 словарь добавлен в 2.5			Объект словаря, содержащий данные подключения.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение, используемое при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.

	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под личным контролем, использующих самозаверенные сертификаты. Этот параметр можно опустить, задав переменную среды `F5_VALIDATE_CERTS`.
server string / обязательно			Хост BIG-IP. Этот параметр можно опустить, задав переменную среды `F5_SERVER`.
server_port целое число добавлено в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, задав переменную среды `F5_SERVER_PORT`.
state string		Варианты: present ← absent enabled disabled	Состояние пула. Когда `present`, гарантирует создание и включение пула. Когда `absent`, гарантирует удаление пула из системы. Когда `enabled` или `disabled`, гарантирует включение или отключение (соответственно) пула на удаленном устройстве.
ttl целое число добавлено в 2.8			Указывает количество секунд, в течение которых адрес IP, найденный ранее, является действительным.
type string		Варианты: a aaaa cname mx naptr srv	Тип пула GTM, который вы хотите создать. В версиях BIG-IP до 12-й включительно этот параметр не требуется. В более поздних версиях BIG-IP он является обязательным.
user string / обязательно			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, задав переменную среды `F5_USER`.
validate_certs boolean добавлено в 2.0		Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под личным контролем, использующих самозаверенные сертификаты. Этот параметр можно опустить, задав переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Поддержка версий TMOS ниже v12.x устарела для этого модуля и будет удалена в Ansible 2.12.
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP ≥ 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что специфическая для BIG-IP конфигурация сохранится на диске, убедитесь, что вы включили хотя бы одну задачу, использующую модуль 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 string		changed	Новый альтернативный метод балансировки нагрузки для пула. Пример: drop-packet
fallback_ip string		changed	Новый резервный IP-адрес, используемый при балансировке нагрузки с помощью метода `fallback_ip`. Пример: 10.10.10.10
fallback_lb_method string		changed	Новый резервный метод балансировки нагрузки для пула. Пример: fewest-hops
max_answers_returned integer		changed	Новое значение Максимального возврата ответов. Пример: 25
members complex		changed	Список членов пула.
	server string	changed	Имя сервера в составе члена.
	virtual_server string	changed	Имя виртуального сервера в составе члена.
monitors list		changed	Новый список мониторов для ресурса. Пример: ['/Common/monitor1', '/Common/monitor2']
preferred_lb_method string		changed	Новый предпочтительный метод балансировки нагрузки для пула. Пример: topology

Статус

Этот модуль гарантирует отсутствие обратной несовместимости в будущем. [stableinterface]
Этот модуль поддерживается партнёром Ansible. [certified]

Авторы

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.8/modules/bigip_gtm_pool_module.html