bigip_gtm_virtual_server - Управляет виртуальными серверами F5 BIG-IP GTM
Новая версия с 2.6.
Обзор
- Управляет виртуальными серверами F5 BIG-IP GTM. Один сервер GTM может иметь несколько связанных с ним виртуальных серверов. Они организованы аналогично членам пула по отношению к пулам.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address (добавлено в 2.6) | Указывает IP-адрес виртуального сервера. При создании нового виртуального сервера GTM этот параметр обязателен. | ||
| availability_requirements (добавлено в 2.6) | Указывает, если активировано более одного монитора состояния, количество мониторов состояния, которые должны получить успешные ответы, чтобы ссылка считалась доступной. | ||
| type |
| Тип правила мониторинга, когда указан monitors. При создании нового виртуального сервера, если это значение не указано, по умолчанию используется 'all'. | |
| at_least | Указывает минимальное количество активных мониторов состояния, которые должны быть успешными, прежде чем ссылка будет считаться активной. Этот параметр актуален только при использовании type типа at_least. Этот параметр будет проигнорирован, если используется тип all или require. | ||
| number_of_probes | Указывает минимальное количество запросов, которые должны быть успешными, чтобы этот сервер был объявлен активным. При создании нового виртуального сервера, если этот параметр указан, то должен быть также указан параметр number_of_probers. Значение этого параметра должно всегда быть меньше или равно значению number_of_probers. Этот параметр актуален только при использовании type типа require. Этот параметр будет проигнорирован, если используется тип all или at_least. | ||
| number_of_probers | Указывает количество проберы, которые должны использоваться при выполнении запросов. При создании нового виртуального сервера, если этот параметр указан, то должен быть также указан параметр number_of_probes. Значение этого параметра должно всегда быть больше или равно значению number_of_probers. Этот параметр актуален только при использовании type типа require. Этот параметр будет проигнорирован, если используется тип all или at_least. | ||
| limits (добавлено в 2.6) | Указывает пороговые значения ресурсов или требования к ограничениям на уровне сервера. При включении одного или нескольких параметров ограничения, система использует эти данные для включения/выключения серверов в работу. Вы можете определить ограничения для любого или всех параметров ограничений. Однако, когда сервер не соответствует требованию порогового значения ресурса, система помечает весь сервер как недоступный и направляет трафик балансировки нагрузки на другой ресурс. Доступные параметры ограничений зависят от типа сервера. | ||
| bits_enabled bool |
| Включено ли ограничение на количество бит. Этот параметр позволяет включать или выключать действие ограничения. | |
| packets_enabled bool |
| Включено ли ограничение на количество пакетов. Этот параметр позволяет включать или выключать действие ограничения. | |
| connections_enabled bool |
| Включено ли текущее ограничение на соединения. Этот параметр позволяет включать или выключать действие ограничения. | |
| bits_limit | Указывает максимальную разрешенную скорость пропускной способности данных в битах в секунду для виртуальных серверов на сервере. Если объем сетевого трафика превышает это ограничение, система помечает сервер как недоступный. | ||
| packets_limit | Указывает максимальную разрешенную скорость передачи данных в пакетах в секунду для виртуальных серверов на сервере. Если объем сетевого трафика превышает это ограничение, система помечает сервер как недоступный. | ||
| connections_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) | Объект словаря, содержащий данные подключения. | ||
| password обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых лично, использующих самозаверяемые сертификаты. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена. | |
| timeout | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания превышено до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для переводов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| server_name (добавлено в 2.6) | Указывает имя сервера, с которым связан виртуальный сервер. | ||
| server_port (добавлено в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| состояние |
| Когда present, гарантирует существование ресурса.Когда absent, гарантирует удаление ресурса. | |
| адрес_перевода (добавлен в 2.6) | Указывает IP-адрес перевода для виртуального сервера. Чтобы сбросить этот параметр, укажите пустую строку ( "") в качестве значения.При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию ::. | ||
| порт_перевода (добавлен в 2.6) | Указывает номер порта перевода или имя службы для виртуального сервера. Для указания всех портов используйте *. При создании нового виртуального сервера GTM, если этот параметр не указан, будет использоваться значение по умолчанию *. | ||
| пользователь обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная окружения F5_USER установлена. | ||
| validate_certs bool (добавлен в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами, с самозаверяющими сертификатами. Вы можете опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| virtual_server_dependencies (добавлен в 2.6) | Указывает виртуальные серверы, от которых зависит текущий виртуальный сервер. Если любой из указанных серверов недоступен, текущий виртуальный сервер также отображается как недоступный. | ||
| сервер обязательно | Сервер, к которому принадлежит зависимый виртуальный сервер. | ||
| virtual_server обязательно | Виртуальный сервер, от которого зависит. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- 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
Возвращаемые значения
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| адрес строка | изменён | Новый адрес ресурса. Пример: 1.2.3.4 |
| требования_доступности словарь | изменён | Новые конфигурации требований доступности для ресурса. Пример: {'тип': 'все'} |
| пределы словарь | изменён | Новые конфигурации ограничений для ресурса. Пример: {'включено_бит': True, 'предел_бит': 100} |
| ссылка строка | изменён | Новое значение ссылки для ресурса. Пример: /Общие/моя_ссылка |
| мониторы список | изменён | Новый список мониторов для ресурса. Пример: ['/Общие/монитор1', '/Общие/монитор2'] |
| порт целое число | изменён | Новый порт ресурса. Пример: 500 |
| имя_сервера строка | изменён | Имя сервера, связанное с виртуальным сервером. Пример: /Общие/мой_gtm_сервер |
| адрес_перевода целое число | изменён | Новый адрес перевода ресурса. Пример: 500 |
| порт_перевода целое число | изменён | Новый порт перевода ресурса. Пример: 500 |
| virtual_server_dependencies список | изменён | Новый список зависимостей виртуальных серверов для ресурса Пример: ['/Общие/vs1', '/Общие/vs2'] |
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет вноситься обратная несовместимость в интерфейс.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/bigip_gtm_virtual_server_module.html
