oracle.oci.oci_usage_proxy_monthly_reward_facts – Fetches details about one or multiple MonthlyReward 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_usage_proxy_monthly_reward_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns the list of rewards for a 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.
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.

Examples

- name: List monthly_rewards
  oci_usage_proxy_monthly_reward_facts:
    # required
    tenancy_id: "ocid1.tenancy.oc1..xxxxxxEXAMPLExxxxxx"
    subscription_id: "ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
monthly_rewards
complex
on success
List of MonthlyReward resources

Sample:
[{'available_rewards': 3.4, 'earned_rewards': 3.4, 'eligible_usage_amount': 1.2, 'ineligible_usage_amount': 1.2, 'is_manual': True, 'redeemed_rewards': 3.4, 'time_rewards_earned': '2013-10-20T19:20:30+01:00', 'time_rewards_expired': '2013-10-20T19:20:30+01:00', 'time_usage_ended': '2013-10-20T19:20:30+01:00', 'time_usage_started': '2013-10-20T19:20:30+01:00', 'usage_amount': 1.2, 'usage_period_key': 'usage_period_key_example'}]
 
available_rewards
float
on success
The number of rewards available for a specific usage period.

Sample:
3.4
 
earned_rewards
float
on success
The number of rewards earned for the specific usage period.

Sample:
3.4
 
eligible_usage_amount
float
on success
The eligible usage amount for the usage period.

Sample:
1.2
 
ineligible_usage_amount
float
on success
The ineligible usage amount for the usage period.

Sample:
1.2
 
is_manual
boolean
on success
The boolean parameter to indicate whether or not the available rewards are manually posted.

Sample:
True
 
redeemed_rewards
float
on success
The number of rewards redeemed for a specific month.

Sample:
3.4
 
time_rewards_earned
string
on success
The date and time when rewards accrue.

Sample:
2013-10-20T19:20:30+01:00
 
time_rewards_expired
string
on success
The date and time when rewards expire.

Sample:
2013-10-20T19:20:30+01:00
 
time_usage_ended
string
on success
The end date and time for the usage period.

Sample:
2013-10-20T19:20:30+01:00
 
time_usage_started
string
on success
The start date and time for the usage period.

Sample:
2013-10-20T19:20:30+01:00
 
usage_amount
float
on success
The usage amount for the usage period.

Sample:
1.2
 
usage_period_key
string
on success
The usage period ID.

Sample:
usage_period_key_example


Authors

  • Oracle (@oracle)