oracle.oci.oci_usage_proxy_redemption_facts – Fetches details about one or multiple Redemption 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_usage_proxy_redemption_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns the list of redemption for the subscription ID.

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.
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:
  • TIMEREDEEMED
The field to be used only for list redemptions API. Supports one sort order.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, which can be ascending (ASC) or descending (DESC).
subscription_id
string / required
The subscription ID for which rewards information is requested for.
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
tenancy_id
string / required
The OCID of the tenancy.
time_redeemed_greater_than_or_equal_to
string
The starting redeemed date filter for the redemption history.
time_redeemed_less_than
string
The ending redeemed date filter for the redemption history.

Examples

- name: List redemptions
  oci_usage_proxy_redemption_facts:
    # required
    tenancy_id: "ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx"
    subscription_id: "ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    time_redeemed_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_redeemed_less_than: 2013-10-20T19:20:30+01:00
    sort_order: ASC
    sort_by: TIMEREDEEMED

Return Values

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

Key Returned Description
redemptions
complex
on success
List of Redemption resources

Sample:
[{'base_rewards': 3.4, 'fx_rate': 1.2, 'invoice_currency': 'invoice_currency_example', 'invoice_number': 'invoice_number_example', 'invoice_total_amount': 1.2, 'redeemed_rewards': 3.4, 'redemption_code': 'redemption_code_example', 'redemption_email': 'redemption_email_example', 'time_invoiced': '2013-10-20T19:20:30+01:00', 'time_redeemed': '2013-10-20T19:20:30+01:00'}]
 
base_rewards
float
on success
It provides the redeemed rewards in base/subscription currency.

Sample:
3.4
 
fx_rate
float
on success
It provides the fxRate between invoice currency and subscription currency.

Sample:
1.2
 
invoice_currency
string
on success
The currency associated with invoice.

Sample:
invoice_currency_example
 
invoice_number
string
on success
It provides the invoice number against the redemption.

Sample:
invoice_number_example
 
invoice_total_amount
float
on success
It provides the invoice total amount of given redemption.

Sample:
1.2
 
redeemed_rewards
float
on success
It provides the redeemed rewards in invoice currency.

Sample:
3.4
 
redemption_code
string
on success
The redemption code used in the Billing Center during the reward redemption process.

Sample:
redemption_code_example
 
redemption_email
string
on success
It provides the redemption email id.

Sample:
redemption_email_example
 
time_invoiced
string
on success
It provides the invoice date.

Sample:
2013-10-20T19:20:30+01:00
 
time_redeemed
string
on success
It provides redeem date.

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


Authors

  • Oracle (@oracle)