oracle.oci.oci_golden_gate_certificate_facts – Fetches details about one or multiple Certificate resources 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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple Certificate resources in Oracle Cloud Infrastructure

  • Returns a list of certificates from truststore.

  • If certificate_key is specified, the details of a single Certificate will be returned.

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_key
string
A unique certificate identifier.
Required to get a specific certificate.
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.
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter to return only connections having the 'lifecycleState' given.
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.
sort_by
string
    Choices:
  • timeCreated
  • displayName
The field to sort by. Only one sort order can be provided. Default order for 'timeCreated' is descending. Default order for 'displayName' is ascending. If no value is specified timeCreated is the default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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

Examples

- name: Get a specific certificate
  oci_golden_gate_certificate_facts:
    # required
    certificate_key: certificate_key_example
    deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"

- name: List certificates
  oci_golden_gate_certificate_facts:
    # required
    deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    lifecycle_state: CREATING
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
certificates
complex
on success
List of Certificate resources

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.
Returned for get operation

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

Sample:
certificate_content_example
 
deployment_id
string
on success
The OCID of the deployment being referenced.
Returned for get operation

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

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

Sample:
True
 
issuer
string
on success
The Certificate issuer.
Returned for get operation

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.
Returned for get operation

Sample:
md5_hash_example
 
public_key
string
on success
The Certificate public key.
Returned for get operation

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

Sample:
public_key_algorithm_example
 
public_key_size
integer
on success
The Certificate public key size.
Returned for get operation

Sample:
56
 
serial
string
on success
The Certificate serial.
Returned for get operation

Sample:
serial_example
 
sha1_hash
string
on success
The Certificate sha1 hash.
Returned for get operation

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.
Returned for get operation

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`.
Returned for get operation

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.
Returned for get operation

Sample:
version_example


Authors

  • Oracle (@oracle)