oci_cost_tracking_tag_facts - Retrieve details of all cost-tracking tag key definitions for a specified tenancy in OCI¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

This module retrieves details of all tag key definitions that are enabled for cost-tracking for the specified tenancy

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
api_user		The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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		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		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		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	Choices: api_key ← instance_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.
compartment_id required		The OCID of the parent compartment (remember that the tenancy is simply the root compartment). aliases: id
config_file_location		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		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		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		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

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Get details of all cost-tracking tag key definitions of the specified tenancy
  oci_cost_tracking_tag_facts:
    compartment_id: "ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx...o244pucq"

Return Values ¶

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

Key		Returned	Description
tags complex		on success	Information about one or more cost-tracking tag key definitions Sample: {'tags': [{'is_cost_tracking': True, 'description': 'This tag will show the cost center that will be used for billing of resources.', 'compartment_id': None, 'defined_tags': {}, 'freeform_tags': {}, 'time_created': '2018-01-16T04:55:22.600000+00:00', 'is_retired': False, 'id': 'ocid1.tagdefinition.oc1..xxxxxEXAMPLExxxxx', 'name': 'CostCenter'}]}
	description string	always	The description that was assigned to the tag key definition. Sample: This tag will show the cost center that will be used for billing of resources.
	compartment_id string	always	The OCID of the compartment that contains the tag definition.
	is_retired string	always	Whether the tag key definition is retired. Sample: True
	id string	always	The OCID of the tag key definition. Sample: ocid1.tagdefinition.oc1..xxxxxEXAMPLExxxxx
	time_created string	always	Date and time the Tag key definition object was created, in the format defined by RFC3339. Sample: 2016-08-25 21:10:29.600000
	name string	always	The name of the tag. The name must be unique across all tags in the namespace and can't be changed. Sample: CostCenter

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Sivakumar Thyagarajan (@sivakumart)

Hint

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