Parameter |
Choices/Defaults |
Comments |
always_send
boolean
|
|
Sends the cookie persistence entry on every reply, even if the entry has previously been supplied to the client.
|
cookie_encryption
string
|
Choices:
- disabled
- preferred
- required
|
Specifies the way in which the cookie encryption format is used.
When disabled , generates the cookie format unencrypted.
When preferred , generates an encrypted cookie, but accepts both encrypted and unencrypted formats.
When required , cookie format must be encrypted.
|
cookie_method
string
|
Choices:
- hash
- insert
- passive
- rewrite
|
Specifies the type of cookie processing the system uses.
When hash , specifies the server provides the cookie, which the system then maps consistently to a specific node. This persistence type requires a cookie_name value.
When insert , specifies the system inserts server information, in the form of a cookie, into the header of the server response.
When passive , specifies the server provides the cookie, formatted with the correct server information and timeout. This persistence type requires a cookie_name value.
When rewrite , specifies the system intercepts the BIGipCookie header, sent from the server, and overwrites the name and value of that cookie.
|
cookie_name
string
|
|
Specifies a unique name for the cookie.
|
description
string
|
|
Description of the profile.
|
encrypt_cookie_pool_name
boolean
|
|
Specifies whether the pool-name in the inserted BIG-IP default cookie should be encrypted.
|
encryption_passphrase
string
|
|
Specifies a passphrase to be used for cookie encryption.
|
expiration
dictionary
|
|
Specifies the expiration time of the cookie. By default the system generates and uses a session cookie. This cookie expires when the user session expires (when the browser is closed).
|
|
days
integer
|
|
Cookie expiration time in days. The value must be in range from 0 to 24855 days.
|
|
hours
integer
|
|
Cookie expiration time in hours. The value must be in the range from 0 to 23 hours.
|
|
minutes
integer
|
|
Cookie expiration time in minutes. The value must be in the range from 0 to 59 minutes.
|
|
seconds
integer
|
Default:
0
|
Cookie expiration time in seconds. The value must be in the range from 0 to 59 seconds.
|
http_only
boolean
|
|
Specifies whether the httponly attribute should be enabled or disabled for the inserted cookies.
|
match_across_pools
boolean
|
|
When yes , specifies the system can use any pool that contains this persistence record.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
match_across_services
boolean
|
|
When yes , specifies all persistent connections from a client IP address that go to the same virtual IP address also go to the same node.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
match_across_virtuals
boolean
|
|
When yes , specifies all persistent connections from the same client IP address go to the same node.
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.
|
override_connection_limit
boolean
|
|
When yes , specifies the system allows you to specify that pool member connection limits will be overridden for persisted clients.
Per-virtual connection limits remain hard limits and are not overridden.
|
parent
string
|
Default:
"cookie"
|
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 cookie 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 .
|
secure
boolean
|
|
Specifies whether the secure attribute should be enabled or disabled for the inserted cookies.
|
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 allow updating passphrases if the user chooses to do so. on_create will only set the passphrase for newly created profiles.
|