oci_load_balancer_certificate – Add or remove a SSL certificate from a load balancer in OCI Load Balancing Service

New in version 2.5.

Synopsis

  • Add a SSL certificate to OCI Load Balancer
  • Delete a SSL certificate, if present.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
ca_certificate
-
The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider. The absolute path of the certificate file should be provided.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
load_balancer_id
- / required
Identifier of the Load Balancer in which the certificate belongs

aliases: id
name
- / required
The name of the certificate to add to the load balancer.
passphrase
-
A passphrase for encrypted private keys. This is needed only if you created your certificate with a passphrase.
private_key
-
The SSL private key for your certificate, in PEM format.The absolute path of the private key file should be provided.
public_certificate
-
The public certificate, in PEM format, that you received from your SSL certificate provider. The absolute path of the public certificate file should be provided.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
-
    Choices:
  • present ←
  • absent
Create or delete certificate. For state=present, if it does not exists, it gets added.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
string
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

# Note: These examples do not set authentication details.
# Add a certificate bundle (without passphrase) to a loadbalancer
- name: Add a certificate bundle (without passphrase) to a loadbalancer
  oci_load_balancer_certificate:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    name: "ansible_certtificate"
    ca_certificate: "certificate_src/ca_cert.pem"
    private_key: "certificate_src/private_key.pem"
    public_certificate: "certificate_src/cert.pem"
    state: 'present'
# Add a certificate bundle (with a passphrase for encrypted private keys) to a load balancer
- name: Create certificate with Passphrase
  oci_load_balancer_certificate:
    name: "ansible_cert_with_passphrase"
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    ca_certificate: "certificate_src/ca_cert.pem"
    passphrase: "ansible"
    private_key: "certificate_src/private_key_with_passphrase.pem"
    public_certificate: "certificate_src/cert_with_passphrase.pem"
    state: 'present'
# Delete a SSL Certificate from a load balancer
- name: Delete a SSL certificate
  oci_load_balancer_certificate:
    load_balancer_id: "ocid1.loadbalancer.oc1.iad.xxxxxEXAMPLExxxxx"
    name: "ansible_certtificate"
    state: 'absent'

Return Values

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

Key Returned Description
certificate
complex
success
Attributes of the created certificate. For delete, deleted certificate description will be returned.

Sample:
{'certificate_name': 'ansible_cert', 'public_certificate': '-----BEGIN CERTIFICATE-----\nMIIDPjCCAiYCCQC5OEUUNtrC\n-----END CERTIFICATE-----', 'ca_certificate': '-----BEGIN CERTIFICATE-----\nMIIDlTCCAn2gAw\n-----END CERTIFICATE-----'}
  ca_certificate
string
always
The Certificate Authority certificate, or any interim certificate, that you received from your SSL certificate provider.

Sample:
-----BEGIN CERTIFICATE----- MIIDlTCCA -----END CERTIFICATE-----
  certificate_name
string
always
Name of the certificate

Sample:
ansible_certificate
  public_certificate
string
always
The public certificate, in PEM format, that you received from your SSL certificate provider.

Sample:
-----BEGIN CERTIFICATE----- MIIDlTCCAn -----END CERTIFICATE-----


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Debayan Gupta(@debayan_gupta)

Hint

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