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

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

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

Описание

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

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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` не смогли выбрать пул.
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		По умолчанию: null	Объект словаря, содержащий данные подключения.
	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 - / обязательно	Варианты: rest cli ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user - / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, задав переменную среды `F5_USER`.

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

Примечания

Примечание

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

Примеры

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

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

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

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

Ключ		Возвращаемое	Описание
alternate_lb_method строка		изменено	Новый альтернативный метод балансировки нагрузки для пула. Пример: drop-packet
fallback_ip строка		изменено	Новый резервный IP, используемый при балансировке нагрузки с помощью метода `fallback_ip`. Пример: 10.10.10.10
fallback_lb_method строка		изменено	Новый резервный метод балансировки нагрузки для пула. Пример: fewest-hops
members сложный тип		изменено	Список членов в пуле.
	server строка	изменено	Имя серверной части члена.
	virtual_server строка	изменено	Имя виртуального сервера части члена.
monitors список		изменено	Новый список мониторов для ресурса. Пример: ['/Common/monitor1', '/Common/monitor2']
preferred_lb_method строка		изменено	Новый предпочтительный метод балансировки нагрузки для пула. Пример: topology

Статус

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

Авторы

Tim Rupp (@caphrim007)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_gtm_pool_module.html