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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules

Для использования в книге задач укажите: f5networks.f5_modules.bigip_gtm_pool_member

Новое в версии 1.0.0: модуля f5networks.f5_modules

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate list / elements=dictionary			Список определений членов пула 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/tcp`.
partition строка		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
pool строка / обязательно			Имя пула GTM. Для пулов, созданных на разных разделах, вы должны указать раздел пула в формате полного пути, например `/FooBar/pool_name`.
provider словарь добавлен в 1.0.0 модуля f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem логическое	Варианты: нет да	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TEEM`.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. Псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое	Варианты: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
ratio целое число			Устанавливает вес члена пула для целей балансировки нагрузки.
replace_all_with логическое		Варианты: нет ← да	Удаляет членов, не определённых в параметре `aggregate`. Эта операция выполняется полностью или никак, то есть остановится, если некоторые члены пула не могут быть удалены. Псевдонимы: purge
server_name строка			Указывает сервер GTM, который содержит `virtual_server`.
state строка		Варианты: present ← absent enabled disabled	Состояние члена пула. При `present`, гарантирует создание и включение члена пула. При `absent`, гарантирует удаление члена пула из системы. При `enabled` или `disabled`, гарантирует включение или выключение (соответственно) члена пула на удалённом устройстве. Рекомендуем использовать параметр `members` модуля `bigip_gtm_pool` при добавлении и удалении членов, так как он предоставляет более простой способ задания порядка. Если это невозможно, следует использовать параметр `state` здесь. Помните, что порядок членов будет изменён, если вы добавите или удалите их с помощью этого метода. В какой-то степени это можно контролировать с помощью параметра `member_order`.
type строка / обязательно		Варианты: 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 на диске, необходимо включить как минимум одну задачу, использующую модуль f5networks.f5_modules.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 boolean	changed	Включена ли лимитация на биты. Пример: True
bits_limit integer	changed	Новый лимит bits_enabled. Пример: 100
connections_enabled boolean	changed	Включена ли лимитация на соединения. Пример: True
connections_limit integer	changed	Новый лимит connections_limit. Пример: 100
description string	changed	Новое описание члена. Пример: Моё описание
disabled boolean	changed	Член пула отключен или нет. Пример: True
enabled boolean	changed	Член пула включен или нет. Пример: True
member_order integer	changed	Новый порядок отображения члена в пуле. Пример: 2
monitor string	changed	Новый монитор, назначенный члену пула. Пример: /Common/monitor1
packets_enabled boolean	changed	Включена ли лимитация на пакеты. Пример: True
packets_limit integer	changed	Новый лимит packets_limit. Пример: 100
ratio integer	changed	Новый вес члена для балансировки нагрузки. Пример: 10
replace_all_with boolean	changed	Удаляет всех членов пула, кроме агрегированных, с устройства Пример: True

Авторы

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.10/collections/f5networks/f5_modules/bigip_gtm_pool_member_module.html