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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список добавлен в 2.8			Список определений пулов, которые должны быть созданы, изменены или удалены. псевдонимы: пулы
description строка добавлен в 2.3			Указывает описательный текст, который идентифицирует пул.
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		По умолчанию: "Общие"	Раздел устройства для управления ресурсами.
password строка / обязательно			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
priority_group_activation целое число добавлен в 2.6			Указывает, балансирует ли система трафик в соответствии с приоритетом, назначенным члену пула. При создании нового пула, если этот параметр не указан, по умолчанию используется `0`. Чтобы отключить эту настройку, укажите значение `0`. После включения этой настройки вы можете указать приоритет члена пула при создании нового пула или на экране свойств члена пула. Система обрабатывает члены пула с одинаковым приоритетом как группу. Чтобы включить активацию группы приоритетов, укажите число от `0` до `65535`, которое представляет собой минимальное количество членов, которые должны быть доступны в одной группе приоритетов, прежде чем система перенаправит трафик на членов группы с более низким приоритетом. Когда достаточное количество членов станет доступным в группе с более высоким приоритетом, система снова перенаправит трафик на группу с более высоким приоритетом. псевдонимы: minimum_active_members
provider словарь добавлен в 2.5			Объект словаря, содержащий сведения о подключении.
	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 целое число	По умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
	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 целое число добавлен в 2.2			Устанавливает количество попыток, предпринимаемых системой для связи с членом пула после пассивного отказа.
server строка / обязательно			Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.

server_port целое число добавлено в 2.2	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`.
service_down_action строка	Варианты: none reset drop reselect	Устанавливает действие, выполняемое при выходе узла из строя в пуле.
slow_ramp_time целое число		Устанавливает время наращивания (в секундах) для постепенного увеличения нагрузки на вновь добавленных или только что обнаруженных активных членах пула.
state строка добавлено в 2.5	Варианты: absent present ←	Когда `present`, гарантирует, что пул существует с указанными атрибутами. Когда `absent`, удаляет пул из системы.
user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs булево добавлено в 2.0	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на сайтах, которыми вы управляете, и которые используют самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`.

Примечания

Примечание

Для добавления членов в пул используйте модуль 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: absent
    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	Контакт, установленный в дата-центре. Пример: 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

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
Этот модуль поддерживается партнером Ansible. [certified]

Авторы

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.8/modules/bigip_pool_module.html