bigip_profile_http_compression – Manage HTTP compression profiles on a BIG-IP
bigip_profile_http_compression – Manage HTTP compression profiles on a BIG-IP
New in version 2.7.
Synopsis
- Manage HTTP compression profiles on a BIG-IP.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
buffer_size - |
Maximum number of compressed bytes that 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. | ||
description - |
Description of the HTTP compression profile. | ||
gzip_level - |
|
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 - |
|
Number of kilobytes of memory that the system uses for internal compression buffers when compressing a server response. | |
gzip_window_size - |
|
Number of kilobytes in the window size that the system uses when compressing a server response. | |
name - / required |
Specifies the name of the compression profile. | ||
parent - |
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 | ||
partition - |
Default: "Common" |
Device partition to manage resources on. | |
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
provider - added in 2.5 |
Default: null |
A dict object containing connection details. | |
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
ssh_keyfile - |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable | ||
timeout - |
Default: 10 |
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 - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
user - / required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
state - |
|
When When | |
user - / required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable | ||
validate_certs boolean added in 2.0 |
|
If You may omit this option by setting the environment variable |
Notes
Note
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk
. - 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 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 | 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, in KB, of the profile.
Sample: 16 |
gzip_window_size integer |
changed |
The new GZIP window size, in KB, of the profile.
Sample: 64 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_profile_http_compression_module.html