f5networks.f5_modules.bigip_profile_http2 模块 – 在 BIG-IP 上管理 HTTP2 配置文件

注意

此模块是 f5networks.f5_modules 集合 (版本 1.32.1) 的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定：f5networks.f5_modules.bigip_profile_http2。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

在 BIG-IP 系统上管理 HTTP2 配置文件。

参数 

参数	注释
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/2 的 HTTP 报头插入到发送到服务器的请求中。创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。选项 `false` `true`
insert_header_name 字符串	指定由 `insert_header` 参数控制的 HTTP 报头名称。创建新配置文件时，如果未指定此参数，则默认值由父配置文件提供。
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 整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超时，模块将出错。
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 网络设备的更多信息，请参见 https://ansible.org.cn/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

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

Key	描述
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)