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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список добавлен в 2.8			Список определений членов пула GTM, которые должны быть созданы, изменены или удалены. При использовании `aggregates`, если одно из определений агрегата недействительно, запуск агрегата завершится с ошибкой, указав последнюю встреченную ошибку. Модуль `NOT` отменит все внесенные изменения до обнаружения ошибки. Модуль также не укажет, какие изменения были внесены до сбоя, поэтому настоятельно рекомендуется запускать модуль в режиме проверки для выполнения базовой валидации перед выполнением модуля. псевдонимы: 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. Например, `/Common/tcp`.
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
pool строка / обязательно			Имя пула GTM. Для пулов, созданных на разных разделах, необходимо указать раздел пула в формате полного пути, например, `/FooBar/pool_name`.
provider словарь добавлен в 2.5			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика авторизации для получения маркеров авторизации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	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 целое число		Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечет до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs булево	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
ratio целое число			Указывает вес члена пула для целей балансировки нагрузки.
replace_all_with булево добавлен в 2.8		Варианты: нет ← да	Удаляет членов, не определённых в параметре `aggregate`. Эта операция выполняется полностью или нисколько, то есть она остановится, если некоторые члены пула не могут быть удалены. псевдонимы: purge
server_name строка / обязательно			Указывает сервер GTM, который содержит `virtual_server`.

Состояние строка	Варианты: текущее ← отсутствует активировано деактивировано	Состояние участника пула. Когда `present`, гарантирует, что участник пула создан и активирован. Когда `absent`, гарантирует, что участник пула удален из системы. Когда `enabled` или `disabled`, гарантирует, что участник пула активирован или деактивирован (соответственно) на удаленном устройстве. Рекомендуется использовать параметр `members` модуля `bigip_gtm_pool` при добавлении и удалении участников, так как это обеспечивает более удобный способ задания порядка. Если это невозможно, то необходимо использовать параметр `state`. Помните, что порядок участников изменится, если вы добавите или удалите их с помощью этого метода. В некоторой степени это можно контролировать с помощью параметра `member_order`.
Тип строка / обязательно	Варианты: a aaaa cname mx naptr srv	Тип пула GTM, в котором находится участник.
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 булево	изменено	Включена ли граница битов. Пример: True
bits_limit целое число	изменено	Новая граница для битов. Пример: 100
connections_enabled булево	изменено	Включена ли граница подключений. Пример: True
connections_limit целое число	изменено	Новая граница для подключений. Пример: 100
description строка	изменено	Новое описание участника. Пример: Моё описание
disabled булево	изменено	Участник пула деактивирован или нет. Пример: True
enabled булево	изменено	Участник пула активирован или нет. Пример: True
member_order целое число	изменено	Новый порядок, в котором участник отображается в пуле. Пример: 2
monitor строка	изменено	Новый монитор, назначенный участнику пула. Пример: /Common/monitor1
packets_enabled булево	изменено	Включена ли граница пакетов. Пример: True
packets_limit целое число	изменено	Новая граница для пакетов. Пример: 100
ratio целое число	изменено	Новый вес участника для балансировки нагрузки. Пример: 10
replace_all_with булево	изменено	Удаляет все участники пула, не являющиеся агрегативными, с устройства. Пример: 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.9/modules/bigip_gtm_pool_member_module.html