f5networks.f5_modules.bigip_gtm_virtual_server module – Управляет виртуальными серверами F5 BIG-IP GTM

address

string

Указывает IP-адрес виртуального сервера.

Этот параметр обязателен при создании виртуального сервера GTM.

availability_requirements

dictionary

Если активировано несколько мониторов работоспособности, указывает количество мониторов, которые должны получить успешные ответы, чтобы канал считался доступным.

at_least

integer

Указывает минимальное количество активных мониторов работоспособности, которые должны успешно сработать, чтобы канал считался работающим.

Этот параметр имеет значение только при использовании type типа at_least.

Этот параметр игнорируется, если используется тип all или require.

number_of_probers

integer

Указывает количество проберов, используемых при выполнении проверок.

При создании виртуального сервера, если указан этот параметр, необходимо также указать параметр number_of_probes.

Значение этого параметра всегда должно быть больше или равно значению number_of_probers.

Этот параметр имеет значение только при использовании type типа require.

Этот параметр игнорируется, если используется тип all или at_least.

number_of_probes

integer

Указывает минимальное количество проб, которые должны завершиться успешно, чтобы сервер считался работающим.

При создании виртуального сервера, если указан этот параметр, необходимо также указать параметр number_of_probers.

Значение этого параметра всегда должно быть меньше или равно значению number_of_probers.

Этот параметр имеет значение только при использовании type типа require.

Этот параметр игнорируется, если используется тип all или at_least.

type

string / обязательный

Тип правила мониторинга, если указано monitors.

При создании виртуального сервера, если это значение не указано, будет использоваться значение по умолчанию all.

Допустимые значения:

• "all"
• "at_least"
• "require"

limits

dictionary

Указывает пороговые значения ресурсов или требования к ограничениям на уровне сервера.

При включении одного или нескольких параметров ограничений система использует эти данные для вывода серверов из эксплуатации и возврата их в эксплуатацию.

Можно задать любые или все параметры ограничений. Однако, если сервер не соответствует требованиям порогового значения ресурса, система помечает весь сервер как недоступный и направляет трафик балансировки нагрузки к другому ресурсу.

Доступные параметры ограничений зависят от типа сервера.

bits_enabled

boolean

Включено ли ограничение по битам.

Этот параметр позволяет включить или отключить действие ограничения.

Допустимые значения:

• false
• true

bits_limit

integer

Указывает максимально допустимую скорость передачи данных для виртуальных серверов на сервере в битах в секунду.

Если объём сетевого трафика превышает это ограничение, система помечает сервер как недоступный.

connections_enabled

boolean

Включено ли ограничение на текущее количество соединений.

Этот параметр позволяет включить или отключить действие ограничения.

Допустимые значения:

• false
• true

connections_limit

integer

Указывает максимальное совокупное количество одновременных соединений для всех виртуальных серверов на сервере.

Если количество соединений превышает это ограничение, система помечает сервер как недоступный.

packets_enabled

boolean

Включено ли ограничение по пакетам.

Этот параметр позволяет включить или отключить действие ограничения.

Допустимые значения:

• false
• true

packets_limit

integer

Указывает максимально допустимую скорость передачи данных для виртуальных серверов на сервере в пакетах в секунду.

Если объём сетевого трафика превышает это ограничение, система помечает сервер как недоступный.

link

string

Указывает канал, который будет назначен серверу или виртуальному серверу.

monitors

list / элементы типа string

Указывает мониторы работоспособности, которые система использует для мониторинга этого ресурса.

Если availability_requirements.type равно require, в списке monitors может быть только один монитор.

name

string / обязательный

Указывает имя виртуального сервера.

partition

string

Раздел устройства, в котором управляются ресурсы.

По умолчанию: "Common"

port

integer

Указывает номер порта службы виртуального сервера или участника пула. Например, для службы HTTP обычно используется порт 80.

Чтобы указать все порты, используйте *.

При создании виртуального сервера GTM, если этот параметр не указан, используется значение по умолчанию *.

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

Объект dict, содержащий сведения о подключении.

auth_provider

string

Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства.

Этот параметр используется при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если yes, данные телеметрии TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную среды F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM объявлена устаревшей, так как её название было неоднозначным.

Допустимые значения:

• false ← (по умолчанию)
• true

password

псевдонимы: pass, pwd

string / обязательный

Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_PASSWORD.

server

string / обязательный

Узел BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

Указывает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истекает до завершения операции, модуль выдаёт ошибку.

transport

string

Настраивает транспортное соединение для подключения к удалённому устройству.

Допустимые значения:

• "rest" ← (по умолчанию)

user

string / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве.

Этот параметр можно не указывать, задав переменную среды F5_USER.

validate_certs

boolean

Если no, SSL-сертификаты не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами.

Этот параметр можно не указывать, задав переменную среды F5_VALIDATE_CERTS.

Допустимые значения:

• false
• true ← (по умолчанию)

server_name

string / обязательный

Указывает имя сервера, с которым связан виртуальный сервер.

state

string

Если present, гарантирует, что ресурс существует.

Если absent, гарантирует, что ресурс удалён.

Допустимые значения:

• "present" ← (по умолчанию)
• "absent"
• "enabled"
• "disabled"

translation_address

string

Указывает IP-адрес трансляции для виртуального сервера.

Чтобы сбросить этот параметр, укажите пустую строку ("") в качестве значения.

При создании виртуального сервера GTM, если этот параметр не указан, используется значение по умолчанию ::.

translation_port

string

Указывает номер порта трансляции или имя службы для виртуального сервера.

Чтобы указать все порты, используйте *.

При создании виртуального сервера GTM, если этот параметр не указан, используется значение по умолчанию *.

virtual_server_dependencies

list / элементы типа dictionary

Указывает виртуальные серверы, от которых зависит текущий виртуальный сервер.

Если какой-либо из указанных серверов недоступен, текущий виртуальный сервер также помечается как недоступный.

server

string / обязательный

Сервер, частью которого является зависимый виртуальный сервер.

virtual_server

string / обязательный

Виртуальный сервер, от которого зависит текущий.

address

string

Новый адрес ресурса.

Возвращается: changed

Пример: "1.2.3.4"

availability_requirements

dictionary

Новые настройки требований к доступности ресурса.

Возвращается: changed

Пример: {"type": "all"}

limits

dictionary

Новые настройки ограничений ресурса.

Возвращается: changed

Пример: {"bits_enabled": true, "bits_limit": 100}

link

string

Новое значение ссылки для ресурса.

Возвращается: changed

Пример: "/Common/my-link"

monitors

list / elements=string

Новый список мониторов ресурса.

Возвращается: changed

Пример: ["/Common/monitor1", "/Common/monitor2"]

port

integer

Новый порт ресурса.

Возвращается: changed

Пример: 500

server_name

string

Имя сервера, связанного с виртуальным сервером.

Возвращается: changed

Пример: "/Common/my-gtm-server"

translation_address

integer

Новый адрес трансляции ресурса.

Возвращается: changed

Пример: 500

translation_port

integer

Новый порт трансляции ресурса.

Возвращается: changed

Пример: 500

virtual_server_dependencies

list / elements=string

Новый список зависимостей виртуального сервера для ресурса.

Возвращается: changed

Пример: ["/Common/vs1", "/Common/vs2"]