f5networks.f5_modules.bigip_profile_http module – Manage HTTP 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
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage HTTP profiles on a BIG-IP device.
Parameters
Parameter |
Comments |
---|---|
Enables or disables trusting the client IP address, and statistics from the client IP address, based on the request’s XFF (X-forwarded-for) headers, if they exist. 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 the name of a configured DNS resolver, this option is mandatory when Format of the name can be either be prepended by partition ( To remove the entry, you can set a value of |
|
Passphrase for cookie encryption. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Cookie names for the system to encrypt. To remove the entry completely, set a value of When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies protocol enforcement settings for the HTTP profile. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies the behavior when too many client headers are received. If set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies the behavior when too many server headers are received. If set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies which HTTP methods count as being known, removing RFC-defined methods from this list will cause the HTTP filter to not recognize them. The default list provided with the system include: The When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies the maximum number of headers allowed in HTTP request/response. The valid value range is between 16 and 4096 inclusive. When set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies the maximum header size specified in bytes. The valid value range is between 0 and 4294967295 inclusive. When set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies the number of requests the system accepts on a per-connection basis. The valid value range is between 0 and 4294967295 inclusive. When set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies the behavior when too-large client headers are received. If set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies the behavior when too-large server headers are received. If set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Enables HTTP/1.1 pipelining, allowing clients to make requests even when prior requests have not received a response. In order for this to succeed, destination servers must include support for pipelining. If set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies what happens if a truncated redirect is seen from a server. If When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies whether to allow, reject or switch to pass-through mode when an unknown HTTP method is parsed. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies an HTTP fallback host. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies one or more HTTP error codes from server responses that should trigger a redirection to the fallback host. The accepted valid error codes are as defined by RFC2616. The codes can be specified as individual items or as valid ranges, for example Mixing response code range across error types is invalid, for example defining When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
The name of a header in an HTTP request, which the system removes from request. To remove the entry completely, set a value of The format of the header must be in When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
A string the system inserts as a header in an HTTP request. To remove the entry completely, set a value of The format of the header must be in When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
When set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
When set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
When set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies the system inserts an X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies the maximum length of time, in seconds, that HSTS functionality requests clients only use HTTPS to connect to the current host and any sub-domains of the current host’s domain name. The accepted value range is 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. |
|
Enables the system to perform HTTP header transformations for keeping server-side connections open. This feature requires a OneConnect profile. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
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:
|
|
Specifies the proxy mode for the profile. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies whether the system rewrites the URIs that are part of HTTP redirect (3XX) responses. When set to When set to When set to When set to When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies how to handle chunked and unchunked requests. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies how to handle chunked and unchunked responses. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies the string used as the server name in traffic generated by BIG-IP. To remove the entry completely, set a value of When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies sFlow settings for the HTTP profile. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies the maximum interval in seconds between two pollings. The valid value range is between 0 and 4294967295 seconds inclusive. For this setting to take effect the When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies whether the global HTTP poll-interval setting overrides the object-level When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies the ratio of packets observed to the samples generated. For example, a sampling rate of The valid value range is between 0 and 4294967295 packets inclusive. For this setting to take effect the When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies whether the global HTTP sampling-rate setting overrides the object-level sampling-rate setting. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
When When Choices:
|
|
Choices:
|
|
Specifies alternative XFF headers instead of the default X-forwarded-for header. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
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 HTTP profile
bigip_profile_http:
name: my_profile
insert_xforwarded_for: true
redirect_rewrite: all
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
- name: Remove HTTP profile
bigip_profile_http:
name: my_profile
state: absent
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Add HTTP profile for transparent proxy
bigip_profile_http:
name: my_profile
proxy_type: transparent
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 |
---|---|
Enables or disables trusting the client IP address and statistics from the client IP address. Returned: changed Sample: |
|
Description of the profile. Returned: changed Sample: |
|
Configured dns resolver. Returned: changed Sample: |
|
Cookie names to encrypt. Returned: changed Sample: |
|
Specifies protocol enforcement settings for the HTTP profile. Returned: changed Sample: |
|
Specifies the behavior when too many server headers are received. Returned: changed Sample: |
|
The list of known HTTP methods. Returned: changed Sample: |
|
The maximum number of headers allowed in HTTP request/response. Returned: changed Sample: |
|
The maximum header size specified in bytes. Returned: changed Sample: |
|
The number of requests the system accepts on a per-connection basis. Returned: changed Sample: |
|
Specifies the behavior when too-large client headers are received. Returned: changed Sample: |
|
Specifies the behavior when too-large server headers are received. Returned: changed Sample: |
|
Allows, rejects. or switches to pass-through mode when dealing with pipelined data. Returned: changed Sample: |
|
Specifies what happens if a truncated redirect is seen from a server. Returned: changed Sample: |
|
Allows, rejects. or switches to pass-through mode when an unknown HTTP method is parsed. Returned: changed Sample: |
|
Specifies an HTTP fallback host. Returned: changed Sample: |
|
HTTP error codes from server responses that should trigger a redirection to the fallback host. Returned: changed Sample: |
|
The name of a header in an HTTP request, which the system removes from request. Returned: changed Sample: |
|
The string the system inserts as a header in an HTTP request. Returned: changed Sample: |
|
Enables the HSTS settings. Returned: changed Sample: |
|
Enables the HSTS preload. Returned: changed Sample: |
|
Applies the HSTS policy to the HSTS host and its sub-domains. Returned: changed Sample: |
|
Insert X-Forwarded-For-Header. Returned: changed Sample: |
|
The maximum length of time, in seconds, that HSTS functionality requests that clients only use HTTPS. Returned: changed Sample: |
|
Enables or disables HTTP header transformations. Returned: changed Sample: |
|
Specifies the profile from which this profile inherits settings. Returned: changed Sample: |
|
Specify proxy mode of the profile. Returned: changed Sample: |
|
Rewrite URI that are part of 3xx responses. Returned: changed Sample: |
|
Specifies how to handle chunked and unchunked requests. Returned: changed Sample: |
|
Specifies how to handle chunked and unchunked responses. Returned: changed Sample: |
|
The string used as the server name in traffic generated by BIG-IP. Returned: changed Sample: |
|
Specifies sFlow settings for the HTTP profile. Returned: changed Sample: |
|
Specifies the maximum interval in seconds between two pollings. Returned: changed Sample: |
|
Enables/Disables overriding HTTP poll-interval setting. Returned: changed Sample: |
|
Specifies the ratio of packets observed to the samples generated. Returned: changed Sample: |
|
Enables/Disables overriding HTTP sampling-rate setting. Returned: changed Sample: |
|
Specifies alternative XFF headers instead of the default X-forwarded-for header. Returned: changed Sample: |