bigip_gtm_virtual_server – Управляет виртуальными серверами F5 BIG-IP GTM
Новая в версии 2.6.
Описание
- Управляет виртуальными серверами F5 BIG-IP GTM. У сервера GTM может быть много связанных с ним виртуальных серверов. Они организованы аналогично тому, как члены пула относятся к пулам.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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 логическое |
| Включен ли лимит битов или нет. Этот параметр позволяет включать или выключать действие лимита. | |
| bits_limit целое число | Указывает максимальную допустимую скорость пропускной способности данных в битах в секунду для виртуальных серверов на сервере. Если объем сетевого трафика превысит этот лимит, система пометит сервер как недоступный. | ||
| connections_enabled логическое |
| Включен ли текущий лимит подключений или нет. Этот параметр позволяет включать или выключать действие лимита. | |
| connections_limit целое число | Указывает максимальное количество одновременных подключений, в сумме, для всех виртуальных серверов на сервере. Если количество подключений превысит этот лимит, система пометит сервер как недоступный. | ||
| packets_enabled логическое |
| Включен ли лимит пакетов или нет. Этот параметр позволяет включать или выключать действие лимита. | |
| packets_limit целое число | Указывает максимальную допустимую скорость передачи данных в пакетах в секунду для виртуальных серверов на сервере. Если объем сетевого трафика превысит этот лимит, система пометит сервер как недоступный. | ||
| link строка добавлен в 2.6 | Указывает соединение, которое нужно назначить серверу или виртуальному серверу. | ||
| monitors список добавлен в 2.6 | Указывает мониторы работоспособности, которые система в настоящее время использует для мониторинга данного ресурса. Когда availability_requirements.type равно require, в списке monitors может быть только один монитор. | ||
| name строка добавлен в 2.6 | Указывает имя виртуального сервера. | ||
| partition строка добавлен в 2.6 | Значение по умолчанию: "Общий" | Раздел устройства для управления ресурсами. | |
| port целое число | Указывает номер порта службы для виртуального сервера или члена пула. Например, служба HTTP обычно использует порт 80. Для указания всех портов используйте *. При создании нового виртуального сервера GTM, если этот параметр не указан, используется значение по умолчанию *. | ||
| 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 строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| пользователь строка / обязательно | Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные права на устройстве. Этот параметр можно опустить, установив переменную окружения F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.Этот параметр можно опустить, установив переменную окружения F5_VALIDATE_CERTS. | |
| имя_сервера строка добавлен в 2.6 | Указывает имя сервера, с которым связан виртуальный сервер. | ||
| состояние строка |
| При present, гарантирует, что ресурс существует.При absent, гарантирует удаление ресурса. | |
| адрес_перевода строка добавлен в 2.6 | Указывает IP-адрес перевода для виртуального сервера. Для отмены этого параметра укажите пустую строку ( "") в качестве значения.При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию ::. | ||
| порт_перевода строка добавлен в 2.6 | Указывает номер порта перевода или имя службы для виртуального сервера. Для указания всех портов используйте *. При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию *. | ||
| зависимости_виртуальных_серверов список добавлен в 2.6 | Указывает виртуальные серверы, от которых зависит текущий виртуальный сервер. Если любой из указанных серверов недоступен, текущий виртуальный сервер также считается недоступным. | ||
| сервер строка / обязательно | Сервер, к которому принадлежит зависимый виртуальный сервер. | ||
| виртуальный_сервер строка / обязательно | Виртуальный сервер, от которого зависит. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 работают только с активной конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диске, обязательно включите по крайней мере одну задачу, использующую модуль 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 |
| требования_доступности словарь | изменено | Новые настройки требований доступности для ресурса. Пример: {'тип': 'все'} |
| лимиты словарь | изменено | Новые настройки ограничений для ресурса. Пример: {'bits_enabled': True, 'bits_limit': 100} |
| ссылка строка | изменено | Новое значение ссылки для ресурса. Пример: /Общие/моя-ссылка |
| мониторы список | изменено | Новый список мониторов для ресурса. Пример: ['/Общие/монитор1', '/Общие/монитор2'] |
| порт целое число | изменено | Новый порт ресурса. Пример: 500 |
| имя_сервера строка | изменено | Имя сервера, связанного с виртуальным сервером. Пример: /Общие/мой-сервер-gtm |
| адрес_перевода целое число | изменено | Новый адрес перевода ресурса. Пример: 500 |
| порт_перевода целое число | изменено | Новый порт перевода ресурса. Пример: 500 |
| зависимости_виртуальных_серверов список | изменено | Новый список зависимостей виртуальных серверов для ресурса Пример: ['/Общие/vs1', '/Общие/vs2'] |
Статус
- Этот модуль гарантирует обратную совместимость изменений интерфейса в будущем. [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_virtual_server_module.html
