Spec-Zone.ru › Ansible 2.6

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

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

Описание

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

Требования

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

  • f5-sdk >= 3.0.9

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
description
(добавлено в 2.3)
Указывает описательный текст, идентифицирующий пул.
lb_method
(добавлено в 1.3)
    Варианты:
  • dynamic-ratio-member
  • dynamic-ratio-node
  • fastest-app-response
  • fastest-node
  • least-connections-member
  • least-connections-node
  • least-sessions
  • observed-member
  • observed-node
  • predictive-member
  • predictive-node
  • ratio-least-connections-member
  • ratio-least-connections-node
  • ratio-member
  • ratio-node
  • ratio-session
  • round-robin
  • weighted-least-connections-member
  • weighted-least-connections-node
Метод балансировки нагрузки. При создании нового пула, если это значение не указано, будет использовано значение по умолчанию round-robin.
metadata
(добавлено в 2.5)
Произвольные пары ключ/значение, которые можно прикрепить к пулу. Это полезно в ситуациях, когда вы хотите добавить аннотации к пулу, управляемому Ansible.
Имена ключей будут храниться в виде строк; это включает имена, которые являются числами.
Значения для всех ключей будут храниться в виде строк; это включает значения, которые являются числами.
Данные будут сохранены, а не временные.
monitor_type
(добавлено в 1.3)
    Варианты:
  • and_list
  • m_of_n
  • single
Тип правила мониторинга, когда monitors указано.
При создании нового пула, если это значение не указано, по умолчанию используется 'and_list'.
Когда single гарантирует, что все указанные мониторы проверяются, но также включает проверки, чтобы убедиться, что вы указали только один монитор.
Когда and_list гарантирует, что проверяются все мониторы.
Когда m_of_n гарантирует, что quorum из monitors проверяются. m_of_n требует, чтобы quorum 1 или больше было установлено либо в плейбуке, либо уже существует на устройстве.
И single, и and_list функционально идентичны, поскольку BIG-IP рассматривает все мониторы как «список».
monitors
(добавлено в 1.3)
Список имен шаблонов мониторинга. Если секция не указана как часть имени монитора, то вместо этого будет использоваться опция partition.
name
обязательно
Имя пула

псевдонимы: pool
partition
(добавлено в 2.5)
Значение по умолчанию:
"Common"
Раздел устройства для управления ресурсами.
password
обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.

псевдонимы: pass, pwd
priority_group_activation
(добавлено в 2.6)
Указывает, балансирует ли система трафик в соответствии с номером приоритета, назначенным члену пула.
При создании нового пула, если этот параметр не указан, используется значение по умолчанию 0.
Чтобы отключить эту настройку, укажите значение 0.
После включения этой настройки вы можете указать приоритет члена пула при создании нового пула или на экране свойств члена пула.
Система рассматривает члены пула с одинаковым приоритетом как группу.
Чтобы включить активацию группы приоритета, укажите число от 0 до 65535, которое представляет собой минимальное количество членов, которые должны быть доступны в одной группе приоритета, прежде чем система направит трафик на членов с более низким приоритетом.
Когда достаточное количество членов станет доступным в группе с более высоким приоритетом, система снова направляет трафик в группу с более высоким приоритетом.

псевдонимы: minimum_active_members
provider
(добавлено в 2.5)
Объект словаря, содержащий данные подключения.
password
обязательно
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.

псевдонимы: pass, pwd
server
обязательно
Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена.
server_port Значение по умолчанию:
443
Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена.
validate_certs
bool
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами лично, с самозаверяющими сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.
timeout Значение по умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку.
ssh_keyfile
Указывает файл ключа SSH для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
transport
обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное соединение для использования при подключении к удаленному устройству.
quorum
(добавлено в 1.3)
Значение кворума монитора, когда monitor_type является m_of_n.
Кворум должен быть значением 1 или больше, когда monitor_type является m_of_n.
reselect_tries
(добавлено в 2.2)
Устанавливает количество попыток системы связаться с членом пула после пассивного сбоя.
server
обязательно
Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена.
server_port
(добавлено в 2.2)
Значение по умолчанию:
443
Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена.
service_down_action
(добавлено в 1.3)
    Варианты:
  • none
  • reset
  • drop
  • reselect
Устанавливает действие, которое выполняется при выходе узла из строя в пуле.
slow_ramp_time
(добавлено в 1.3)
Устанавливает время наращивания (в секундах) для постепенного увеличения нагрузки на вновь добавленные или недавно обнаруженные активные члены пула.
state
(добавлено в 2.5)
    Варианты:
  • absent
  • present ←
Если present, гарантирует существование пула со всеми указанными атрибутами.
Если absent, удаляет пул из системы.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена.
validate_certs
bool

(добавлено в 2.0)
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами лично, с самозаверяющими сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена.

Примечания

Примечание

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

Примеры

- name: Create pool
  bigip_pool:
    server: lb.mydomain.com
    user: admin
    password: secret
    state: present
    name: my-pool
    partition: Common
    lb_method: least-connections-member
    slow_ramp_time: 120
  delegate_to: localhost

- name: Modify load balancer method
  bigip_pool:
    server: lb.mydomain.com
    user: admin
    password: secret
    state: present
    name: my-pool
    partition: Common
    lb_method: round-robin
  delegate_to: localhost

- 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
  delegate_to: localhost

- name: Set a single monitor (with enforcement)
  bigip_pool:
    server: lb.mydomain.com
    user: admin
    password: secret
    state: present
    name: my-pool
    partition: Common
    monitor_type: single
    monitors:
      - http
  delegate_to: localhost

- name: Set a single monitor (without enforcement)
  bigip_pool:
    server: lb.mydomain.com
    user: admin
    password: secret
    state: present
    name: my-pool
    partition: Common
    monitors:
      - http
  delegate_to: localhost

- name: Set multiple monitors (all must succeed)
  bigip_pool:
    server: lb.mydomain.com
    user: admin
    password: secret
    state: present
    name: my-pool
    partition: Common
    monitor_type: and_list
    monitors:
      - http
      - tcp
  delegate_to: localhost

- name: Set multiple monitors (at least 1 must succeed)
  bigip_pool:
    server: lb.mydomain.com
    user: admin
    password: secret
    state: present
    name: my-pool
    partition: Common
    monitor_type: m_of_n
    quorum: 1
    monitors:
      - http
      - tcp
  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: Delete pool
  bigip_pool:
    server: lb.mydomain.com
    user: admin
    password: secret
    state: absent
    name: my-pool
    partition: Common
  delegate_to: localhost

- name: Add metadata to pool
  bigip_pool:
    server: lb.mydomain.com
    user: admin
    password: secret
    state: absent
    name: my-pool
    partition: Common
    metadata:
      ansible: 2.4
      updated_at: 2017-12-20T17:50:46Z
  delegate_to: localhost

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

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

Ключ Возвращённое значение Описание
description
строка
changed
Описание пула.

Пример:
Пул веб-серверов
lb_method
строка
changed
Метод балансировки нагрузки для пула.

Пример:
round-robin
metadata
словарь
changed
Новое значение пула.

Пример:
{'key1': 'foo', 'key2': 'bar'}
monitor_type
строка
changed
Контакт, который был установлен для дата-центра.

Пример:
admin@root.local
monitors
список
changed
Мониторы, установленные для пула.

Пример:
['/Common/http', '/Common/gateway_icmp']
priority_group_activation
целое число
changed
Новое минимальное количество членов для активации группы приоритетов.

Пример:
10
quorum
целое число
changed
Кворум, установленный для пула.

Пример:
2
reselect_tries
целое число
changed
Новое значение, задающее количество попыток соединения с членом.

Пример:
10
service_down_action
строка
changed
Действие при недоступности службы в пуле.

Пример:
reset
slow_ramp_time
целое число
changed
Новое значение для времени медленного наращивания.

Пример:
500


Статус

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

Техническое обслуживание

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

Список других модулей, поддерживаемых сообществом 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.6/modules/bigip_pool_module.html

Spec-Zone.ru

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