bigip_gtm_pool_member – Управление настройками члена пула GTM

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

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

Краткое описание

Управляет различными настройками членов пула GTM. Настройки, которые можно настроить с помощью этого модуля, значительно шире, чем те, что можно выполнить в модуле bigip_gtm_pool. Модуль пула предназначен для изменения порядка членов в пуле, а не различных настроек членов. Для настройки всех остальных параметров следует использовать модуль bigip_gtm_pool_member.

Требования

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

f5-sdk >= 3.0.16

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
description -			Описание члена пула.
limits -			Указывает пороговые значения ресурсов или требования к ограничениям на уровне члена пула. При включении одного или нескольких параметров ограничения система использует эти данные для включения и выключения членов в работе. Вы можете определить ограничения для любого или всех параметров ограничений. Однако, если член не соответствует пороговым значениям ресурсов, система помечает его как недоступный и перенаправляет трафик балансировки нагрузки на другой ресурс.
	bits_enabled boolean	Варианты: no yes	Включено ли ограничение по битам. Этот параметр позволяет включить или выключить эффект ограничения.
	bits_limit -		Указывает максимальную допустимую скорость пропускной способности данных в битах в секунду для члена. Если объем сетевого трафика превышает это ограничение, система помечает члена как недоступный.
	connections_enabled boolean	Варианты: no yes	Включено ли текущее ограничение подключений. Этот параметр позволяет включить или выключить эффект ограничения.
	connections_limit -		Указывает максимальное количество одновременных подключений для всех членов. Если подключения превышают это ограничение, система помечает сервер как недоступный.
	packets_enabled boolean	Варианты: no yes	Включено ли ограничение по пакетам. Этот параметр позволяет включить или выключить эффект ограничения.
	packets_limit -		Указывает максимальную допустимую скорость передачи данных в пакетах в секунду для члена. Если объем сетевого трафика превышает это ограничение, система помечает члена как недоступный.
member_order -			Указывает порядок отображения члена в пуле. Система использует это число с методами балансировки нагрузки, которые включают в себя приоритезацию членов пула, таких как метод балансировки Ratio. При создании нового члена с помощью этого модуля, если параметр `member_order` не указан, он будет по умолчанию `0` (первый член в пуле).
monitor -			Указывает монитор, назначенный этому члену пула. Члены пула поддерживают только один монитор. Если `port` `gtm_virtual_server` `*`, принятые значения этого параметра будут затронуты. При создании нового члена пула, если этот параметр не указан, будет использоваться значение по умолчанию `default`. Чтобы удалить монитор из члена пула, используйте значение `none`. Для членов пула, созданных на разных разделах, вы также можете указать полный путь к общему монитору. Например, `/Common/tcp`.
partition -		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
password - / обязательно			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
pool - / обязательно			Имя пула GTM.
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`.
ratio -			Указывает вес члена пула для целей балансировки нагрузки.
server - / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, задав переменную окружения `F5_SERVER`.
server_name - / обязательно			Указывает сервер GTM, который содержит `virtual_server`.
server_port - добавлено в 2.2		Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную окружения `F5_SERVER_PORT`.
state -		Варианты: present ← absent enabled disabled	Состояние члена пула. Когда `present`, гарантирует, что член пула создан и включен. Когда `absent`, гарантирует, что член пула удален из системы. Когда `enabled` или `disabled`, гарантирует, что член пула включен или выключен (соответственно) на удаленном устройстве. Рекомендуется использовать параметр `members` модуля `bigip_gtm_pool` при добавлении и удалении членов, это предоставляет более простой способ определения порядка. Если это невозможно, то следует использовать параметр `state`. Помните, что порядок членов будет изменен, если вы добавите или удалите их с помощью этого метода. В некоторой степени это можно контролировать с помощью параметра `member_order`.

тип - / обязательно	Варианты: a aaaa cname mx naptr srv	Тип пула GTM, в котором находится член.
пользователь - / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
validate_certs boolean добавлено в 2.0	Варианты: no да ←	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах, контролируемых вами, использующих самозаверенные сертификаты. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`.
virtual_server - / обязательно		Указывает имя виртуального сервера GTM, назначенного указанному `server`.

Примечания

Примечание

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

Примеры

- name: Create a ...
  bigip_gtm_pool_member:
    name: foo
    password: secret
    server: lb.mydomain.com
    state: present
    user: admin
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
param1 boolean	changed	Новое значение param1 ресурса. Пример: True
param2 строка	changed	Новое значение param2 ресурса. Пример: Foo is bar

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Данный модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

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_member_module.html