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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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 list / elements=string	Указывает, что будет причиной обработки входящего подключения как подключения HTTP/2. Параметры `alpn` и `always` взаимоисключающие. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. Варианты выбора: `"alpn"` `"always"`
description string	Описание профиля.
enforce_tls_requirements boolean	Указывает, требует ли система использования TLS для обмена данными между указанными отправителями и получателями. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. Варианты выбора: `false` `true`
frame_size integer	Указывает размер кадров данных в байтах, которые HTTP/2 отправляет клиенту. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. Допустимый диапазон значений в байтах: `1024 - 16384`.
header_table_size integer	Указывает размер таблицы заголовков в байтах. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. Допустимый диапазон значений в байтах: `0 - 65535`.
idle_timeout integer	Указывает, сколько секунд подключение HTTP/2 может оставаться открытым бездействуя, прежде чем оно будет закрыто. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
insert_header boolean	Указывает, следует ли вставлять в запрос, отправляемый на сервер, HTTP-заголовок, обозначающий использование HTTP/2. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. Варианты выбора: `false` `true`
insert_header_name string	Указывает имя HTTP-заголовка, управляемого параметром `insert_header`. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля.
name string / обязательный	Указывает имя профиля.
parent string	Указывает профиль, от которого данный профиль наследует настройки. При создании нового профиля, если этот параметр не указан, используется системный профиль `http2`.
partition string	Раздел устройства, в котором будут управляться ресурсы. По умолчанию: `"Common"`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Словарь с данными для подключения.
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` ← (по умолчанию)
receive_window integer	Указывает способ управления потоком данных профилем HTTP/2. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. Допустимый диапазон значений в килобайтах: `16 - 128`.
state string	Если `present`, обеспечивает наличие профиля. Если `absent`, обеспечивает удаление профиля. Варианты выбора: `"present"` ← (по умолчанию) `"absent"`
streams integer	Указывает число незавершенных параллельных запросов, разрешенных в одном подключении HTTP/2. При создании нового профиля, если этот параметр не указан, используется значение по умолчанию из родительского профиля. Допустимый диапазон значений: `1 - 256`.
write_size integer	Указывает общий размер объединенных кадров данных в байтах, которые 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 list / elements=string	Указывает режимы обработки подключений HTTP/2. Возвращается: при изменении Пример: `["always"]`
description string	Описание профиля. Возвращается: при изменении Пример: `"My profile"`
enforce_tls_requirements boolean	Указывает, требует ли система использования TLS для обмена данными. Возвращается: при изменении Пример: `true`
frame_size integer	Размер кадров данных. Возвращается: при изменении Пример: `30`
insert_header_name string	Указывает имя заголовка HTTP2. Возвращается: при изменении Пример: `"X-HTTP2"`
streams integer	Число незавершенных параллельных запросов, разрешенных в одном подключении HTTP/2. Возвращается: при изменении Пример: `30`

Авторы

Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

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