oci_suppression_facts – Fetches details of OCI Suppression¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Fetches details of all OCI Suppression in a compartment or a specific OCI Suppression

Requirements ¶

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

python >= 2.7
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_type string	Choices: api_key ← instance_principal instance_obo_user	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 Suppressions must be fetched.
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`.
email_address -		A filter to only return Suppression that match the given Email Adress.
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.
suppression_id -		Identifier of the Suppression whose details needs to be fetched. aliases: id
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
time_created_greater_than_or_equal_to -		Search for suppressions that were created within a specific date range, using this parameter to specify the earliest creation date for the returned list (inclusive). Specifying this parameter without the corresponding time_created_less_than parameter will retrieve suppressions created from the given time_created_greater_than_or_equal_to to the current time, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
time_created_less_than -		Search for suppressions that were created within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive). Specifying this parameter without the corresponding time_created_greater_than_or_equal_to parameter will retrieve all suppressions created before the specified end date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

# Fetch Suppression
- name: List all Suppressions in a compartment
  oci_suppression_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'

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

# Fetch Suppression filtered by time_created_greater_than_or_equal_to
- name: List Suppression in a compartment, filetered by time_created_greater_than_or_equal_to
  oci_suppression_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      time_created_greater_than_or_equal_to: '2018-10-31T09:27:14Z'

# Fetch Suppression filtered by time_created_less_than
- name: List Suppression in a compartment, filetered by time_created_less_than
  oci_suppression_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      time_created_less_than: '2018-10-31T09:27:14Z'

# Fetch Suppression filtered by time_created_greater_than_or_equal_to and time_created_less_than
- name: List Suppression in a compartment, filetered by time_created_greater_than_or_equal_to and time_created_less_than
  oci_suppression_facts:
      compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
      time_created_greater_than_or_equal_to: '2018-10-31T09:25:14Z'
      time_created_less_than: '2018-10-31T09:27:14Z'

# Fetch a specific Suppression
- name: List a specific Suppression
  oci_suppression_facts:
      suppression_id: 'ocid1.emailsuppression.oc1..xxxxxEXAMPLExxxxx..qndq'

Return Values ¶

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

Key		Returned	Description
suppressions complex		success	Attributes of the Fetched Suppression. Sample: [{'email_address': 'ansible-test@oracle.com', 'reason': 'MANUAL', 'id': 'ocid1.emailsuppression.oc1.iad.xxxxxEXAMPLExxxxx', 'time_created': '2018-10-31T09:20:52.245000+00:00'}, {'email_address': 'ansible-user@oracle.com', 'reason': 'MANUAL', 'id': 'ocid1.emailsuppression.oc1.iad.xxxxxEXAMPLExxxxx', 'time_created': '2018-10-31T09:25:52.245000+00:00'}]
	email_address string	always	Email Address of the Suppression Sample: ansible-test@oracle.com
	id string	always	The identifier of the Suppression Sample: ocid1.emailsuppression.oc1.xzvf..xxxxxEXAMPLExxxxx
	reason string	always	The reason that the email address was suppressed. Sample: MANUAL
	time_created datetime	always	Date and time when the Suppression was created, in the format defined by RFC3339 Sample: 2016-08-25 21:10:29.600000+00:00

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Debayan Gupta(@debayan_gupta)

Hint

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

oci_suppression_facts – Fetches details of OCI Suppression¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶