oracle.oci.oci_certificates_management_association_facts – Fetches details about one or multiple Association 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_association_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists all associations that match the query parameters. Optionally, you can use the parameter FilterByAssociationIdQueryParam to limit the result set to a single item that matches the specified association.

  • If association_id is specified, the details of a single Association 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).
associated_resource_id
string
A filter that returns only resources that match the given OCID of an associated Oracle Cloud Infrastructure resource.
association_id
string
The OCID of an association between a certificate-related resource and another Oracle Cloud Infrastructure resource.
Required to get a specific association.

aliases: id
association_type
string
    Choices:
  • CERTIFICATE
  • CERTIFICATE_AUTHORITY
  • CA_BUNDLE
Type of associations to list. If the parameter is set to null, the service lists all types of associations.
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.
certificates_resource_id
string
A filter that returns only resources that match the given OCID of a certificate-related resource.
compartment_id
string
A filter that returns only resources that match the given compartment OCID.
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.
name
string
A filter that returns only resources that match the specified name.
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:
  • NAME
  • TIMECREATED
The field to sort by. You can specify only one sort order. The default order for `TIMECREATED` is descending. The default order for `NAME` 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

Examples

- name: Get a specific association
  oci_certificates_management_association_facts:
    # required
    association_id: "ocid1.association.oc1..xxxxxxEXAMPLExxxxxx"

- name: List associations
  oci_certificates_management_association_facts:

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    certificates_resource_id: "ocid1.certificatesresource.oc1..xxxxxxEXAMPLExxxxxx"
    associated_resource_id: "ocid1.associatedresource.oc1..xxxxxxEXAMPLExxxxxx"
    association_id: "ocid1.association.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    sort_by: NAME
    sort_order: ASC
    association_type: CERTIFICATE

Return Values

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

Key Returned Description
associations
complex
on success
List of Association resources

Sample:
[{'associated_resource_id': 'ocid1.associatedresource.oc1..xxxxxxEXAMPLExxxxxx', 'association_type': 'CERTIFICATE', 'certificates_resource_id': 'ocid1.certificatesresource.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'name': 'name_example', 'time_created': '2013-10-20T19:20:30+01:00'}]
 
associated_resource_id
string
on success
The OCID of the associated resource.

Sample:
ocid1.associatedresource.oc1..xxxxxxEXAMPLExxxxxx
 
association_type
string
on success
Type of the association.

Sample:
CERTIFICATE
 
certificates_resource_id
string
on success
The OCID of the certificate-related resource associated with another Oracle Cloud Infrastructure resource.

Sample:
ocid1.certificatesresource.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The compartment OCID of the association, which is strongly tied to the compartment OCID of the certificate-related resource.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
id
string
on success
The OCID of the association.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current lifecycle state of the association.

Sample:
CREATING
 
name
string
on success
A user-friendly name generated by the service for the association, expressed in a format that follows the pattern: [certificatesResourceEntityType]-[associatedResourceEntityType]-UUID.

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

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)