oracle.oci.oci_golden_gate_certificate – Manage a Certificate resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.0).

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

To use it in a playbook, specify: oracle.oci.oci_golden_gate_certificate.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create and delete a Certificate resource in Oracle Cloud Infrastructure

  • For state=present, creates a new certificate to truststore.

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_ID 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_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
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.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
certificate_content
string
The base64 encoded content of the PEM file containing the SSL certificate.
Required for create using state=present.
certificate_key
string
A unique certificate identifier.
Required for delete using state=absent.
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.
deployment_id
string / required
A unique Deployment identifier.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
is_lock_override
boolean
    Choices:
  • no
  • yes
Whether to override locks (if any exist).
key
string
The identifier key (unique name in the scope of the deployment) of the certificate being referenced. It must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
Required for create using state=present.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
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
string
    Choices:
  • present ←
  • absent
The state of the Certificate.
Use state=present to create a Certificate.
Use state=absent to delete a Certificate.
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
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create certificate
  oci_golden_gate_certificate:
    # required
    key: key_example
    certificate_content: certificate_content_example
    deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    is_lock_override: true

- name: Delete certificate
  oci_golden_gate_certificate:
    # required
    deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"
    certificate_key: certificate_key_example
    state: absent

    # optional
    is_lock_override: true

Return Values

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

Key Returned Description
certificate
complex
on success
Details of the Certificate resource acted upon by the current operation

Sample:
{'authority_key_id': 'ocid1.authoritykey.oc1..xxxxxxEXAMPLExxxxxx', 'certificate_content': 'certificate_content_example', 'deployment_id': 'ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx', 'is_ca': True, 'is_self_signed': True, 'issuer': 'issuer_example', 'key': 'key_example', 'lifecycle_state': 'CREATING', 'md5_hash': 'md5_hash_example', 'public_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...', 'public_key_algorithm': 'public_key_algorithm_example', 'public_key_size': 56, 'serial': 'serial_example', 'sha1_hash': 'sha1_hash_example', 'subject': 'subject_example', 'subject_key_id': 'ocid1.subjectkey.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_valid_from': '2013-10-20T19:20:30+01:00', 'time_valid_to': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}
 
authority_key_id
string
on success
The Certificate authority key id.

Sample:
ocid1.authoritykey.oc1..xxxxxxEXAMPLExxxxxx
 
certificate_content
string
on success
The base64 encoded content of the PEM file containing the SSL certificate.

Sample:
certificate_content_example
 
deployment_id
string
on success
The OCID of the deployment being referenced.

Sample:
ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx
 
is_ca
boolean
on success
Indicates if the certificate is ca.

Sample:
True
 
is_self_signed
boolean
on success
Indicates if the certificate is self signed.

Sample:
True
 
issuer
string
on success
The Certificate issuer.

Sample:
issuer_example
 
key
string
on success
The identifier key (unique name in the scope of the deployment) of the certificate being referenced. It must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.

Sample:
key_example
 
lifecycle_state
string
on success
Possible certificate lifecycle states.

Sample:
CREATING
 
md5_hash
string
on success
The Certificate md5Hash.

Sample:
md5_hash_example
 
public_key
string
on success
The Certificate public key.

Sample:
ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...
 
public_key_algorithm
string
on success
The Certificate public key algorithm.

Sample:
public_key_algorithm_example
 
public_key_size
integer
on success
The Certificate public key size.

Sample:
56
 
serial
string
on success
The Certificate serial.

Sample:
serial_example
 
sha1_hash
string
on success
The Certificate sha1 hash.

Sample:
sha1_hash_example
 
subject
string
on success
The Certificate subject.

Sample:
subject_example
 
subject_key_id
string
on success
The Certificate subject key id.

Sample:
ocid1.subjectkey.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The time the resource was created. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
time_valid_from
string
on success
The time the certificate is valid from. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
time_valid_to
string
on success
The time the certificate is valid to. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.

Sample:
2013-10-20T19:20:30+01:00
 
version
string
on success
The Certificate version.

Sample:
version_example


Authors

  • Oracle (@oracle)