bigip_ssl_pkcs12 – Manage BIG-IP PKCS12 certificates/keys

New in version 1.0.0.

Synopsis

  • Installs, updates and removes PKCS12 certificates/keys on/from the BIG-IP.

Parameters

Parameter Choices/Defaults Configuration Comments
cert_pass
string
Passphrase that the PKCS12 file is encrypted with.
force
boolean
    Choices:
  • no ←
  • yes
When set to yes any existing certificate/key with the same name will be overwritten by the new import.
name
string
The name of the PKCS12 certificate and key to create or override.
This parameter is mandatory when state is absent.
When state is present and the parameter is not given, the certificate and key name is derived from the source parameter.
partition
string
Default:
"Common"
Used to check for existence and removal of installed PKCS12 keys and certs.
source
path
Full path to a PKCS12 file to be imported into the BIG-IP.
Parameter is mandatory when state is present
state
string
    Choices:
  • present ←
  • absent
Certificate and key state. This determines if the provided certificate and key is to be made present on the device or absent.

Examples

- hosts: all
  collections:
    - f5networks.f5_bigip
  connection: httpapi

  vars:
    ansible_host: "lb.mydomain.com"
    ansible_user: "admin"
    ansible_httpapi_password: "secret"
    ansible_network_os: f5networks.f5_bigip.bigip
    ansible_httpapi_use_ssl: yes

  tasks:
    - name: Install PKCS12 cert and key
      bigip_ssl_pkcs12:
        source: /root/baz.p12
        state: present

    - name: Install PKCS12 cert and key - force
      bigip_ssl_pkcs12:
        name: foo
        source: /root/baz.p12
        state: present
        force: yes

    - name: Remove PKCS12 cert and key
      bigip_ssl_pkcs12:
        name: foo
        state: absent

Return Values

The following are the fields unique to this module:

Key Returned Description
name
string
changed
Name of the PKCS12 cert and key to be created/overwritten.

Sample:
some_cert
source
string
changed
Local path to PKCS12 file.

Sample:
/root/some_cert.p12


Status

Authors

  • Wojciech Wypior (@wojtek0806)