bigip_pool - Управляет пулами F5 BIG-IP LTM
Обзор
- Управляет пулами F5 BIG-IP LTM через iControl REST API.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description (добавлено в 2.3) | Указывает описательный текст, идентифицирующий пул. | ||
| lb_method (добавлено в 1.3) |
| Метод балансировки нагрузки. При создании нового пула, если это значение не указано, будет использовано значение по умолчанию round-robin. | |
| metadata (добавлено в 2.5) | Произвольные пары ключ-значение, которые можно добавить к пулу. Это полезно в ситуациях, когда необходимо добавить аннотации к пулу, управляемому Ansible. Имена ключей будут храниться в виде строк; это включает имена, которые являются числами. Значения для всех ключей будут храниться в виде строк; это включает значения, которые являются числами. Данные будут сохранены, а не временные. | ||
| monitor_type (добавлено в 1.3) |
| Тип правила мониторинга, когда указано monitors. При создании нового пула, если это значение не указано, по умолчанию используется 'and_list'. Когда single, гарантирует, что все указанные мониторы проверяются, но дополнительно включает проверки, чтобы убедиться, что вы указали только один монитор.Когда and_list, гарантирует, что все мониторы проверяются.Когда m_of_n, гарантирует, что quorum из monitors проверяются. m_of_n **требует**, чтобы quorum от 1 или более был установлен либо в playbook, либо уже существует на устройстве.Как single, так и and_list функционально идентичны, так как BIG-IP рассматривает все мониторы как «список». | |
| monitors (добавлено в 1.3) | Список имен шаблонов монитора. Если раздел не указан как часть имени монитора, то вместо этого будет использовано значение partition. | ||
| name обязательно | Имя пула псевдонимы: pool | ||
| partition (добавлено в 2.5) | По умолчанию: Common | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль от учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| 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, сертификаты SSL не будут проверены. Используйте это только на контролируемых вами сайтах с самозаверяющимися сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена. | |
| transport обязательно |
| Настраивает транспортное подключение, используемое при подключении к удалённому устройству. | |
| 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) |
| Устанавливает действие, выполняемое при выходе узла из строя в пуле. | |
| slow_ramp_time (добавлено в 1.3) | Устанавливает время наращивания (в секундах) для постепенного наращивания нагрузки на новых добавленных или только что обнаруженных активных членах пула. | ||
| state (добавлено в 2.5) |
| При present, гарантирует, что пул существует с заданными атрибутами.При absent, удаляет пул из системы. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена. | ||
| validate_certs (добавлено в 2.0) |
| Если 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-connection-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 | Установленный метод LB для пула. Пример: round-robin |
| metadata словарь | changed | Новое значение пула. Пример: {'key2': 'bar', 'key1': 'foo'} |
| monitor_type строка | changed | Установленный контакт для дата-центра. Пример: admin@root.local |
| monitors список | changed | Установленные мониторы для пула. Пример: ['/Common/http', '/Common/gateway_icmp'] |
| quorum целое число | changed | Установленное значение кворума для пула. Пример: 2 |
| reselect_tries целое число | changed | Новое значение числа попыток соединения с членом. Пример: 10 |
| service_down_action строка | changed | Действие при отключении службы для пула. Пример: reset |
| slow_ramp_time целое число | changed | Новое значение времени медленного наращивания. Пример: 500 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.
Автор
- 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.5/modules/bigip_pool_module.html