Docs4dev
Docs
ansible / 2.8 / modules / bigip_profile_client_ssl_module.html

bigip_profile_client_ssl – Manages client SSL profiles on a BIG-IP

New in version 2.5.

Synopsis

  • Manages client SSL profiles on a BIG-IP.

Parameters

Parameter Choices/Defaults Comments
advertised_cert_authority
string
added in 2.8
Specifies that the CAs that the system advertises to clients is being trusted by the profile.
allow_expired_crl
boolean
added in 2.8
    Choices:
  • no
  • yes
Instructs the system to use the specified CRL file even if it has expired.
allow_non_ssl
boolean
added in 2.7
    Choices:
  • no
  • yes
Enables or disables acceptance of non-SSL connections.
When creating a new profile, the setting is provided by the parent profile.
cert_auth_depth
integer
added in 2.8
Specifies the maximum number of certificates to be traversed in a client certificate chain.
cert_key_chain
list
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 that 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 will reject this.
This list is a complex list that specifies a number of keys.
cert
string / required
Specifies a cert name for use.
chain
string
Contains a certificate chain that is relevant to the certificate and key mentioned earlier.
This key is optional.
key
string / required
Contains a key name.
passphrase
string
Contains the passphrase of the key file, should it require one.
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.
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.
client_auth_crl
string
added in 2.8
Specifies the name of a file containing a list of revoked client certificates.
client_auth_frequency
string
added in 2.8
    Choices:
  • once
  • always
Specifies the frequency of client authentication for an SSL session.
When once, specifies that the system authenticates the client once for an SSL session.
When always, specifies that the system authenticates the client once for an SSL session and also upon reuse of that session.
client_certificate
string
added in 2.8
    Choices:
  • ignore
  • require
  • request
Specifies the way the system handles client certificates.
When ignore, specifies that the system ignores certificates from client systems.
When require, specifies that the system requires a client to present a valid certificate.
When request, specifies that 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
added in 2.7
    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
  • 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 that 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 a '' or none value is provided all options for SSL processing are disabled.
parent
string
Default:
"/Common/clientssl"
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
added in 2.5
Default:
"Common"
Device partition to manage resources on.
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.
renegotiation
boolean
added in 2.8
    Choices:
  • no
  • yes
Enables or disables SSL renegotiation.
When creating a new profile, the setting is provided by the parent profile.
retain_certificate
boolean
added in 2.8
    Choices:
  • no
  • yes
When yes, client certificate is retained in SSL session.
secure_renegotiation
string
added in 2.7
    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_name
-
added in 2.8
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.
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
added in 2.8
    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
added in 2.8
    Choices:
  • no
  • yes
Requires that 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
added in 2.5
    Choices:
  • present ←
  • absent
When present, ensures that the profile exists.
When absent, ensures the profile is removed.
strict_resume
boolean
added in 2.8
    Choices:
  • no
  • yes
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
added in 2.8
Specifies a client CA that the system trusts.
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

  • 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 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 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 Returned Description
allow_non_ssl
boolean
changed
Acceptance of non-SSL connections.

Sample:
True
ciphers
string
changed
The ciphers applied to the profile.

Sample:
!SSLv3:!SSLv2:ECDHE+AES-GCM+SHA256:ECDHE-RSA-AES128-CBC-SHA
options
list
changed
The list of options for SSL processing.

Sample:
['no-sslv2', 'no-sslv3']
renegotiation
boolean
changed
Renegotiation of SSL sessions.

Sample:
True
secure_renegotiation
string
changed
The method of secure SSL renegotiation.

Sample:
request
strict_resume
boolean
changed
Resumption of SSL sessions after an unclean shutdown.

Sample:
True


Status

Authors

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/bigip_profile_client_ssl_module.html