bigip_pool – Управляет пулами F5 BIG-IP LTM
Описание
- Управляет пулами F5 BIG-IP LTM через iControl REST API.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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 | ||
| priority_group_activation - добавлен в 2.6 | Указывает, балансирует ли система трафик в соответствии с номером приоритета, назначенным члену пула. При создании нового пула, если этот параметр не указан, используется значение по умолчанию 0. Чтобы отключить эту настройку, укажите значение 0. После включения этой настройки вы можете указать приоритет члена пула при создании нового пула или на экране свойств члена пула. Система рассматривает члены пула с одинаковым приоритетом как группу. Чтобы включить активацию группы приоритетов, укажите число от 0 до 65535, которое представляет минимальное количество членов, которые должны быть доступны в одной группе приоритета, прежде чем система направит трафик на членов в группе с более низким приоритетом.Когда достаточное количество членов становится доступным в группе с более высоким приоритетом, система снова направляет трафик в группу с более высоким приоритетом. псевдонимы: minimum_active_members | ||
| provider - добавлен в 2.5 | Значение по умолчанию: null | Объект словаря, содержащий данные подключения. | |
| 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 - / обязательно |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить эту опцию, установив переменную окружения F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов.Вы можете опустить эту опцию, установив переменную окружения F5_VALIDATE_CERTS. | |
| 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 - added in 1.3 | Устанавливает время нарастания (в секундах) для постепенного увеличения нагрузки на новых или недавно обнаруженных членах пула. | ||
| state - added in 2.5 |
| Когда present, гарантирует, что пул существует с указанными атрибутами.Когда absent, удаляет пул из системы. | |
| user - / required | Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean added in 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах под вашим контролем, использующих самозаверенные сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Для добавления членов в пул используйте модуль
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. - Требуется версия программного обеспечения BIG-IP ≥ 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диске, убедитесь, что вы включили хотя бы одну задачу, которая использует модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения вашей текущей конфигурации.
Примеры
- 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 строка | изменён | Описание, установленное для пула. Пример: Пул веб-серверов |
| lb_method строка | изменён | Метод LB, установленный для пула. Пример: round-robin |
| metadata словарь | изменён | Новое значение пула. Пример: {'key1': 'foo', 'key2': 'bar'} |
| monitor_type строка | изменён | Контакт, установленный в дата-центре. Пример: admin@root.local |
| monitors список | изменён | Мониторы, установленные в пуле. Пример: ['/Common/http', '/Common/gateway_icmp'] |
| priority_group_activation целое число | изменён | Новое минимальное количество членов для активации группы приоритетов. Пример: 10 |
| quorum целое число | изменён | Кворум, установленный в пуле. Пример: 2 |
| reselect_tries целое число | изменён | Новое значение количества попыток связи с членом. Пример: 10 |
| service_down_action строка | изменён | Действие при отключении службы для пула. Пример: reset |
| slow_ramp_time целое число | изменён | Новое значение для времени медленного нарастания. Пример: 500 |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Данный модуль поддерживается партнером 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.7/modules/bigip_pool_module.html