bigip_gtm_pool - Управляет пулами F5 BIG-IP GTM
Новая в версии 2.4.
Описание
- Управляет пулами F5 BIG-IP GTM.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
- netaddr
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| alternate_lb_method |
| Режим балансировки нагрузки, к которому система обращается, если preferred_lb_method не смог выбрать пул. | |
| availability_requirements (добавлено в 2.6) | Указывает, если активировано более одного монитора работоспособности, количество мониторов работоспособности, которые должны получить успешные ответы, чтобы соединение считалось доступным. | ||
| type |
| Тип правила мониторинга при указании monitors. При создании нового пула, если это значение не указано, используется значение по умолчанию 'all'. | |
| at_least | Указывает минимальное количество активных мониторов работоспособности, которые должны быть успешными, прежде чем соединение будет считаться активным. Этот параметр актуален только при использовании type типа at_least. Этот параметр будет проигнорирован, если используется тип all или require. | ||
| number_of_probes | Указывает минимальное количество тестов, которые должны быть успешными, для того чтобы сервер был признан активным. При создании нового виртуального сервера, если указан этот параметр, то также должен быть указан параметр number_of_probers. Значение этого параметра всегда должно быть меньше или равно значению number_of_probers. Этот параметр актуален только при использовании type типа require. Этот параметр будет проигнорирован, если используется тип all или at_least. | ||
| number_of_probers | Указывает количество проверочных агентов, которые должны быть использованы при выполнении тестов. При создании нового виртуального сервера, если указан этот параметр, то также должен быть указан параметр number_of_probes. Значение этого параметра всегда должно быть больше или равно значению number_of_probers. Этот параметр актуален только при использовании type типа require. Этот параметр будет проигнорирован, если используется тип all или at_least. | ||
| fallback_ip | Указывает IPv4 или IPv6 адрес сервера, на который система перенаправляет запросы, когда не может использовать один из своих пулов. Обратите внимание, что система использует резервный IP-адрес только если выбран метод балансировки нагрузки fallback_ip. | ||
| fallback_lb_method |
| Режим балансировки нагрузки, к которому система обращается, если preferred_lb_method и alternate_lb_method не смогли выбрать пул. | |
| members (добавлено в 2.6) | Члены, которые нужно назначить в пул. Порядок членов в этом списке определяет порядок их расположения в пуле. | ||
| server обязательно | Имя сервера, частью которого является член пула. | ||
| virtual_server обязательно | Имя виртуального сервера, связанного с сервером, частью которого является член пула. | ||
| monitors (добавлено в 2.6) | Указывает мониторы работоспособности, которые система в настоящее время использует для мониторинга этого ресурса. Если availability_requirements.type require, в списке monitors может быть только один монитор. | ||
| name обязательно | Имя пула GTM. | ||
| partition (добавлено в 2.5) | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| preferred_lb_method |
| Режим балансировки нагрузки, который система пытается использовать в первую очередь. | |
| 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 обязательно |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| state |
| Состояние пула. При present, гарантирует создание и включение пула. При absent, гарантирует удаление пула из системы. При enabled или disabled, гарантирует включение или отключение (соответственно) пула на удалённом устройстве. | |
| type |
| Тип пула GTM, который вы хотите создать. В релизах BIG-IP до версии 12 этот параметр не требуется. В более поздних версиях BIG-IP это обязательный параметр. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена. | ||
| validate_certs bool (added in 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте этот параметр только на сайтах, контролируемых вами, которые используют самозаверяющие сертификаты. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS задана. | |
Примечания
Примечание
- Требуется пакет netaddr Python на хосте. Установка выполняется командой pip install netaddr.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. в https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Установка выполняется командой
pip install f5-sdk.
Примеры
- name: Create a GTM pool
bigip_gtm_pool:
server: lb.mydomain.com
user: admin
password: secret
name: my_pool
delegate_to: localhost
- name: Disable pool
bigip_gtm_pool:
server: lb.mydomain.com
user: admin
password: secret
state: disabled
name: my_pool
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| alternate_lb_method string | changed | Новый альтернативный метод балансировки нагрузки для пула. Пример: drop-packet | |
| fallback_ip string | changed | Новый IP-адрес резервного копирования, используемый при балансировке нагрузки с использованием метода fallback_ip.Пример: 10.10.10.10 | |
| fallback_lb_method string | changed | Новый резервный метод балансировки нагрузки для пула. Пример: fewest-hops | |
| members complex | changed | Список членов в пуле. | |
| server string | changed | Имя части сервера члена. | |
| virtual_server string | changed | Имя виртуального сервера части члена. | |
| monitors list | changed | Новый список мониторов для ресурса. Пример: ['/Common/monitor1', '/Common/monitor2'] | |
| preferred_lb_method string | changed | Новый предпочтительный метод балансировки нагрузки для пула. Пример: topology | |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики гарантируют отсутствие несовместимых изменений интерфейса.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом 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_module.html
