oracle.oci.oci_certificates_certificate_bundle_facts – Fetches details about a CertificateBundle resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.13.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_certificates_certificate_bundle_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about a CertificateBundle resource in Oracle Cloud Infrastructure
Gets a certificate bundle that matches either the specified stage, versionName, or versionNumber parameter. If none of these parameters are provided, the bundle for the certificate version marked as CURRENT will be returned.
By default, the private key is not included in the query result, and a CertificateBundlePublicOnly is returned. If the private key is needed, use the CertificateBundleTypeQueryParam parameter to get a CertificateBundleWithPrivateKey response.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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_bundle_type
string
|
|
The type of certificate bundle. By default, the private key fields are not returned. When querying for certificate bundles, to return results with certificate contents, the private key in PEM format, and the private key passphrase, specify the value of this parameter as `CERTIFICATE_CONTENT_WITH_PRIVATE_KEY`.
|
certificate_id
string
/ required
|
The OCID of the certificate.
aliases: id |
|
certificate_version_name
string
|
The name of the certificate. (This might be referred to as the name of the certificate version, as every certificate consists of at least one version.) Names are unique across versions of a given 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 . |
|
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. |
|
stage
string
|
|
The rotation state of the certificate version.
|
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 |
|
version_number
integer
|
The version number of the certificate. The default value is 0, which means that this query parameter is ignored.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific certificate_bundle
oci_certificates_certificate_bundle_facts:
# required
certificate_id: "ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx"
# optional
version_number: 56
certificate_version_name: certificate_version_name_example
stage: CURRENT
certificate_bundle_type: CERTIFICATE_CONTENT_PUBLIC_ONLY
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
certificate_bundle
complex
|
on success |
CertificateBundle resource
Sample:
{'cert_chain_pem': 'cert_chain_pem_example', 'certificate_bundle_type': 'CERTIFICATE_CONTENT_PUBLIC_ONLY', 'certificate_id': 'ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx', 'certificate_name': 'certificate_name_example', 'certificate_pem': 'certificate_pem_example', 'private_key_pem': 'private_key_pem_example', 'private_key_pem_passphrase': 'private_key_pem_passphrase_example', 'revocation_status': {'revocation_reason': 'UNSPECIFIED', 'time_revoked': '2013-10-20T19:20:30+01:00'}, 'serial_number': 'serial_number_example', 'stages': [], 'time_created': '2013-10-20T19:20:30+01:00', 'validity': {'time_of_validity_not_after': '2013-10-20T19:20:30+01:00', 'time_of_validity_not_before': '2013-10-20T19:20:30+01:00'}, 'version_name': 'version_name_example', 'version_number': 56}
|
||
cert_chain_pem
string
|
on success |
The certificate chain (in PEM format) for the certificate bundle.
Sample:
cert_chain_pem_example
|
||
certificate_bundle_type
string
|
on success |
The type of certificate bundle, which indicates whether the private key fields are included.
Sample:
CERTIFICATE_CONTENT_PUBLIC_ONLY
|
||
certificate_id
string
|
on success |
The OCID of the certificate.
Sample:
ocid1.certificate.oc1..xxxxxxEXAMPLExxxxxx
|
||
certificate_name
string
|
on success |
The name of the certificate.
Sample:
certificate_name_example
|
||
certificate_pem
string
|
on success |
The certificate in PEM format.
Sample:
certificate_pem_example
|
||
private_key_pem
string
|
on success |
The private key (in PEM format) for the certificate.
Sample:
private_key_pem_example
|
||
private_key_pem_passphrase
string
|
on success |
An optional passphrase for the private key.
Sample:
private_key_pem_passphrase_example
|
||
revocation_status
complex
|
on success |
|
||
revocation_reason
string
|
on success |
The reason that the certificate or CA was revoked.
Sample:
UNSPECIFIED
|
||
time_revoked
string
|
on success |
The time when the certificate or CA was revoked.
Sample:
2013-10-20T19:20:30+01:00
|
||
serial_number
string
|
on success |
A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`
Sample:
serial_number_example
|
||
stages
list
/ elements=string
|
on success |
A list of rotation states for the certificate bundle.
|
||
time_created
string
|
on success |
An optional property indicating when the certificate version was created, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
validity
complex
|
on success |
|
||
time_of_validity_not_after
string
|
on success |
The date on which the certificate validity period ends, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
time_of_validity_not_before
string
|
on success |
The date on which the certificate validity period begins, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
version_name
string
|
on success |
The name of the certificate version.
Sample:
version_name_example
|
||
version_number
integer
|
on success |
The version number of the certificate.
Sample:
56
|
Authors¶
Oracle (@oracle)