Spec-Zone.ru › Ansible 2.9

bigip_pool_member – Управляет участниками пула F5 BIG-IP LTM

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

Описание

  • Управляет участниками пулов F5 BIG-IP LTM через iControl SOAP API.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
address
строка
IP-адрес члена пула. Может быть IPv4 или IPv6. При создании нового члена пула необходимо указать либо address, либо fqdn. Этот параметр нельзя изменить после установки.

Псевдонимы: ip, host
aggregate
список
добавлен в 2.8
Список определений членов пула, которые необходимо создать, изменить или удалить.
При использовании aggregates, если одно из определений в агрегате некорректно, выполнение агрегации завершится с ошибкой, которая будет последней встреченной.
Модуль NOT откатит все изменения, произведённые до возникновения ошибки.
Модуль также не укажет, какие изменения были внесены до момента ошибки, поэтому настоятельно рекомендуется запускать модуль в режиме проверки для базовой валидации перед выполнением модуля.

Псевдонимы: members
availability_requirements
словарь
добавлен в 2.8
Указывает, если активировано более одного монитора состояния, количество мониторов состояния, которые должны получить успешные ответы, чтобы соединение считалось доступным.
Указание пустой строки удалит мониторы и вернётся к наследованию от пула (по умолчанию).
Указание none значения полностью удалит мониторинг состояния от члена.
at_least
целое число
Указывает минимальное количество активных мониторов состояния, которые должны предоставить успешные результаты, прежде чем соединение будет считаться активным.
Этот параметр актуален только при использовании type at_least.
Этот параметр будет проигнорирован, если используется тип all.
type
строка
    Варианты:
  • all
  • at_least
Тип правила мониторинга при указании monitors.
При создании нового пула, если это значение не указано, по умолчанию будет использоваться 'all'.
connection_limit
целое число
Предел подключений для члена пула. Установка значения 0 отключает ограничение.
description
строка
Описание члена пула.
fqdn
строка
добавлен в 2.6
Имя FQDN члена пула. Может быть любым именем, являющимся допустимым именем DNS в соответствии с RFC 1123. Поэтому допустимы только символы от "A" до "Z", от "a" до "z", от "0" до "9", дефис ("-") и точка (".")
Имена FQDN должны содержать по крайней мере одну точку, отделяющую хост от домена. Пример: host.domain.
Имена FQDN должны заканчиваться буквой или цифрой.
При создании нового члена пула необходимо указать либо address, либо fqdn. Этот параметр нельзя изменить после установки.

Псевдонимы: hostname
fqdn_auto_populate
логическое значение
добавлен в 2.6
    Варианты:
  • no
  • yes
Указывает, автоматически ли система создаёт временные узлы, используя IP-адреса, возвращённые в результате разрешения запроса DNS для узла, определённого FQDN.
При yes, система генерирует временный узел для каждого IP-адреса, возвращённого в ответ на запрос DNS для FQDN узла. Кроме того, при том, что ответ DNS указывает на то, что IP-адрес временного узла больше не существует, система удаляет временный узел.
При no, система разрешает запрос DNS для FQDN узла с единственным IP-адресом, связанным с FQDN.
При создании нового члена пула значение параметра по умолчанию yes.
После установки этот параметр изменить нельзя.
Этот параметр игнорируется, когда reuse_nodes равно yes.
ip_encapsulation
строка
добавлен в 2.8
Указывает инкапсуляцию IP с использованием IPIP (инкапсуляция IP внутри IP, RFC 2003) или GRE (Generic Router Encapsulation, RFC 2784) для исходящих пакетов (от системы BIG-IP к члену пула серверов).
При none, отключает инкапсуляцию IP.
При inherit, наследует настройку инкапсуляции IP от пула члена.
При любом другом значении, Варианты: None, Наследовать от пула и Специфичный для члена.
monitors
список
добавлен в 2.8
Указывает мониторы состояния, которые система в настоящее время использует для мониторинга данного ресурса.
name
строка
добавлен в 2.6
Имя узла для создания или повторного использования при создании нового члена пула.
Этот параметр необязателен и, если не указан, имя узла будет создано автоматически из указанного address или fqdn.
Состояние enabled является псевдонимом present.
partition
строка
По умолчанию:
"Common"
Раздел для управления ресурсами.
pool
строка / обязательно
Имя пула. Этот пул должен существовать.
port
целое число / обязательно
Порт члена пула.
Это значение нельзя изменить после установки.
preserve_node
логическое значение
    Варианты:
  • no
  • yes
При состоянии absent, попытка удалить узел, на который ссылается член пула.
Узел не будет удалён, если он всё ещё ссылается на другие члены пула. В этом случае модуль не выдаст ошибку.
Установка этого параметра в yes отключает это поведение.
priority_group
целое число
добавлен в 2.5
Указывает число, представляющее группу приоритетов для члена пула.
При добавлении нового члена, значение по умолчанию 0, что означает, что у члена нет приоритета.
Для указания приоритета необходимо активировать использование групп приоритетов при создании нового пула или при добавлении или удалении членов пула. При активации система балансирует трафик в соответствии с номером группы приоритетов, назначенным члену пула.
Чем больше число, тем выше приоритет, поэтому член с приоритетом 3 имеет более высокий приоритет, чем член с приоритетом 1.
provider
словарь
добавлен в 2.5
Объект словаря, содержащий данные подключения.
auth_provider
строка
Конфигурирует поставщика аутентификации для получения маркеров аутентификации от удалённого устройства.
Этот параметр используется при работе с устройствами BIG-IQ.
password
строка / обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Этот параметр можно опустить, установив переменную среды F5_PASSWORD.

Псевдонимы: pass, pwd
server
строка / обязательно
Хост BIG-IP.
Этот параметр можно опустить, установив переменную среды F5_SERVER.
server_port
целое число
По умолчанию:
443
Порт сервера BIG-IP.
Этот параметр можно опустить, установив переменную среды F5_SERVER_PORT.
ssh_keyfile
путь
Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспортов cli.
Этот параметр можно опустить, установив переменную среды ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
transport
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное подключение для подключения к удалённому устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве.
Вы можете опустить этот параметр, задав переменную окружения F5_USER.
validate_certs
булево
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.
Вы можете опустить этот параметр, задав переменную окружения F5_VALIDATE_CERTS.
rate_limit
целое число
Предел скорости для членов пула (соединений в секунду). Установка значения 0 отключает ограничение.
ratio
целое число
Вес коэффициента соотношения членов пула. Допустимые значения от 1 до 100. Новые члены пула, если не переопределены, по умолчанию имеют значение 1.
replace_all_with
булево
добавлено в 2.8
    Варианты:
  • no ←
  • yes
Удаляет членов, не определённых в параметре aggregate.
Эта операция выполняется целиком или никак, что означает, что она остановится, если некоторые члены пула не могут быть удалены.

псевдонимы: purge
reuse_nodes
булево
добавлено в 2.6
    Варианты:
  • no
  • yes ←
Использует определения узлов, если запрошено.
state
строка / обязательно
    Варианты:
  • present ←
  • absent
  • enabled
  • disabled
  • forced_offline
Состояние члена пула.

Примечания

Примечание

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

Примеры

- name: Add pool member
  bigip_pool_member:
    pool: my-pool
    partition: Common
    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
    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
    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
    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: yes
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ Возвращаемое значение Описание
address
строка
изменён
Адрес члена пула.

Пример:
1.2.3.4
connection_limit
целое число
изменён
Новый предел подключений для члена пула

Пример:
1000
description
строка
изменён
Новое описание члена пула.

Пример:
Мой член пула
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


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

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

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_pool_member_module.html

Spec-Zone.ru

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