Spec-Zone.ru › Ansible 2.7

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

Новая версия с 1.4.

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

Описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • f5-sdk >= 3.0.16

Параметры

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

псевдонимы: ip, host
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
boolean
добавлено в 2.6
    Варианты:
  • нет
  • да
Указывает, автоматически ли система создаёт временные узлы, используя IP-адреса, полученные в результате разрешения DNS-запроса для узла, определённого FQDN.
При значении yes, система генерирует временный узел для каждого IP-адреса, возвращённого в ответ на DNS-запрос для FQDN узла. Кроме того, если DNS-ответ указывает, что IP-адрес временного узла больше не существует, система удаляет временный узел.
При значении no, система разрешает DNS-запрос для FQDN узла с единственным IP-адресом, связанным с FQDN.
При создании нового члена пула значение по умолчанию для этого параметра — yes.
Этот параметр игнорируется, когда reuse_nodes имеет значение yes.
name
-
добавлено в 2.6
Имя узла для создания или повторного использования при создании нового члена пула.
Этот параметр необязателен и, если он не указан, имя узла будет создано автоматически на основе заданного address или fqdn.
Состояние enabled является псевдонимом для present.
partition
-
По умолчанию:
"Общий"
Раздел
password
- / обязательно
Пароль от учётной записи пользователя для подключения к BIG-IP.
Можно опустить этот параметр, задав переменную окружения F5_PASSWORD.

псевдонимы: pass, pwd
pool
- / обязательно
Имя пула. Пул должен существовать.
port
- / обязательно
Порт члена пула.
Это значение нельзя изменить после установки.
preserve_node
boolean
добавлено в 2.1
    Варианты:
  • нет
  • да
При значении absent пытается удалить узел, на который ссылается член пула.
Узел не будет удалён, если на него всё ещё ссылаются другие члены пула. В этом случае модуль не выдаст ошибку.
Установка значения yes отключает это поведение.
priority_group
-
добавлено в 2.5
Задает число, представляющее группу приоритетов для члена пула.
При добавлении нового члена значение по умолчанию — 0, что означает отсутствие приоритета.
Для задания приоритета необходимо активировать использование групп приоритетов при создании нового пула или при добавлении или удалении членов пула. При активации система распределяет трафик в соответствии с номером группы приоритетов, назначенной члену пула.
Чем больше число, тем выше приоритет, поэтому член с приоритетом 3 имеет более высокий приоритет, чем член с приоритетом 1.
provider
-
добавлено в 2.5
По умолчанию:
null
Объект типа dict, содержащий данные подключения.
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
-
По умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
transport
- / обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное соединение для подключения к удалённому устройству.
user
- / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве.
Можно опустить этот параметр, задав переменную окружения F5_USER.
validate_certs
boolean
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами лично, с самозаверяющими сертификатами.
Можно опустить этот параметр, задав переменную окружения F5_VALIDATE_CERTS.
rate_limit
-
Предел скорости члена пула (подключений в секунду). Установка значения 0 отключает ограничение.
ratio
-
Весовой коэффициент члена пула. Допустимые значения от 1 до 100. Новые члены пула — если это значение не переопределено — по умолчанию имеют значение 1.
reuse_nodes
boolean
добавлено в 2.6
    Варианты:
  • нет
  • да ←
Использует определения узлов, если запрошено.
server
- / обязательно
Хост BIG-IP.
Можно опустить этот параметр, задав переменную окружения F5_SERVER.
server_port
-
added in 2.2
Значение по умолчанию:
443
Порт сервера BIG-IP.
Этот параметр можно опустить, задав переменную среды F5_SERVER_PORT.
state
- / обязательно
    Варианты:
  • present ←
  • absent
  • enabled
  • disabled
  • forced_offline
Состояние члена пула.
user
- / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Этот параметр можно опустить, задав переменную среды F5_USER.
validate_certs
boolean
added in 2.0
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяемыми сертификатами.
Этот параметр можно опустить, задав переменную среды F5_VALIDATE_CERTS.

Примечания

Примечание

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

Примеры

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

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

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

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

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

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

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

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

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

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

Пример:
Мой член пула
fqdn
строка
изменено
FQDN члена пула.

Пример:
foo.bar.com
fqdn_auto_populate
логическое значение
изменено
Была ли включена автоматическая генерация FQDN для члена?

Пример:
True
priority_group
целое число
изменено
Новая группа приоритетов.

Пример:
3
rate_limit
целое число
изменено
Новый лимит скорости, в подключениях в секунду, для члена пула.

Пример:
100
ratio
целое число
изменено
Новое значение веса члена пула.

Пример:
50


Статус

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

Авторы

  • Tim Rupp (@caphrim007)

Подсказка

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

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

Spec-Zone.ru

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