oci_budget_facts – Fetches details about one or multiple Budget resources in Oracle Cloud Infrastructure

New in version 2.5.

Synopsis

  • Fetches details about one or multiple Budget resources in Oracle Cloud Infrastructure
  • Gets a list of all Budgets in a compartment.
  • If budget_id is specified, the details of a single Budget will be returned.

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_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.
budget_id
-
The unique Budget OCID
Required to get a specific budget.

aliases: id
compartment_id
-
The ID of the compartment in which to list resources.
Required to list multiple budgets.
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.
display_name
-
A user-friendly name. Does not have to be unique, and it's changeable.
Example: `My new resource`

aliases: name
lifecycle_state
-
The current state of the resource to filter by.
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
-
The field to sort by. If not specified, the default is timeCreated. The default sort order for timeCreated is DESC. The default sort order for displayName is ASC in alphanumeric order.
sort_order
-
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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

Examples

- name: List budgets
  oci_budget_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx

- name: Get a specific budget
  oci_budget_facts:
    budget_id: ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx

Return Values

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

Key Returned Description
budgets
complex
 on success
List of Budget resources

Sample:
[{'freeform_tags': {'Department': 'Finance'}, 'description': 'description_example', 'alert_rule_count': 56, 'target_compartment_id': 'ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'time_updated': '2013-10-20T19:20:30+01:00', 'time_spend_computed': '2013-10-20T19:20:30+01:00', 'lifecycle_state': 'ACTIVE', 'display_name': 'display_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'amount': 10, 'reset_period': 'MONTHLY', 'version': 56, 'actual_spend': 10, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'forecasted_spend': 10}]
  actual_spend
float
 on success
The actual spend in currency for the current budget cycle

Sample:
10
  alert_rule_count
integer
 on success
Total number of alert rules in the budget

Sample:
56
  amount
float
 on success
The amount of the budget expressed in the currency of the customer's rate card.

Sample:
10
  compartment_id
string
 on success
The OCID of the compartment

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
  defined_tags
dictionary
 on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
  description
string
 on success
The description of the budget.

Sample:
description_example
  display_name
string
 on success
The display name of the budget.

Sample:
display_name_example
  forecasted_spend
float
 on success
The forecasted spend in currency by the end of the current budget cycle

Sample:
10
  freeform_tags
dictionary
 on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
  id
string
 on success
The OCID of the budget

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
  lifecycle_state
string
 on success
The current state of the budget.

Sample:
ACTIVE
  reset_period
string
 on success
The reset period for the budget.

Sample:
MONTHLY
  target_compartment_id
string
 on success
The OCID of the compartment on which budget is applied

Sample:
ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx
  time_created
string
 on success
Time that budget was created

Sample:
2013-10-20 19:20:30+01:00
  time_spend_computed
string
 on success
The time that the budget spend was last computed

Sample:
2013-10-20 19:20:30+01:00
  time_updated
string
 on success
Time that budget was updated

Sample:
2013-10-20 19:20:30+01:00
  version
integer
 on success
Version of the budget. Starts from 1 and increments by 1.

Sample:
56


Status

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

Authors

  • Manoj Meda (@manojmeda)
  • Mike Ross (@mross22)
  • Nabeel Al-Saber (@nalsaber)

Hint

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