bigip_gtm_pool – Управляет пулами F5 BIG-IP GTM
Новая в версии 2.4.
Описание
- Управляет пулами F5 BIG-IP GTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| alternate_lb_method строка |
| Режим балансировки нагрузки, к которому система обращается, если preferred_lb_method не смог выбрать пул. | |
| availability_requirements словарь добавлено в 2.6 | Указывает, если активировано более одного монитора работоспособности, количество мониторов работоспособности, которые должны получить успешные ответы, чтобы соединение считалось доступным. | ||
| at_least целое число | Устанавливает минимальное количество активных мониторов работоспособности, которые должны быть успешны, прежде чем соединение будет считаться активным. Этот параметр актуален только при использовании type типа at_least. Этот параметр будет проигнорирован, если используется тип all или require. | ||
| number_of_probers целое число | Указывает количество зондирующих агентов, которые должны быть использованы при выполнении зондирования. При создании нового виртуального сервера, если этот параметр указан, то должен также быть указан параметр number_of_probes. Значение этого параметра должно быть больше или равно значению number_of_probers. Этот параметр актуален только при использовании type типа require. Этот параметр будет проигнорирован, если используется тип all или at_least. | ||
| number_of_probes целое число | Устанавливает минимальное количество успешных зондирований, необходимых для объявления сервера активным. При создании нового виртуального сервера, если этот параметр указан, то должен также быть указан параметр number_of_probers. Значение этого параметра должно быть меньше или равно значению number_of_probers. Этот параметр актуален только при использовании type типа require. Этот параметр будет проигнорирован, если используется тип all или at_least. | ||
| type строка |
| Тип правила мониторинга, когда указан monitors. При создании нового пула, если это значение не указано, по умолчанию используется 'all'. | |
| fallback_ip строка | Указывает IPv4 или IPv6 адрес сервера, на который система перенаправляет запросы, когда не может использовать один из своих пулов. Обратите внимание, что система использует резервный IP-адрес только если выбран метод балансировки fallback_ip. | ||
| fallback_lb_method строка |
| Режим балансировки нагрузки, к которому система обращается, если оба preferred_lb_method и alternate_lb_method не смогли выбрать пул. | |
| max_answers_returned целое число добавлено в 2.8 | Указывает максимальное количество доступных виртуальных серверов, которые система отображает в ответе. Максимум 500. | ||
| members список добавлено в 2.6 | Члены, которые нужно назначить пулу. Порядок членов в этом списке соответствует порядку их отображения в пуле. | ||
| server строка / обязательно | Имя сервера, частью которого является член пула. | ||
| virtual_server строка / обязательно | Имя виртуального сервера, связанного с сервером, частью которого является член пула. | ||
| monitors список добавлено в 2.6 | Указывает мониторы работоспособности, которые система в настоящее время использует для мониторинга этого ресурса. Когда availability_requirements.type require, в списке monitors может быть только один монитор. | ||
| name строка / обязательно | Имя пула GTM. | ||
| partition строка добавлено в 2.5 | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| preferred_lb_method строка |
| Режим балансировки нагрузки, который система пытается использовать в первую очередь. | |
| provider словарь добавлено в 2.5 | Объект словаря, содержащий сведения о подключении. | ||
| auth_provider строка | Настраивает поставщика авторизации для получения маркеров авторизации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| 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 целое число | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль возвращает ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых вами, с самоподписанными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| state строка |
| Состояние пула. Когда present, гарантирует, что пул создан и активен. Когда absent, гарантирует, что пул удалён из системы. Когда enabled или disabled, гарантирует, что пул включён или выключен (соответственно) на удалённом устройстве. | |
| ttl целое число добавлено в 2.8 | Указывает количество секунд, в течение которых IP-адрес, после его нахождения, считается действительным. | ||
| type строка |
| Тип пула GTM, который вы хотите создать. В версиях BIG-IP до 12-й версии этот параметр не требуется. В более поздних версиях BIG-IP этот параметр обязателен. | |
Примечания
Примечание
- Поддержка версий TMOS ниже v12.x для данного модуля устарела и будет удалена в Ansible 2.12.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. в https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 изменяют только рабочую конфигурацию продукта F5. Для сохранения конфигурации BIG-IP на диске, убедитесь, что включён хотя бы один task, использующий модуль bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения вашей рабочей конфигурации.
Примеры
- name: Create a GTM pool
bigip_gtm_pool:
name: my_pool
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Disable pool
bigip_gtm_pool:
state: disabled
name: my_pool
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| alternate_lb_method строка | изменено | Новый альтернативный метод балансировки нагрузки для пула. Пример: drop-packet | |
| fallback_ip строка | изменено | Новый резервный IP-адрес, используемый при балансировке нагрузки с использованием метода fallback_ip.Пример: 10.10.10.10 | |
| fallback_lb_method строка | изменено | Новый резервный метод балансировки нагрузки для пула. Пример: fewest-hops | |
| max_answers_returned целое число | изменено | Новое значение Максимальное количество возвращённых ответов. Пример: 25 | |
| members сложное | изменено | Список участников пула. | |
| server строка | изменено | Имя серверной части участника. | |
| virtual_server строка | изменено | Имя виртуального сервера в части участника. | |
| monitors список | изменено | Новый список мониторов для ресурса. Пример: ['/Common/monitor1', '/Common/monitor2'] | |
| preferred_lb_method строка | изменено | Новый предпочитаемый метод балансировки нагрузки для пула. Пример: topology | |
Статус
- Для этого модуля гарантированы изменения интерфейса обратной совместимости в будущем. [stableinterface]
- Этот модуль поддерживается партнёром Ansible. [certified]
Авторы
- 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.9/modules/bigip_gtm_pool_module.html
