oracle.oci.oci_usage_facts – Fetches details about one or multiple Usage 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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Returns usage for the given account.

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_depth
float
The compartment depth level.
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.
filter
dictionary
dimensions
list / elements=dictionary
The dimensions to filter on.
key
string / required
The dimension key.
value
string / required
The dimension value.
filters
list / elements=dictionary
The nested filter object.
dimensions
list / elements=dictionary
The dimensions to filter on.
filters
list / elements=dictionary
The nested filter object.
operator
string
    Choices:
  • AND
  • NOT
  • OR
The filter operator. Example: 'AND', 'OR', 'NOT'.
tags
list / elements=dictionary
The tags to filter on.
operator
string
    Choices:
  • AND
  • NOT
  • OR
The filter operator. Example: 'AND', 'OR', 'NOT'.
tags
list / elements=dictionary
The tags to filter on.
key
string
The tag key.
namespace
string
The tag namespace.
value
string
The tag value.
forecast
dictionary
forecast_type
string
    Choices:
  • BASIC
BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made.
time_forecast_ended
string / required
The forecast end time.
time_forecast_started
string
The forecast start time. Defaults to UTC-1 if not specified.
granularity
string / required
    Choices:
  • HOURLY
  • DAILY
  • MONTHLY
  • TOTAL
The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.
group_by
list / elements=string
Aggregate the result by. example: `["tagNamespace", "tagKey", "tagValue", "service", "skuName", "skuPartNumber", "unit", "compartmentName", "compartmentPath", "compartmentId", "platform", "region", "logicalAd", "resourceId", "tenantId", "tenantName"]`
group_by_tag
list / elements=dictionary
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: `[{"namespace":"oracle", "key":"createdBy"]`
key
string
The tag key.
namespace
string
The tag namespace.
value
string
The tag value.
is_aggregate_by_time
boolean
    Choices:
  • no
  • yes
Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up.
query_type
string
    Choices:
  • USAGE
  • COST
  • CREDIT
  • EXPIREDCREDIT
  • ALLCREDIT
The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. Credit - Query the credit adjustments data. ExpiredCredit - Query the expired credits data. AllCredit - Query the credit adjustments and expired credit.
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.
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
tenant_id
string / required
Tenant ID.
time_usage_ended
string / required
The usage end time.
time_usage_started
string / required
The usage start time.

Examples

- name: List usages
  oci_usage_facts:
    # required
    tenant_id: "ocid1.tenant.oc1..xxxxxxEXAMPLExxxxxx"
    time_usage_started: time_usage_started_example
    time_usage_ended: time_usage_ended_example
    granularity: HOURLY

    # optional
    is_aggregate_by_time: true
    forecast:
      # required
      time_forecast_ended: time_forecast_ended_example

      # optional
      forecast_type: BASIC
      time_forecast_started: time_forecast_started_example
    query_type: USAGE
    group_by: [ "group_by_example" ]
    group_by_tag:
    - # optional
      namespace: namespace_example
      key: key_example
      value: value_example
    compartment_depth: 3.4
    filter:
      # optional
      operator: AND
      dimensions:
      - # required
        key: key_example
        value: value_example
      tags:
      - # optional
        namespace: namespace_example
        key: key_example
        value: value_example
      filters:
      - # optional
        operator: AND
        dimensions: [ "dimensions_example" ]
        tags: [ "tags_example" ]
        filters: [ "filters_example" ]

Return Values

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

Key Returned Description
usages
complex
on success
List of Usage resources

Sample:
[{'ad': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_name': 'compartment_name_example', 'compartment_path': 'compartment_path_example', 'computed_amount': 10, 'computed_quantity': 10, 'currency': 'currency_example', 'discount': 10, 'is_forecast': True, 'list_rate': 10, 'overage': 'overage_example', 'overages_flag': 'overages_flag_example', 'platform': 'platform_example', 'region': 'us-phoenix-1', 'resource_id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'resource_name': 'resource_name_example', 'service': 'service_example', 'shape': 'shape_example', 'sku_name': 'sku_name_example', 'sku_part_number': 'sku_part_number_example', 'subscription_id': 'ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx', 'tags': [{'key': 'key_example', 'namespace': 'namespace_example', 'value': 'value_example'}], 'tenant_id': 'ocid1.tenant.oc1..xxxxxxEXAMPLExxxxxx', 'tenant_name': 'tenant_name_example', 'time_usage_ended': '2013-10-20T19:20:30+01:00', 'time_usage_started': '2013-10-20T19:20:30+01:00', 'unit': 'unit_example', 'unit_price': 10, 'weight': 10}]
 
ad
string
on success
The availability domain of the usage.

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
The compartment OCID.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_name
string
on success
The compartment name.

Sample:
compartment_name_example
 
compartment_path
string
on success
The compartment path, starting from root.

Sample:
compartment_path_example
 
computed_amount
float
on success
The computed cost.

Sample:
10
 
computed_quantity
float
on success
The usage number.

Sample:
10
 
currency
string
on success
The price currency.

Sample:
currency_example
 
discount
float
on success
The discretionary discount applied to the SKU.

Sample:
10
 
is_forecast
boolean
on success
The forecasted data.

Sample:
True
 
list_rate
float
on success
The SKU list rate (not discount).

Sample:
10
 
overage
string
on success
The overage usage.

Sample:
overage_example
 
overages_flag
string
on success
The SPM OverageFlag.

Sample:
overages_flag_example
 
platform
string
on success
Platform for the cost.

Sample:
platform_example
 
region
string
on success
The region of the usage.

Sample:
us-phoenix-1
 
resource_id
string
on success
The resource OCID that is incurring the cost.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
resource_name
string
on success
The resource name that is incurring the cost.

Sample:
resource_name_example
 
service
string
on success
The service name that is incurring the cost.

Sample:
service_example
 
shape
string
on success
The resource shape.

Sample:
shape_example
 
sku_name
string
on success
The SKU friendly name.

Sample:
sku_name_example
 
sku_part_number
string
on success
The SKU part number.

Sample:
sku_part_number_example
 
subscription_id
string
on success
The subscription ID.

Sample:
ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx
 
tags
complex
on success
For grouping, a tag definition. For filtering, a definition and key.

   
key
string
on success
The tag key.

Sample:
key_example
   
namespace
string
on success
The tag namespace.

Sample:
namespace_example
   
value
string
on success
The tag value.

Sample:
value_example
 
tenant_id
string
on success
The tenancy OCID.

Sample:
ocid1.tenant.oc1..xxxxxxEXAMPLExxxxxx
 
tenant_name
string
on success
The tenancy name.

Sample:
tenant_name_example
 
time_usage_ended
string
on success
The usage end time.

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

Sample:
2013-10-20T19:20:30+01:00
 
unit
string
on success
The usage unit.

Sample:
unit_example
 
unit_price
float
on success
The price per unit.

Sample:
10
 
weight
float
on success
The resource size being metered.

Sample:
10


Authors

  • Oracle (@oracle)