W3cubDocs

/Ansible

f5networks.f5_modules.bigip_ssl_key_cert module – Import/Delete SSL keys and certs from BIG-IP

Note

This module is part of the f5networks.f5_modules collection (version 1.37.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_ssl_key_cert.

New in f5networks.f5_modules 1.6.0

Synopsis

  • This module imports/deletes SSL keys and certificates on a BIG-IP. Keys can be imported from key files on the local disk, in PEM format. Certificates can be imported from certificate and key files on the local disk, in PEM format.

Parameters

Parameter

Comments

cert_content

string

Sets the contents of a certificate directly to the specified value. This is used with lookup plugins or for anything with formatting or

content must be provided when state is present.

cert_name

string

SSL certificate name. This is the cert name used when importing a certificate into the BIG-IP. It also determines the filenames of the objects on the LTM.

issuer_cert

string

Issuer certificate used for OCSP monitoring.

This parameter is only valid on versions of BIG-IP 13.0.0 or above.

key_content

string

Sets the contents of a key directly to the specified value. This is used with lookup plugins, or for anything with formatting or templating. This must be provided when state is present.

key_name

string

The name of the key.

partition

string

Device partition to manage resources on.

Default: "Common"

passphrase

string

Passphrase on key.

provider

dictionary

added in f5networks.f5_modules 1.0.0

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

Previously used variable F5_TEEM is deprecated as its name was confusing.

Choices:

  • false ← (default)
  • true

password

aliases: pass, pwd

string / required

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

server

string / required

The BIG-IP host or the BIG-IQ host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

integer

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

Default: 443

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.

Choices:

  • "rest" ← (default)

user

string / required

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

Choices:

  • false
  • true ← (default)

state

string

When present, ensures the key and/or cert is uploaded to the device. When absent, ensures the key and/or cert is removed from the device. If the key and/or cert is currently in use, the module will not be able to remove the key.

Choices:

  • "present" ← (default)
  • "absent"

true_names

boolean

added in f5networks.f5_modules 1.24.0

When true, the module does not append .crt and .key extensions to the given certificate and key names.

When false, the module appends .crt and .key extensions to the given certificate and key names.

Choices:

  • false ← (default)
  • true

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: Import both key and cert
  bigip_ssl_key_cert:
    key_content: "{{ lookup('file', 'key.pem') }}"
    key_name: cert1
    cert_content: "{{ lookup('file', 'cert.pem') }}"
    cert_name: cert1
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Authors

  • Nitin Khanna (@nitinthewiz)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_ssl_key_cert_module.html