Spec-Zone.ru › Ansible 2.5

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

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

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

Описание

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

Требования

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

  • bigsuds
  • f5-sdk >= 3.0.9

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
connection_limit
Предел подключений к члену пула. Установка значения 0 отключает ограничение.
description
Описание члена пула.
host
обязательно
IP-адрес члена пула.

алиасы: address, name
monitor_state
(добавлен в 2.0)
    Варианты:
  • enabled
  • disabled
Установить статус доступности мониторинга для члена пула.
partition Значение по умолчанию:
Common
Раздел
password
обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_PASSWORD.

алиасы: pass, pwd
pool
обязательно
Имя пула. Этот пул должен существовать.
port
обязательно
Порт члена пула.
preserve_node
(добавлен в 2.1)
    Варианты:
  • yes
  • нет ←
Значение по умолчанию:
нет
Когда состояние отсутствует, и член пула больше не упоминается в других пулах, по умолчанию удаляется неиспользуемый объект узла. Установка значения 'yes' отключает это поведение.
priority_group
(добавлен в 2.5)
Указывает число, представляющее группу приоритетов для члена пула.
При добавлении нового члена значение по умолчанию равно 0, что означает, что член не имеет приоритета.
Для указания приоритета необходимо активировать использование группы приоритетов при создании нового пула или при добавлении или удалении членов пула. При активации система балансирует нагрузку в соответствии с номером группы приоритетов, назначенным члену пула.
Чем больше число, тем выше приоритет, поэтому член с приоритетом 3 имеет более высокий приоритет, чем член с приоритетом 1.
provider
(добавлен в 2.5)
Значение по умолчанию:
None
Объект словаря, содержащий сведения о подключении.
ssh_keyfile
Указывает SSH-ключевой файл для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout Значение по умолчанию:
10
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
server
обязательно
Хост BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_SERVER.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если установлена переменная среды F5_USER.
server_port Значение по умолчанию:
443
Порт сервера BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_SERVER_PORT.
password
обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_PASSWORD.

алиасы: pass, pwd
validate_certs
    Варианты:
  • no
  • да ←
Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Можно опустить этот параметр, если установлена переменная среды F5_VALIDATE_CERTS.
transport
обязательно
    Варианты:
  • rest
  • cli ←
Настройка транспортного подключения для подключения к удаленному устройству.
rate_limit
Предел скорости члена пула (подключений в секунду). Установка значения 0 отключает ограничение.
ratio
Вес коэффициента члена пула. Допустимые значения от 1 до 100. Новые члены пула — если не переопределено этим значением — по умолчанию равны 1.
server
обязательно
Хост BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_SERVER.
server_port
(добавлен в 2.2)
Значение по умолчанию:
443
Порт сервера BIG-IP. Можно опустить этот параметр, если установлена переменная среды F5_SERVER_PORT.
session_state
(добавлен в 2.0)
    Варианты:
  • enabled
  • disabled
Установить новый статус доступности сессии для члена пула.
state
обязательно
    Варианты:
  • present ←
  • absent
Состояние члена пула.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если установлена переменная среды F5_USER.
validate_certs
(добавлен в 2.0)
    Варианты:
  • no
  • да ←
Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Можно опустить этот параметр, если установлена переменная среды F5_VALIDATE_CERTS.

Примечания

Примечание

  • Требуется версия ПО BIG-IP >= 11
  • Требуется разработанный F5 модуль ‘bigsuds’ (см. http://devcentral.f5.com)
  • Лучше всего запускать как local_action в вашем playbook
  • Заменяет bigip_pool для управления членами пула
  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.

Примеры

- 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


# The BIG-IP GUI doesn't map directly to the API calls for "Pool ->
# Members -> State". The following states map to API monitor
# and session states.
#
# Enabled (all traffic allowed):
# monitor_state=enabled, session_state=enabled
# Disabled (only persistent or active connections allowed):
# monitor_state=enabled, session_state=disabled
# Forced offline (only active connections allowed):
# monitor_state=disabled, session_state=disabled
#
# See https://devcentral.f5.com/questions/icontrol-equivalent-call-for-b-node-down

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

Статус

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

Автор

  • Matt Hite (@mhite)
  • 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.5/modules/bigip_pool_member_module.html

Spec-Zone.ru

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