f5networks.f5_modules.bigip_profile_client_ssl module – Manages client SSL profiles on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.30.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_client_ssl
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages client SSL profiles on a BIG-IP device.
Parameters
Parameter |
Comments |
---|---|
Specifies the CAs the system advertises to clients is being trusted by the profile. |
|
Instructs the system to use the specified CRL file even if it has expired. Choices:
|
|
Enables or disables acceptance of non-SSL connections. When creating a new profile, the setting is provided by the parent profile. Choices:
|
|
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. |
|
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. |
|
Specifies the maximum number of certificates to be traversed in a client certificate chain. |
|
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. |
|
Specifies a certificate name for use. |
|
Contains a certificate chain relevant to the certificate and key mentioned previously. This key is optional. |
|
Contains a key name. |
|
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 |
|
When When Choices:
|
|
Specifies the cipher group to assign to this profile. When the When creating a new profile with The parameter only works on TMOS version 13.x and later. |
|
Specifies the list of ciphers the system supports. When the |
|
Specifies the name of a file containing a list of revoked client certificates. |
|
Specifies the frequency of client authentication for an SSL session. When When Choices:
|
|
Specifies the way the system handles client certificates. When When When Choices:
|
|
Specifies the name of the profile. |
|
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 Choices:
|
|
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the |
|
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:
|
|
Enables or disables SSL renegotiation. When creating a new profile, the setting is provided by the parent profile. Choices:
|
|
When Choices:
|
|
Specifies the method of secure renegotiations for SSL connections. When creating a new profile, the setting is provided by the parent profile. When
With the Choices:
|
|
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 |
|
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. Choices:
|
|
Requires the network peers also provide SNI support. This setting only takes effect when When creating a new profile, the setting is provided by the parent profile. Choices:
|
|
When When Choices:
|
|
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. Choices:
|
|
Specifies a client CA the system trusts. |
Notes
Note
Requires BIG-IP software version >= 12
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 client SSL profile
bigip_profile_client_ssl:
state: present
name: my_profile
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Create client SSL profile with specific ciphers
bigip_profile_client_ssl:
state: present
name: my_profile
ciphers: "!SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA"
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Create client SSL profile with specific cipher group
bigip_profile_client_ssl:
state: present
name: my_profile
ciphers: "none"
cipher_group: "/Common/f5-secure"
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Create client SSL profile with specific SSL options
bigip_profile_client_ssl:
state: present
name: my_profile
options:
- no-sslv2
- no-sslv3
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Create client SSL profile require secure renegotiation
bigip_profile_client_ssl:
state: present
name: my_profile
secure_renegotiation: request
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Create a client SSL profile with a cert/key/chain setting
bigip_profile_client_ssl:
state: present
name: my_profile
cert_key_chain:
- cert: bigip_ssl_cert1
key: bigip_ssl_key1
chain: bigip_ssl_cert1
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Acceptance of non-SSL connections. Returned: changed Sample: |
|
Specifies the number of sessions in the SSL session cache. Returned: changed Sample: |
|
Specifies the timeout value in seconds of the SSL session cache entries. Returned: changed Sample: |
|
The cipher group applied to the profile. Returned: changed Sample: |
|
The ciphers applied to the profile. Returned: changed Sample: |
|
The list of options for SSL processing. Returned: changed Sample: |
|
Renegotiation of SSL sessions. Returned: changed Sample: |
|
The method of secure SSL renegotiation. Returned: changed Sample: |
|
Resumption of SSL sessions after an unclean shutdown. Returned: changed Sample: |