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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: f5networks.f5_modules.bigip_pool.

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

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

Описание

Управляет пулами F5 BIG-IP LTM с помощью iControl REST API.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список / элементы=словарь			Список определений пулов для создания, изменения или удаления. При использовании `aggregates`, если одно из определений агрегата некорректно, выполнение агрегата завершится ошибкой, указав последнюю встреченную ошибку. Модуль не будет отменять изменения, внесенные до возникновения ошибки. Модуль также не будет указывать, какие изменения были внесены до сбоя. Поэтому настоятельно рекомендуется запускать модуль в режиме `check` для обеспечения базовой проверки перед выполнением этого модуля. псевдонимы: пулы
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 или больше было установлено либо в книге задач, либо уже существует на устройстве. И `single`, и `and_list` функционально идентичны, поскольку BIG-IP рассматривает все мониторы как «список».
monitors список / элементы=строка			Список имен шаблонов мониторинга. Если раздел не указан в имени монитора, используется опция `partition`.
name строка			Имя пула псевдонимы: пул
partition строка		По умолчанию: "Общий"	Раздел устройства для управления ресурсами.
priority_group_activation целое число			Указывает, балансирует ли система трафик в соответствии с приоритетом, назначенным члену пула. При создании нового пула, если этот параметр не указан, используется значение по умолчанию `0`. Чтобы отключить эту настройку, укажите значение `0`. После включения этой настройки вы можете указать приоритет члена пула при создании нового пула или на экране свойств члена пула. Система обрабатывает члены пула с одинаковым приоритетом как группу. Чтобы включить активацию группы приоритетов, укажите число от `0` до `65535`, которое представляет собой минимальное количество членов, которые должны быть доступны в одной группе приоритетов, прежде чем система направит трафик членам в группе более низкого приоритета. Когда достаточное количество членов станет доступно в группе более высокого приоритета, система снова направит трафик в группу более высокого приоритета. псевдонимы: minimum_active_members
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`.
quorum целое число			Значение кворума монитора, когда `monitor_type` равно `m_of_n`. Кворум должен быть значением 1 или больше, когда `monitor_type` равно `m_of_n`.
replace_all_with булево		Варианты: нет ← да	Удаляет пулы, не определенные в параметре `aggregate`. Эта операция выполняется целиком или ничего, то есть она остановится, если некоторые пулы не могут быть удалены. псевдонимы: очистить
reselect_tries целое число			Устанавливает количество попыток системы связаться с членом пула после пассивного сбоя.
service_down_action строка		Варианты: нет сбросить отбросить перевыбрать	Устанавливает действие, которое должно быть выполнено, когда узел в пуле выходит из строя.
slow_ramp_time целое число			Устанавливает время наращивания (в секундах), чтобы постепенно наращивать нагрузку на новые добавленные или недавно обнаруженные активные члены пула.
state строка		Варианты: отсутствует наличие ←	Когда `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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_pool_module.html