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 не может выбрать пул. | |
| fallback_ip | Указывает IPv4 или IPv6 адрес сервера, на который система перенаправляет запросы, когда не может использовать один из своих пулов. Обратите внимание, что система использует резервный IP-адрес только если выбран fallback_ip режим балансировки нагрузки. | ||
| fallback_lb_method |
| Режим балансировки нагрузки, который система пытается использовать, если оба preferred_lb_method и alternate_lb_method не могут выбрать пул. | |
| name обязательно | Имя пула GTM. | ||
| partition (добавлено в 2.5) | Значение по умолчанию: Common | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная окружения F5_PASSWORD установлена.алиасы: pass, pwd | ||
| preferred_lb_method |
| Режим балансировки нагрузки, который система пытается использовать в первую очередь. | |
| 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 обязательно |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| 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 (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте это только на сайтах, контролируемых вами, с самозаверенными сертификатами. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
Примечания
Примечание
- Требуется пакет Python netaddr на хосте. Это так же просто, как pip install netaddr.
- Для получения дополнительной информации об использовании Ansible для управления устройствами F5 Networks см. https://www.ansible.com/integrations/networks/f5.
- Требуется пакет Python f5-sdk на хосте. Это так же просто, как
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 строка | изменено | Новый альтернативный метод балансировки нагрузки для пула. Пример: drop-packet |
| fallback_ip строка | изменено | Новый резервный IP-адрес, используемый при балансировке нагрузки с использованием метода fallback_ip. Пример: 10.10.10.10 |
| fallback_lb_method строка | изменено | Новый резервный метод балансировки нагрузки для пула. Пример: fewest-hops |
| preferred_lb_method строка | изменено | Новый предпочтительный метод балансировки нагрузки для пула. Пример: topology |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Автор
- 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.5/modules/bigip_gtm_pool_module.html
