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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в книге задач укажите: f5networks.f5_modules.bigip_profile_http.

Добавлен в версии 1.0.0: из f5networks.f5_modules

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
accept_xff boolean		Варианты: нет да	Включает или отключает доверие к 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 / elements=string			Имена cookie, которые система должна зашифровать. Для полного удаления записи, установите значение `none` или `''`. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
enforcement dictionary			Указывает настройки принудительного применения протокола для HTTP-профиля. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	excess_client_headers string	Варианты: отклонить пропустить	Указывает поведение при получении слишком большого количества заголовков клиента. Если установлено `pass-through`, переключается в режим пропуска, когда `reject`, подключение отклоняется. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	excess_server_headers string	Варианты: отклонить пропустить	Указывает поведение при получении слишком большого количества заголовков сервера. Если установлено `pass-through`, переключается в режим пропуска, когда `reject`, подключение отклоняется. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	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`, подключение отклоняется. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	oversize_server_headers string	Варианты: отклонить пропустить	Указывает поведение при получении заголовков сервера сверхразмерного размера. Если установлено `pass-through`, переключается в режим пропуска, когда `reject`, подключение отклоняется. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	pipeline string	Варианты: разрешить отклонить пропустить	Включает HTTP/1.1 конвейеризацию, позволяя клиентам отправлять запросы, даже если предыдущие запросы не получили ответа. Для успешной работы, целевые серверы должны поддерживать конвейеризацию. Если установлено `pass-through`, конвейеризированные данные заставляют BIG-IP немедленно переключиться в режим пропуска и отключить HTTP-фильтр. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	truncated_redirects boolean	Варианты: нет да	Указывает, что происходит, если получен усечённый редирект от сервера. Если `yes`, перенаправление передаётся клиенту, в противном случае некорректный HTTP игнорируется. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
	unknown_method string	Варианты: разрешить отклонить пропустить	Указывает, разрешить, отклонить или переключиться в режим пропуска при обработке неизвестного HTTP-метода. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
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		Варианты: нет да	Если установлено `yes`, включаются настройки HSTS. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
include_subdomains boolean		Варианты: нет да	Если установлено `yes`, политика HSTS применяется к хосту HSTS и его поддоменам. При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.

insert_xforwarded_for boolean		Выбором: нет да	Указывает, что система вставляет заголовок X-Forwarded-For в HTTP-запрос с IP-адресом клиента для использования с пулом соединений. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
maximum_age string			Указывает максимальную длительность в секундах, в течение которой функция HSTS запрашивает от клиентов использовать только HTTPS для подключения к текущему хосту и всем дочерним доменам текущего доменного имени. Допустимый диапазон значений — `0 - 4294967295` секунд. Значение `0` секунд возобновляет доступ к HTTP-соединению через обычный протокол, в то время как значение `indefinite` устанавливает максимальное значение. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
name string / обязательно			Указывает имя профиля.
oneconnect_transformations boolean		Выбором: нет да	Включает преобразование заголовков HTTP для поддержания открытых соединений на стороне сервера. Эта функция требует профиль OneConnect. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
parent string			Указывает профиль, из которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, используется профиль по умолчанию, предоставляемый системой (`http`).
partition string		По умолчанию: "Common"	Раздел устройства для управления ресурсами.
provider dictionary добавлен в 1.0.0 f5networks.f5_modules			Объект типа dict, содержащий данные подключения.
	auth_provider string		Настраивает поставщика аутентификации для получения маркеров аутентификации от удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem boolean	Выбором: нет да	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TEEM`.
	password string / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server string / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port integer	По умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout integer		Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
	transport string	Выбором: rest ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user string / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs boolean	Выбором: нет да ←	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
proxy_type string		Выбором: обратный прозрачный явный	Указывает режим прокси для профиля. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
redirect_rewrite string		Выбором: нет все соответствующие узлы	Указывает, переписывает ли система URI, которые являются частью ответов HTTP перенаправления (3XX). При значении `none`, система не будет переписывать URI в ответах HTTP перенаправления. При значении `all`, система переписывает URI во всех ответах HTTP перенаправления. При значении `matching`, система переписывает URI в ответах HTTP перенаправления, которые соответствуют URI запроса. При значении `nodes`, если URI содержит IP-адрес узла вместо имени хоста, система изменит его на адрес виртуального сервера. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
request_chunking string		Выбором: переформировать выборочно сохранить	Указывает, как обрабатывать запросы в формате chunks и без него. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
response_chunking string		Выбором: переформировать выборочно сохранить	Указывает, как обрабатывать ответы в формате chunks и без него. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
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` на уровне объекта. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
	sampling_rate integer		Указывает соотношение наблюдаемых пакетов к сгенерированным образцам. Например, скорость выборки `2000` указывает, что 1 образец будет случайным образом сгенерирован на каждые 2000 наблюдаемых пакетов. Допустимый диапазон значений — от 0 до 4294967295 пакетов включительно. Для применения этой настройки параметр `sampling_rate_global` должен быть установлен в значение `no`. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
	sampling_rate_global boolean	Выбором: нет да	Указывает, переопределяет ли глобальная настройка скорости выборки HTTP значение настройки на уровне объекта. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
state string		Выбором: наличие ← отсутствует	При значении `present`, гарантирует, что профиль существует. При значении `absent`, гарантирует, что профиль удалён.
update_password string		Выбором: всегда ← при_создании	`always` обновит пароли, если `encrypt_cookie_secret` указано. `on_create` будет устанавливать пароль только для вновь созданных профилей.
xff_alternative_names список / элементы=строка			Указывает альтернативные заголовки XFF вместо стандартного заголовка X-forwarded-for. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, необходимо включить по крайней мере одну задачу, использующую модуль f5networks.f5_modules.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		changed	Включает или отключает доверие к IP-адресу клиента и статистике по IP-адресу клиента. Пример: True
description string		changed	Описание профиля. Пример: Мой профиль
dns_resolver string		changed	Настроенный DNS-резолвер. Пример: /Common/FooBar
encrypt_cookies list / elements=string		changed	Имена файлов cookie для шифрования. Пример: ['MyCookie1', 'MyCookie2']
enforcement complex		changed	Указывает параметры принудительного применения протокола для профиля HTTP. Пример: хэш/словарь значений
	excess_server_headers string	changed	Указывает поведение при получении слишком большого количества заголовков сервера. Пример: pass-through
	known_methods list / elements=string	changed	Список известных HTTP-методов. Пример: ['default', 'FOO', 'BAR']
	max_header_count string	changed	Максимальное количество заголовков, разрешенных в HTTP-запросе/ответе. Пример: 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	changed	Разрешить, отклонить или переключиться на прохождение при обработке неизвестного HTTP-метода. Пример: allow
fallback_host string		changed	Указывает резервный HTTP-хост. Пример: foobar.com
fallback_status_codes list / elements=string		changed	HTTP-коды ошибок от ответов сервера, которые должны вызвать переадресацию на резервный хост. Пример: ['400-404', '500', '501']
header_erase string		changed	Имя заголовка в HTTP-запросе, который система удаляет из запроса. Пример: FOO:BAR
header_insert string		changed	Строка, которую система вставляет в качестве заголовка в HTTP-запрос. Пример: FOO:BAR
hsts_mode boolean		changed	Включает параметры HSTS.
include_subdomains boolean		changed	Применяет политику HSTS к хосту HSTS и его дочерним доменам. Пример: True
insert_xforwarded_for boolean		changed	Вставить заголовок X-Forwarded-For. Пример: True
maximum_age string		changed	Максимальное время в секундах, в течение которого функция HSTS запрашивает, чтобы клиенты использовали только HTTPS. Пример: неопределенное время
oneconnect_transformations boolean		changed	Включает или отключает преобразования заголовков HTTP.
parent string		changed	Указывает профиль, из которого этот профиль наследует настройки. Пример: /Common/http
proxy_type string		changed	Укажите режим прокси для профиля. Пример: explicit
redirect_rewrite string		changed	Перезаписывает URI, которые являются частью ответов 3xx. Пример: all
request_chunking string		changed	Указывает, как обрабатывать запросы с чанкингом и без. Пример: rechunk
response_chunking string		changed	Указывает, как обрабатывать ответы с чанкингом и без. Пример: rechunk
server_agent_name string		changed	Строка, используемая в качестве имени сервера в трафике, генерируемом BIG-IP. Пример: foobar
sflow complex		changed	Указывает параметры sFlow для профиля HTTP. Пример: хэш/словарь значений
	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 / elements=string		changed	Указывает альтернативные заголовки XFF вместо стандартного заголовка X-forwarded-for. Пример: ['FooBar', 'client1']

Авторы

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.10/collections/f5networks/f5_modules/bigip_profile_http_module.html