f5networks.f5_modules.bigip_ssl_key_cert (1.28.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - When C(present), ensures the key and/or cert is uploaded to the device. When C(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.
    type: str

key_name:
    description:
    - The name of the key.
    type: str

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - 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 C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - 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.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - 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 C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(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 C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules

cert_name:
    description:
    - 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.
    type: str

partition:
    default: Common
    description:
    - Device partition to manage resources on.
    type: str

passphrase:
    description:
    - Passphrase on key.
    type: str

true_names:
    default: false
    description:
    - When C(true), the module does not append C(.crt) and C(.key) extensions to the given
      certificate and key names.
    - When C(false), the module appends C(.crt) and C(.key) extensions to the given certificate
      and key names.
    type: bool
    version_added: 1.24.0
    version_added_collection: f5networks.f5_modules

issuer_cert:
    description:
    - Issuer certificate used for OCSP monitoring.
    - This parameter is only valid on versions of BIG-IP 13.0.0 or above.
    type: str

key_content:
    description:
    - 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
      C(state) is C(present).
    type: str

cert_content:
    description:
    - Sets the contents of a certificate directly to the specified value. This is used
      with lookup plugins or for anything with formatting or
    - C(content) must be provided when C(state) is C(present).
    type: str