Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_gtm_pool_member — управление настройками участников пула GTM

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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

псевдонимы: members

list / элементы=dictionary

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

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

Модуль NOT не отменяет автоматически внесённые изменения, сделанные до возникновения ошибки.

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

description

string

Описание участника пула.

limits

dictionary

Задаёт пороговые значения ресурсов или ограничения на уровне участника пула.

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

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

bits_enabled

boolean

Включено ли ограничение скорости передачи данных в битах.

Варианты:

  • false
  • true

bits_limit

integer

Задаёт максимально допустимую скорость передачи данных для участника в битах в секунду.

connections_enabled

boolean

Включено ли ограничение на количество текущих подключений.

Варианты:

  • false
  • true

connections_limit

integer

Задаёт максимальное общее количество одновременных подключений для всех участников.

packets_enabled

boolean

Включено ли ограничение скорости передачи пакетов.

Варианты:

  • false
  • true

packets_limit

integer

Задаёт максимально допустимую скорость передачи данных для участника в пакетах в секунду.

member_order

integer

Задаёт порядок отображения участника в пуле.

Система использует это число в методах балансировки нагрузки, предусматривающих приоритет участников пула, например в методе балансировки Ratio.

monitor

string

Задаёт монитор, назначенный этому участнику пула.

Для участников пула поддерживается только один монитор.

Если port у gtm_virtual_server имеет значение *, допустимые значения этого параметра будут ограничены.

Если при создании участника пула этот параметр не указан, будет использовано значение по умолчанию default.

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

partition

string

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

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

ratio

integer

Задаёт вес участника пула для балансировки нагрузки.

server_name

string

Задаёт имя сервера GTM, содержащего virtual_server.

state

string

Состояние участника пула. Значение present обеспечивает создание и включение участника пула. Значение absent обеспечивает удаление участника пула из системы. Значение enabled или disabled обеспечивает включение или отключение участника (соответственно) на удалённом устройстве.

Варианты:

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

virtual_server

string

Задаёт имя виртуального сервера GTM, назначенного указанному server.

description

string

Описание участника пула.

limits

dictionary

Задаёт пороговые значения ресурсов или ограничения на уровне участника пула.

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

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

bits_enabled

boolean

Включено ли ограничение скорости передачи данных в битах.

Варианты:

  • false
  • true

bits_limit

integer

Задаёт максимально допустимую скорость передачи данных для участника в битах в секунду.

connections_enabled

boolean

Включено ли ограничение на количество текущих подключений.

Варианты:

  • false
  • true

connections_limit

integer

Задаёт максимальное общее количество одновременных подключений для всех участников.

packets_enabled

boolean

Включено ли ограничение скорости передачи пакетов.

Варианты:

  • false
  • true

packets_limit

integer

Задаёт максимально допустимую скорость передачи данных для участника в пакетах в секунду.

member_order

integer

Задаёт порядок отображения участника в пуле.

Система использует это число в методах балансировки нагрузки, предусматривающих приоритет участников пула, например в методе балансировки Ratio.

monitor

string

Задаёт монитор, назначенный этому участнику пула.

Для участников пула поддерживается только один монитор.

Если port у gtm_virtual_server имеет значение *, допустимые значения этого параметра будут ограничены.

Если при создании участника пула этот параметр не указан, будет использовано значение по умолчанию default.

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

partition

string

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

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

pool

string / обязательный

Имя пула GTM.

Для пулов, созданных в других разделах, необходимо указать раздел пула в формате полного пути, например /FooBar/pool_name.

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

псевдонимы: pass, pwd

string / обязательный

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

Этот параметр можно не указывать, задав переменную среды F5_PASSWORD.

server

string / обязательный

Узел BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_SERVER.

server_port

integer

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

Этот параметр можно не указывать, задав переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

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

transport

string

Настраивает транспортное соединение для подключения к удалённому устройству.

Варианты:

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

user

string / обязательный

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

Этот параметр можно не указывать, задав переменную среды F5_USER.

validate_certs

boolean

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

Этот параметр можно не указывать, задав переменную среды F5_VALIDATE_CERTS.

Варианты:

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

ratio

integer

Задаёт вес участника пула для балансировки нагрузки.

replace_all_with

псевдонимы: purge

boolean

Удаляет участников, не указанных в параметре aggregate.

Эта операция выполняется целиком или не выполняется вовсе: она остановится, если некоторые участники пула невозможно удалить.

Варианты:

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

server_name

string

Задаёт имя сервера GTM, содержащего virtual_server.

state

string

Состояние участника пула. Значение present обеспечивает создание и включение участника пула. Значение absent обеспечивает удаление участника пула из системы. Значение enabled или disabled обеспечивает включение или отключение участника (соответственно) на удалённом устройстве.

Варианты:

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

type

string / обязательный

Тип пула GTM, в который входит участник.

Варианты:

  • "a"
  • "aaaa"
  • "cname"
  • "mx"
  • "naptr"
  • "srv"

virtual_server

string

Задаёт имя виртуального сервера 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: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Возвращаемые значения

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

Ключ

Описание

bits_enabled

boolean

Включено ли ограничение для битов.

Возвращается: при изменении

Пример: true

bits_limit

integer

Новое значение ограничения bits_enabled.

Возвращается: при изменении

Пример: 100

connections_enabled

boolean

Включено ли ограничение для подключений.

Возвращается: при изменении

Пример: true

connections_limit

integer

Новое значение ограничения connections_limit.

Возвращается: при изменении

Пример: 100

description

string

Новое описание участника.

Возвращается: при изменении

Пример: "My description"

disabled

boolean

Отключен ли участник пула.

Возвращается: при изменении

Пример: true

enabled

boolean

Включен ли участник пула.

Возвращается: при изменении

Пример: true

member_order

integer

Новый порядок участника в пуле.

Возвращается: при изменении

Пример: 2

monitor

string

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

Возвращается: при изменении

Пример: "/Common/monitor1"

packets_enabled

boolean

Включено ли ограничение для пакетов.

Возвращается: при изменении

Пример: true

packets_limit

integer

Новое значение ограничения packets_limit.

Возвращается: при изменении

Пример: 100

ratio

integer

Новый вес участника при балансировке нагрузки.

Возвращается: при изменении

Пример: 10

replace_all_with

boolean

Удаляет с устройства все участники пула, не входящие в агрегат

Возвращается: при изменении

Пример: true

Авторы

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_gtm_pool_member_module.html

Spec-Zone.ru

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