Spec-Zone.ru › Ansible 2.11

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

Примечание

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

Для его установки используйте: 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
    Варианты:
  • 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 / elements=string
Имена cookie, которые система должна шифровать.
Для полного удаления записи установите значение none или ''.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
enforcement
dictionary
Устанавливает параметры принудительного применения протокола для профиля HTTP.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
excess_client_headers
string
    Варианты:
  • reject
  • pass-through
Указывает поведение при получении слишком большого количества заголовков клиента.
Если установлено pass-through, режим переключается на проброс, когда reject, соединение отклоняется.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
excess_server_headers
string
    Варианты:
  • reject
  • pass-through
Указывает поведение при получении слишком большого количества заголовков сервера.
Если установлено 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
    Варианты:
  • 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
Указывает резервный 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
    Варианты:
  • no
  • yes
При установке значения yes, включаются параметры HSTS.
При создании нового профиля, если этот параметр не указан, используется значение родительского профиля по умолчанию.
include_subdomains
boolean
    Варианты:
  • no
  • yes
При установке значения 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
Объект словаря, содержащий данные подключения.
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
    Варианты:
  • переформирование
  • селективное
  • сохранение
Указывает, как обрабатывать запросы в формате chunk и не в формате chunk.
При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля.
response_chunking
string
    Варианты:
  • переформирование
  • селективное
  • сохранение
Указывает, как обрабатывать ответы в формате chunk и не в формате chunk.
При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля.
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
list / элементы=string
Указывает альтернативные заголовки 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
логический тип
изменён
Включает или отключает доверие к IP-адресу клиента и статистике по IP-адресу клиента.

Пример:
True
description
строка
изменён
Описание профиля.

Пример:
Мой профиль
dns_resolver
строка
изменён
Настроенный DNS-резолвер.

Пример:
/Common/FooBar
encrypt_cookies
список / элементы=строка
изменён
Имена файлов cookie для шифрования.

Пример:
['MyCookie1', 'MyCookie2']
enforcement
сложный тип
изменён
Указывает параметры принудительного выполнения протоколов для профиля HTTP.

Пример:
хеш/словарь значений
excess_server_headers
строка
изменён
Определяет поведение при получении слишком большого количества заголовков сервера.

Пример:
pass-through
known_methods
список / элементы=строка
изменён
Список известных HTTP-методов.

Пример:
['default', 'FOO', 'BAR']
max_header_count
строка
изменён
Максимальное количество заголовков, разрешенных в HTTP-запросе/ответе.

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

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

Пример:
default
oversize_client_headers
строка
изменён
Определяет поведение при получении слишком больших заголовков клиента.

Пример:
reject
oversize_server_headers
строка
изменён
Определяет поведение при получении слишком больших заголовков сервера.

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

Пример:
allow
truncated_redirects
логический тип
изменён
Указывает, что происходит, если получен обрезанный редирект от сервера.

Пример:
True
unknown_method
строка
изменён
Разрешает, отклоняет или переключается в режим прохождения, когда анализируется неизвестный HTTP-метод.

Пример:
allow
fallback_host
строка
изменён
Указывает резервный HTTP-хост.

Пример:
foobar.com
fallback_status_codes
список / элементы=строка
изменён
HTTP-коды ошибок из ответов сервера, которые должны привести к редиректу на резервный хост.

Пример:
['400-404', '500', '501']
header_erase
строка
изменён
Имя заголовка в HTTP-запросе, который система удаляет из запроса.

Пример:
FOO:BAR
header_insert
строка
изменён
Строка, которую система вставляет в качестве заголовка в HTTP-запрос.

Пример:
FOO:BAR
hsts_mode
логический тип
изменён
Включает настройки HSTS.
include_subdomains
логический тип
изменён
Применяет политику HSTS к хосту HSTS и его дочерним доменам.

Пример:
True
insert_xforwarded_for
логический тип
изменён
Вставить заголовок X-Forwarded-For.

Пример:
True
maximum_age
строка
изменён
Максимальная продолжительность времени в секундах, в течение которой функция HSTS запрашивает от клиентов использовать только HTTPS.

Пример:
неопределённо
oneconnect_transformations
логический тип
изменён
Включает или отключает преобразования заголовков HTTP.
parent
строка
изменён
Указывает профиль, из которого этот профиль наследует настройки.

Пример:
/Common/http
proxy_type
строка
изменён
Указывает режим прокси-сервера профиля.

Пример:
explicit
redirect_rewrite
строка
изменён
Переписывает URI, которые являются частью ответов 3xx.

Пример:
all
request_chunking
строка
изменён
Определяет, как обрабатывать запросы в формате chunked и не в формате chunked.

Пример:
rechunk
response_chunking
строка
изменён
Определяет, как обрабатывать ответы в формате chunked и не в формате chunked.

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

Пример:
foobar
sflow
сложный тип
изменён
Указывает настройки sFlow для профиля HTTP.

Пример:
хеш/словарь значений
poll_interval
целое число
изменён
Указывает максимальный интервал в секундах между двумя опросами.

Пример:
30
poll_interval_global
логический тип
изменён
Включает/Отключает переопределение настройки интервала опроса HTTP.

Пример:
True
sampling_rate
целое число
изменён
Указывает отношение наблюдаемых пакетов к генерируемым выборкам.

Пример:
2000
sampling_rate_global
логический тип
изменён
Включает/Отключает переопределение настройки частоты выборки HTTP.

Пример:
True
xff_alternative_names
список / элементы=строка
изменён
Указывает альтернативные заголовки XFF вместо стандартного заголовка X-forwarded-for.

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


Авторы

  • Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_profile_http_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API