Модуль f5networks.f5_modules.bigip_profile_http2 – Управление профилями HTTP2 на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_profile_http2.

Новое в f5networks.f5_modules 1.0.0

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

Описание

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

Параметры

Параметр	Комментарии
activation_modes список / элементы=строка	Указывает, что вызовет обработку входящего соединения как HTTP/2 соединения. `alpn` и `always` — взаимно исключающие. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля. Выбор: `"alpn"` `"always"`
description строка	Описание профиля.
enforce_tls_requirements логическое	Указывает, требует ли система TLS для связи между указанными отправителями и получателями. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля. Выбор: `false` `true`
frame_size целое число	Указывает размер кадров данных в байтах, которые HTTP/2 отправляет клиенту. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля. Допустимый диапазон значений в байтах: `1024 - 16384`.
header_table_size целое число	Указывает размер таблицы заголовков в байтах. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля. Допустимый диапазон значений в байтах: `0 - 65535`.
idle_timeout целое число	Указывает количество секунд, в течение которого HTTP/2 соединение остается открытым без активности, прежде чем будет закрыто. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля.
insert_header логическое	Указывает, следует ли вставлять HTTP-заголовок, указывающий на использование HTTP/2, в запрос, отправляемый на сервер. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля. Выбор: `false` `true`
insert_header_name строка	Указывает имя HTTP-заголовка, управляемого параметром `insert_header`. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля.
name строка / обязательно	Указывает имя профиля.
parent строка	Указывает профиль, из которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, по умолчанию используется профиль `http2`, предоставленный системой.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
provider словарь добавлен в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
no_f5_teem логическое	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную окружения `F5_TELEMETRY_OFF`. Предыдущая переменная `F5_TEEM` устарела, так как её название было неоднозначным. Выбор: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательно	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`.
server строка / обязательно	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернёт ошибку.

END_OF_DOCUMENT_MARKER

transport строка	Настраивает транспортное соединение для подключения к удалённому устройству. Выбор: `"rest"` ← (по умолчанию)
user строка / обязательно	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
validate_certs булево	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющимися сертификатами. Этот параметр можно опустить, установив переменную среды `F5_VALIDATE_CERTS`. Выбор: `false` `true` ← (по умолчанию)
receive_window целое число	Указывает способ управления потоком HTTP/2 профилем. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля. Допустимый диапазон значений в килобайтах — `16 - 128`.
state строка	Если `present`, гарантирует существование профиля. Если `absent`, гарантирует удаление профиля. Выбор: `"present"` ← (по умолчанию) `"absent"`
streams целое число	Указывает количество разрешённых одновременных запросов на одном соединении HTTP/2. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля. Допустимый диапазон значений — `1 - 256`.
write_size целое число	Указывает общий размер объединённых фреймов данных в байтах, которые HTTP/2 отправляет в одном запросе. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию родительского профиля. Допустимый диапазон значений в байтах — `2048 - 32768`.

Примечания

Примечание

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

Примеры

- name: Create HTTP2 profile
  bigip_profile_http2:
    name: my_profile
    insert_header: true
    insert_header_name: FOO
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

- name: Add HTTP profile set activation modes
  bigip_profile_http:
    name: my_profile
    activation_modes:
      - always
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
activation_modes список / элементы=строка	Указывает режимы обработки соединений HTTP/2. Возвращаемое: changed Пример: `["always"]`
description строка	Описание профиля. Возвращаемое: changed Пример: `"My profile"`
enforce_tls_requirements булево	Указывает, требует ли система TLS для связи. Возвращаемое: changed Пример: `true`
frame_size целое число	Размер фреймов данных. Возвращаемое: changed Пример: `30`
insert_header_name строка	Указывает имя заголовка HTTP2. Возвращаемое: changed Пример: `"X-HTTP2"`
streams целое число	Количество разрешённых одновременных запросов на одном соединении HTTP/2. Возвращаемое: changed Пример: `30`

Авторы

Wojciech Wypior (@wojtek0806)

Ссылки на сборку

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