f5networks.f5_modules.bigip_profile_http модуль — Управление профилями HTTP на BIG-IP

accept_xff

boolean

Включает или отключает доверие к IP-адресу клиента и статистике по IP-адресу клиента, основанной на заголовках XFF (X-forwarded-for) запроса, если они существуют.

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

Варианты:

• false
• true

description

string

Описание профиля.

dns_resolver

string

Указывает имя настроенного DNS-резолвера. Этот параметр обязателен, когда proxy_type установлен в значение explicit.

Формат имени может быть с префиксом раздела (/Common/foo) или указан просто как имя объекта (foo).

Для удаления записи можно установить значение none или '', но профиль proxy_type не должен быть установлен как explicit.

encrypt_cookie_secret

string

Фраза для шифрования cookie.

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

encrypt_cookies

list / elements=string

Имена cookie, которые система должна зашифровывать.

Для полного удаления записи необходимо установить значение none или ''.

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

enforcement

dictionary

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

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

excess_client_headers

string

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

Если установлено значение pass-through, переключается в режим проброса, а при значении reject, соединение отклоняется.

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

Варианты:

• "reject"
• "pass-through"

excess_server_headers

string

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

Если установлено значение pass-through, переключается в режим проброса, а при значении reject, соединение отклоняется.

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

Варианты:

• "reject"
• "pass-through"

known_methods

list / elements=string

Указывает, какие методы HTTP считаются известными. Удаление RFC-определенных методов из этого списка приведет к тому, что HTTP-фильтр их не распознает.

Список по умолчанию включает: CONNECT, DELETE, GET, HEAD, LOCK, OPTIONS, POST, PROPFIND, PUT, TRACE ,UNLOCK. Список может быть дополнен, указав ключевое слово default в качестве одного из элементов списка.

Ключевое слово default также может быть использовано для восстановления значения по умолчанию known_methods в системе.

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

max_header_count

string

Указывает максимальное количество заголовков, разрешенных в запросе/ответе HTTP.

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

Если установлено значение default, значение равно 64.

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

max_header_size

string

Указывает максимальный размер заголовка в байтах.

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

Если установлено значение default, значение равно 32768 байтам.

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

max_requests

string

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

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

Если установлено значение default, значение равно 0, что означает, что система не будет ограничивать количество запросов на подключение.

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

oversize_client_headers

string

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

Если установлено значение pass-through, переключается в режим проброса, а при значении reject, соединение отклоняется.

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

Варианты:

• "reject"
• "pass-through"

oversize_server_headers

string

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

Если установлено значение pass-through, переключается в режим проброса, а при значении reject, соединение отклоняется.

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

Варианты:

• "reject"
• "pass-through"

pipeline

string

Включает HTTP/1.1 конвейеризацию, позволяя клиентам отправлять запросы, даже если предыдущие запросы не получили ответа.

Для этого необходимо, чтобы целевые серверы поддерживали конвейеризацию.

Если установлено значение pass-through, конвейеризованные данные заставляют BIG-IP немедленно переключиться в режим прямого пропуска и отключить HTTP-фильтр.

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

Варианты:

• "allow"
• "reject"
• "pass-through"

truncated_redirects

boolean

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

Если true, переадресация передаётся клиенту, иначе некорректный HTTP-запрос игнорируется.

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

Варианты:

• false
• true

unknown_method

string

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

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

Варианты:

• "allow"
• "reject"
• "pass-through"

fallback_host

string

Указывает резервный HTTP-хост.

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

fallback_status_codes

list / elements=string

Указывает один или несколько кодов ошибок HTTP от серверных ответов, которые должны инициировать переадресацию на резервный хост.

Допустимые коды ошибок определены в RFC2616.

Коды могут быть указаны как отдельные элементы или как допустимые диапазоны, например 400-417 или 500-505.

Смешивание диапазонов кодов ответов для разных типов ошибок недопустимо, например, определение 400-505 вызовет ошибку.

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

header_erase

string

Имя заголовка HTTP-запроса, который система удаляет из запроса.

Чтобы полностью удалить запись, установите значение none или ''.

Формат заголовка должен быть в формате KEY:VALUE, иначе произойдет ошибка.

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

header_insert

string

Строка, которую система вставляет в качестве заголовка в HTTP-запрос.

Чтобы полностью удалить запись, установите значение none или ''.

Формат заголовка должен быть в формате KEY:VALUE, иначе произойдет ошибка.

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

hsts_mode

boolean

При установке значения true, включаются настройки HSTS.

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

Варианты:

• false
• true

hsts_preload

boolean

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

При установке значения true, добавляет хост HSTS и его поддомены в предварительно загруженный список браузера сайтов, которые считаются только HTTPS.

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

Варианты:

• false
• true

include_subdomains

boolean

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

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

Варианты:

• false
• true

insert_xforwarded_for

boolean

Указывает, что система вставляет заголовок X-Forwarded-For в HTTP-запрос с IP-адресом клиента для использования с пулингом подключений.

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

Варианты:

• false
• true

maximum_age

string

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

Принимаемые значения составляют 0 - 4294967295 секунды. Значение 0 секунд снова разрешает доступ к HTTP без шифрования, в то время как indefinite устанавливает его максимальное значение.

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

name

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

Указывает имя профиля.

oneconnect_transformations

boolean

Включает выполнение преобразований HTTP-заголовков для поддержания открытых подключений на стороне сервера. Для этой функции требуется профиль OneConnect.

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

Варианты:

• false
• true

parent

string

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

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

partition

string

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

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

provider

dictionary

added in f5networks.f5_modules 1.0.0

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

auth_provider

string

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

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

no_f5_teem

boolean

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

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

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

Варианты:

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

password

aliases: 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 ← (по умолчанию)

proxy_type

string

Указывает режим прокси для профиля.

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

Варианты:

• "reverse"
• "transparent"
• "explicit"

redirect_rewrite

string

Указывает, переписывает ли система URI, которые являются частью ответов HTTP-перенаправления (3XX).

При значении none, система не будет переписывать URI в ответах HTTP-перенаправления.

При значении all, система переписывает URI во всех ответах HTTP-перенаправления.

При значении matching, система переписывает URI в ответах HTTP-перенаправления, соответствующих запрошенному URI.

При значении nodes, если URI содержит адрес узла IP вместо имени хоста, система меняет его на адрес виртуального сервера.

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

Варианты:

• "none"
• "all"
• "matching"
• "nodes"

request_chunking

string

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

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

Варианты:

• "rechunk"
• "selective"
• "preserve"
• "sustain"
• "unchunk"

response_chunking

string

Указывает, как обрабатывать ответы с чанкингом и без чанкинга.

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

Варианты:

• "rechunk"
• "selective"
• "preserve"
• "sustain"
• "unchunk"

server_agent_name

string

Указывает строку, используемую в качестве имени сервера в трафике, генерируемом BIG-IP.

Чтобы полностью удалить запись, установите значение none или ''.

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

sflow

dictionary

Указывает параметры sFlow для профиля HTTP.

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

poll_interval

integer

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

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

Для того, чтобы это значение вступило в силу, необходимо установить параметр poll_interval_global в значение no.

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

poll_interval_global

boolean

Указывает, будет ли глобальная настройка интервала опроса HTTP переопределять значение параметра poll-interval на уровне объекта.

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

Варианты:

• false
• true

sampling_rate

integer

Указывает отношение наблюдаемых пакетов к сгенерированным выборкам. Например, значение sampling_rate 2000 указывает, что 1 выборка будет случайным образом сгенерирована для каждых 2000 наблюдаемых пакетов.

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

Для того, чтобы это значение вступило в силу, необходимо установить параметр sampling_rate_global в значение no.

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

sampling_rate_global

boolean

Указывает, будет ли глобальная настройка частоты выборки HTTP переопределять значение параметра sampling-rate на уровне объекта.

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

Варианты:

• false
• true

state

string

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

Если absent, гарантирует удаление профиля.

Варианты:

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

update_password

string

always будет обновлять пароли, если параметр encrypt_cookie_secret указан.

on_create будет устанавливать пароль только для вновь созданных профилей.

Варианты:

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

xff_alternative_names

list / elements=string

Указывает альтернативные заголовки XFF вместо стандартного заголовка X-forwarded-for.

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

accept_xff

boolean

Включает или отключает доверие к IP-адресу клиента и статистике по IP-адресу клиента.

Возвращено: changed

Пример: true

description

string

Описание профиля.

Возвращено: changed

Пример: "My profile"

dns_resolver

string

Настроенный DNS-резолвер.

Возвращено: changed

Пример: "/Common/FooBar"

encrypt_cookies

list / elements=string

Имена cookie для шифрования.

Возвращено: changed

Пример: ["MyCookie1", "MyCookie2"]

enforcement

complex

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

Возвращено: changed

Пример: "hash/dictionary of values"

excess_server_headers

string

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

Возвращено: changed

Пример: "pass-through"

known_methods

list / elements=string

Список известных HTTP-методов.

Возвращено: changed

Пример: ["default", "FOO", "BAR"]

max_header_count

string

Максимальное количество заголовков, разрешенных в HTTP-запросе/ответе.

Возвращено: changed

Пример: "4096"

max_header_size

string

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

Возвращено: changed

Пример: "default"

max_requests

string

Количество запросов, принимаемых системой на подключение.

Возвращено: changed

Пример: "default"

oversize_client_headers

string

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

Возвращено: changed

Пример: "reject"

oversize_server_headers

string

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

Возвращено: changed

Пример: "reject"

pipeline

string

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

Возвращено: changed

Пример: "allow"

truncated_redirects

boolean

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

Возвращено: changed

Пример: true

unknown_method

string

Разрешить, отклонить или переключиться в режим прохождения при обработке неизвестного HTTP-метода.

Возвращено: changed

Пример: "allow"

fallback_host

string

Указывает резервный HTTP-хост.

Возвращено: changed

Пример: "foobar.com"

fallback_status_codes

list / elements=string

Коды ошибок HTTP из ответов сервера, которые должны вызывать перенаправление на резервный хост.

Возвращено: changed

Пример: ["400-404", "500", "501"]

header_erase

string

Имя заголовка в HTTP-запросе, который система удаляет из запроса.

Возвращено: changed

Пример: "FOO:BAR"

header_insert

string

Строка, которую система вставляет в качестве заголовка в HTTP-запрос.

Возвращено: changed

Пример: "FOO:BAR"

hsts_mode

boolean

Включает настройки HSTS.

Возвращено: changed

Пример: false

hsts_preload

boolean

Включает предварительную загрузку HSTS.

Возвращено: changed

Пример: false

include_subdomains

boolean

Применяет политику HSTS к хосту HSTS и его поддоменам.

Возвращено: changed

Пример: true

insert_xforwarded_for

boolean

Вставить X-Forwarded-For-Header.

Возвращено: changed

Пример: true

maximum_age

string

Максимальная продолжительность времени в секундах, в течение которого функциональность HSTS запрашивает, чтобы клиенты использовали только HTTPS.

Возвращено: changed

Пример: "indefinite"

oneconnect_transformations

boolean

Включает или отключает преобразования HTTP-заголовков.

Возвращено: changed

Пример: false

parent

string

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

Возвращено: changed

Пример: "/Common/http"

proxy_type

string

Укажите режим прокси-сервера профиля.

Возвращено: changed

Пример: "explicit"

redirect_rewrite

string

Переписать URI, которые являются частью ответов 3xx.

Возвращено: changed

Пример: "all"

request_chunking

string

Указывает, как обрабатывать фрагментированные и нефрагментированные запросы.

Возвращено: changed

Пример: "rechunk"

response_chunking

string

Указывает, как обрабатывать фрагментированные и нефрагментированные ответы.

Возвращено: changed

Пример: "rechunk"

server_agent_name

string

Строка, используемая в качестве имени сервера в трафике, генерируемом BIG-IP.

Возвращено: changed

Пример: "foobar"

sflow

complex

Указывает настройки sFlow для HTTP-профиля.

Возвращено: changed

Пример: "hash/dictionary of values"

poll_interval

integer

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

Возвращено: changed

Пример: 30

poll_interval_global

boolean

Включает/выключает переопределение настройки интервала опроса HTTP.

Возвращено: changed

Пример: true

sampling_rate

integer

Указывает отношение наблюдаемых пакетов к сгенерированным образцам.

Возвращено: changed

Пример: 2000

sampling_rate_global

boolean

Включает/выключает переопределение настройки частоты выборки HTTP.

Возвращено: changed

Пример: true

xff_alternative_names

list / elements=string

Указывает альтернативные заголовки XFF вместо стандартного заголовка X-forwarded-for.

Возвращено: changed

Пример: ["FooBar", "client1"]