oracle.oci.oci_certificates_management_certificate_authority_version_facts – Fetches details about one or multiple CertificateAuthorityVersion resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_management_certificate_authority_version_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists all versions for the specified certificate authority (CA). Optionally, you can use the parameter FilterByVersionNumberQueryParam to limit the results to a single item that matches the specified version number.

  • If certificate_authority_version_number is specified, the details of a single CertificateAuthorityVersion 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
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_authority_id
string / required
The OCID of the certificate authority (CA).
certificate_authority_version_number
integer
The version number of the certificate authority (CA).
Required to get a specific certificate_authority_version.
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.
sort_by
string
    Choices:
  • VERSION_NUMBER
The field to sort by. You can specify only one sort order. The default order for 'VERSION_NUMBER' is ascending.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`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
version_number
integer
A filter that returns only resources that match the specified version number. The default value is 0, which means that this filter is not applied.

Examples

- name: Get a specific certificate_authority_version
  oci_certificates_management_certificate_authority_version_facts:
    # required
    certificate_authority_version_number: 56
    certificate_authority_id: "ocid1.certificateauthority.oc1..xxxxxxEXAMPLExxxxxx"

- name: List certificate_authority_versions
  oci_certificates_management_certificate_authority_version_facts:
    # required
    certificate_authority_id: "ocid1.certificateauthority.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    version_number: 56
    sort_by: VERSION_NUMBER
    sort_order: ASC

Return Values

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

Key Returned Description
certificate_authority_versions
complex
on success
List of CertificateAuthorityVersion resources

Sample:
[{'certificate_authority_id': 'ocid1.certificateauthority.oc1..xxxxxxEXAMPLExxxxxx', 'issuer_ca_version_number': 56, 'revocation_status': {'revocation_reason': 'UNSPECIFIED', 'time_of_revocation': '2013-10-20T19:20:30+01:00'}, 'serial_number': 'serial_number_example', 'stages': [], 'subject_alternative_names': [{'type': 'DNS', 'value': 'value_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_of_deletion': '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}]
 
certificate_authority_id
string
on success
The OCID of the CA.

Sample:
ocid1.certificateauthority.oc1..xxxxxxEXAMPLExxxxxx
 
issuer_ca_version_number
integer
on success
The version number of the issuing CA.

Sample:
56
 
revocation_status
complex
on success

   
revocation_reason
string
on success
The reason the certificate or certificate authority (CA) was revoked.

Sample:
UNSPECIFIED
   
time_of_revocation
string
on success
The time when the entity was revoked, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`

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 this CA version.

 
subject_alternative_names
complex
on success
A list of subject alternative names. A subject alternative name specifies the domain names, including subdomains, and IP addresses covered by the certificates issued by this CA.
Returned for get operation

   
type
string
on success
The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported.

Sample:
DNS
   
value
string
on success
The subject alternative name.

Sample:
value_example
 
time_created
string
on success
A optional property indicating when the CA version was created, expressed in RFC 3339 timestamp format. Example: `2019-04-03T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_of_deletion
string
on success
An optional property indicating when to delete the CA version, 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 CA version. When the value is not null, a name is unique across versions for a given CA.

Sample:
version_name_example
 
version_number
integer
on success
The version number of this CA.

Sample:
56


Authors

  • Oracle (@oracle)