f5networks.f5_modules.bigip_profile_http_compression module – Manage HTTP compression profiles on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_profile_http_compression
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage HTTP compression profiles on a BIG-IP device.
Parameters
Parameter |
Comments |
---|---|
Maximum number of compressed bytes the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies the list of the content types that are allowed. |
|
Description of the HTTP compression profile. |
|
Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. Valid values are between 1 (least compression and fastest) to 9 (most compression and slowest). Choices:
|
|
Number of kilobytes of memory the system uses for internal compression buffers when compressing a server response. Choices:
|
|
Number of kilobytes in the window size the system uses when compressing a server response. Choices:
|
|
Specifies the name of the compression profile. |
|
Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
When When Choices:
|
Notes
Note
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The new buffer size of the profile. Returned: changed Sample: |
|
The new description of the resource. Returned: changed Sample: |
|
The new GZIP level of the profile. Smaller is less compression. Returned: changed Sample: |
|
The new GZIP memory level of the profile, in KB. Returned: changed Sample: |
|
The new GZIP window size of the profile, in KB. Returned: changed Sample: |