Parameter |
Choices/Defaults |
Comments |
advertised_cert_authority
string
|
|
Specifies the CAs the system advertises to clients is being trusted by the profile.
|
allow_expired_crl
boolean
|
|
Instructs the system to use the specified CRL file even if it has expired.
|
allow_non_ssl
boolean
|
|
Enables or disables acceptance of non-SSL connections.
When creating a new profile, the setting is provided by the parent profile.
|
cache_size
integer
added in 1.0.0 of f5networks.f5_modules
|
|
Specifies the number of sessions in the SSL session cache.
The valid value range is between 0 and 4194304 inclusive.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
cache_timeout
integer
added in 1.0.0 of f5networks.f5_modules
|
|
Specifies the timeout value in seconds of the SSL session cache entries.
Acceptable values are between 0 and 86400 inclusive.
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
|
cert_auth_depth
integer
|
|
Specifies the maximum number of certificates to be traversed in a client certificate chain.
|
cert_key_chain
list
/ elements=dictionary
|
|
One or more certificates and keys to associate with the SSL profile. This option is always a list. The keys in the list dictate the details of the client/key/chain combination. Note that BIG-IPs can only have one of each type of each certificate/key type. This means you can only have one RSA, one DSA, and one ECDSA per profile. If you attempt to assign two RSA, DSA, or ECDSA certificate/key combo, the device rejects it.
This list is a complex list that specifies a number of keys.
|
|
cert
string
/ required
|
|
Specifies a certificate name for use.
|
|
chain
string
|
|
Contains a certificate chain relevant to the certificate and key mentioned previously.
This key is optional.
|
|
key
string
/ required
|
|
Contains a key name.
|
|
passphrase
string
|
|
Contains the passphrase of the key file, if required.
Passphrases are encrypted on the remote BIG-IP device. Therefore, there is no way to compare them when updating a client SSL profile. Due to this, if you specify a passphrase, this module will always register a changed event.
|
|
true_names
boolean
added in 1.1.0 of f5networks.f5_modules
|
|
When yes , the module will not append .crt and .key extensions to the given certificate and key names.
When no , the module will append .crt and .key extensions to the given certificate and key names.
|
cipher_group
string
added in 1.2.0 of f5networks.f5_modules
|
|
Specifies the cipher group to assign to this profile.
When the ciphers parameter is in use, the cipher_group must be set to either none or '' .
When creating a new profile with cipher_group , if the parent profile has ciphers set by default, the cipher parameter must be set to none or '' during creation.
The parameter only works on TMOS version 13.x and later.
|
ciphers
string
|
|
Specifies the list of ciphers the system supports.
When the cipher_group parameter is in use, the ciphers parameter needs to be set to either none or '' .
|
client_auth_crl
string
|
|
Specifies the name of a file containing a list of revoked client certificates.
|
client_auth_frequency
string
|
|
Specifies the frequency of client authentication for an SSL session.
When once , specifies the system authenticates the client once for an SSL session.
When always , specifies the system authenticates the client once for an SSL session and also upon reuse of that session.
|
client_certificate
string
|
Choices:
- ignore
- require
- request
|
Specifies the way the system handles client certificates.
When ignore , specifies the system ignores certificates from client systems.
When require , specifies the system requires a client to present a valid certificate.
When request , specifies the system requests a valid certificate from a client but always authenticate the client.
|
name
string
/ required
|
|
Specifies the name of the profile.
|
options
list
/ elements=string
|
Choices:
- netscape-reuse-cipher-change-bug
- microsoft-big-sslv3-buffer
- msie-sslv2-rsa-padding
- ssleay-080-client-dh-bug
- tls-d5-bug
- tls-block-padding-bug
- dont-insert-empty-fragments
- no-ssl
- no-dtls
- no-session-resumption-on-renegotiation
- no-tlsv1.1
- no-tlsv1.2
- no-tlsv1.3
- single-dh-use
- ephemeral-rsa
- cipher-server-preference
- tls-rollback-bug
- no-sslv2
- no-sslv3
- no-tls
- no-tlsv1
- pkcs1-check-1
- pkcs1-check-2
- netscape-ca-dn-bug
- netscape-demo-cipher-change-bug
- none
|
Options the system uses for SSL processing in the form of a list. When creating a new profile, the list is provided by the parent profile.
When '' or none , all options for SSL processing are disabled.
|
parent
string
|
|
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the clientssl parent on the Common partition.
|
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 .
|
renegotiation
boolean
|
|
Enables or disables SSL renegotiation.
When creating a new profile, the setting is provided by the parent profile.
|
retain_certificate
boolean
|
|
When yes , the client certificate is retained in SSL session.
|
secure_renegotiation
string
|
Choices:
- require
- require-strict
- request
|
Specifies the method of secure renegotiations for SSL connections. When creating a new profile, the setting is provided by the parent profile.
When request , the system requests secure renegotiation of SSL connections.
require is a default setting and when set, the system permits initial SSL handshakes from clients, but terminates renegotiations from unpatched clients.
With the require-strict setting, the system requires strict renegotiation of SSL connections. In this mode, the system refuses connections to insecure servers, and terminates existing SSL connections to insecure servers.
|
server_name
string
|
|
Specifies the fully qualified DNS hostname of the server used in Server Name Indication communications. When creating a new profile, the setting is provided by the parent profile.
The server name can also be a wildcard string containing the asterisk * character.
|
sni_default
boolean
|
|
Indicates the system uses this profile as the default SSL profile when there is no match to the server name, or when the client provides no SNI extension support.
When creating a new profile, the setting is provided by the parent profile.
There can be only one SSL profile with this setting enabled.
|
sni_require
boolean
|
|
Requires the network peers also provide SNI support. This setting only takes effect when sni_default is set to true .
When creating a new profile, the setting is provided by the parent profile.
|
state
string
|
Choices:
present ←
- absent
|
When present , ensures the profile exists.
When absent , ensures the profile is removed.
|
strict_resume
boolean
|
|
Enables or disables the resumption of SSL sessions after an unclean shutdown.
When creating a new profile, the setting is provided by the parent profile.
|
trusted_cert_authority
string
|
|
Specifies a client CA the system trusts.
|