Модуль f5networks.f5_modules.bigip_policy_rule — Управление правилами политики LTM на BIG-IP

actions

list / elements=dictionary

Действия, которые вы хотите выполнить с правилом политики.

Доступные атрибуты варьируются в зависимости от действия, однако каждое действие требует указания type.

Эти условия могут быть указаны в любом порядке. Несмотря на то, что они находятся в списке, порядок в списке не имеет значения для BIG-IP.

asm_policy

string

Политика ASM для включения.

Этот параметр действителен только с типом enable.

cookie_expiry

integer

added in f5networks.f5_modules 1.1.0

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

Этот параметр действителен только с типом persist.

cookie_insert

string

added in f5networks.f5_modules 1.1.0

Имя cookie, на котором вы хотите сохранить данные.

Этот параметр действителен только с типом persist.

disable_target

string

added in f5networks.f5_modules 1.8.0

Цель, которую вы хотите отключить.

Этот параметр действителен только с типом disable.

Варианты:

• "server_ssl"
• "persist"
• "asm"

event

string

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

С действием set_variable используется для указания события действия, например, запрос или ответ.

Допустимые варианты событий для типа действия forward: client_accepted, proxy_request request, ssl_client_hello и ssl_client_server_hello_send.

Допустимые варианты событий для типа действия reset: client_accepted, proxy_connect proxy_request, proxy_response, request, response, server_connected, ssl_client_hello, ssl_client_server_hello_send, ssl_server_handshake, ssl_server_hello, websocket_request, websocket_response.

Допустимые варианты событий для типа действия disable: client_accepted, proxy_connect proxy_request, proxy_response, request, server_connected.

expression

string

Выражение Tcl, используемое с действием set_variable.

http_connect

dictionary

added in f5networks.f5_modules 1.8.0

Заголовок HTTP Connect, который вы хотите заменить.

Этот параметр действителен только с типом replace.

event

string / required

Тип события, когда заголовок http_connect заменяется.

Варианты:

• "client_accepted"
• "proxy_connect"
• "proxy_request"
• "proxy_response"
• "request"
• "server_connected"
• "ssl_client_hello"

port

integer

Номер порта.

Если номер порта не указан, значение по умолчанию устанавливается равным 0.

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

value

string / required

Значение http_connect.

http_cookie

dictionary

added in f5networks.f5_modules 1.8.0

Заголовок HTTP Cookie, который вы хотите удалить или вставить.

Этот параметр действителен только с типами remove и insert.

event

string / required

Тип события, когда http_cookie удаляется или вставляется.

Варианты:

• "request"
• "proxy_connect"
• "proxy_request"

name

string / required

Имя http_cookie.

value

string

Значение http_cookie.

Это обязательный параметр при настройке с действием типа insert.

http_header

dictionary

added in f5networks.f5_modules 1.8.0

HTTP-заголовок, который вы хотите удалить или вставить.

Этот параметр действителен только с типами remove, insert и replace.

event

string / required

Тип события, когда http_header удаляется, заменяется или вставляется.

События request и response являются вариантами только с типами remove и insert.

Все события действительны с действием типа replace.

Варианты:

• "request"
• "response"
• "proxy_connect"
• "proxy_request"
• "proxy_response"

name

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

Имя http_header.

value

строка

Значение http_header.

Обязательный параметр при конфигурации с типом insert или replace.

http_host

словарь

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

Заголовок HTTP Host, который нужно заменить.

Этот параметр действителен только с типом replace.

event

строка / обязательно

Тип события при замене http_host.

Варианты:

• "request"
• "proxy_connect"
• "proxy_request"

value

строка / обязательно

Значение http_host.

http_referer

словарь

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

Заголовок HTTP Referer, который нужно удалить, заменить или вставить.

Этот параметр действителен только с типом remove, insert и replace.

event

строка / обязательно

Тип события при удалении, замене или вставке c(http_referer).

Варианты:

• "request"
• "proxy_connect"
• "proxy_request"

value

строка

Значение http_referer.

Этот параметр обязателен при конфигурации действия типа insert.

Этот параметр игнорируется для типа remove.

Этот параметр необязателен для типа replace.

http_set_cookie

словарь

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

Заголовок HTTP Set-Cookie, который нужно удалить или вставить.

Этот параметр действителен только с типом remove или c(insert).

name

строка / обязательно

Имя http_set_cookie.

value

строка

Значение http_set_cookie.

Этот параметр обязателен при конфигурации действия типа insert.

http_uri

словарь

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

Заменяет HTTP URI, путь или строку.

Этот параметр действителен только с типом replace.

event

строка / обязательно

Тип события при замене http_uri.

Варианты:

• "request"
• "proxy_connect"
• "proxy_request"

type

строка / обязательно

Указывает часть http_uri для замены.

Варианты:

• "path"
• "query_string"
• "full_string"

value

строка / обязательно

Значение http_uri.

location

строка

Новый URL, для которого отправляется ответ перенаправления.

Для этого поля можно использовать подстановку Tcl-команд.

node

строка

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

Узел, на который нужно перенаправить трафик.

Этот параметр действителен только с типом forward.

pool

строка

Пул, на который нужно перенаправить трафик.

Этот параметр действителен только с типом forward.

type

string / required

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

Когда type есть forward, система связывает заданный pool, или virtual, или node с этим правилом.

Когда type есть enable, система связывает заданный asm_policy с этим правилом.

Когда type есть ignore, система удаляет все существующие действия из этого правила.

Когда type есть redirect, система перенаправляет HTTP-запрос на другой URL.

Когда type есть reset, система сбрасывает соединение при event.

Когда type есть persist, система связывает cookie_insert и cookie_expiry с этим правилом.

Когда type есть set_variable, система устанавливает переменную на основе вычисляемого Tcl expression на основе event.

Когда type есть remove, система удаляет http_set_cookie, http_referer, http_header или http_cookie с этим правилом.

Когда type есть insert, система вставляет http_set_cookie, http_referer, http_header или http_cookie с этим правилом.

Когда type есть replace, система заменяет http_connect, http_referer, http_header, http_uri или http_host с этим правилом.

Когда type есть disable, система отключает disable_target с этим правилом.

Варианты:

• "forward"
• "enable"
• "ignore"
• "redirect"
• "reset"
• "persist"
• "set_variable"
• "remove"
• "insert"
• "replace"
• "disable"

variable_name

string

Имя переменной, используемое с действием set_variable.

virtual

string

Виртуальный сервер, на который вы хотите переадресовывать трафик.

Этот параметр действителен только для типа forward.

conditions

list / elements=dictionary

Список атрибутов, описывающих условие.

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

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

Следующие вложенные параметры не являются обязательными для всех типов условий, прочитайте описание для получения более подробной информации.

Эти условия могут быть указаны в любом порядке. Несмотря на то, что они находятся в списке, порядок в списке не имеет значения для BIG-IP.

address_matches_with_any

list / elements=string

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

Список строк IP-адресов подсети, с которыми должен совпадать IP-адрес.

Этот параметр действителен только для типа tcp.

address_matches_with_datagroup

list / elements=string

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

Список строк внутренних групп данных, с которыми должен совпадать IP-адрес.

Этот параметр действителен только для типа tcp.

address_matches_with_external_datagroup

list / elements=string

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

Список строк внешних групп данных, с которыми должен совпадать IP-адрес.

Этот параметр действителен только для типа tcp.

event

string

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

Поддерживается только для http_header, http_method, ssl_extension и tcp.

Допустимые варианты для типов условий http_header: proxy_connect, proxy_request, proxy_response, request и response.

Допустимые варианты для типов условий http_method: proxy_connect, proxy_request, proxy_response, request и response.

Допустимые варианты для типов условий tcp: request, client_accepted, proxy_connect, proxy_request, proxy_response, ssl_client_hello, и ssl_client_server_hello_send.

Допустимые варианты для ssl_extension: ssl_client_hello, и ssl_client_server_hello_send.

header_is_any

list / elements=string

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

Список строк символов, с которыми должно совпадать значение HTTP-заголовка.

Этот параметр действителен только для типа http_header.

header_name

string

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

Имя http_header.

Этот параметр действителен только для типа http_header.

host_begins_not_with_any

list / elements=string

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

Список строк символов, с которых HTTP-хост НЕ должен начинаться.

Этот параметр действителен только для типа http_host.

host_begins_with_any

list / elements=string

Список строк символов, с которых должен начинаться HTTP-хост.

Этот параметр действителен только для типа http_host.

host_contains

list / elements=string

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

Список строк символов, которые должен содержать HTTP-хост.

Этот параметр действителен только для типа http_host.

host_ends_not_with_any

list / elements=string

added in f5networks.f5_modules 1.22.0

Список строк символов, с которых HTTP Host НЕ должен начинаться.

Этот параметр допустим только с типом http_host.

host_ends_with_any

list / elements=string

added in f5networks.f5_modules 1.8.0

Список строк символов, на которых должен заканчиваться HTTP Host.

Этот параметр допустим только с типом http_host.

host_is_any

list / elements=string

Список строк символов, с которыми должен совпадать HTTP Host.

Этот параметр допустим только с типом http_host.

host_is_not_any

list / elements=string

Список строк символов, с которыми HTTP Host не должен совпадать.

Этот параметр допустим только с типом http_host.

method_matches_with_any

list / elements=string

added in f5networks.f5_modules 1.10.0

Список строк символов, с которыми должно совпадать значение HTTP Method.

Этот параметр допустим только с типом http_method.

path_begins_with_any

list / elements=string

Список строк символов, с которых должен начинаться HTTP URI.

Этот параметр допустим только с типом http_uri.

path_contains

list / elements=string

added in f5networks.f5_modules 1.8.0

Список строк символов, которые должен содержать HTTP URI.

Этот параметр допустим только с типом http_uri.

path_is_any

list / elements=string

added in f5networks.f5_modules 1.8.0

Список строк символов, с которыми должен совпадать HTTP URI.

Этот параметр допустим только с типом http_uri.

server_name_begins_not_with_any

list / elements=string

added in f5networks.f5_modules 1.27.0

Список имен, с которых имя сервера НЕ должно начинаться.

Этот параметр допустим только с типом ssl_extension.

server_name_begins_with_any

list / elements=string

added in f5networks.f5_modules 1.27.0

Список имен, с которых должно начинаться имя сервера.

Этот параметр допустим только с типом ssl_extension.

server_name_contains

list / elements=string

added in f5networks.f5_modules 1.27.0

Список имен, которые должно содержать имя сервера.

Этот параметр допустим только с типом ssl_extension.

server_name_ends_not_with_any

list / elements=string

added in f5networks.f5_modules 1.27.0

Список имен, на которых имя сервера НЕ должно заканчиваться.

Этот параметр допустим только с типом ssl_extension.

server_name_ends_with_any

list / elements=string

added in f5networks.f5_modules 1.27.0

Список имен, на которых должно заканчиваться имя сервера.

Этот параметр допустим только с типом ssl_extension.

server_name_is_any

list / elements=string

Список имен, включающий имя сервера.

Этот параметр допустим только с типом ssl_extension.

server_name_is_not_any

list / elements=string

added in f5networks.f5_modules 1.27.0

Список имен, НЕ включающий имя сервера.

Этот параметр допустим только с типом ssl_extension.

type

string / required

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

Когда type равно http_uri, допустимые варианты: path_begins_with_any, path_contains или path_is_any.

Когда type равно http_host, допустимые варианты: host_is_any, host_is_not_any, host_contains host_begins_with_any, host_begins_not_with_any, host_ends_with_any или host_ends_not_with_any

Когда type равно http_header, параметр header_name является обязательным, и допустимый вариант: header_is_any.

Когда type равно http_method, допустимые варианты: method_matches_with_any.

Когда type равно all_traffic, система удаляет все существующие условия из этого правила.

Варианты:

• "http_uri"
• "all_traffic"
• "http_host"
• "http_header"
• "http_method"
• "ssl_extension"
• "tcp"

описание

строка

Описание правила политики.

имя

строка / обязательно

Имя правила.

раздел

строка

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

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

политика

строка / обязательно

Имя политики, с которой вы хотите связать это правило.

поставщик

словарь

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

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

auth_provider

строка

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

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

no_f5_teem

булево

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

Вы можете опустить этот параметр, задав переменную среды F5_TELEMETRY_OFF

Предыдущая переменная F5_TEEM устарела, так как её имя вызывало путаницу.

Варианты:

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

пароль

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

строка / обязательно

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

Вы можете опустить этот параметр, задав переменную среды F5_PASSWORD

сервер

строка / обязательно

Хост BIG-IP или хост BIG-IQ.

Вы можете опустить этот параметр, задав переменную среды F5_SERVER

порт_сервера

целое число

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

Вы можете опустить этот параметр, задав переменную среды F5_SERVER_PORT

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

таймаут

целое число

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

транспорт

строка

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

Варианты:

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

пользователь

строка / обязательно

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

Вы можете опустить этот параметр, задав переменную среды F5_USER

validate_certs

булево

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

Вы можете опустить этот параметр, задав переменную среды F5_VALIDATE_CERTS

Варианты:

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

заменить_на

булево

Указывает, нужно ли conditions/actions, заданные пользователем, перезаписать то, что уже существует на устройстве.

Этот параметр полезен, когда требуется удалить подмножество conditions/actions. Данный параметр аналогичен флагу replace-all-with, доступному в командах TMSH.

Использование этого параметра не является идемпотентным.

Варианты:

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

порядок_правила

целое число

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

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

Если параметр не задан, устройство задаёт ему значение 0.

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

Чем меньше число, тем ниже правило в общем порядке, где наименьшее число 0 является самым верхним правилом.

Допустимый диапазон значений от 0 до 4294967295 включительно.

состояние

строка

Когда present, гарантирует загрузку ключа на устройство. Когда absent, гарантирует удаление ключа с устройства. Если ключ в данный момент используется, модуль не сможет удалить ключ.

Варианты:

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