f5networks.f5_modules.bigip_pool – Управляет пулами F5 BIG-IP LTM

Примечание

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

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

Для использования в playbook укажите: f5networks.f5_modules.bigip_pool.

Новое в версии 1.0.0: из f5networks.f5_modules

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

Обзор

Управляет пулами F5 BIG-IP LTM через iControl REST API.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список / элементы=словарь			Список определений пулов, которые необходимо создать, изменить или удалить. При использовании `aggregates`, если одно из определений в агрегате неверно, выполнение агрегата завершится ошибкой, указав последнюю встреченную ошибку. Модуль НЕ отменит внесенные изменения до возникновения ошибки. Модуль также не укажет, какие изменения были внесены до возникновения ошибки. Поэтому мы настоятельно рекомендуем запускать модуль в `check` режиме, чтобы обеспечить базовую проверку перед выполнением этого модуля. псевдонимы: pools
description строка			Указывает описательный текст, идентифицирующий пул.
lb_method строка		Варианты: dynamic-ratio-member dynamic-ratio-node fastest-app-response fastest-node least-connections-member least-connections-node least-sessions observed-member observed-node predictive-member predictive-node ratio-least-connections-member ratio-least-connections-node ratio-member ratio-node ratio-session round-robin weighted-least-connections-member weighted-least-connections-node	Метод балансировки нагрузки. При создании нового пула, если это значение не указано, используется значение по умолчанию `round-robin`.
metadata сырые данные			Произвольные пары ключ/значение, которые вы можете прикрепить к пулу. Это полезно в ситуациях, когда вы хотите добавить аннотацию к пулу для управления с помощью Ansible. Имена ключей хранятся как строки; это включает имена, которые являются числами. Значения для всех ключей хранятся как строки; это включает значения, которые являются числами. Данные будут сохраняться, а не временными.
monitor_type строка		Варианты: and_list m_of_n single	Тип правила мониторинга при указании `monitors`. При создании нового пула, если это значение не указано, используется значение по умолчанию `and_list`. Когда `single`, проверяются все указанные мониторы, но также проверяется, что вы указали только один монитор. Когда `and_list`, проверяются все мониторы. Когда `m_of_n`, проверяется `quorum` из `monitors`. `m_of_n` требует `quorum` 1 или более, указанный в playbook или уже существующий на устройстве. И `single`, и `and_list` функционально идентичны, так как BIG-IP рассматривает все мониторы как «список».
monitors список / элементы=строка			Список имен шаблонов мониторов. Если раздела не указано в имени монитора, используется `partition`.
name строка			Имя пула псевдонимы: pool
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
priority_group_activation целое число			Указывает, балансирует ли система трафик в соответствии с номером приоритета, назначенным члену пула. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `0`. Чтобы отключить эту настройку, укажите значение `0`. После активации этой настройки вы можете указать приоритет члена пула при создании нового пула или на экране свойств члена пула. Система рассматривает членов пула с одинаковым приоритетом как группу. Чтобы активировать активацию группы приоритетов, укажите число от `0` до `65535`, которое представляет минимальное количество членов, которые должны быть доступны в одной группе приоритетов, прежде чем система перенаправит трафик на членов в группе с более низким приоритетом. Когда достаточное количество членов станет доступно в группе с более высоким приоритетом, система снова перенаправит трафик в группу с более высоким приоритетом. псевдонимы: minimum_active_members
provider словарь добавлен в 1.0.0 версии f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает провайдера аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem булево	Варианты: no yes	Если `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 yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самозаверенными сертификатами. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
quorum целое число			Значение кворума монитора, когда `monitor_type` равен `m_of_n`. Кворум должен быть значением 1 или больше, когда `monitor_type` равен `m_of_n`.
replace_all_with булево		Варианты: no ← yes	Удаляет пулы, не определенные в параметре `aggregate`. Эта операция выполняется все или ничего, то есть она остановится, если некоторые пулы не удастся удалить. псевдонимы: purge
reselect_tries целое число			Устанавливает количество попыток системы связаться с членом пула после пассивного отказа.
service_down_action строка		Варианты: none reset drop reselect	Устанавливает действие, которое следует выполнить при отключении узла в пуле.
slow_ramp_time целое число			Устанавливает время наращивания (в секундах) для постепенного увеличения нагрузки на вновь добавленных или недавно обнаруженных активных членах пула.
state строка		Варианты: absent present ←	При `present`, гарантирует, что пул существует с предоставленными атрибутами. При `absent`, удаляет пул из системы.

Примечания

Примечание

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

Примеры

- name: Create pool
  bigip_pool:
    state: present
    name: my-pool
    partition: Common
    lb_method: least-connections-member
    slow_ramp_time: 120
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Modify load balancer method
  bigip_pool:
    state: present
    name: my-pool
    partition: Common
    lb_method: round-robin
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Set a single monitor (with enforcement)
  bigip_pool:
    state: present
    name: my-pool
    partition: Common
    monitor_type: single
    monitors:
      - http
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Set a single monitor (without enforcement)
  bigip_pool:
    state: present
    name: my-pool
    partition: Common
    monitors:
      - http
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Set multiple monitors (all must succeed)
  bigip_pool:
    state: present
    name: my-pool
    partition: Common
    monitor_type: and_list
    monitors:
      - http
      - tcp
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Set multiple monitors (at least 1 must succeed)
  bigip_pool:
    state: present
    name: my-pool
    partition: Common
    monitor_type: m_of_n
    quorum: 1
    monitors:
      - http
      - tcp
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Delete pool
  bigip_pool:
    state: absent
    name: my-pool
    partition: Common
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add metadata to pool
  bigip_pool:
    state: present
    name: my-pool
    partition: Common
    metadata:
      ansible: 2.4
      updated_at: 2017-12-20T17:50:46Z
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add pools Aggregate
  bigip_pool:
    aggregate:
      - name: my-pool
        partition: Common
        lb_method: least-connections-member
        slow_ramp_time: 120
      - name: my-pool2
        partition: Common
        lb_method: least-sessions
        slow_ramp_time: 120
      - name: my-pool3
        partition: Common
        lb_method: round-robin
        slow_ramp_time: 120
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add pools Aggregate, purge others
  bigip_pool:
    aggregate:
      - name: my-pool
        partition: Common
        lb_method: least-connections-member
        slow_ramp_time: 120
      - name: my-pool2
        partition: Common
        lb_method: least-sessions
        slow_ramp_time: 120
      - name: my-pool3
        partition: Common
        lb_method: round-robin
        slow_ramp_time: 120
    replace_all_with: yes
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращаемое значение	Описание
description строка	changed	Описание, установленное для пула. Пример: Пул веб-серверов
lb_method строка	changed	Метод балансировки нагрузки, установленный для пула. Пример: round-robin
metadata словарь	changed	Новое значение пула. Пример: {'key1': 'foo', 'key2': 'bar'}
monitor_type строка	changed	Измененное значение для monitor_type пула. Пример: m_of_n
monitors список / элементы=строка	changed	Мониторы, установленные для пула. Пример: ['/Common/http', '/Common/gateway_icmp']
priority_group_activation целое число	changed	Новое минимальное количество членов для активации группы приоритетов. Пример: 10
quorum целое число	changed	Кворум, установленный для пула. Пример: 2
replace_all_with булево	changed	Удаляет все пулы, не являющиеся агрегированными, с устройства Пример: True
reselect_tries целое число	changed	Новое значение, установленное для количества попыток связи с членом. Пример: 10
service_down_action строка	changed	Действие при отключении службы, установленное для пула. Пример: reset
slow_ramp_time целое число	changed	Новое значение, установленное для времени медленного наращивания. Пример: 500

Авторы

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