Spec-Zone.ru › Ansible 2.11

f5networks.f5_modules.bigip_gtm_pool_member – Управление параметрами члена пула GTM

Примечание

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

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

Для использования в книге задач укажите: f5networks.f5_modules.bigip_gtm_pool_member.

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

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

Обзор

  • Управляет различными параметрами членов пула GTM (теперь BIG-IP DNS). Параметры, которые можно настроить с помощью этого модуля, гораздо шире, чем в модуле bigip_gtm_pool. Модуль пула предназначен для изменения порядка членов в пуле, а не различных настроек членов. Для настройки всех остальных параметров следует использовать модуль bigip_gtm_pool_member.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aggregate
list / elements=dictionary
Список определений членов пула GTM, которые должны быть созданы, изменены или удалены.
При использовании aggregates, если одно из определений агрегата неверно, запуск агрегата завершится ошибкой, указав последнюю обнаруженную ошибку.
Модуль NOT откатит все внесенные изменения до обнаружения ошибки.
Модуль также не укажет, какие изменения были внесены до сбоя, поэтому мы настоятельно рекомендуем вам запустить модуль в режиме проверки для проведения базовой проверки перед выполнением модуля.

Псевдонимы: members
description
строка
Описание члена пула.
limits
словарь
Устанавливает пороговые значения ресурсов или требования к ограничениям на уровне члена пула.
При включении одного или нескольких параметров ограничений система использует эти данные для включения и выключения членов пула.
Вы можете определить ограничения для любого или всех параметров ограничений. Однако, если член пула не соответствует требованиям порогового значения ресурса, система помечает его как недоступный и направляет трафик балансировки нагрузки на другой ресурс.
bits_enabled
булево
    Варианты:
  • нет
  • да
Включено ли ограничение по битам.
Этот параметр позволяет включать или отключать действие ограничения.
bits_limit
целое число
Устанавливает максимальную допустимую скорость передачи данных для члена пула в битах в секунду.
Если объем сетевого трафика превысит это ограничение, система пометит члена пула как недоступного.
connections_enabled
булево
    Варианты:
  • нет
  • да
Включено ли текущее ограничение по подключениям.
Этот параметр позволяет включать или отключать действие ограничения.
connections_limit
целое число
Устанавливает максимальное количество одновременных подключений для всех членов пула в совокупности.
Если количество подключений превысит это ограничение, система пометит сервер как недоступный.
packets_enabled
булево
    Варианты:
  • нет
  • да
Включено ли ограничение по пакетам.
Этот параметр позволяет включать или отключать действие ограничения.
packets_limit
целое число
Устанавливает максимальную допустимую скорость передачи данных для члена пула в пакетах в секунду.
Если объем сетевого трафика превысит это ограничение, система пометит члена пула как недоступного.
member_order
целое число
Устанавливает порядок отображения члена пула в пуле.
Система использует это число с методами балансировки нагрузки, предполагающими приоритет членов пула, такими как метод балансировки нагрузки Ratio.
При создании нового члена с помощью данного модуля, если параметр member_order не указан, он будет по умолчанию равен 0 (первый член пула).
monitor
строка
Указывает монитор, назначенный этому члену пула.
Члены пула поддерживают только один монитор.
Если port gtm_virtual_server *, допустимые значения этого параметра изменятся.
Если при создании нового члена пула этот параметр не указан, будет использоваться значение по умолчанию default.
Для удаления монитора из члена пула используйте значение none.
Для членов пула, созданных на разных разделах, вы также можете указать полный путь к общему монитору. Например, /Common/tcp.
partition
строка
Значение по умолчанию:
"Общий"
Раздел устройства для управления ресурсами.
pool
строка / обязательно
Имя пула GTM.
Для пулов, созданных на разных разделах, необходимо указать раздел пула в формате полного пути, например, /FooBar/pool_name.
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.
ratio
целое число
Устанавливает вес члена пула для целей балансировки нагрузки.
replace_all_with
булево
    Варианты:
  • нет ←
  • да
Удаляет членов, не определённых в параметре aggregate.
Эта операция выполняется полностью или нисколько, то есть она остановится, если некоторые члены пула не могут быть удалены.

Псевдонимы: purge
server_name
строка
Указывает сервер GTM, содержащий virtual_server.
state
строка
    Варианты:
  • present ←
  • absent
  • enabled
  • disabled
Состояние члена пула. При present, гарантируется создание и включение члена пула. При absent, гарантируется удаление члена пула из системы. При enabled или disabled, гарантируется включение или выключение (соответственно) члена пула на удалённом устройстве.
Мы рекомендуем использовать параметр members модуля bigip_gtm_pool при добавлении и удалении членов, так как это предоставляет более простой способ задания порядка. Если это невозможно, параметр state должен быть использован здесь.
Помните, что порядок членов будет изменён, если вы добавите или удалите их с помощью этого метода. В некоторой степени это можно контролировать с помощью параметра member_order.
type
строка / обязательно
    Варианты:
  • a
  • aaaa
  • cname
  • mx
  • naptr
  • srv
Тип пула GTM, в котором находится член пула.
virtual_server
строка
Указывает имя виртуального сервера GTM, назначенного указанному server.

Примечания

Примечание

  • Дополнительную информацию об использовании 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: yes
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Значения возврата

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

Ключ Возвращаемое значение Описание
bits_enabled
boolean
changed
Включена ли лимит bits.

Пример:
True
bits_limit
integer
changed
Новый лимит bits_enabled.

Пример:
100
connections_enabled
boolean
changed
Включен ли лимит connections.

Пример:
True
connections_limit
integer
changed
Новый лимит connections_limit.

Пример:
100
description
string
changed
Новое описание члена.

Пример:
Моё описание
disabled
boolean
changed
Член пула отключён или нет.

Пример:
True
enabled
boolean
changed
Член пула включён или нет.

Пример:
True
member_order
integer
changed
Новый порядок отображения члена в пуле.

Пример:
2
monitor
string
changed
Новый монитор, назначенный члену пула.

Пример:
/Common/monitor1
packets_enabled
boolean
changed
Включен ли лимит packets.

Пример:
True
packets_limit
integer
changed
Новый лимит packets_limit.

Пример:
100
ratio
integer
changed
Новая весовая оценка члена для балансировки нагрузки.

Пример:
10
replace_all_with
boolean
changed
Удаляет все члены пула, которые не являются агрегатами, с устройства

Пример:
True


Авторы

  • 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_gtm_pool_member_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API