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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список добавлен в 2.8			Список определений пулов, которые нужно создать, изменить или удалить. При использовании `aggregates` если одно из определений агрегата некорректно, выполнение агрегированной задачи завершится с ошибкой, указав последнюю встреченную ошибку. Модуль `NOT` откатит все внесённые изменения до момента возникновения ошибки. Модуль также не укажет, какие изменения были внесены до ошибки, поэтому настоятельно рекомендуется запускать модуль в режиме проверки для базовой валидации перед выполнением модуля. псевдонимы: пулы
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 необработанные данные добавлен в 2.5			Произвольные пары ключ-значение, которые можно прикрепить к пулу. Это полезно в ситуациях, когда вам нужно добавить аннотацию к пулу, который управляется 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 или больше задано в скрипте или уже существует на устройстве. Оба `single` и `and_list` функционально идентичны, так как BIG-IP рассматривает все мониторы как «список».
monitors список			Список имен шаблонов мониторов. Если раздел не указан как часть имени монитора, будет использоваться опция `partition`.
name строка / обязательно			Имя пула псевдонимы: пул
partition строка добавлен в 2.5		Значение по умолчанию: "Общие"	Раздел устройства для управления ресурсами.
priority_group_activation целое число добавлен в 2.6			Указывает, балансирует ли система трафик в соответствии с приоритетом, назначенным члену пула. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `0`. Чтобы отключить эту настройку, укажите значение `0`. После включения этой настройки вы можете указать приоритет члена пула при создании нового пула или на экране свойств члена пула. Система рассматривает члены пула с одинаковым приоритетом как группу. Чтобы включить активацию группы приоритетов, укажите число от `0` до `65535`, которое представляет минимальное количество членов, которые должны быть доступны в одной группе приоритетов, прежде чем система перенаправит трафик на членов группы с более низким приоритетом. Когда достаточное количество членов станет доступно в группе с более высоким приоритетом, система снова перенаправит трафик на группу с более высоким приоритетом. псевдонимы: minimum_active_members
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`.
quorum целое число			Значение кворума монитора, когда `monitor_type` это `m_of_n`. Кворум должен быть значением 1 или больше, когда `monitor_type` это `m_of_n`.
replace_all_with булево добавлен в 2.8		Варианты: нет ← да	Удалить пулы, не определённые в параметре `aggregate`. Эта операция «все или ничего», что означает, что она остановится, если некоторые пулы не могут быть удалены. псевдонимы: очистить
reselect_tries целое число			Устанавливает количество попыток системы связаться с членом пула после пассивного отказа.
service_down_action строка		Варианты: ничего сбросить отбросить перевыбрать	Устанавливает действие, которое должно выполняться при отключении узла в пуле.

slow_ramp_time целое число			Устанавливает время нарастания нагрузки (в секундах) для постепенного наращивания нагрузки на новых или только что обнаруженных членах пула.
state строка добавлено в 2.5		Варианты: absent present ←	Когда `present`, гарантирует, что пул существует с предоставленными атрибутами. Когда `absent`, удаляет пул из системы.

Примечания

Примечание

Для добавления членов в пул используйте модуль bigip_pool_member. Ранее модуль bigip_pool позволял управлять членами, но это было удалено в версии 2.5 Ansible.
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Для обеспечения сохранения BIG-IP специфической конфигурации на диск, убедитесь, что включен хотя бы один таск, использующий модуль 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	Метод LB, установленный для пула. Пример: round-robin
metadata словарь	changed	Новое значение пула. Пример: {'key1': 'foo', 'key2': 'bar'}
monitor_type строка	changed	Контакт, установленный для дата-центра. Пример: admin@root.local
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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается партнером 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_pool_module.html