bigip_profile_http – Управление профилями HTTP на BIG-IP

Новая версия с 2.7.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Управление профилями HTTP на BIG-IP.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
accept_xff boolean добавлен в 2.9		Варианты: no yes	Включает или отключает доверие к IP-адресу клиента и статистике по IP-адресу клиента, основанной на заголовках XFF (X-forwarded-for) запроса, если они существуют. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
description string			Описание профиля.
dns_resolver string			Указывает имя настроенного DNS-разрешителя. Этот параметр обязателен, когда `proxy_type` установлен в значение `explicit`. Формат имени может быть префиксным (`/Common/foo`) или указан как имя объекта (`foo`). Для удаления записи можно установить значение `none` или `''`, однако профиль `proxy_type` не должен быть установлен как `explicit`.
encrypt_cookie_secret string			Пароль для шифрования cookie. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
encrypt_cookies list			Имена cookie, которые система должна шифровать. Для полного удаления записи нужно установить значение `none` или `''`. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
enforcement dictionary добавлен в 2.9			Указывает настройки принудительного применения протокола для профиля HTTP. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	excess_client_headers string	Варианты: reject pass-through	Указывает поведение при получении слишком большого количества заголовков клиента. Если установлено значение `pass-through`, будет переключено на пропускной режим, при `reject` соединение будет отклонено. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	excess_server_headers string	Варианты: reject pass-through	Указывает поведение при получении слишком большого количества заголовков сервера. Если установлено значение `pass-through`, будет переключено на пропускной режим, при `reject` соединение будет отклонено. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	known_methods list		Указывает, какие 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	Варианты: reject pass-through	Указывает поведение при получении заголовков клиента слишком большого размера. Если установлено значение `pass-through`, будет переключено на пропускной режим, при `reject` соединение будет отклонено. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	oversize_server_headers string	Варианты: reject pass-through	Указывает поведение при получении заголовков сервера слишком большого размера. Если установлено значение `pass-through`, будет переключено на пропускной режим, при `reject` соединение будет отклонено. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	pipeline string	Варианты: allow reject pass-through	Включает HTTP/1.1-пайплайнирование, позволяющее клиентам отправлять запросы, даже если предыдущие запросы ещё не получили ответа. Однако для этого необходимо, чтобы целевые серверы поддерживали пайплайнирование. Если установлено значение `pass-through`, данные пайплайнирования заставят BIG-IP немедленно переключиться в пропускной режим и отключить HTTP-фильтр. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	truncated_redirects boolean	Варианты: no yes	Указывает, что произойдёт при получении обрыва редиректа со стороны сервера. Если `yes`, редирект будет перенаправлен клиенту, в противном случае неправильный HTTP будет проигнорирован. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	unknown_method string	Варианты: allow reject pass-through	Указывает, разрешить, отклонить или переключиться в режим пропуска при обработке неизвестного HTTP-метода. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
fallback_host string добавлен в 2.9			Указывает резервный хост HTTP. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
fallback_status_codes list добавлен в 2.9			Указывает один или несколько кодов ошибок HTTP из ответов сервера, которые должны вызвать переадресацию на резервный хост. Принятые коды ошибок определены в rfc2616. Коды могут быть указаны как отдельные элементы или как допустимые диапазоны, например, `400-417` или `500-505`. Смешивание диапазонов кодов ответов для разных типов ошибок недопустимо, например, определение `400-505` вызовет ошибку. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.

header_erase строка добавлено в 2.8			Имя заголовка в запросе HTTP, который система удаляет из запроса. Для полного удаления записи следует установить значение `none` или `''`. Формат заголовка должен быть в формате `KEY:VALUE`, в противном случае возникает ошибка. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
header_insert строка добавлено в 2.8			Строка, которую система вставляет в качестве заголовка в запрос HTTP. Для полного удаления записи следует установить значение `none` или `''`. Формат заголовка должен быть в формате `KEY:VALUE`, в противном случае возникает ошибка. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
hsts_mode логическое добавлено в 2.8		Варианты: нет да	При установке значения `yes`, включаются настройки HSTS. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
include_subdomains логическое добавлено в 2.8		Варианты: нет да	При установке значения `yes`, политика HSTS применяется к хосту HSTS и его доменным поддоменам. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
insert_xforwarded_for логическое		Варианты: нет да	При указании система вставляет заголовок X-Forwarded-For в запрос HTTP с IP-адресом клиента для использования с пулом соединений. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
maximum_age строка добавлено в 2.8			Указывает максимальную длительность в секундах, в течение которой функциональность HSTS требует, чтобы клиенты использовали только HTTPS для подключения к текущему хосту и любым поддоменам текущего доменного имени. Допустимый диапазон значений составляет `0 - 4294967295` секунд, значение `0` секунд повторно разрешает доступ по протоколу HTTP, а указание `indefinite` установит его в максимальное значение. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
name строка / обязательно			Указывает имя профиля.
oneconnect_transformations логическое добавлено в 2.9		Варианты: нет да	Включает возможность системы выполнять преобразования заголовков HTTP для поддержания открытых соединений на стороне сервера. Эта функция требует настройки профиля OneConnect. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
parent строка		По умолчанию: "/Common/http"	Указывает профиль, из которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, используется системный профиль `http`.
partition строка		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
provider словарь добавлено в 2.5			Объект типа dict, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает SSH-ключ для аутентификации соединения с удалённым устройством. Этот аргумент используется только для транспортов типа cli. Этот параметр можно опустить, установив переменную окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, установив переменную окружения `F5_USER`.
	validate_certs логическое	Варианты: нет да ←	Если значение `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно опустить, установив переменную окружения `F5_VALIDATE_CERTS`.
proxy_type строка		Варианты: обратный прозрачный явный	Указывает режим прокси для профиля. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
redirect_rewrite строка		Варианты: нет все соответствующие узлы	Указывает, переписывает ли система URI, которые являются частью ответов HTTP с перенаправлением (3XX). При установке значения `none`, система не будет переписывать URI в ответах HTTP с перенаправлением. При установке значения `all`, система переписывает URI во всех ответах HTTP с перенаправлением. При установке значения `matching`, система переписывает URI в ответах HTTP с перенаправлением, которые соответствуют URI запроса. При установке значения `nodes`, если URI содержит IP-адрес узла вместо имени хоста, система изменяет его на адрес виртуального сервера. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.
request_chunking строка добавлено в 2.9		Варианты: rechunk selective preserve	Указывает, как обрабатывать запросы с фрагментацией и без фрагментации. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля.

response_chunking строка добавлен в 2.9		Варианты: rechunk selective preserve	Указывает, как обрабатывать фрагментированные и нефрагментированные ответы. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
server_agent_name строка добавлен в 2.8			Указывает строку, используемую в качестве имени сервера в трафике, генерируемом BIG-IP. Для полного удаления записи следует установить значение `none` или `''`. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
sflow словарь добавлен в 2.9			Устанавливает параметры sFlow для профиля HTTP. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
	poll_interval целое число		Указывает максимальный интервал в секундах между двумя опросами. Допустимый диапазон значений от 0 до 4294967295 секунд включительно. Для того, чтобы это значение вступило в силу, параметр `poll_interval_global` должен быть установлен в значение `no`. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
	poll_interval_global логическое	Варианты: нет да	Указывает, переопределяет ли глобальная настройка интервала опроса HTTP значение интервала опроса на уровне объекта. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
	sampling_rate целое число		Указывает соотношение наблюдаемых пакетов к генерируемым выборкам. Например, скорость выборки `2000` указывает, что 1 выборка будет случайно сгенерирована для каждых 2000 наблюдаемых пакетов. Допустимый диапазон значений от 0 до 4294967295 пакетов включительно. Для того, чтобы это значение вступило в силу, параметр `sampling_rate_global` должен быть установлен в значение `no`. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
	sampling_rate_global логическое	Варианты: нет да	Указывает, переопределяет ли глобальная настройка скорости выборки HTTP значение скорости выборки на уровне объекта. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
state строка		Варианты: наличие ← отсутствует	При значении `present`, гарантирует существование профиля. При значении `absent`, гарантирует удаление профиля.
update_password строка		Варианты: всегда ← при_создании	`always` будет обновлять пароли, если параметр `encrypt_cookie_secret` указан. `on_create` будет устанавливать пароль только для вновь созданных профилей.
xff_alternative_names список добавлен в 2.9			Указывает альтернативные заголовки XFF вместо стандартного заголовка X-forwarded-for. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохранится на диске, необходимо включить по крайней мере одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create HTTP profile
  bigip_profile_http:
    name: my_profile
    insert_xforwarded_for: yes
    redirect_rewrite: all
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove HTTP profile
  bigip_profile_http:
    name: my_profile
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add HTTP profile for transparent proxy
  bigip_profile_http:
    name: my_profile
    proxy_type: transparent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ		Возвращаемое значение	Описание
accept_xff boolean		изменённое	Включает или отключает доверие к IP-адресу клиента и статистике по IP-адресу клиента. Пример: True
description string		изменённое	Описание профиля. Пример: Мой профиль
dns_resolver string		изменённое	Настроенный DNS-резолвер. Пример: /Common/FooBar
encrypt_cookies list		изменённое	Имена куки для шифрования. Пример: ['MyCookie1', 'MyCookie2']
enforcement complex		изменённое	Указывает параметры принудительного применения протокола для профиля HTTP. Пример: hash/словарь значений
	excess_server_headers string	изменённое	Указывает поведение при получении слишком большого количества заголовков сервера. Пример: pass-through
	known_methods list	изменённое	Список известных методов HTTP. Пример: ['default', 'FOO', 'BAR']
	max_header_count string	изменённое	Максимальное количество заголовков, разрешённых в запросе/ответе HTTP. Пример: 4096
	max_header_size string	изменённое	Максимальный размер заголовка, указанный в байтах. Пример: default
	max_requests string	изменённое	Количество запросов, принимаемых системой на основе каждого подключения. Пример: default
	oversize_client_headers string	изменённое	Указывает поведение при получении заголовков клиента слишком большого размера. Пример: reject
	oversize_server_headers string	изменённое	Указывает поведение при получении заголовков сервера слишком большого размера. Пример: reject
	pipeline string	изменённое	Разрешает, отклоняет или переключается на режим проброса при работе с данными с использованием пайплайнов. Пример: allow
	truncated_redirects boolean	изменённое	Указывает, что произойдёт при получении усеченного перенаправления от сервера. Пример: True
	unknown_method string	изменённое	Разрешает, отклоняет или переключается на режим проброса при обработке неизвестного метода HTTP. Пример: allow
fallback_host string		изменённое	Указывает резервный хост HTTP. Пример: foobar.com
fallback_status_codes list		изменённое	HTTP коды ошибок от ответов сервера, которые должны вызвать переадресацию на резервный хост. Пример: ['400-404', '500', '501']
header_erase string		изменённое	Имя заголовка в запросе HTTP, который система удаляет из запроса. Пример: FOO:BAR
header_insert string		изменённое	Строка, которую система вставляет в качестве заголовка в запрос HTTP. Пример: FOO:BAR
hsts_mode boolean		изменённое	Включает настройки HSTS.
include_subdomains boolean		изменённое	Применяет политику HSTS к хосту HSTS и его дочерним доменам. Пример: True
insert_xforwarded_for boolean		изменённое	Вставка заголовка X-Forwarded-For. Пример: True
maximum_age string		изменённое	Максимальная продолжительность времени в секундах, в течение которой функциональность HSTS запрашивает, чтобы клиенты использовали только HTTPS. Пример: неопределённо
oneconnect_transformations boolean		изменённое	Включает или отключает преобразования заголовков HTTP.
parent string		изменённое	Указывает профиль, из которого этот профиль наследует настройки. Пример: /Common/http
proxy_type string		изменённое	Укажите режим прокси для профиля. Пример: explicit
redirect_rewrite string		изменённое	Перезаписывает URI, которые являются частью ответов 3xx. Пример: all
request_chunking string		изменённое	Указывает, как обрабатывать запросы с чанкированием и без чанкирования. Пример: rechunk
response_chunking string		изменённое	Указывает, как обрабатывать ответы с чанкированием и без чанкирования. Пример: rechunk

server_agent_name string		changed	Строка, используемая в качестве имени сервера в трафике, генерируемом BIG-IP. Пример: foobar
sflow complex		changed	Указывает настройки sFlow для профиля HTTP. Пример: hash/dictionary of values
	poll_interval integer	changed	Указывает максимальный интервал в секундах между двумя опросами. Пример: 30
	poll_interval_global boolean	changed	Включает/выключает переопределение настройки интервала опроса HTTP. Пример: True
	sampling_rate integer	changed	Указывает отношение наблюдаемых пакетов к генерируемым образцам. Пример: 2000
	sampling_rate_global boolean	changed	Включает/выключает переопределение настройки частоты выборки HTTP. Пример: True
xff_alternative_names list		changed	Указывает альтернативные заголовки XFF вместо стандартного заголовка X-forwarded-for. Пример: ['FooBar', 'client1']

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицированный]

Авторы

Wojciech Wypior (@wojtek0806)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_profile_http_module.html