bigip_profile_http – Manage HTTP profiles on a BIG-IP

New in version 2.7.

Synopsis

  • Manage HTTP profiles on a BIG-IP.

Parameters

Parameter Choices/Defaults Comments
description
string
Description of the profile.
dns_resolver
string
Specifies the name of a configured DNS resolver, this option is mandatory when proxy_type is set to explicit.
Format of the name can be either be prepended by partition (/Common/foo), or specified just as an object name (foo).
To remove the entry a value of none or '' can be set, however the profile proxy_type must not be set as explicit.
encrypt_cookie_secret
string
Passphrase for cookie encryption.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
encrypt_cookies
list
Cookie names for the system to encrypt.
To remove the entry completely a value of none or '' should be set.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
header_erase
string
added in 2.8
The name of a header, in an HTTP request, which the system removes from request.
To remove the entry completely a value of none or '' should be set.
The format of the header must be in KEY:VALUE format, otherwise error is raised.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
header_insert
string
added in 2.8
A string that the system inserts as a header in an HTTP request.
To remove the entry completely a value of none or '' should be set.
The format of the header must be in KEY:VALUE format, otherwise error is raised.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
hsts_mode
boolean
added in 2.8
    Choices:
  • no
  • yes
When set to yes, enables the HSTS settings.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
include_subdomains
boolean
added in 2.8
    Choices:
  • no
  • yes
When set to yes, applies the HSTS policy to the HSTS host and its sub-domains.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
insert_xforwarded_for
boolean
    Choices:
  • no
  • yes
When specified 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.
maximum_age
string
added in 2.8
Specifies the maximum length of time, in seconds, that HSTS functionality requests that 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 0 - 4294967295 seconds, a value of 0 seconds re-enables plaintext HTTP access, while specifying indefinite will set it to the maximum value.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
name
string / required
Specifies the name of the profile.
parent
string
Default:
"/Common/http"
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 http profile.
partition
string
Default:
"Common"
Device partition to manage resources on.
password
string / required
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
provider
dictionary
added in 2.5
A dict object containing connection details.
password
string / required
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
server
string / required
The BIG-IP 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.
ssh_keyfile
path
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 ANSIBLE_NET_SSH_KEYFILE.
timeout
integer
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
string
    Choices:
  • cli
  • rest ←
Configures the transport connection to use when connecting to the remote device.
user
string / 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 F5_USER.
validate_certs
boolean
    Choices:
  • no
  • yes ←
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.
proxy_type
string
    Choices:
  • reverse
  • transparent
  • explicit
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.
redirect_rewrite
string
    Choices:
  • none
  • all
  • matching
  • nodes
Specifies whether the system rewrites the URIs that are part of HTTP redirect (3XX) responses.
When set to none the system will not rewrite the URI in any HTTP redirect responses.
When set to all the system rewrites the URI in all HTTP redirect responses.
When set to matching the system rewrites the URI in any HTTP redirect responses that match the request URI.
When set to nodes if the URI contains a node IP address instead of a host name, the system changes it to the virtual server address.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
server
string / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_agent_name
string
added in 2.8
Specifies the string used as the server name in traffic generated by LTM.
To remove the entry completely a value of none or '' should be set.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
server_port
integer
added in 2.2
Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
state
string
    Choices:
  • present ←
  • absent
When present, ensures that the profile exists.
When absent, ensures the profile is removed.
update_password
string
    Choices:
  • always ←
  • on_create
always will update passwords if the encrypt_cookie_secret is specified.
on_create will only set the password for newly created profiles.
user
string / 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 F5_USER.
validate_certs
boolean
added in 2.0
    Choices:
  • no
  • yes ←
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.

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 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: yes
    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 Returned Description
description
string
changed
Description of the profile.

Sample:
My profile
dns_resolver
string
changed
Configured dns resolver.

Sample:
/Common/FooBar
encrypt_cookies
list
changed
Cookie names to encrypt.

Sample:
['MyCookie1', 'MyCookie2']
insert_xforwarded_for
boolean
changed
Insert X-Forwarded-For-Header.

Sample:
True
proxy_type
string
changed
Specify proxy mode of the profile.

Sample:
explicit
redirect_rewrite
string
changed
Rewrite URI that are part of 3xx responses.

Sample:
all


Status

Authors

  • Wojciech Wypior (@wojtek0806)

Hint

If you notice any issues in this documentation you can edit this document to improve it.