Модуль f5networks.f5_modules.bigip_pool — управление пулами F5 BIG-IP LTM

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_pool.

Добавлено в f5networks.f5_modules 1.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
aggregate псевдонимы: pools список / элементы=словарь	Список описаний пулов, которые необходимо создать, изменить или удалить. При использовании `aggregates`, если одно из описаний в aggregate недействительно, выполнение aggregate завершится ошибкой, в которой будет указана последняя обнаруженная ошибка. Модуль НЕ отменит изменения, внесённые до возникновения ошибки. Модуль также не укажет, какие изменения были внесены до сбоя. Поэтому мы настоятельно рекомендуем запускать модуль в режиме `check`, чтобы выполнить базовую проверку перед запуском этого модуля.
description строка	Задаёт описательный текст, идентифицирующий пул.
lb_method строка	Метод балансировки нагрузки. При создании нового пула, если это значение не указано, используется значение по умолчанию `round-robin`. Варианты: `"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"`
metadata любой тип	Произвольные пары «ключ/значение», которые можно прикрепить к пулу. Это полезно в ситуациях, когда нужно добавить к пулу аннотацию о том, что им управляет Ansible. Имена ключей хранятся в виде строк; это относится и к именам, являющимся числами. Значения всех ключей хранятся в виде строк; это относится и к значениям, являющимся числами. Данные сохраняются и не являются временными.
min_up_members целое число	Задаёт минимальное количество работоспособных участников пула, в противном случае система выполняет действие, указанное в параметре `min-up-members-action`. Используйте этот параметр для шлюзовых пулов в резервированной системе, где пулу назначен номер устройства. Это означает, что пул настроен только на указанном устройстве. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `0`.
min_up_members_action строка	Задаёт действие, которое необходимо выполнить, если `min_up_members_checking` имеет значение `enabled`, а количество активных участников пула становится меньше числа, указанного в параметре `min_up_members`. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `failover`. Варианты: `"failover"` `"reboot"` `"restart-all"`
min_up_members_checking строка	Включает или отключает функцию `min_up_members`. Если включить эту функцию, необходимо также указать значения для обоих параметров: `min_up_members` и `min_up_members_action`. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `disabled`. Варианты: `"enabled"` `"disabled"`
monitor_type псевдонимы: availability_requirements_type строка	Тип правила монитора, если указано `monitors`. При создании нового пула, если это значение не указано, используется значение по умолчанию `and_list`. При значении `single` проверяются все указанные мониторы, а также выполняется дополнительная проверка, гарантирующая, что указан только один монитор. При значении `and_list` проверяются все мониторы. При значении `m_of_n` проверяется `quorum` из `monitors`. Для `m_of_n` требуется, чтобы значение `quorum` было равно 1 или больше и было задано либо в плейбуке, либо уже существовало на устройстве. С точки зрения функциональности `single` и `and_list` идентичны, поскольку BIG-IP рассматривает все мониторы как «список». Варианты: `"and_list"` `"m_of_n"` `"single"`
monitors список / элементы=строка	Список имён шаблонов мониторов. Если раздел не указан в имени монитора, вместо него используется параметр `partition`.
name псевдонимы: pool строка	Имя пула
partition строка	Раздел устройства, в котором следует управлять ресурсами. По умолчанию: `"Common"`
priority_group_activation псевдонимы: minimum_active_members целое число	Указывает, распределяет ли система нагрузку между участниками пула в соответствии с назначенными им номерами приоритета. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `0`. Чтобы отключить этот параметр, укажите значение `0`. После включения этого параметра можно указать приоритет участника пула при создании нового пула или на экране свойств участника пула. Система рассматривает участников пула с одинаковым приоритетом как группу. Чтобы включить активацию группы приоритетов, укажите число от `0` до `65535`, соответствующее минимальному количеству участников, которое должно быть доступно в одной группе приоритетов, прежде чем система начнёт направлять трафик участникам группы с более низким приоритетом. Когда в группе с более высоким приоритетом становится доступно достаточное количество участников, система снова направляет трафик в эту группу.
quorum псевдонимы: availability_requirements_at_least целое число	Значение кворума мониторов, когда `monitor_type` имеет значение `m_of_n`. Если `monitor_type` имеет значение `m_of_n`, кворум должен быть равен 1 или больше.
reselect_tries целое число	Задаёт количество попыток системы связаться с участником пула после пассивного сбоя.
service_down_action строка	Задаёт действие, выполняемое при отказе узла в пуле. Варианты: `"none"` `"reset"` `"drop"` `"reselect"`
slow_ramp_time целое число	Задаёт время нарастания (в секундах), в течение которого постепенно увеличивается нагрузка на вновь добавленных или только что обнаруженных работоспособных участников пула.
state строка	При значении `present` гарантирует, что пул существует с указанными атрибутами. При значении `absent` удаляет пул из системы. Варианты: `"absent"` `"present"` ← (по умолчанию)
description строка	Задаёт описательный текст, идентифицирующий пул.
lb_method строка	Метод балансировки нагрузки. При создании нового пула, если это значение не указано, используется значение по умолчанию `round-robin`. Варианты: `"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"`
metadata любой тип	Произвольные пары «ключ/значение», которые можно прикрепить к пулу. Это полезно в ситуациях, когда нужно добавить к пулу аннотацию о том, что им управляет Ansible. Имена ключей хранятся в виде строк; это относится и к именам, являющимся числами. Значения всех ключей хранятся в виде строк; это относится и к значениям, являющимся числами. Данные сохраняются и не являются временными.
min_up_members целое число	Задаёт минимальное количество работоспособных участников пула, в противном случае система выполняет действие, указанное в параметре `min-up-members-action`. Используйте этот параметр для шлюзовых пулов в резервированной системе, где пулу назначен номер устройства. Это означает, что пул настроен только на указанном устройстве. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `0`.
min_up_members_action строка	Задаёт действие, которое необходимо выполнить, если `min_up_members_checking` имеет значение `enabled`, а количество активных участников пула становится меньше числа, указанного в параметре `min_up_members`. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `failover`. Варианты: `"failover"` `"reboot"` `"restart-all"`
min_up_members_checking строка	Включает или отключает функцию `min_up_members`. Если включить эту функцию, необходимо также указать значения для обоих параметров: `min_up_members` и `min_up_members_action`. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `disabled`. Варианты: `"enabled"` `"disabled"`
monitor_type псевдонимы: availability_requirements_type строка	Тип правила монитора, если указано `monitors`. При создании нового пула, если это значение не указано, используется значение по умолчанию `and_list`. При значении `single` проверяются все указанные мониторы, а также выполняется дополнительная проверка, гарантирующая, что указан только один монитор. При значении `and_list` проверяются все мониторы. При значении `m_of_n` проверяется `quorum` из `monitors`. Для `m_of_n` требуется, чтобы значение `quorum` было равно 1 или больше и было задано либо в плейбуке, либо уже существовало на устройстве. С точки зрения функциональности `single` и `and_list` идентичны, поскольку BIG-IP рассматривает все мониторы как «список». Варианты: `"and_list"` `"m_of_n"` `"single"`
monitors список / элементы=строка	Список имён шаблонов мониторов. Если раздел не указан в имени монитора, вместо него используется параметр `partition`.
name псевдонимы: pool строка	Имя пула
partition строка	Раздел устройства, в котором следует управлять ресурсами. По умолчанию: `"Common"`
priority_group_activation псевдонимы: minimum_active_members целое число	Указывает, распределяет ли система нагрузку между участниками пула в соответствии с назначенными им номерами приоритета. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `0`. Чтобы отключить этот параметр, укажите значение `0`. После включения этого параметра можно указать приоритет участника пула при создании нового пула или на экране свойств участника пула. Система рассматривает участников пула с одинаковым приоритетом как группу. Чтобы включить активацию группы приоритетов, укажите число от `0` до `65535`, соответствующее минимальному количеству участников, которое должно быть доступно в одной группе приоритетов, прежде чем система начнёт направлять трафик участникам группы с более низким приоритетом. Когда в группе с более высоким приоритетом становится доступно достаточное количество участников, система снова направляет трафик в эту группу.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации от удалённого устройства. Этот параметр используется преимущественно при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если задано `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как её имя вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server строка / обязательный	Узел BIG-IP или узел BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истекает до завершения операции, модуль выдаёт ошибку.
transport строка	Настраивает транспортное соединение, используемое для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.

validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах, которыми вы управляете лично и где используются самоподписанные сертификаты. Этот параметр можно не указывать, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
quorum псевдонимы: availability_requirements_at_least integer	Значение кворума монитора, когда `monitor_type` равно `m_of_n`. Если `monitor_type` равно `m_of_n`, значение кворума должно быть не меньше 1.
replace_all_with псевдонимы: purge boolean	Удаляет пулы, не указанные в параметре `aggregate`. Операция выполняется целиком или не выполняется вовсе: она будет остановлена, если некоторые пулы невозможно удалить. Варианты: `false` ← (по умолчанию) `true`
reselect_tries integer	Задает количество попыток системы связаться с участником пула после пассивного сбоя.
service_down_action string	Задает действие, выполняемое при отключении узла в пуле. Варианты: `"none"` `"reset"` `"drop"` `"reselect"`
slow_ramp_time integer	Задает время постепенного увеличения нагрузки (в секундах) на недавно добавленные или недавно обнаруженные работающие участники пула.
state string	Если `present`, гарантирует существование пула с указанными атрибутами. Если `absent`, удаляет пул из системы. Варианты: `"absent"` `"present"` ← (по умолчанию)

Примечания

Примечание

Дополнительные сведения об использовании 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: Set multiple monitors (at least 2 must succeed)
  bigip_pool:
    state: present
    name: my-pool
    partition: Common
    availability_requirements_type: m_of_n
    availability_requirements_at_least: 2
    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: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

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

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_pool_module.html