oracle.oci.oci_osub_subscription_rate_card_facts – Fetches details about one or multiple RateCard 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_osub_subscription_rate_card_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • List API that returns all ratecards for given Subscription Id and Account ID (if provided) and for a particular date range

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.
compartment_id
string / required
The OCID of the compartment.
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.
part_number
string
This param is used to get the rate card(s) filterd by the partNumber
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
  • TIMESTART
The field to sort by. You can provide one sort order (`sortOrder`).
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
subscription_id
string / required
Line level Subscription 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_from
string
This param is used to get the rate card(s) whose effective start date starts on or after a particular date
time_to
string
This param is used to get the rate card(s) whose effective end date ends on or before a particular date
x_one_origin_region
string
The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

Examples

- name: List rate_cards
  oci_osub_subscription_rate_card_facts:
    # required
    subscription_id: "ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    time_from: 2013-10-20T19:20:30+01:00
    time_to: 2013-10-20T19:20:30+01:00
    part_number: part_number_example
    sort_order: ASC
    sort_by: TIMECREATED
    x_one_origin_region: us-phoenix-1

Return Values

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

Key Returned Description
rate_cards
complex
on success
List of RateCard resources

Sample:
[{'currency': {'iso_code': 'iso_code_example', 'name': 'name_example', 'std_precision': 56}, 'discretionary_discount_percentage': 'discretionary_discount_percentage_example', 'is_tier': True, 'net_unit_price': 'net_unit_price_example', 'overage_price': 'overage_price_example', 'product': {'billing_category': 'billing_category_example', 'name': 'name_example', 'part_number': 'part_number_example', 'product_category': 'product_category_example', 'ucm_rate_card_part_type': 'ucm_rate_card_part_type_example', 'unit_of_measure': 'unit_of_measure_example'}, 'rate_card_tiers': [{'net_unit_price': 'net_unit_price_example', 'overage_price': 'overage_price_example', 'up_to_quantity': 'up_to_quantity_example'}], 'time_end': '2013-10-20T19:20:30+01:00', 'time_start': '2013-10-20T19:20:30+01:00'}]
 
currency
complex
on success

   
iso_code
string
on success
Currency Code

Sample:
iso_code_example
   
name
string
on success
Currency name

Sample:
name_example
   
std_precision
integer
on success
Standard Precision of the Currency

Sample:
56
 
discretionary_discount_percentage
string
on success
Rate card discretionary discount percentage

Sample:
discretionary_discount_percentage_example
 
is_tier
boolean
on success
Rate card price tier flag

Sample:
True
 
net_unit_price
string
on success
Rate card net unit price

Sample:
net_unit_price_example
 
overage_price
string
on success
Rate card overage price

Sample:
overage_price_example
 
product
complex
on success

   
billing_category
string
on success
Metered service billing category

Sample:
billing_category_example
   
name
string
on success
Product name

Sample:
name_example
   
part_number
string
on success
Product part numner

Sample:
part_number_example
   
product_category
string
on success
Product category

Sample:
product_category_example
   
ucm_rate_card_part_type
string
on success
Rate card part type of Product

Sample:
ucm_rate_card_part_type_example
   
unit_of_measure
string
on success
Unit of measure

Sample:
unit_of_measure_example
 
rate_card_tiers
complex
on success
List of tiered rate card prices

   
net_unit_price
string
on success
Rate card tier net unit price

Sample:
net_unit_price_example
   
overage_price
string
on success
Rate card tier overage price

Sample:
overage_price_example
   
up_to_quantity
string
on success
Rate card tier quantity range

Sample:
up_to_quantity_example
 
time_end
string
on success
Rate card end date

Sample:
2013-10-20T19:20:30+01:00
 
time_start
string
on success
Rate card start date

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


Authors

  • Oracle (@oracle)