bigip_gtm_pool_member — Управление настройками участников пула GTM
Новая в версии 2.6.
Описание
- Управляет различными настройками участников пула GTM. Настройки, которые можно настроить с помощью этого модуля, значительно шире, чем те, что можно сделать в модуле
bigip_gtm_pool. Модуль пула предназначен для изменения порядка участников в пуле, а не различных настроек самих участников. Для настройки всех остальных параметров необходимо использовать модульbigip_gtm_pool_member.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description | Описание члена пула. | ||
| limits | Указывает пороги ресурсов или требования к ограничениям на уровне члена пула. При включении одного или нескольких параметров ограничения система использует эти данные для включения и выключения членов в работе. Вы можете определить ограничения для любого или всех параметров ограничений. Однако, когда член не соответствует требованиям порога ресурсов, система отмечает его как недоступный и направляет трафик балансировки нагрузки на другой ресурс. | ||
| bits_enabled bool |
| Включены ли ограничения по битам. Этот параметр позволяет включать или выключать действие ограничения. | |
| packets_enabled bool |
| Включены ли ограничения по пакетам. Этот параметр позволяет включать или выключать действие ограничения. | |
| connections_enabled bool |
| Включены ли ограничения на текущие соединения. Этот параметр позволяет включать или выключать действие ограничения. | |
| bits_limit | Указывает максимальную допустимую скорость пропускной способности данных в битах в секунду для члена. Если объем сетевого трафика превышает это ограничение, система отмечает члена как недоступного. | ||
| packets_limit | Указывает максимальную допустимую скорость передачи данных в пакетах в секунду для члена. Если объем сетевого трафика превышает это ограничение, система отмечает члена как недоступного. | ||
| connections_limit | Указывает максимальное количество одновременных соединений для всех членов. Если соединения превысят это ограничение, система отметит сервер как недоступный. | ||
| member_order | Указывает порядок отображения члена в пуле. Система использует это число с методами балансировки нагрузки, которые включают в себя приоритет членов пула, например, метод балансировки нагрузки Ratio. При создании нового члена с помощью этого модуля, если параметр member_order не указан, он будет по умолчанию равен 0 (первый член в пуле). | ||
| monitor | Указывает монитор, назначенный этому члену пула. Члены пула поддерживают только один монитор. Если port параметра gtm_virtual_server равен *, допустимые значения этого параметра будут изменены.При создании нового члена пула, если этот параметр не указан, будет использоваться значение по умолчанию default. Чтобы удалить монитор из члена пула, используйте значение none. Для членов пула, созданных на разных разделах, вы также можете указать полный путь к монитору Common. Например, /Common/tcp. | ||
| partition | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| pool обязательно | Имя пула GTM. | ||
| provider (добавлен в 2.5) | Объект dict, содержащий данные подключения. | ||
| 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, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами лично, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена. | |
| timeout | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настройка транспорта для подключения к удаленному устройству. | |
| ratio | Указывает вес члена пула для целей балансировки нагрузки. | ||
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| server_name обязательно | Указывает сервер GTM, содержащий virtual_server. | ||
| server_port (добавлен в 2.2) | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| state |
| Состояние члена пула. При значении present, гарантирует, что член пула создан и включен. При значении absent, гарантирует, что член пула удален из системы. При значении enabled или disabled, гарантирует, что член пула включен или отключен (соответственно) на удаленном устройстве.Рекомендуется использовать параметр members модуля bigip_gtm_pool при добавлении и удалении членов, так как это предоставляет более простой способ указания порядка. Если это невозможно, то следует использовать параметр state.Помните, что порядок членов будет изменен, если вы добавите или удалите их с помощью этого метода. В некоторой степени это можно контролировать с помощью параметра member_order. | |
| type обязательно |
| Тип пула GTM, в котором находится член. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена. | ||
| validate_certs bool (добавлен в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами лично, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена. | |
| virtual_server обязательно | Указывает имя виртуального сервера GTM, который назначен указанному server. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Create a ...
bigip_gtm_pool_member:
name: foo
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
Значения возврата
Общие возвращаемые значения задокументированы здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращено | Описание |
|---|---|---|
| param1 bool | изменено | Новое значение параметра param1 ресурса. Пример: True |
| param2 string | изменено | Новое значение параметра param2 ресурса. Пример: Foo is bar |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/bigip_gtm_pool_member_module.html