f5networks.f5_modules.bigip_gtm_virtual_server – Управляет виртуальными серверами F5 BIG-IP GTM
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Для использования в плейбуке укажите: f5networks.f5_modules.bigip_gtm_virtual_server.
Новый в версии 1.0.0: модуля f5networks.f5_modules
Обзор
- Управляет виртуальными серверами F5 BIG-IP GTM (теперь BIG-IP DNS). Один сервер GTM может иметь множество связанных с ним виртуальных серверов. Они организованы аналогично членам пула.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address строка | Указывает IP-адрес виртуального сервера. При создании нового виртуального сервера GTM этот параметр является обязательным. | ||
| availability_requirements словарь | Если активировано более одного монитора состояния, указывает количество мониторов состояния, которые должны получить успешные ответы, чтобы ссылка считалась доступной. | ||
| 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. | |
| limits словарь | Указывает пороги ресурсов или требования к ограничениям на уровне сервера. При включении одного или нескольких ограничений система использует эти данные для включения и выключения серверов. Вы можете определить ограничения для любых или всех параметров ограничений. Однако, когда сервер не соответствует требованию порога ресурса, система помечает весь сервер как недоступный и перенаправляет трафик балансировки нагрузки на другой ресурс. Доступные параметры ограничений зависят от типа сервера. | ||
| bits_enabled логический тип |
| Включено или выключено ограничение по битам. Этот параметр позволяет включать и выключать действие ограничения. | |
| bits_limit целое число | Указывает максимальную допустимую скорость пропускной способности данных для виртуальных серверов на сервере в битах в секунду. Если объем сетевого трафика превысит это ограничение, система пометит сервер как недоступный. | ||
| connections_enabled логический тип |
| Включено или выключено текущее ограничение соединений. Этот параметр позволяет включать и выключать действие ограничения. | |
| connections_limit целое число | Указывает максимальное количество одновременных соединений, вместе взятых, для всех виртуальных серверов на сервере. Если соединения превысят это ограничение, система пометит сервер как недоступный. | ||
| packets_enabled логический тип |
| Включено или выключено ограничение по пакетам. Этот параметр позволяет включать и выключать действие ограничения. | |
| packets_limit целое число | Указывает максимальную допустимую скорость передачи данных для виртуальных серверов на сервере в пакетах в секунду. Если объем сетевого трафика превысит это ограничение, система пометит сервер как недоступный. | ||
| link строка | Указывает ссылку для назначения серверу или виртуальному серверу. | ||
| monitors список / элементы=строка | Указывает мониторы состояния, которые система в настоящее время использует для мониторинга этого ресурса. Когда availability_requirements.type require, вы можете иметь только один монитор в списке monitors. | ||
| name строка / обязательно | Указывает имя виртуального сервера. | ||
| partition строка | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| port целое число | Указывает номер порта службы для виртуального сервера или члена пула. Например, служба HTTP обычно использует порт 80. Для указания всех портов используйте *. При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию *. | ||
| provider словарь добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem логический тип |
| Если yes, данные телеметрии TEEM не отправляются в F5.Вы можете опустить этот параметр, установив переменную среды F5_TEEM. | |
| password строка / обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логический тип |
| Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самоподписанными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| server_name строка / обязательно | Указывает имя сервера, к которому связан виртуальный сервер. | ||
| state строка |
| При present, гарантирует существование ресурса.При absent, гарантирует удаление ресурса. | |
| translation_address строка | Указывает IP-адрес трансляции для виртуального сервера. Чтобы сбросить этот параметр, используйте пустую строку ( "") в качестве значения.При создании нового виртуального сервера GTM, если этот параметр не указан, будет использовано значение по умолчанию ::. | ||
| порт_перевода строка | Указывает номер порта перевода или имя службы для виртуального сервера. Для указания всех портов используйте *. При создании нового виртуального сервера GTM, если этот параметр не указан, используется значение по умолчанию *. | ||
| зависимости_виртуального_сервера список / элементы=словарь | Указывает виртуальные серверы, от которых зависит текущий виртуальный сервер. Если любой из указанных серверов недоступен, текущий виртуальный сервер также отображается как недоступный. | ||
| сервер строка / обязательный | Сервер, к которому относится зависимый виртуальный сервер. | ||
| виртуальный_сервер строка / обязательный | Виртуальный сервер, от которого требуется зависимость. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 манипулируют только рабочей конфигурацией продукта F5. Чтобы гарантировать, что конфигурация BIG-IP сохранится на диске, убедитесь, что включен хотя бы один task, использующий модуль f5networks.f5_modules.bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения рабочей конфигурации.
Примеры
- name: Enable virtual server
bigip_gtm_virtual_server:
server_name: server1
name: my-virtual-server
state: enabled
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| адрес строка | изменено | Новый адрес ресурса. Пример: 1.2.3.4 |
| требования_к_доступности словарь | изменено | Новые конфигурации требований к доступности для ресурса. Пример: {'тип': 'все'} |
| пределы словарь | изменено | Новые конфигурации ограничений для ресурса. Пример: {'биты_включены': True, 'пределы_битов': 100} |
| ссылка строка | изменено | Новое значение ссылки для ресурса. Пример: /Общие/моя_ссылка |
| мониторы список / элементы=строка | изменено | Новый список мониторов для ресурса. Пример: ['/Общие/монитор1', '/Общие/монитор2'] |
| порт целое_число | изменено | Новый порт ресурса. Пример: 500 |
| имя_сервера строка | изменено | Имя сервера, связанное с виртуальным сервером. Пример: /Общие/мой_сервер_gtm |
| адрес_перевода целое_число | изменено | Новый адрес перевода ресурса. Пример: 500 |
| порт_перевода целое_число | изменено | Новый порт перевода ресурса. Пример: 500 |
| зависимости_виртуального_сервера список / элементы=строка | изменено | Новый список зависимостей виртуального сервера для ресурса. Пример: ['/Общие/vs1', '/Общие/vs2'] |
Авторы
- 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.10/collections/f5networks/f5_modules/bigip_gtm_virtual_server_module.html
