bigip_gtm_virtual_server – Управляет виртуальными серверами F5 BIG-IP GTM
Новая в версии 2.6.
Обзор
- Управляет виртуальными серверами F5 BIG-IP GTM. У сервера GTM может быть много связанных с ним виртуальных серверов. Они организованы примерно так же, как члены пула к пулам.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address - добавлено в 2.6 | Указывает IP-адрес виртуального сервера. При создании нового виртуального сервера GTM этот параметр обязателен. | ||
| 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'. | |
| limits - добавлено в 2.6 | Указывает пороги ресурсов или требования к лимитам на уровне сервера. Когда вы активируете одну или несколько установок лимитов, система затем использует эти данные для включения/выключения серверов. Вы можете определять ограничения для любых или всех настроек лимитов. Однако, когда сервер не соответствует требованию порога ресурсов, система помечает весь сервер как недоступный и направляет трафик балансировки нагрузки на другой ресурс. Доступные настройки лимитов зависят от типа сервера. | ||
| bits_enabled boolean |
| Включен ли лимит битов или нет. Этот параметр позволяет включать или отключать действие лимита. | |
| bits_limit - | Указывает максимальную разрешенную скорость передачи данных в битах в секунду для виртуальных серверов на сервере. Если объем сетевого трафика превысит этот лимит, система помечает сервер как недоступный. | ||
| connections_enabled boolean |
| Включен ли текущий лимит подключений или нет. Этот параметр позволяет включать или отключать действие лимита. | |
| connections_limit - | Указывает максимальное количество одновременных подключений, в совокупности, для всех виртуальных серверов на сервере. Если подключения превысят этот лимит, система помечает сервер как недоступный. | ||
| packets_enabled boolean |
| Включен ли лимит пакетов или нет. Этот параметр позволяет включать или отключать действие лимита. | |
| packets_limit - | Указывает максимальную разрешенную скорость передачи данных в пакетах в секунду для виртуальных серверов на сервере. Если объем сетевого трафика превысит этот лимит, система помечает сервер как недоступный. | ||
| link - добавлено в 2.6 | Указывает соединение для назначения серверу или виртуальному серверу. | ||
| monitors - добавлено в 2.6 | Указывает мониторы работоспособности, которые система в настоящее время использует для мониторинга этого ресурса. Когда availability_requirements.type require, в списке monitors может быть только один монитор. | ||
| name - добавлено в 2.6 | Указывает имя виртуального сервера. | ||
| partition - добавлено в 2.6 | По умолчанию: "Общие" | Раздел устройства для управления ресурсами. | |
| password - / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_PASSWORD. псевдонимы: pass, pwd | ||
| port - | Указывает номер порта сервиса для виртуального сервера или члена пула. Например, HTTP-сервис обычно использует порт 80. Чтобы указать все порты, используйте *.При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию *. | ||
| provider - добавлено в 2.5 | По умолчанию: null | Объект словаря, содержащий данные подключения. | |
| 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 - | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. | |
| transport - / обязательно |
| Настраивает соединение транспорта для подключения к удалённому устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под вашим контролем, использующих самозаверяющие сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| server - / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_name - добавлено в 2.6 | Указывает имя сервера, с которым связан виртуальный сервер. | ||
| server_port - добавлено в 2.2 | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| state - |
| При значении present, гарантирует, что ресурс существует.При значении absent, гарантирует удаление ресурса. | |
| translation_address - добавлено в 2.6 | Указывает IP-адрес трансляции для виртуального сервера. Для отмены этого параметра, укажите пустую строку ( ""). При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию ::. | ||
| translation_port - добавлено в 2.6 | Указывает номер порта трансляции или имя службы для виртуального сервера. Для указания всех портов, используйте *. При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию *. | ||
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs boolean добавлено в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под вашим контролем, использующих самозаверяющие сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| virtual_server_dependencies - добавлено в 2.6 | Указывает виртуальные серверы, от которых зависит текущий виртуальный сервер. Если какой-либо из указанных серверов недоступен, текущий виртуальный сервер также отображается как недоступный. | ||
| server - / обязательно | Сервер, частью которого является зависимый виртуальный сервер. | ||
| virtual_server - / обязательно | Виртуальный сервер, от которого зависит. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия ПО BIG-IP ≥ 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохранится на диске, обязательно включите по крайней мере одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Enable virtual server
bigip_gtm_virtual_server:
server: lb.mydomain.com
user: admin
password: secret
server_name: server1
name: my-virtual-server
state: enabled
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны в этом месте, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| address строка | изменилось | Новый адрес ресурса. Пример: 1.2.3.4 |
| availability_requirements словарь | изменилось | Новые настройки требований доступности для ресурса. Пример: {'type': 'all'} |
| limits словарь | изменилось | Новые настройки ограничений для ресурса. Пример: {'bits_enabled': True, 'bits_limit': 100} |
| link строка | изменилось | Новое значение ссылки для ресурса. Пример: /Common/my-link |
| monitors список | изменилось | Новый список мониторов для ресурса. Пример: ['/Common/monitor1', '/Common/monitor2'] |
| port целое число | изменилось | Новый порт ресурса. Пример: 500 |
| server_name строка | изменилось | Имя сервера, связанного с виртуальным сервером. Пример: /Common/my-gtm-server |
| translation_address целое число | изменилось | Новый адрес трансляции ресурса. Пример: 500 |
| translation_port целое число | изменилось | Новый порт трансляции ресурса. Пример: 500 |
| virtual_server_dependencies список | изменилось | Новый список зависимостей виртуального сервера для ресурса Пример: ['/Common/vs1', '/Common/vs2'] |
Статус
- Гарантируется отсутствие изменений в обратной совместимости этого модуля в будущем. [stableinterface]
- Этот модуль поддерживается партнером Ansible. [certified]
Авторы
- 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.7/modules/bigip_gtm_virtual_server_module.html
