oracle.oci.oci_opsi_resource_capacity_trend_facts – Fetches details about a ResourceCapacityTrend resource 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_opsi_resource_capacity_trend_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a ResourceCapacityTrend resource in Oracle Cloud Infrastructure

  • Returns response with time series data (endTimestamp, capacity, baseCapacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
analysis_time_interval
string
Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).
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.
cdb_name
list / elements=string
Filter by one or more cdb name.
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
    Choices:
  • no
  • yes
A flag to search all resources within a given compartment and all sub-compartments.
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.
database_id
list / elements=string
Optional list of database OCIDs of the associated DBaaS entity.
database_type
list / elements=string
    Choices:
  • ADW-S
  • ATP-S
  • ADW-D
  • ATP-D
  • EXTERNAL-PDB
  • EXTERNAL-NONCDB
  • COMANAGED-VM-CDB
  • COMANAGED-VM-PDB
  • COMANAGED-VM-NONCDB
  • COMANAGED-BM-CDB
  • COMANAGED-BM-PDB
  • COMANAGED-BM-NONCDB
  • COMANAGED-EXACS-CDB
  • COMANAGED-EXACS-PDB
  • COMANAGED-EXACS-NONCDB
Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB.
defined_tag_equals
list / elements=string
A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
defined_tag_exists
list / elements=string
A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
exadata_insight_id
list / elements=string
Optional list of exadata insight resource OCIDs.
freeform_tag_equals
list / elements=string
A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
freeform_tag_exists
list / elements=string
A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
host_name
list / elements=string
Filter by one or more hostname.
id
list / elements=string
Optional list of database insight resource OCIDs.
is_database_instance_level_metrics
boolean
    Choices:
  • no
  • yes
Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host.
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.
resource_metric
string / required
Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO.
sort_by
string
    Choices:
  • endTimestamp
  • capacity
  • baseCapacity
Sorts using end timestamp , capacity or baseCapacity
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
tablespace_name
string
Tablespace name for a database
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
time_interval_end
string
Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
time_interval_start
string
Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
utilization_level
string
    Choices:
  • HIGH_UTILIZATION
  • LOW_UTILIZATION
  • MEDIUM_HIGH_UTILIZATION
  • MEDIUM_LOW_UTILIZATION
Filter by utilization level by the following buckets: - HIGH_UTILIZATION: DBs with utilization greater or equal than 75. - LOW_UTILIZATION: DBs with utilization lower than 25. - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75. - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.

Examples

- name: Get a specific resource_capacity_trend
  oci_opsi_resource_capacity_trend_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    resource_metric: resource_metric_example

    # optional
    analysis_time_interval: analysis_time_interval_example
    time_interval_start: 2013-10-20T19:20:30+01:00
    time_interval_end: 2013-10-20T19:20:30+01:00
    database_type: [ "ADW-S" ]
    database_id: [ "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx" ]
    id: [ "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx" ]
    exadata_insight_id: [ "ocid1.exadatainsight.oc1..xxxxxxEXAMPLExxxxxx" ]
    cdb_name: [ "cdb_name_example" ]
    utilization_level: HIGH_UTILIZATION
    sort_order: ASC
    sort_by: endTimestamp
    tablespace_name: tablespace_name_example
    host_name: [ "host_name_example" ]
    is_database_instance_level_metrics: true
    defined_tag_equals: [ "defined_tag_equals_example" ]
    freeform_tag_equals: [ "freeform_tag_equals_example" ]
    defined_tag_exists: [ "defined_tag_exists_example" ]
    freeform_tag_exists: [ "freeform_tag_exists_example" ]
    compartment_id_in_subtree: true

Return Values

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

Key Returned Description
resource_capacity_trend
complex
on success
ResourceCapacityTrend resource

Sample:
{'capacity_data': [{'base_capacity': 1.2, 'capacity': 1.2, 'end_timestamp': '2013-10-20T19:20:30+01:00', 'total_host_capacity': 1.2}], 'item_duration_in_ms': 56, 'resource_metric': 'CPU', 'time_interval_end': '2013-10-20T19:20:30+01:00', 'time_interval_start': '2013-10-20T19:20:30+01:00', 'usage_unit': 'CORES'}
 
capacity_data
complex
on success
Capacity Data with time interval

   
base_capacity
float
on success
The base allocated amount of the resource metric type (CPU, STORAGE) for a set of databases.

Sample:
1.2
   
capacity
float
on success
The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases.

Sample:
1.2
   
end_timestamp
string
on success
The timestamp in which the current sampling period ends in RFC 3339 format.

Sample:
2013-10-20T19:20:30+01:00
   
total_host_capacity
float
on success
The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases.

Sample:
1.2
 
item_duration_in_ms
integer
on success
Time duration in milliseconds between data points (one hour or one day).

Sample:
56
 
resource_metric
string
on success
Defines the type of resource metric (example: CPU, STORAGE)

Sample:
CPU
 
time_interval_end
string
on success
The end timestamp that was passed into the request.

Sample:
2013-10-20T19:20:30+01:00
 
time_interval_start
string
on success
The start timestamp that was passed into the request.

Sample:
2013-10-20T19:20:30+01:00
 
usage_unit
string
on success
Displays usage unit ( CORES, GB , PERCENT, MBPS)

Sample:
CORES


Authors

  • Oracle (@oracle)