Модуль 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 и его поддомены в список предварительной загрузки HSTS браузера — список сайтов, для которых разрешен только HTTPS.

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

Варианты:

• false
• true

include_subdomains

boolean

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

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

Варианты:

• false
• true

insert_xforwarded_for

boolean

Указывает, что система вставляет в HTTP-запрос заголовок X-Forwarded-For с 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

добавлено в 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 ← (по умолчанию)

proxy_type

string

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

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

Варианты:

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

redirect_rewrite

string

Указывает, переписывает ли система URI, содержащиеся в ответах перенаправления HTTP (3XX).

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

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

Если задано значение matching, система переписывает URI в ответах перенаправления HTTP, URI которых совпадает с 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

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

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

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

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

sampling_rate_global

boolean

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

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

Варианты:

• 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.

Возвращается: 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"]