f5networks.f5_modules.bigip_profile_server_ssl module – Manages server SSL profiles on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.31.0).
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_server_ssl
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages server SSL profiles on a BIG-IP system.
Parameters
Parameter |
Comments |
---|---|
Specifies a Common Name (CN) that is embedded in a server certificate. The system authenticates a server based on the specified CN. |
|
Specifies a server CA the system trusts. The default is (None). |
|
Specifies the name of the certificate the system uses for server-side SSL processing. |
|
Specifies the certificates-key chain to associate with the SSL profile. |
|
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 creating a new profile, the default cipher list is provided by the parent profile. When the |
|
Specifies the file name of the SSL key. |
|
Specifies the name of the profile. |
|
Specifies the name of the OCSP profile for purpose of validating the status of server certificate. |
|
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. Default: |
|
Device partition to manage resources on. Default: |
|
Specifies a passphrase used to encrypt the key. |
|
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:
|
|
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 way the system handles server certificates. When When 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. |
|
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:
|
|
Choices:
|
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 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 a new server SSL profile
bigip_profile_server_ssl:
name: foo
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create server SSL profile with specific cipher group
bigip_profile_server_ssl:
state: present
name: foo_group
ciphers: "none"
cipher_group: "/Common/f5-secure"
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 |
---|---|
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: |