oracle.oci.oci_opsi_summarize_exadata_insight_resource_forecast_trend_facts – Fetches details about one or multiple SummarizeExadataInsightResourceForecastTrend 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_opsi_summarize_exadata_insight_resource_forecast_trend_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Get historical usage and forecast predictions for an exadata system with breakdown by databases, hosts or storage servers. Additionally resources can be filtered using databaseInsightId, hostInsightId or storageServerName query parameters. Top five resources are returned if total exceeds the limit specified. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Database name is returned in name field. DatabaseInsightId , cdbName and hostName query parameter applies to ResourceType DATABASE. Valid values for ResourceType HOST are CPU and MEMORY. HostName s returned in name field. HostInsightId and hostName query parameter applies to ResourceType HOST. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. Storage server name is returned in name field for resourceMetric IOPS and THROUGHPUT and asmName is returned in name field for resourceMetric STORAGE. StorageServerName query parameter applies to ResourceType STORAGE_SERVER. Valid value for ResourceType DISKGROUP is STORAGE. Comma delimited (asmName,diskgroupName) is returned in name field.

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.
confidence
integer
This parameter is used to change data's confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%.
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_insight_id
list / elements=string
Optional list of database insight resource OCIDs.
exadata_insight_id
string / required
OCID of exadata insight resource.
exadata_type
list / elements=string
Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC.
forecast_days
integer
Number of days used for utilization forecast analysis.
forecast_model
string
    Choices:
  • LINEAR
  • ML_AUTO
  • ML_NO_AUTO
Choose algorithm model for the forecasting. Possible values: - LINEAR: Uses linear regression algorithm for forecasting. - ML_AUTO: Automatically detects best algorithm to use for forecasting. - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm.
forecast_start_day
integer
Number of days used for utilization forecast analysis.
host_insight_id
list / elements=string
Optional list of host insight resource OCIDs.
host_name
list / elements=string
Filter by hostname.
name
string
Use name along with the other options to return only resources that match the given name exactly.
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, IO, IOPS, THROUGHPUT
resource_type
string / required
Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE
sort_by
string
    Choices:
  • id
  • name
  • daysToReachCapacity
The order in which resource Forecast trend records are listed
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
statistic
string
    Choices:
  • AVG
  • MAX
Choose the type of statistic metric data to be used for forecasting.
storage_server_name
list / elements=string
Optional storage server name on an exadata system.
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.

Examples

- name: List summarize_exadata_insight_resource_forecast_trends
  oci_opsi_summarize_exadata_insight_resource_forecast_trend_facts:
    # required
    resource_type: resource_type_example
    resource_metric: resource_metric_example
    exadata_insight_id: "ocid1.exadatainsight.oc1..xxxxxxEXAMPLExxxxxx"

    # 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_insight_id: [ "ocid1.databaseinsight.oc1..xxxxxxEXAMPLExxxxxx" ]
    host_insight_id: [ "ocid1.hostinsight.oc1..xxxxxxEXAMPLExxxxxx" ]
    storage_server_name: [ "storage_server_name_example" ]
    exadata_type: [ "exadata_type_example" ]
    statistic: AVG
    forecast_start_day: 0
    forecast_days: 0
    forecast_model: LINEAR
    cdb_name: [ "cdb_name_example" ]
    host_name: [ "host_name_example" ]
    confidence: 1
    sort_order: ASC
    sort_by: id

Return Values

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

Key Returned Description
summarize_exadata_insight_resource_forecast_trends
complex
on success
List of SummarizeExadataInsightResourceForecastTrend resources

Sample:
[{'days_to_reach_capacity': 56, 'historical_data': [{'end_timestamp': '2013-10-20T19:20:30+01:00', 'usage': 1.2}], 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'pattern': 'LINEAR', 'projected_data': [{'end_timestamp': '2013-10-20T19:20:30+01:00', 'high_value': 1.2, 'low_value': 1.2, 'usage': 1.2}]}]
 
days_to_reach_capacity
integer
on success
Days to reach capacity for a storage server

Sample:
56
 
historical_data
complex
on success
Time series data used for the forecast analysis.

   
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
   
usage
float
on success
Total amount used of the resource metric type (CPU, STORAGE).

Sample:
1.2
 
id
string
on success
The OCID of the database insight resource.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
name
string
on success
The name of the resource.

Sample:
name_example
 
pattern
string
on success
Time series patterns used in the forecasting.

Sample:
LINEAR
 
projected_data
complex
on success
Time series data result of the forecasting analysis.

   
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
   
high_value
float
on success
Upper uncertainty bound of the current usage value.

Sample:
1.2
   
low_value
float
on success
Lower uncertainty bound of the current usage value.

Sample:
1.2
   
usage
float
on success
Total amount used of the resource metric type (CPU, STORAGE).

Sample:
1.2


Authors

  • Oracle (@oracle)