oracle.oci.oci_email_dkim_facts – Fetches details about one or multiple Dkim resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists DKIMs for a email domain.

  • If dkim_id is specified, the details of a single Dkim 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.
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.
dkim_id
string
The OCID of this DKIM.
Required to get a specific dkim.

aliases: id
email_domain_id
string
The OCID of the email domain to which this DKIM belongs.
Required to list multiple dkims.
lifecycle_state
string
    Choices:
  • ACTIVE
  • CREATING
  • DELETING
  • DELETED
  • FAILED
  • INACTIVE
  • NEEDS_ATTENTION
  • UPDATING
Filter returned list by specified lifecycle state. This parameter is case-insensitive.
name
string
A filter to only return resources that match the given name exactly.
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
  • ID
  • NAME
Specifies the attribute with which to sort the DKIMs.
Default: `TIMECREATED`
* **TIMECREATED:** Sorts by timeCreated. * **NAME:** Sorts by name. * **ID:** Sorts by id.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending or descending order.
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 dkim
  oci_email_dkim_facts:
    # required
    dkim_id: "ocid1.dkim.oc1..xxxxxxEXAMPLExxxxxx"

- name: List dkims
  oci_email_dkim_facts:
    # required
    email_domain_id: "ocid1.emaildomain.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    sort_order: ASC
    lifecycle_state: ACTIVE
    sort_by: TIMECREATED

Return Values

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

Key Returned Description
dkims
complex
on success
List of Dkim resources

Sample:
[{'cname_record_value': 'cname_record_value_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'dns_subdomain_name': 'dns_subdomain_name_example', 'email_domain_id': 'ocid1.emaildomain.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'name': 'name_example', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'txt_record_value': 'txt_record_value_example'}]
 
cname_record_value
string
on success
The DNS CNAME record value to provision to the DKIM DNS subdomain, when using the CNAME method for DKIM setup (preferred).
Returned for get operation

Sample:
cname_record_value_example
 
compartment_id
string
on success
The OCID of the compartment that contains this DKIM.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
The description of the DKIM. Avoid entering confidential information.

Sample:
description_example
 
dns_subdomain_name
string
on success
The name of the DNS subdomain that must be provisioned to enable email recipients to verify DKIM signatures. It is usually created with a CNAME record set to the cnameRecordValue
Returned for get operation

Sample:
dns_subdomain_name_example
 
email_domain_id
string
on success
The OCID of the email domain that this DKIM belongs to.

Sample:
ocid1.emaildomain.oc1..xxxxxxEXAMPLExxxxxx
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the DKIM.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource.
Returned for get operation

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the DKIM.

Sample:
ACTIVE
 
name
string
on success
The DKIM selector. If the same domain is managed in more than one region, each region must use different selectors.

Sample:
name_example
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_created
string
on success
The time the DKIM was created. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".
Example: `2021-02-12T22:47:12.613Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time of the last change to the DKIM configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

Sample:
2013-10-20T19:20:30+01:00
 
txt_record_value
string
on success
The DNS TXT record value to provision to the DKIM DNS subdomain in place of using a CNAME record. This is used in cases where a CNAME can not be used, such as when the cnameRecordValue would exceed the maximum length for a DNS entry. This can also be used by customers who have an existing procedure to directly provision TXT records for DKIM. Be aware that many DNS APIs will require you to break this string into segments of less than 255 characters.
Returned for get operation

Sample:
txt_record_value_example


Authors

  • Oracle (@oracle)