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

aggregate

aliases: pools

list / elements=dictionary

Список определений пула, которые необходимо создать, изменить или удалить.

При использовании aggregates, если одно из определений агрегата недействительно, выполнение агрегата завершится неудачей с указанием последней обнаруженной ошибки.

Модуль НЕ отменит никаких изменений, внесенных до обнаружения ошибки.

Модуль также не будет указывать, какие изменения были внесены до сбоя. Поэтому мы настоятельно рекомендуем запускать модуль в режиме check для обеспечения базовой проверки перед выполнением этого модуля.

description

string

Указывает описательный текст, идентифицирующий пул.

lb_method

string

Метод балансировки нагрузки. При создании нового пула, если это значение не указано, используется значение по умолчанию 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

any

Произвольные пары ключ/значение, которые можно прикрепить к пулу. Это полезно в ситуациях, когда может потребоваться аннотировать пул для управления Ansible.

Имена ключей хранятся как строки; это включает имена, которые являются числами.

Значения для всех ключей хранятся как строки; это включает значения, которые являются числами.

Данные будут сохраняться, а не быть временными.

min_up_members

integer

Указывает минимальное количество участников пула, которые должны быть активны,

в противном случае система выполняет действие, указанное в параметре min-up-members-action.

Используйте этот параметр для пулов шлюзов в избыточной системе, где к пулу применяется номер блока.

Это указывает, что пул настроен только на указанном блоке.

При создании нового пула, если этот параметр не указан, значение по умолчанию равно 0.

min_up_members_action

string

Указывает действие, которое необходимо выполнить, если min_up_members_checking равно enabled и количество активных участников пула падает ниже числа, указанного в параметре min_up_members.

При создании нового пула, если этот параметр не указан, значение по умолчанию равно failover.

Варианты:

• "failover"
• "reboot"
• "restart-all"

min_up_members_checking

string

Включает или отключает функцию min_up_members.

Если вы включите эту функцию, вы также должны указать значение для параметров min_up_members и min_up_members_action.

При создании нового пула, если этот параметр не указан, значение по умолчанию равно disabled.

Варианты:

• "enabled"
• "disabled"

monitor_type

aliases: availability_requirements_type

string

Тип правила мониторинга, когда указан monitors.

При создании нового пула, если это значение не указано, используется значение по умолчанию and_list.

При single, гарантируется проверка всех указанных мониторов, но также включаются проверки, чтобы убедиться, что вы указали только один монитор.

При and_list, гарантируется проверка всех мониторов.

При m_of_n, гарантируется проверка quorum из monitors . m_of_n требует установки quorum 1 или большего значения либо в playbook, либо уже существующего на устройстве.

И single, и and_list функционально идентичны, поскольку BIG-IP рассматривает все мониторы как «список».

Варианты:

• "and_list"
• "m_of_n"
• "single"

monitors

list / elements=string

Список имен шаблонов мониторов. Если раздел не указан как часть имени монитора, вместо него используется параметр partition.

name

aliases: pool

string

Имя пула

partition

string

Раздел устройства, на котором необходимо управлять ресурсами.

По умолчанию: "Common"

priority_group_activation

aliases: minimum_active_members

integer

Указывает, балансирует ли система нагрузку в соответствии с номером приоритета, назначенным члену пула.

При создании нового пула, если этот параметр не указан, используется значение по умолчанию 0.

Чтобы отключить эту настройку, укажите значение 0.

После активации этой настройки вы можете указать приоритет члена пула при создании нового пула или на экране свойств члена пула.

Система обрабатывает члены пула с одинаковым приоритетом как группу.

Чтобы включить активацию группы приоритетов, укажите число от 0 до 65535, которое представляет собой минимальное количество членов, которые должны быть доступны в одной группе приоритетов, прежде чем система перенаправит трафик на членов с более низким приоритетом.

Когда достаточное количество членов станет доступным в группе с более высоким приоритетом, система снова перенаправит трафик на группу с более высоким приоритетом.

quorum

aliases: availability_requirements_at_least

integer

Отслеживать значение кворума, когда monitor_type равно m_of_n.

Значение кворума должно быть 1 или больше, когда monitor_type равно m_of_n.

reselect_tries

integer

Устанавливает количество попыток системы связаться с членом пула после пассивного сбоя.

service_down_action

string

Устанавливает действие, которое должно быть выполнено, когда узел выходит из строя в пуле.

Варианты:

• "none"
• "reset"
• "drop"
• "reselect"

slow_ramp_time

integer

Устанавливает время нарастания (в секундах) для постепенного увеличения нагрузки на вновь добавленных или недавно обнаруженных активных членах пула.

state

string

Когда present, гарантирует, что пул существует с указанными атрибутами.

Когда absent, удаляет пул из системы.

Варианты:

• "absent"
• "present" ← (по умолчанию)

description

string

Указывает описательный текст, идентифицирующий пул.

lb_method

string

Метод балансировки нагрузки. При создании нового пула, если это значение не указано, используется значение по умолчанию 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

any

Произвольные пары ключ/значение, которые можно прикрепить к пулу. Это полезно в ситуациях, когда вам нужно добавить аннотацию к пулу, управляемому Ansible.

Имена ключей хранятся как строки; это включает имена, которые являются числами.

Значения для всех ключей хранятся как строки; это включает значения, которые являются числами.

Данные будут сохранены, а не временные.

min_up_members

integer

Указывает минимальное количество членов пула, которые должны быть активны,

в противном случае система выполняет действие, указанное в параметре min-up-members-action.

Используйте этот параметр для пулов шлюзов в редунданой системе, где присваивается номер устройства пулу.

Это указывает, что пул настроен только на указанном устройстве.

При создании нового пула, если этот параметр не указан, по умолчанию используется 0.

min_up_members_action

string

Указывает действие, которое должно быть выполнено, если min_up_members_checking равно enabled и количество активных членов пула падает ниже значения, указанного в параметре min_up_members.

При создании нового пула, если этот параметр не указан, по умолчанию используется failover.

Варианты:

• "failover"
• "reboot"
• "restart-all"

min_up_members_checking

string

Включает или отключает функцию min_up_members.

Если вы включите эту функцию, вам также необходимо указать значение для параметров min_up_members и min_up_members_action.

При создании нового пула, если этот параметр не указан, по умолчанию используется disabled.

Варианты:

• "enabled"
• "disabled"

monitor_type

aliases: availability_requirements_type

string

Тип правила мониторинга, когда указан monitors.

При создании нового пула, если это значение не указано, используется значение по умолчанию and_list.

Когда single, гарантируется проверка всех указанных мониторов, но дополнительно включаются проверки, чтобы убедиться, что вы указали только один монитор.

Когда and_list, гарантируется проверка всех мониторов.

Когда m_of_n, гарантируется проверка quorum из monitors. m_of_n требует установки значения quorum 1 или больше, либо в playbook, либо уже существующего на устройстве.

Оба single и and_list функционально идентичны, поскольку BIG-IP рассматривает все мониторы как «список».

Варианты:

• "and_list"
• "m_of_n"
• "single"

monitors

list / elements=string

Список имен шаблонов мониторов. Если раздел не указан как часть имени монитора, вместо него используется параметр partition.

name

aliases: pool

string

Имя пула

partition

string

Раздел устройства, на котором необходимо управлять ресурсами.

Значение по умолчанию: "Common"

priority_group_activation

aliases: minimum_active_members

integer

Указывает, балансирует ли система трафик в соответствии с приоритетным номером, назначенным участнику пула.

При создании нового пула, если этот параметр не указан, используется значение по умолчанию 0.

Чтобы отключить этот параметр, укажите значение 0.

После включения этого параметра вы можете указать приоритет участника пула при создании нового пула или на экране свойств участника пула.

Система рассматривает участников пула с одинаковым приоритетом как группу.

Чтобы включить активацию приоритетной группы, укажите число от 0 до 65535, которое представляет минимальное количество участников, которые должны быть доступны в одной приоритетной группе, прежде чем система начнет направлять трафик участникам в группе с более низким приоритетом.

Когда достаточное количество участников становится доступно в группе с более высоким приоритетом, система снова направляет трафик в группу с более высоким приоритетом.

provider

dictionary

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

Объект dict, содержащий данные подключения.

auth_provider

string

Настраивает поставщика авторизации для получения токенов аутентификации от удаленного устройства.

Этот параметр действительно используется при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если yes, данные телеметрии TEEM не отправляются в F5.

Вы можете опустить этот параметр, установив переменную среды F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM устарела, так как ее имя было непонятным.

Варианты:

• false ← (по умолчанию)
• true

password

aliases: pass, pwd

string / required

Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

server

string / required

Хост BIG-IP или хост BIG-IQ.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.

Значение по умолчанию: 443

timeout

integer

Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.

transport

string

Настраивает транспортное соединение, которое необходимо использовать при подключении к удаленному устройству.

Варианты:

• "rest" ← (по умолчанию)

user

string / required

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные права на устройстве.

Вы можете опустить этот параметр, установив переменную среды F5_USER.

validate_certs

boolean

Если no, SSL-сертификаты не проверяются. Используйте это только на лично контролируемых сайтах, использующих самоподписанные сертификаты.

Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

• false
• true ← (по умолчанию)

quorum

aliases: availability_requirements_at_least

целое число

Отслеживает значение quorum, когда monitor_type равно m_of_n.

Значение quorum должно быть 1 или больше, когда monitor_type равно m_of_n.

replace_all_with

aliases: purge

булево

Удаляет пулы, не определённые в параметре aggregate.

Данная операция выполняется целиком или не выполняется, то есть она остановится, если некоторые пулы не могут быть удалены.

Варианты:

• false ← (по умолчанию)
• true

reselect_tries

целое число

Устанавливает количество попыток системы связаться с членом пула после пассивного сбоя.

service_down_action

строка

Устанавливает действие, которое должно быть выполнено при выходе узла из строя в пуле.

Варианты:

• "none"
• "reset"
• "drop"
• "reselect"

slow_ramp_time

целое число

Устанавливает время наращивания нагрузки (в секундах) для постепенного наращивания нагрузки на недавно добавленных или только что обнаруженных активных членах пула.

state

строка

В случае present, гарантирует существование пула с указанными атрибутами.

В случае absent, удаляет пул из системы.

Варианты:

• "absent"
• "present" ← (по умолчанию)