Parameter |
Choices/Defaults |
Comments |
accept_xff
boolean
|
|
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.
|
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, you can set a value of none or '' , 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
/ elements=string
|
|
Cookie names for the system to encrypt.
To remove the entry completely, set a value of none or '' .
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
enforcement
dictionary
|
|
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.
|
|
excess_client_headers
string
|
Choices:
- reject
- pass-through
|
Specifies the behavior when too many client headers are received.
If set to pass-through , it switches to pass-through mode, when reject , the connection is rejected.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
excess_server_headers
string
|
Choices:
- reject
- pass-through
|
Specifies the behavior when too many server headers are received.
If set to pass-through , it switches to pass-through mode, when reject the connection is rejected.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
known_methods
list
/ elements=string
|
|
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: CONNECT , DELETE , GET , HEAD , LOCK , OPTIONS , POST , PROPFIND , PUT , TRACE ,UNLOCK . The list can be appended by by specifying the default keyword as one of the list elements.
The default keyword can also be used to restore the default known_methods on the system.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
max_header_count
string
|
|
Specifies the maximum number of headers allowed in HTTP request/response.
The valid value range is between 16 and 4096 inclusive.
When set to default , the value is 64 .
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
max_header_size
string
|
|
Specifies the maximum header size specified in bytes.
The valid value range is between 0 and 4294967295 inclusive.
When set to default , the value is 32768 bytes
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
max_requests
string
|
|
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 default , the value is 0 , which means the system will not limit the number of requests per connection.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
oversize_client_headers
string
|
Choices:
- reject
- pass-through
|
Specifies the behavior when too-large client headers are received.
If set to pass-through ,it switches to pass-through mode, when reject the connection is rejected.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
oversize_server_headers
string
|
Choices:
- reject
- pass-through
|
Specifies the behavior when too-large server headers are received.
If set to pass-through , it switches to pass-through mode, when reject the connection is rejected.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
pipeline
string
|
Choices:
- allow
- reject
- pass-through
|
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 pass-through , pipelined data causes the BIG-IP to immediately switch to pass-through mode and disable the HTTP filter.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
truncated_redirects
boolean
|
|
Specifies what happens if a truncated redirect is seen from a server.
If yes , the redirect is forwarded to the client, otherwise the malformed HTTP is silently ignored.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
unknown_method
string
|
Choices:
- allow
- reject
- pass-through
|
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.
|
fallback_host
string
|
|
Specifies an HTTP fallback host.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
fallback_status_codes
list
/ elements=string
|
|
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 400-417 or 500-505 .
Mixing response code range across error types is invalid, for example defining 400-505 will raise an error.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
header_erase
string
|
|
The name of a header in an HTTP request, which the system removes from request.
To remove the entry completely, set a value of none or '' .
The format of the header must be in KEY:VALUE format, otherwise an error occurs.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
header_insert
string
|
|
A string the system inserts as a header in an HTTP request.
To remove the entry completely, set a value of none or '' .
The format of the header must be in KEY:VALUE format, otherwise an error occurs.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
hsts_mode
boolean
|
|
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
|
|
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
|
|
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.
|
maximum_age
string
|
|
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 0 - 4294967295 seconds. A value of 0 seconds re-enables plaintext HTTP access, while specifying indefinite sets 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.
|
oneconnect_transformations
boolean
|
|
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.
|
parent
string
|
|
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.
|
provider
dictionary
added in 1.0.0 of f5networks.f5_modules
|
|
A dict object containing connection details.
|
|
auth_provider
string
|
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
|
no_f5_teem
boolean
|
|
If yes , TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TEEM .
|
|
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 .
|
|
timeout
integer
|
|
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
|
|
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
|
|
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.
|
request_chunking
string
|
Choices:
- rechunk
- selective
- preserve
|
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.
|
response_chunking
string
|
Choices:
- rechunk
- selective
- preserve
|
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.
|
server_agent_name
string
|
|
Specifies the string used as the server name in traffic generated by BIG-IP.
To remove the entry completely, set a value of none or '' .
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
sflow
dictionary
|
|
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.
|
|
poll_interval
integer
|
|
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 poll_interval_global parameter must be set to no .
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
poll_interval_global
boolean
|
|
Specifies whether the global HTTP poll-interval setting overrides the object-level poll-interval setting.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
sampling_rate
integer
|
|
Specifies the ratio of packets observed to the samples generated. For example, a sampling rate of 2000 specifies 1 sample will be randomly generated for every 2000 packets observed.
The valid value range is between 0 and 4294967295 packets inclusive.
For this setting to take effect the sampling_rate_global parameter must be set to no .
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
|
sampling_rate_global
boolean
|
|
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.
|
state
string
|
Choices:
present ←
- absent
|
When present , ensures 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.
|
xff_alternative_names
list
/ elements=string
|
|
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.
|