f5networks.f5_modules.bigip_gtm_pool_member модуль — Управление параметрами членов пула GTM
Примечание
Этот модуль входит в состав коллекции f5networks.f5_modules (версия 1.31.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install f5networks.f5_modules.
Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_gtm_pool_member.
Введено в f5networks.f5_modules 1.0.0
Описание
- Управляет различными параметрами членов пула GTM (теперь BIG-IP DNS). Параметры, которые можно настроить с помощью этого модуля, намного шире, чем те, которые можно настроить с помощью модуля
bigip_gtm_pool. Модуль пула предназначен для изменения порядка членов в пуле, а не различных параметров членов. Для настройки всех остальных параметров следует использовать модульbigip_gtm_pool_member.
Параметры
Параметр | Комментарии |
|---|---|
aggregate aliases: members list / elements=dictionary | Список определений участников пула GTM, которые необходимо создать, изменить или удалить. При использовании Модуль Модуль также не будет указывать, какие изменения были внесены до сбоя, поэтому мы настоятельно рекомендуем запускать модуль в режиме проверки для базовой проверки перед выполнением модуля. |
|
description string |
Описание участника пула. |
|
limits dictionary |
Указывает пороговые значения ресурсов или требования к лимитам на уровне участника пула. При включении одной или нескольких настроек лимита система использует эти данные для включения и выключения участников из сервиса. Вы можете определить лимиты для любого или всех параметров лимита. Однако, когда участник не соответствует требованию порогового значения ресурса, система помечает участника как недоступный и перенаправляет трафик балансировки нагрузки на другой ресурс. |
|
bits_enabled boolean |
Включен ли лимит битов. Варианты:
|
|
bits_limit integer |
Указывает максимальную допустимую скорость передачи данных для участника в битах в секунду. |
|
connections_enabled boolean |
Включен ли лимит текущих подключений. Варианты:
|
|
connections_limit integer |
Указывает максимальное количество одновременных соединений, суммарно, для всех участников. |
|
packets_enabled boolean |
Включен ли лимит пакетов. Варианты:
|
|
packets_limit integer |
Указывает максимальную допустимую скорость передачи данных для участника в пакетах в секунду. |
|
member_order integer |
Указывает порядок, в котором участник будет отображаться в пуле. Система использует это число с методами балансировки нагрузки, которые включают приоритизацию участников пула, например, метод балансировки нагрузки Ratio. |
|
monitor string |
Указывает монитор, назначенный этому участнику пула. Участники пула поддерживают только один монитор. Если Если этот параметр не указан при создании нового участника пула, будет использоваться значение по умолчанию Чтобы удалить монитор из участника пула, используйте значение |
|
partition string |
Раздел устройства для управления ресурсами. По умолчанию: |
|
ratio integer |
Указывает вес участника пула для целей балансировки нагрузки. |
|
server_name string |
Указывает сервер GTM, содержащий |
|
state string |
Состояние участника пула. При значении Варианты:
|
|
virtual_server string |
Указывает имя виртуального сервера GTM, назначенного указанному |
description string | Описание члена пула. |
limits dictionary | Указывает пороговые значения ресурсов или требования к ограничениям на уровне члена пула. При включении одного или нескольких настроек ограничений система использует эти данные для включения и выключения членов. Можно определить ограничения для любых или всех настроек ограничений. Однако, когда член не соответствует порогу ресурса, система помечает его как недоступный и направляет трафик балансировки нагрузки на другой ресурс. |
|
bits_enabled boolean |
Включено ли ограничение по битам. Варианты:
|
|
bits_limit integer |
Устанавливает максимальную допустимую скорость пропускной способности данных для члена в битах в секунду. |
|
connections_enabled boolean |
Включено ли ограничение текущих соединений. Варианты:
|
|
connections_limit integer |
Устанавливает максимальное количество одновременных соединений, совместно для всех членов. |
|
packets_enabled boolean |
Включено ли ограничение пакетов. Варианты:
|
|
packets_limit integer |
Устанавливает максимальную допустимую скорость передачи данных для члена в пакетах в секунду. |
member_order integer | Указывает порядок отображения члена в пуле. Система использует это число с методами балансировки нагрузки, которые предполагают приоритет членов пула, например, методом балансировки Ratios. |
monitor string | Указывает монитор, назначенный данному члену пула. Члены пула поддерживают только один монитор. Если Если этот параметр не указан при создании нового члена пула, будет использоваться значение по умолчанию Чтобы удалить монитор из члена пула, используйте значение |
partition string | Раздел устройства для управления ресурсами. По умолчанию: |
pool string / обязательно | Имя пула GTM. Для пулов, созданных в разных разделах, необходимо указать раздел пула в полном формате пути, например, |
provider dictionary добавлено в f5networks.f5_modules 1.0.0 | Объект словаря, содержащий данные подключения. |
|
auth_provider string |
Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. |
|
no_f5_teem boolean |
Если Этот параметр можно опустить, задав переменную среды Предыдущая переменная Варианты:
|
|
password псевдонимы: pass, pwd string / обязательно |
Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно опустить, задав переменную среды |
|
server string / обязательно |
Хост BIG-IP или BIG-IQ. Этот параметр можно опустить, задав переменную среды |
|
server_port integer |
Порт сервера BIG-IP. Этот параметр можно опустить, задав переменную среды По умолчанию: |
|
timeout целое число |
Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. |
|
transport строка |
Настраивает транспортное подключение для подключения к удалённому устройству. Варианты:
|
|
user строка / обязательно |
Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды |
|
validate_certs булево |
Если Вы можете опустить этот параметр, установив переменную среды Варианты:
|
ratio целое число | Указывает вес участника пула для целей балансировки нагрузки. |
replace_all_with псевдонимы: purge булево | Удаляет участников, не определённых в параметре Эта операция выполняется полностью или не выполняется, т.е. она остановится, если некоторые участники пула не могут быть удалены. Варианты:
|
server_name строка | Указывает сервер GTM, который содержит |
state строка | Состояние участника пула. Когда Варианты:
|
type строка / обязательно | Тип пула GTM, в котором находится участник. Варианты:
|
virtual_server строка | Указывает имя виртуального сервера GTM, назначенного указанному |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP ≥ 12.
- Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, включите по крайней мере одну задачу, использующую модуль f5networks.f5_modules.bigip_config, для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Create a GTM pool member
bigip_gtm_pool_member:
pool: pool1
server_name: server1
virtual_server: vs1
type: a
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create a GTM pool member different partition
bigip_gtm_pool_member:
server_name: /Common/foo_name
virtual_server: GTMVSName
type: a
pool: /FooBar/foo-pool
partition: Common
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Add GTM pool members aggregate
bigip_gtm_pool_member:
pool: pool1
type: a
aggregate:
- server_name: server1
virtual_server: vs1
partition: Common
description: web server1
member_order: 0
- server_name: server2
virtual_server: vs2
partition: Common
description: web server2
member_order: 1
- server_name: server3
virtual_server: vs3
partition: Common
description: web server3
member_order: 2
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add GTM pool members aggregate, remove non aggregates
bigip_gtm_pool_member:
pool: pool1
type: a
aggregate:
- server_name: server1
virtual_server: vs1
partition: Common
description: web server1
member_order: 0
- server_name: server2
virtual_server: vs2
partition: Common
description: web server2
member_order: 1
- server_name: server3
virtual_server: vs3
partition: Common
description: web server3
member_order: 2
replace_all_with: true
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
bits_enabled boolean | Включена ли граница битов. Возвращаемое значение: changed Пример: |
bits_limit integer | Новая граница битов. Возвращаемое значение: changed Пример: |
connections_enabled boolean | Включена ли граница подключений. Возвращаемое значение: changed Пример: |
connections_limit integer | Новая граница подключений. Возвращаемое значение: changed Пример: |
description string | Новое описание члена. Возвращаемое значение: changed Пример: |
disabled boolean | Член пула отключен или нет. Возвращаемое значение: changed Пример: |
enabled boolean | Член пула включен или нет. Возвращаемое значение: changed Пример: |
member_order integer | Новый порядок отображения члена в пуле. Возвращаемое значение: changed Пример: |
monitor string | Новый монитор, назначенный члену пула. Возвращаемое значение: changed Пример: |
packets_enabled boolean | Включена ли граница пакетов. Возвращаемое значение: changed Пример: |
packets_limit integer | Новая граница пакетов. Возвращаемое значение: changed Пример: |
ratio integer | Новый вес члена для балансировки нагрузки. Возвращаемое значение: changed Пример: |
replace_all_with boolean | Удаляет все члены пула, кроме агрегированных, с устройства Возвращаемое значение: changed Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_gtm_pool_member_module.html