bigip_profile_server_ssl – Manages server SSL profiles on a BIG-IP

New in version 2.8.

Synopsis

  • Manages server SSL profiles on a BIG-IP.

Parameters

Parameter Choices/Defaults Comments
certificate
string
Specifies the name of the certificate that the system uses for server-side SSL processing.
chain
string
Specifies the certificates-key chain to associate with the SSL profile.
ciphers
string
Specifies the list of ciphers that the system supports. When creating a new profile, the default cipher list is provided by the parent profile.
key
string
Specifies the file name of the SSL key.
name
string / required
Specifies the name of the profile.
ocsp_profile
string
Specifies the name of the OCSP profile for purpose of validating status of server certificate.
parent
string
Default:
"/Common/serverssl"
The parent template of this monitor template. Once this value has been set, it cannot be changed.
partition
string
Default:
"Common"
Device partition to manage resources on.
passphrase
string
Specifies a passphrase used to encrypt the key.
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
provider
dictionary
added in 2.5
A dict object containing connection details.
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.
ssh_keyfile
path
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports.
You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE.
timeout
integer
Default:
10
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
    Choices:
  • cli
  • rest ←
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
    Choices:
  • no
  • yes ←
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_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 is set the system request secure renegotation 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.
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
string / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_certificate
string
    Choices:
  • ignore
  • require
Specifies the way the system handles server certificates.
When ignore, specifies that the system ignores certificates from server systems.
When require, specifies that the system requires a server to present a valid certificate.
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.
server_port
integer
added in 2.2
 Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
sni_default
boolean
    Choices:
  • no
  • yes
Indicates that 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
    Choices:
  • no
  • yes
Requires that the network peers also provide SNI support, setting only takes effect when sni_default is yes.
When creating a new profile, the setting is provided by the parent profile.
state
string
    Choices:
  • present ←
  • absent
When present, ensures that the profile exists.
When absent, ensures the profile is removed.
update_password
string
    Choices:
  • always ←
  • on_create
always will allow to update passwords if the user chooses to do so. on_create will only set the password for newly created profiles.
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
added in 2.0
    Choices:
  • no
  • yes ←
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.

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 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
ciphers
string
 changed
The ciphers applied to the profile.

Sample:
!SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA
secure_renegotiation
string
 changed
The method of secure SSL renegotiation.

Sample:
request


Status

Authors

  • Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation you can edit this document to improve it.