oracle.oci.oci_optimizer_category_facts – Fetches details about one or multiple Category resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.13.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_optimizer_category_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists the supported Cloud Advisor categories.

  • If category_id is specified, the details of a single Category 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_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.
category_id
string
The unique OCID associated with the category.
Required to get a specific category.

aliases: id
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.
child_tenancy_ids
list / elements=string
A list of child tenancies for which the respective data will be returned. Please note that the parent tenancy id can also be included in this list. For example, if there is a parent P with two children A and B, to return results of only parent P and child A, this list should be populated with tenancy id of parent P and child A.
If this list contains a tenancy id that isn't part of the organization of parent P, the request will fail. That is, let's say there is an organization with parent P with children A and B, and also one other tenant T that isn't part of the organization. If T is included in the list of childTenancyIds, the request will fail.
It is important to note that if you are setting the includeOrganization parameter value as true and also populating the childTenancyIds parameter with a list of child tenancies, the request will fail. The childTenancyIds and includeOrganization should be used exclusively.
When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
compartment_id
string
The OCID of the compartment.
Required to list multiple categories.
compartment_id_in_subtree
boolean
    Choices:
  • no
  • yes
When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned depending on the the setting of `accessLevel`.
Can only be set to true when performing ListCompartments on the tenancy (root compartment).
Required to list multiple categories.
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.
include_organization
boolean
    Choices:
  • no
  • yes
When set to true, the data for all child tenancies including the parent is returned. That is, if there is an organization with parent P and children A and B, to return the data for the parent P, child A and child B, this parameter value should be set to true.
Please note that this parameter shouldn't be used along with childTenancyIds parameter. If you would like to get results specifically for parent P and only child A, use the childTenancyIds parameter and populate the list with tenancy id of P and A.
When using this parameter, please make sure to set the compartmentId with the parent tenancy ID.
lifecycle_state
string
    Choices:
  • ACTIVE
  • FAILED
  • INACTIVE
  • ATTACHING
  • DETACHING
  • DELETING
  • DELETED
  • UPDATING
  • CREATING
A filter that returns results that match the lifecycle state specified.
name
string
Optional. A filter that returns results that match the name specified.
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:
  • NAME
  • TIMECREATED
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`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: Get a specific category
  oci_optimizer_category_facts:
    # required
    category_id: "ocid1.category.oc1..xxxxxxEXAMPLExxxxxx"

- name: List categories
  oci_optimizer_category_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id_in_subtree: true

    # optional
    child_tenancy_ids: [ "child_tenancy_ids_example" ]
    include_organization: true
    name: name_example
    sort_order: ASC
    sort_by: NAME
    lifecycle_state: ACTIVE

Return Values

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

Key Returned Description
categories
complex
on success
List of Category resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_name': 'compartment_name_example', 'description': 'description_example', 'estimated_cost_saving': 1.2, 'extended_metadata': {}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'name': 'name_example', 'recommendation_counts': [{'count': 56, 'importance': 'CRITICAL'}], 'resource_counts': [{'count': 56, 'status': 'PENDING'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
The OCID of the tenancy. The tenancy is the root compartment.

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

Sample:
compartment_name_example
 
description
string
on success
Text describing the category.

Sample:
description_example
 
estimated_cost_saving
float
on success
The estimated cost savings, in dollars, for the category.

Sample:
1.2
 
extended_metadata
dictionary
on success
Additional metadata key/value pairs for the category.
For example:
`{"EstimatedSaving": "200"}`
 
id
string
on success
The unique OCID of the category.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The category's current state.

Sample:
ACTIVE
 
name
string
on success
The name assigned to the category.

Sample:
name_example
 
recommendation_counts
complex
on success
An array of `RecommendationCount` objects grouped by the level of importance assigned to the recommendation.
   
count
integer
on success
The count of recommendations.

Sample:
56
   
importance
string
on success
The level of importance assigned to the recommendation.

Sample:
CRITICAL
 
resource_counts
complex
on success
An array of `ResourceCount` objects grouped by the status of the recommendation.
   
count
integer
on success
The count of resources.

Sample:
56
   
status
string
on success
The recommendation status of the resource.

Sample:
PENDING
 
time_created
string
on success
The date and time the category details were created, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the category details were last updated, in the format defined by RFC3339.

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


Authors

  • Oracle (@oracle)