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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

Впервые в f5networks.f5_modules 1.0.0

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

Описание

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

Параметры

Параметр	Комментарии
адрес псевдонимы: ip, хост строка	IP-адрес члена пула. Он может быть IPv4 или IPv6. При создании нового члена пула необходимо указать один из `address` или `fqdn`. Этот параметр нельзя обновить после его установки.
агрегированный псевдонимы: члены список / элементы=словарь	Список определений членов пула, которые необходимо создать, изменить или удалить. При использовании `aggregates`, если одно из агрегированных определений неверно, выполнение агрегации завершится с ошибкой, указав последнюю обнаруженную ошибку. Модуль НЕ БУДЕТ откатывать внесенные изменения до момента обнаружения ошибки. Модуль также не будет указывать, какие изменения были внесены до возникновения ошибки. Поэтому настоятельно рекомендуется запускать модуль в режиме `check` для обеспечения базовой проверки перед выполнением этого модуля.
адрес псевдонимы: ip, хост строка	IP-адрес члена пула. Он может быть IPv4 или IPv6. При создании нового члена пула необходимо указать один из `address` или `fqdn`. Этот параметр нельзя обновить после его установки.
требования_доступности словарь	Если активировано более одного монитора состояния, указывает количество мониторов состояния, которые должны получить успешные ответы, чтобы соединение считалось доступным. Указание пустой строки удалит мониторы и вернет к наследованию от пула (по умолчанию). Указание `none` полностью удалит мониторинг состояния от члена.
по_крайней_мере целое_число	Указывает минимальное количество активных мониторов состояния, которые должны быть успешными, прежде чем соединение будет считаться активным. Этот параметр актуален только при использовании `type` `at_least`. Этот параметр будет проигнорирован, если используется тип `all`.
тип строка / обязательно	Тип правила мониторинга, когда указано `monitors`. При создании нового пула, если значение не указано, будет использоваться значение по умолчанию `all`. Варианты: `"all"` `"at_least"`
предел_соединений целое_число	Предел подключений члена пула. Установка значения `0` отключает предел.
описание строка	Описание члена пула.
полное_имя_домена псевдонимы: имя_хоста строка	Полное доменное имя (FQDN) члена пула. Это может быть любое имя, которое является допустимым именем DNS по RFC 1123. Поэтому единственными допустимыми символами являются латинские буквы «A» до «Z», «a» до «z», цифры «0» до «9», дефис («-») и точка («.»). Полные доменные имена (FQDN) должны содержать по крайней мере одну точку, разделяющую имя хоста и домен. Например, `host.domain`. Полные доменные имена (FQDN) должны заканчиваться буквой или цифрой. При создании нового члена пула необходимо указать один из `address` или `fqdn`. Этот параметр нельзя обновить после его установки.
автозаполнение_fqdn булево	Указывает, автоматически ли система создает временные узлы, используя IP-адреса, возвращенные в результате разрешения запроса DNS для узла, определенного полным доменным именем (FQDN). При `true`, система генерирует временный узел для каждого IP-адреса, возвращенного в ответ на запрос DNS для полного доменного имени (FQDN) узла. Кроме того, когда ответ DNS указывает, что IP-адрес временного узла больше не существует, система удаляет временный узел. При `false`, система разрешает запрос DNS для полного доменного имени (FQDN) узла с единственным IP-адресом, связанным с полным доменным именем (FQDN). При создании нового члена пула значение этого параметра по умолчанию равно `true`. После установки этот параметр изменить нельзя. Этот параметр игнорируется, когда `reuse_nodes` равно `true`. Варианты: `false` `true`
инкапсуляция_ip строка	Указывает инкапсуляцию IP, используя либо IPIP (инкапсуляция IP в IP, RFC 2003), либо GRE (Generic Router Encapsulation, RFC 2784) для исходящих пакетов (от системы BIG-IP к члену пула серверов). При значении `none`, отключает инкапсуляцию IP. При значении `inherit`, наследует значение инкапсуляции IP от пула члена. При любом другом значении доступны варианты: None, Наследовать из пула и Узел-специфический.
мониторы список / элементы=строка	Указывает мониторы состояния, которые в настоящее время используются для мониторинга этого ресурса.

name строка	Имя узла для создания или повторного использования при создании нового члена пула. Хотя этот параметр необязателен, мы рекомендуем указывать его всегда, чтобы избежать неожиданного поведения. Если не указано, имя узла создается автоматически из указанного `address` или `fqdn`. Состояние `enabled` является псевдонимом `present`.
partition строка	Раздел для управления ресурсами. По умолчанию: `"Common"`
port целое число	Порт члена пула. Это значение нельзя изменить после его установки. Параметр должен быть предоставлен при использовании агрегатов.
preserve_node булево	Когда состояние `absent`, система пытается удалить узел, к которому ссылается член пула. Узел не будет удален, если он все еще используется другими членами пула. В этом случае модуль не выведет ошибку. Указание `true` отключает это поведение. Варианты: `false` `true`
priority_group целое число	Указывает число, представляющее группу приоритетов для члена пула. При добавлении нового члена значение по умолчанию равно `0`, что означает, что член не имеет приоритета. Для задания приоритета необходимо активировать использование групп приоритетов при создании нового пула или при добавлении или удалении членов пула. При активации система распределяет нагрузку в соответствии с номером группы приоритетов, назначенным члену пула. Чем больше число, тем выше приоритет. Так, член с приоритетом 3 имеет более высокий приоритет, чем член с приоритетом 1.
rate_limit целое число	Предел скорости члена пула (соединений в секунду). Установка значения в `0` отключает ограничение.
ratio целое число	Весовой коэффициент отношения члена пула. Допустимые значения находятся в диапазоне от 1 до 100. Новые члены пула (если не переопределено этим значением) по умолчанию имеют значение 1.
reuse_nodes булево	Использует определения узлов, если это запрошено. Варианты: `false` `true` ← (по умолчанию)
state строка	Состояние члена пула. Варианты: `"present"` ← (по умолчанию) `"absent"` `"enabled"` `"disabled"` `"forced_offline"`
availability_requirements словарь	Если активировано более одного монитора работоспособности, указывает количество мониторов работоспособности, которые должны получить успешные ответы, чтобы ссылка считалась доступной. Указание пустой строки удалит мониторы и вернет к наследованию от пула (по умолчанию). Указание `none` полностью удалит любой мониторинг работоспособности из члена.
at_least целое число	Указывает минимальное количество активных мониторов работоспособности, которые должны быть успешными, прежде чем ссылка будет считаться активной. Этот параметр важен только при использовании `type` типа `at_least`. Этот параметр будет проигнорирован, если используется тип `all`.
type строка / обязательно	Тип правила мониторинга, когда указано `monitors`. При создании нового пула, если это значение не указано, используется значение по умолчанию `all`. Варианты: `"all"` `"at_least"`
connection_limit целое число	Ограничение соединений члена пула. Установка значения в `0` отключает ограничение.
description строка	Описание члена пула.
fqdn псевдонимы: hostname строка	FQDN имя члена пула. Это может быть любое имя, являющееся допустимым именем DNS согласно RFC 1123. Следовательно, единственные допустимые символы – это “A” до “Z”, “a” до “z”, “0” до “9”, тире (“-”) и точка (“.”). FQDN имена должны содержать по крайней мере одну точку; разделяя хост и домен. Например, `host.domain`. FQDN имена должны заканчиваться буквой или цифрой. При создании нового члена пула необходимо указать либо `address`, либо `fqdn`. Этот параметр нельзя обновить после его установки.

fqdn_auto_populate boolean	Указывает, автоматически ли система создаёт временные узлы, используя IP-адреса, возвращённые в результате разрешения DNS-запроса для узла, определённого FQDN. Когда `true`, система генерирует временный узел для каждого IP-адреса, возвращённого в ответ на DNS-запрос для FQDN узла. Кроме того, когда DNS-ответ указывает, что IP-адрес временного узла больше не существует, система удаляет временный узел. Когда `false`, система разрешает DNS-запрос для FQDN узла с единственным IP-адресом, связанным с FQDN. При создании нового члена пула значение по умолчанию для этого параметра — `true`. После установки этот параметр изменить нельзя. Этот параметр игнорируется, когда `reuse_nodes` имеет значение `true`. Варианты: `false` `true`
ip_encapsulation string	Указывает IP-инкапсуляцию, используя IPIP (инкапсуляция IP внутри IP, RFC 2003) или GRE (Generic Router Encapsulation, RFC 2784) для исходящих пакетов (от системы BIG-IP к члену пула серверов). Когда `none`, отключается IP-инкапсуляция. Когда `inherit`, наследование настроек IP-инкапсуляции от пула члена. В остальных случаях возможные значения: None, Inherit from Pool, и Member Specific.
monitors list / elements=string	Указывает используемые в настоящее время мониторы состояния для мониторинга данного ресурса.
name string	Имя узла для создания или повторного использования при создании нового члена пула. Хотя этот параметр необязателен, рекомендуется его указывать всегда, чтобы избежать непредвиденного поведения. Если не указано, имя узла создаётся автоматически из указанного `address` или `fqdn`. Состояние `enabled` — это псевдоним состояния `present`.
partition string	Раздел для управления ресурсами. По умолчанию: `"Common"`
pool string / обязательно	Имя пула. Пул должен существовать.
port integer	Порт члена пула. Это значение изменить нельзя после его установки. Параметр должен быть предоставлен при использовании агрегатов.
preserve_node boolean	Когда состояние — `absent`, система пытается удалить узел, на который ссылается член пула. Узел не будет удалён, если он всё ещё ссылается на других членов пула. В этом случае модуль не выдаст ошибку. Установка значения `true` отключает это поведение. Варианты: `false` `true`
priority_group integer	Указывает число, представляющее группу приоритетов для члена пула. При добавлении нового члена значение по умолчанию — `0`, что означает отсутствие приоритета у члена. Для задания приоритета необходимо включить использование группы приоритетов при создании нового пула или при добавлении или удалении членов пула. При включении система распределяет трафик в соответствии с номером группы приоритетов, назначенной члену пула. Чем больше число, тем выше приоритет. Так, член с приоритетом 3 имеет более высокий приоритет, чем член с приоритетом 1.
provider dictionary added in f5networks.f5_modules 1.0.0	Объект словаря, содержащий сведения о подключении.
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` ← (по умолчанию)
rate_limit integer	Предел скорости для узла пула (соединения в секунду). Установка значения `0` отключает ограничение.
ratio integer	Вес коэффициента распределения для узла пула. Допустимые значения от 1 до 100. Новые узлы пула – если не указано иное – по умолчанию имеют значение 1.
replace_all_with псевдонимы: purge boolean	Удаляет узлы, не определённые в параметре `aggregate`. Эта операция выполняется полностью или не выполняется, то есть остановится, если некоторые узлы пула нельзя удалить. Варианты: `false` ← (по умолчанию) `true`
reuse_nodes boolean	Использует определения узлов, если запрошено. Варианты: `false` `true` ← (по умолчанию)
state string	Состояние узла пула. Варианты: `"present"` ← (по умолчанию) `"absent"` `"enabled"` `"disabled"` `"forced_offline"`

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что специфическая для BIG-IP конфигурация сохранится на диске, обязательно включите хотя бы одну задачу, которая использует модуль f5networks.f5_modules.bigip_config, для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Add pool member
  bigip_pool_member:
    pool: my-pool
    partition: Common
    name: my-member
    host: "{{ ansible_default_ipv4['address'] }}"
    port: 80
    description: web server
    connection_limit: 100
    rate_limit: 50
    ratio: 2
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Modify pool member ratio and description
  bigip_pool_member:
    pool: my-pool
    partition: Common
    name: my-member
    host: "{{ ansible_default_ipv4['address'] }}"
    port: 80
    ratio: 1
    description: nginx server
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove pool member from pool
  bigip_pool_member:
    state: absent
    pool: my-pool
    partition: Common
    name: my-member
    host: "{{ ansible_default_ipv4['address'] }}"
    port: 80
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Force pool member offline
  bigip_pool_member:
    state: forced_offline
    pool: my-pool
    partition: Common
    name: my-member
    host: "{{ ansible_default_ipv4['address'] }}"
    port: 80
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Create members with priority groups
  bigip_pool_member:
    pool: my-pool
    partition: Common
    host: "{{ item.address }}"
    name: "{{ item.name }}"
    priority_group: "{{ item.priority_group }}"
    port: 80
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost
  loop:
    - address: 1.1.1.1
      name: web1
      priority_group: 4
    - address: 2.2.2.2
      name: web2
      priority_group: 3
    - address: 3.3.3.3
      name: web3
      priority_group: 2
    - address: 4.4.4.4
      name: web4
      priority_group: 1

- name: Add pool members aggregate
  bigip_pool_member:
    pool: my-pool
    aggregate:
      - host: 192.168.1.1
        partition: Common
        port: 80
        description: web server
        connection_limit: 100
        rate_limit: 50
        ratio: 2
      - host: 192.168.1.2
        partition: Common
        port: 80
        description: web server
        connection_limit: 100
        rate_limit: 50
        ratio: 2
      - host: 192.168.1.3
        partition: Common
        port: 80
        description: web server
        connection_limit: 100
        rate_limit: 50
        ratio: 2
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add pool members aggregate, remove non aggregates
  bigip_pool_member:
    pool: my-pool
    aggregate:
      - host: 192.168.1.1
        partition: Common
        port: 80
        description: web server
        connection_limit: 100
        rate_limit: 50
        ratio: 2
      - host: 192.168.1.2
        partition: Common
        port: 80
        description: web server
        connection_limit: 100
        rate_limit: 50
        ratio: 2
      - host: 192.168.1.3
        partition: Common
        port: 80
        description: web server
        connection_limit: 100
        rate_limit: 50
        ratio: 2
    replace_all_with: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ	Описание
address строка	Адрес члена пула. Возвращаемое значение: изменённое Пример: `"1.2.3.4"`
connection_limit целое число	Новый предел подключений для члена пула. Возвращаемое значение: изменённое Пример: `1000`
description строка	Новое описание члена пула. Возвращаемое значение: изменённое Пример: `"My pool member"`
fqdn строка	FQDN члена пула. Возвращаемое значение: изменённое Пример: `"foo.bar.com"`
fqdn_auto_populate логическое значение	Установлена ли автоматическая генерация FQDN для члена или нет. Возвращаемое значение: изменённое Пример: `true`
monitors список / элементы=строка	Новый список мониторов для ресурса. Возвращаемое значение: изменённое Пример: `["/Common/monitor1", "/Common/monitor2"]`
priority_group целое число	Новая группа приоритетов. Возвращаемое значение: изменённое Пример: `3`
rate_limit целое число	Новый предел скорости, в подключениях в секунду, для члена пула. Возвращаемое значение: изменённое Пример: `100`
ratio целое число	Новый вес отношения члена пула. Возвращаемое значение: изменённое Пример: `50`
replace_all_with логическое значение	Удаляет всех членов пула, не являющихся агрегированными, с устройства. Возвращаемое значение: изменённое Пример: `true`

Авторы

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

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

© 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_pool_member_module.html