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 | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Можно опустить этот параметр, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| port целое число | Указывает номер порта службы для виртуального сервера или члена пула. Например, служба HTTP обычно использует порт 80. Для указания всех портов используйте *.При создании нового виртуального сервера GTM, если этот параметр не указан, используется значение по умолчанию *. | ||
| provider словарь добавлен в 2.5 | Объект типа dict, содержащий данные подключения. | ||
| 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 логическое значение |
| Если 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 логическое значение добавлен в 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.
- Требуется версия ПО 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| address строка | changed | Новый адрес ресурса. Пример: 1.2.3.4 |
| availability_requirements словарь | changed | Новые конфигурации требований доступности для ресурса. Пример: {'type': 'all'} |
| limits словарь | changed | Новые конфигурации ограничений для ресурса. Пример: {'bits_enabled': True, 'bits_limit': 100} |
| link строка | changed | Новое значение ссылки для ресурса. Пример: /Common/my-link |
| monitors список | changed | Новый список мониторов для ресурса. Пример: ['/Common/monitor1', '/Common/monitor2'] |
| port целое число | changed | Новый порт ресурса. Пример: 500 |
| server_name строка | changed | Имя сервера, связанного с виртуальным сервером. Пример: /Common/my-gtm-server |
| translation_address целое число | changed | Новый адрес трансляции ресурса. Пример: 500 |
| translation_port целое число | changed | Новый порт трансляции ресурса. Пример: 500 |
| virtual_server_dependencies список | changed | Новый список зависимостей виртуальных серверов для ресурса. Пример: ['/Common/vs1', '/Common/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.8/modules/bigip_gtm_virtual_server_module.html
