f5networks.f5_modules.bigip_profile_http_compression 模块 – 在 BIG-IP 上管理 HTTP 压缩配置文件

注意

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

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

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

要在剧本中使用它，请指定： f5networks.f5_modules.bigip_profile_http_compression。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理 BIG-IP 设备上的 HTTP 压缩配置文件。

参数 

参数	注释
buffer_size 整数	系统在将 Content-Length 头（指定压缩大小）插入响应之前缓冲的压缩字节的最大数量。创建新配置文件时，如果未指定此参数，则由父配置文件提供默认值。
content_type_include 列表 / 元素=字符串 f5networks.f5_modules 1.15.0 中新增	指定允许的内容类型列表。
description 字符串	HTTP 压缩配置文件的描述。
gzip_level 整数	指定系统压缩内容的程度。较高的压缩级别会导致压缩过程变慢。有效值介于 1（压缩最少且最快）到 9（压缩最多且最慢）之间。选项 `1` `2` `3` `4` `5` `6` `7` `8` `9`
gzip_memory_level 整数	系统在压缩服务器响应时用于内部压缩缓冲区的内存量（千字节）。选项 `1` `2` `4` `8` `16` `32` `64` `128` `256`
gzip_window_size 整数	系统在压缩服务器响应时使用的窗口大小（千字节）。选项 `1` `2` `4` `8` `16` `32` `64` `128`
name 字符串 / 必需	指定压缩配置文件的名称。
parent 字符串	指定此配置文件继承设置的配置文件。创建新配置文件时，如果未指定此参数，则默认为系统提供的 `httpcompression` 配置文件。
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` ← (默认)
state 字符串	当 `present` 时，确保配置文件存在。当 `absent` 时，确保配置文件已删除。选项 `"present"` ← (默认) `"absent"`

备注 

注意

有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 特定的配置持久保存到磁盘，请确保至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参考模块的文档以了解保存运行配置的正确使用方法。

示例 

- name: Create an HTTP compression profile
  bigip_profile_http_compression:
    name: profile1
    description: Custom HTTP Compression Profile
    buffer_size: 131072
    gzip_level: 6
    gzip_memory_level: 16k
    gzip_window_size: 64k
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

键	描述
buffer_size 整数	配置文件的新缓冲区大小。返回：已更改示例： `4096`
description 字符串	资源的新描述。返回：已更改示例： `"My custom profile"`
gzip_level 整数	配置文件新的 GZIP 级别。数值越小，压缩率越低。返回：已更改示例： `2`
gzip_memory_level 整数	配置文件新的 GZIP 内存级别，单位为 KB。返回：已更改示例： `16`
gzip_window_size 整数	配置文件新的 GZIP 窗口大小，单位为 KB。返回：已更改示例： `64`

作者

Tim Rupp (@caphrim007)