f5networks.f5_modules.bigip_profile_http2 module – Manage HTTP2 profiles on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.25.0).
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_http2.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage HTTP2 profiles on a BIG-IP system.
Parameters
Parameter |
Comments |
|---|---|
Specifies what will cause an incoming connection to be handled as a HTTP/2 connection. The When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Description of the profile. |
|
Specifies whether the system requires TLS for communications between specified senders and recipients. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies the size of data frames, in bytes, that HTTP/2 sends to the client. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The valid value range in bytes is |
|
Specifies the size of the header table, in bytes. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The valid value range in bytes is |
|
Specifies the number of seconds an HTTP/2 connection is idly left open before being shut down. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies whether an HTTP header indicating the use of HTTP/2 should be inserted into the request that goes to the server. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies the name of the HTTP header controlled by When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies the name of the 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. You may omit this option by setting the environment variable |
|
The BIG-IP 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 with. 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:
|
|
Specifies the way the HTTP/2 profile performs flow control. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The valid value range in kilobytes is |
|
When When Choices:
|
|
Specifies the number of outstanding concurrent requests allowed on a single HTTP/2 connection. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The valid value range is |
|
Specifies the total size of combined data frames, in bytes, that HTTP/2 sends in a single write. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. The valid value range in bytes is |
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 HTTP2 profile
bigip_profile_http2:
name: my_profile
insert_header: yes
insert_header_name: FOO
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove HTTP profile
bigip_profile_http2:
name: my_profile
state: absent
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add HTTP profile set activation modes
bigip_profile_http:
name: my_profile
activation_modes:
- always
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 |
|---|---|
Specifies HTTP/2 connection handling modes. Returned: changed Sample: |
|
Description of the profile. Returned: changed Sample: |
|
Specifies whether the system requires TLS for communications. Returned: changed Sample: |
|
The size of the data frames. Returned: changed Sample: |
|
Specifies the name of the HTTP2 header. Returned: changed Sample: |
|
The number of outstanding concurrent requests allowed on a single HTTP/2 connection. Returned: changed Sample: |