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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список добавлен в 2.8			Список определений членов пула GTM, которые будут созданы, изменены или удалены. псевдонимы: members
description строка			Описание члена пула.
limits словарь			Устанавливает пороговые значения ресурсов или требования к ограничениям на уровне члена пула. При включении одного или нескольких параметров ограничений система использует эти данные, чтобы включать и выключать членов пула из работы. Вы можете определить ограничения для любых или всех параметров ограничений. Однако, когда член не соответствует порогу ресурса, система помечает члена как недоступный и направляет трафик балансировки нагрузки на другой ресурс.
	bits_enabled булево	Варианты: нет да	Включено ли ограничение по битам. Этот параметр позволяет включить или выключить действие ограничения.
	bits_limit целое число		Устанавливает максимальную допустимую скорость передачи данных в битах в секунду для члена. Если объем сетевого трафика превышает это ограничение, система помечает члена как недоступный.
	connections_enabled булево	Варианты: нет да	Включено ли ограничение по текущим подключениям. Этот параметр позволяет включить или выключить действие ограничения.
	connections_limit целое число		Устанавливает максимальное количество одновременных подключений, в совокупности, для всех членов. Если подключения превышают это ограничение, система помечает сервер как недоступный.
	packets_enabled булево	Варианты: нет да	Включено ли ограничение по пакетам. Этот параметр позволяет включить или выключить действие ограничения.
	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. Для пулов, созданных на разных разделах, вы должны указать раздел пула в формате полного пути, например `/FooBar/pool_name`.
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 булево	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.
ratio целое число			Устанавливает вес члена пула для целей балансировки нагрузки.
replace_all_with булево добавлен в 2.8		Варианты: нет ← да	Удаляет членов, не определенных в параметре `aggregate`. Эта операция выполняется полностью или не выполняется, что означает, что она остановится, если некоторые члены пула не могут быть удалены. псевдонимы: purge
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`.
type строка / обязательно	Варианты: a aaaa cname mx naptr srv	Тип пула GTM, в котором находится член.
user строка / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
validate_certs булево добавлен в 2.0	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на сайтах под вашим контролем, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
virtual_server строка / обязательно		Указывает имя виртуального сервера GTM, который назначен указанному `server`.

Примечания

Примечание

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

Примеры

- name: Create a GTM pool member
  bigip_gtm_pool_member:
    pool: pool1
    server_name: server1
    virtual_server: vs1
    type: a
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a GTM pool member different partition
  bigip_gtm_pool_member:
    server_name: /Common/foo_name
    virtual_server: GTMVSName
    type: a
    pool: /FooBar/foo-pool
    partition: Common
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Add GTM pool members aggregate
  bigip_gtm_pool_member:
    pool: pool1
    type: a
    aggregate:
      - server_name: server1
        virtual_server: vs1
        partition: Common
        description: web server1
        member_order: 0
      - server_name: server2
        virtual_server: vs2
        partition: Common
        description: web server2
        member_order: 1
      - server_name: server3
        virtual_server: vs3
        partition: Common
        description: web server3
        member_order: 2
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add GTM pool members aggregate, remove non aggregates
  bigip_gtm_pool_member:
    pool: pool1
    type: a
    aggregate:
      - server_name: server1
        virtual_server: vs1
        partition: Common
        description: web server1
        member_order: 0
      - server_name: server2
        virtual_server: vs2
        partition: Common
        description: web server2
        member_order: 1
      - server_name: server3
        virtual_server: vs3
        partition: Common
        description: web server3
        member_order: 2
    replace_all_with: yes
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
bits_enabled булево	changed	Включен ли лимит битов. Пример: True
bits_limit целое число	changed	Новый лимит битов. Пример: 100
connections_enabled булево	changed	Включен ли лимит соединений. Пример: True
connections_limit целое число	changed	Новый лимит соединений. Пример: 100
description строка	changed	Новое описание члена. Пример: Мое описание
disabled булево	changed	Член пула отключен или нет. Пример: True
enabled булево	changed	Член пула включен или нет. Пример: True
member_order целое число	changed	Новый порядок отображения члена в пуле. Пример: 2
monitor строка	changed	Новый монитор, назначенный члену пула. Пример: /Common/monitor1
packets_enabled булево	changed	Включен ли лимит пакетов. Пример: True
packets_limit целое число	changed	Новый лимит пакетов. Пример: 100
ratio целое число	changed	Новая весовая функция члена для балансировки нагрузки. Пример: 10
replace_all_with булево	changed	Удаляет все члены пула, не являющиеся агрегированными, с устройства. Пример: True

Статус

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

Авторы

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