Last updated on: 2024-01-16 03:25:50.
bigip_profile_http_compression – Manage HTTP compression profiles on a BIG-IP¶
New in version 1.0.0.
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments | |
---|---|---|---|---|
buffer_size
integer
|
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.
|
|||
content_type_include
list
/ elements=string
added in 1.15.0 |
S
p
e
c
i
f
i
e
s
t
h
e
l
i
s
t
o
f
t
h
e
c
o
n
t
e
n
t
t
y
p
e
s
t
h
a
t
a
r
e
a
l
l
o
w
e
d
.
|
|||
description
string
|
Description of the HTTP compression profile.
|
|||
gzip_level
integer
|
|
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).
|
||
gzip_memory_level
integer
|
|
Number of kilobytes of memory the system uses for internal compression buffers when compressing a server response.
|
||
gzip_window_size
integer
|
|
Number of kilobytes in the window size the system uses when compressing a server response.
|
||
name
string
/ required
|
Specifies the name of the compression profile.
|
|||
parent
string
|
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
httpcompression profile. |
|||
partition
string
|
Default: "Common"
|
Device partition to manage resources on.
|
||
provider
dictionary
added in 1.0.0 |
A dict object containing connection details.
|
|||
auth_provider
string
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
|||
no_f5_teem
boolean
|
|
If
yes , TEEM telemetry data is not sent to F5.You may omit this option by setting the environment variable
F5_TELEMETRY_OFF .Previously used variable
F5_TEEM is deprecated as its name was confusing. |
||
password
string
/ required
|
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
F5_PASSWORD .aliases: pass, pwd |
|||
server
string
/ required
|
The BIG-IP host or the BIG-IQ host.
You may omit this option by setting the environment variable
F5_SERVER . |
|||
server_port
integer
|
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
||
timeout
integer
|
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.
|
|||
transport
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
||
user
string
/ required
|
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
F5_USER . |
|||
validate_certs
boolean
|
|
If
no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.You may omit this option by setting the environment variable
F5_VALIDATE_CERTS . |
||
state
string
|
|
When
present , ensures the profile exists.When
absent , ensures the profile is removed. |
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¶
The following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
buffer_size
integer
|
changed |
The new buffer size of the profile.
Sample:
4096
|
description
string
|
changed |
The new description of the resource.
Sample:
My custom profile
|
gzip_level
integer
|
changed |
The new GZIP level of the profile. Smaller is less compression.
Sample:
2
|
gzip_memory_level
integer
|
changed |
The new GZIP memory level of the profile, in KB.
Sample:
16
|
gzip_window_size
integer
|
changed |
The new GZIP window size of the profile, in KB.
Sample:
64
|