oci_sender_facts - Fetches details of OCI Sender.

New in version 2.5.

Synopsis

  • Fetches details of all OCI Sender in a compartment or a specific OCI Sender

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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
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
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
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_type
    Choices:
  • api_key ←
  • instance_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.
compartment_id
Identifier of the compartment from which details of all Senders must be fetched.
config_file_location
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
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.
email_address
A filter to only return Sender that match the given Email Adress.
lifecycle_state
    Choices:
  • CREATING
  • ACTIVE
  • DELETING
  • DELETED
A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
region
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.
sender_id
Identifier of the Sender whose details needs to be fetched.

aliases: id
tenancy
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

# Fetch Sender
- name: List all Senders in a compartment
  oci_sender_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'

# Fetch Sender with specific Email Address
- name: List Sender in a compartment, filetered by Email Address
  oci_sender_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      email_address: 'ansible-test@oracle.com'

# Fetch Sender filtered by Lifecycle State
- name: List Sender in a compartment, filetered by Lifecycle State
  oci_sender_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      lifecycle_state: 'ACTIVE'

# Fetch a specific Sender
- name: List a specific Sender
  oci_sender_facts:
      sender_id: 'ocid1.emailsender.oc1..xxxxxEXAMPLExxxxx..qndq'

Return Values

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

Key Returned Description
senders
complex
success
Attributes of the Fetched Sender.

Sample:
[{'lifecycle_state': 'ACTIVE', 'email_address': 'ansible-test@oracle.com', 'id': 'ocid1.emailsender.oc1.iad.xxxxxEXAMPLExxxxx', 'is_spf': False, 'time_created': '2018-10-31T09:20:52.245000+00:00'}, {'lifecycle_state': 'ACTIVE', 'email_address': 'ansible-user@oracle.com', 'id': 'ocid1.emailsender.oc1.iad.xxxxxEXAMPLExxxxx', 'is_spf': False, 'time_created': '2018-10-31T09:25:52.245000+00:00'}]
  lifecycle_state
string
always
The current state of the Sender.

Sample:
ACTIVE
  is_spf
boolean
always
Value of the SPF field.

  compartment_id
string
always
The identifier of the compartment containing the Sender

Sample:
ocid1.compartment.oc1.xzvf..xxxxxEXAMPLExxxxx
  email_address
string
always
Email Address of the Sender

Sample:
ansible-test@oracle.com
  id
string
always
The identifier of the Sender

Sample:
ocid1.emailsender.oc1.xzvf..xxxxxEXAMPLExxxxx
  time_created
datetime
always
Date and time when the Sender was created, in the format defined by RFC3339

Sample:
2016-08-25 21:10:29.600000


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.