oracle.oci.oci_optimizer_profile_level_facts – Fetches details about one or multiple ProfileLevel resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists the existing profile levels.

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.
compartment_id_in_subtree
boolean / required
    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).
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.
name
string
Optional. A filter that returns results that match the name specified.
recommendation_name
string
Optional. A filter that returns results that match the recommendation 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: List profile_levels
  oci_optimizer_profile_level_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id_in_subtree: true

    # optional
    name: name_example
    recommendation_name: recommendation_name_example
    sort_order: ASC
    sort_by: NAME

Return Values

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

Key Returned Description
profile_levels
complex
on success
List of ProfileLevel resources

Sample:
[{'default_interval': 56, 'metrics': [{'name': 'name_example', 'statistic': 'statistic_example', 'target': 1.2, 'threshold': 1.2}], 'name': 'name_example', 'recommendation_name': 'recommendation_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'valid_intervals': []}]
 
default_interval
integer
on success
The default aggregation interval (in days) for profiles using this profile level.

Sample:
56
 
metrics
complex
on success
The metrics that will be evaluated by profiles using this profile level.

   
name
string
on success
The name of the metric (e.g., `CpuUtilization`).

Sample:
name_example
   
statistic
string
on success
The name of the statistic (e.g., `p95`).

Sample:
statistic_example
   
target
float
on success
Optional. The metric value that the recommendation will target.

Sample:
1.2
   
threshold
float
on success
The threshold that must be crossed for the recommendation to appear.

Sample:
1.2
 
name
string
on success
A unique name for the profile level.

Sample:
name_example
 
recommendation_name
string
on success
The name of the recommendation this profile level applies to.

Sample:
recommendation_name_example
 
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
 
valid_intervals
list / elements=string
on success
An array of aggregation intervals (in days) allowed for profiles using this profile level.



Authors

  • Oracle (@oracle)