oracle.oci.oci_opsi_host_insight_resource_statistics_facts – Fetches details about one or multiple HostInsightResourceStatistics 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_host_insight_resource_statistics_facts.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • Lists the resource statistics (usage, capacity, usage change percent, utilization percent, load) for each host filtered by utilization level in a compartment and in all sub-compartments if specified.

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.
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.
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.
forecast_days
integer
Number of days used for utilization forecast analysis.
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_id
string
Optional OCID of the host (Compute Id)
host_type
list / elements=string
Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST
id
list / elements=string
Optional list of host insight resource OCIDs.
insight_by
string
Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast
percentile
integer
Percentile values of daily usage to be used for computing the aggregate resource usage.
platform_type
list / elements=string
    Choices:
  • LINUX
  • SOLARIS
  • SUNOS
  • ZLINUX
Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX].
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 host resource metric. Supported values are CPU, MEMORY, and LOGICAL_MEMORY.
sort_by
string
    Choices:
  • utilizationPercent
  • usage
  • usageChangePercent
  • hostName
  • platformType
The order in which resource statistics records are listed.
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
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 host_insight_resource_statistics
  oci_opsi_host_insight_resource_statistics_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
    platform_type: [ "LINUX" ]
    id: [ "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx" ]
    exadata_insight_id: [ "ocid1.exadatainsight.oc1..xxxxxxEXAMPLExxxxxx" ]
    percentile: 1
    insight_by: insight_by_example
    forecast_days: 30
    sort_order: ASC
    sort_by: utilizationPercent
    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
    host_type: [ "host_type_example" ]
    host_id: "ocid1.host.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
host_insight_resource_statistics
complex
on success
List of HostInsightResourceStatistics resources

Sample:
[{'items': [{'current_statistics': {'available_memory': 1.2, 'capacity': 1.2, 'free_memory': 1.2, 'huge_page_size_in_mb': 1.2, 'huge_pages_free': 56, 'huge_pages_reserved': 56, 'huge_pages_total': 56, 'load': {'average': 1.2, 'lower_quartile': 1.2, 'maximum': 1.2, 'median': 1.2, 'minimum': 1.2, 'upper_quartile': 1.2}, 'resource_name': 'HOST_CPU_STATISTICS', 'usage': 1.2, 'usage_change_percent': 1.2, 'utilization_percent': 1.2}, 'host_details': {'agent_identifier': 'agent_identifier_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'host_display_name': 'host_display_name_example', 'host_name': 'host_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'platform_type': 'LINUX'}}], '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'}]
 
items
complex
on success
Collection of Resource Statistics items

   
current_statistics
complex
on success

     
available_memory
float
on success

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
     
free_memory
float
on success

Sample:
1.2
     
huge_page_size_in_mb
float
on success
Size of huge pages in megabytes.

Sample:
1.2
     
huge_pages_free
integer
on success
Total number of available huge pages.

Sample:
56
     
huge_pages_reserved
integer
on success
Total number of huge pages which are used or reserved.

Sample:
56
     
huge_pages_total
integer
on success
Total number of huge pages.

Sample:
56
     
load
complex
on success

       
average
float
on success
The average number in the data set.

Sample:
1.2
       
lower_quartile
float
on success
The middle number between the smallest number and the median of the data set. It's also known as the 25th quartile.

Sample:
1.2
       
maximum
float
on success
The largest number in the data set.

Sample:
1.2
       
median
float
on success
The middle number in the data set.

Sample:
1.2
       
minimum
float
on success
The smallest number in the data set.

Sample:
1.2
       
upper_quartile
float
on success
The middle number between the median and the largest number of the data set. It's also known as the 75th quartile.

Sample:
1.2
     
resource_name
string
on success
Name of resource for host

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

Sample:
1.2
     
usage_change_percent
float
on success
Change in resource utilization in percentage

Sample:
1.2
     
utilization_percent
float
on success
Resource utilization in percentage.

Sample:
1.2
   
host_details
complex
on success

     
agent_identifier
string
on success
The identifier of the agent.

Sample:
agent_identifier_example
     
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
     
host_display_name
string
on success
The user-friendly name for the host. The name does not have to be unique.

Sample:
host_display_name_example
     
host_name
string
on success
The host name. The host name is unique amongst the hosts managed by the same management agent.

Sample:
host_name_example
     
id
string
on success
The OCID of the host.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
     
platform_type
string
on success
Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX].

Sample:
LINUX
 
resource_metric
string
on success
Defines the type of resource metric (CPU, Physical Memory, Logical Memory)

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)