Steampunk Ansible Documentation - f5networks.f5_modules.bigip_profile_http_compression (1.28.0) - module - Manage HTTP compression profiles on a BIG-IP

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

Manage HTTP compression profiles on a BIG-IP device.

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

name:
description:
- Specifies the name of the compression profile.
required: true
type: str

state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the profile exists.
- When C(absent), ensures the profile is removed.
type: str

parent:
description:
- 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 C(httpcompression) profile.
type: str

provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- 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 C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- 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 C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules

partition:
default: Common
description:
- Device partition to manage resources on.
type: str

gzip_level:
choices:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
description:
- 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).
type: int

buffer_size:
description:
- 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.
type: int

description:
description:
- Description of the HTTP compression profile.
type: str

gzip_window_size:
choices:
- 1
- 2
- 4
- 8
- 16
- 32
- 64
- 128
description:
- Number of kilobytes in the window size the system uses when compressing a server
response.
type: int

gzip_memory_level:
choices:
- 1
- 2
- 4
- 8
- 16
- 32
- 64
- 128
- 256
description:
- Number of kilobytes of memory the system uses for internal compression buffers when
compressing a server response.
type: int

content_type_include:
description: Specifies the list of the content types that are allowed.
elements: str
type: list
version_added: 1.15.0
version_added_collection: f5networks.f5_modules

Outputs

buffer_size:
  description: The new buffer size of the profile.
  returned: changed
  sample: 4096
  type: int
description:
  description: The new description of the resource.
  returned: changed
  sample: My custom profile
  type: str
gzip_level:
  description: The new GZIP level of the profile. Smaller is less compression.
  returned: changed
  sample: 2
  type: int
gzip_memory_level:
  description: The new GZIP memory level of the profile, in KB.
  returned: changed
  sample: 16
  type: int
gzip_window_size:
  description: The new GZIP window size of the profile, in KB.
  returned: changed
  sample: 64
  type: int