oracle.oci.oci_database_management_database_fleet_health_metrics_facts – Fetches details about a DatabaseFleetHealthMetrics resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a DatabaseFleetHealthMetrics resource in Oracle Cloud Infrastructure

  • Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group. Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the health metrics.

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.
compare_baseline_time
string / required
The baseline time for metrics comparison.
compare_target_time
string / required
The target time for metrics comparison.
compare_type
string
    Choices:
  • HOUR
  • DAY
  • WEEK
The time window used for metrics comparison.
compartment_id
string
The OCID of the 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.
filter_by_database_deployment_type
string
The filter used to filter the databases in the fleet by a specific Oracle Database deployment type.
filter_by_database_sub_type
string
The filter used to filter the databases in the fleet by a specific Oracle Database subtype.
filter_by_database_type
string
The filter used to filter the databases in the fleet by a specific Oracle Database type.
filter_by_database_version
string
The filter used to filter the databases in the fleet by a specific Oracle Database version.
filter_by_metric_names
string
The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.
managed_database_group_id
string
The OCID of the Managed Database Group.
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.
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 database_fleet_health_metrics
  oci_database_management_database_fleet_health_metrics_facts:
    # required
    compare_baseline_time: compare_baseline_time_example
    compare_target_time: compare_target_time_example

    # optional
    managed_database_group_id: "ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    compare_type: HOUR
    filter_by_metric_names: filter_by_metric_names_example
    filter_by_database_type: filter_by_database_type_example
    filter_by_database_sub_type: filter_by_database_sub_type_example
    filter_by_database_deployment_type: filter_by_database_deployment_type_example
    filter_by_database_version: filter_by_database_version_example

Return Values

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

Key Returned Description
database_fleet_health_metrics
complex
on success
DatabaseFleetHealthMetrics resource

Sample:
{'compare_baseline_time': 'compare_baseline_time_example', 'compare_target_time': 'compare_target_time_example', 'compare_type': 'HOUR', 'fleet_databases': [{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_container_id': 'ocid1.databasecontainer.oc1..xxxxxxEXAMPLExxxxxx', 'database_name': 'database_name_example', 'database_sub_type': 'CDB', 'database_type': 'EXTERNAL_SIDB', 'database_version': 'database_version_example', 'db_id': 'ocid1.db.oc1..xxxxxxEXAMPLExxxxxx', 'deployment_type': 'ONPREMISE', 'metrics': [{'baseline_value': 1.2, 'dimensions': [{'dimension_name': 'dimension_name_example', 'dimension_value': 'dimension_value_example'}], 'metric_name': 'metric_name_example', 'percentage_change': 1.2, 'target_value': 1.2, 'timestamp': '2013-10-20T19:20:30+01:00', 'unit': 'unit_example'}], 'workload_type': 'OLTP'}], 'fleet_summary': {'aggregated_metrics': [{'baseline_value': 1.2, 'dimensions': [{'dimension_name': 'dimension_name_example', 'dimension_value': 'dimension_value_example'}], 'metric_name': 'metric_name_example', 'percentage_change': 1.2, 'target_value': 1.2, 'unit': 'unit_example'}], 'inventory': [{'database_sub_type': 'CDB', 'database_type': 'EXTERNAL_SIDB', 'deployment_type': 'ONPREMISE', 'inventory_count': 56}]}}
 
compare_baseline_time
string
on success
The baseline date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". This is the date and time against which percentage change is calculated.

Sample:
compare_baseline_time_example
 
compare_target_time
string
on success
The target date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". All the metrics are returned for the target date and time and the percentage change is calculated against the baseline date and time.

Sample:
compare_target_time_example
 
compare_type
string
on success
The time window used for metrics comparison.

Sample:
HOUR
 
fleet_databases
complex
on success
A list of the databases present in the fleet and their usage metrics.

   
compartment_id
string
on success
The OCID of the compartment where the Managed Database resides.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
   
database_container_id
string
on success
The OCID of the parent Container Database, in the case of a Pluggable Database.

Sample:
ocid1.databasecontainer.oc1..xxxxxxEXAMPLExxxxxx
   
database_name
string
on success
The display name of the Managed Database.

Sample:
database_name_example
   
database_sub_type
string
on success
The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.

Sample:
CDB
   
database_type
string
on success
The type of Oracle Database installation.

Sample:
EXTERNAL_SIDB
   
database_version
string
on success
The Oracle Database version.

Sample:
database_version_example
   
db_id
string
on success
The OCID of the Managed Database.

Sample:
ocid1.db.oc1..xxxxxxEXAMPLExxxxxx
   
deployment_type
string
on success
The infrastructure used to deploy the Oracle Database.

Sample:
ONPREMISE
   
metrics
complex
on success
A list of the database health metrics like CPU, Storage, and Memory.

     
baseline_value
float
on success
The baseline value of the metric.

Sample:
1.2
     
dimensions
complex
on success
The dimensions of the metric.

       
dimension_name
string
on success
The name of the dimension.

Sample:
dimension_name_example
       
dimension_value
string
on success
The value of the dimension.

Sample:
dimension_value_example
     
metric_name
string
on success
The name of the metric.

Sample:
metric_name_example
     
percentage_change
float
on success
The percentage change in the metric aggregated value compared to the baseline value.

Sample:
1.2
     
target_value
float
on success
The target value of the metric.

Sample:
1.2
     
timestamp
string
on success
The data point date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

Sample:
2013-10-20T19:20:30+01:00
     
unit
string
on success
The unit of the value.

Sample:
unit_example
   
workload_type
string
on success
The workload type of the Autonomous Database.

Sample:
OLTP
 
fleet_summary
complex
on success

   
aggregated_metrics
complex
on success
A list of databases present in the fleet and their usage metrics.

     
baseline_value
float
on success
The metric aggregated value at the baseline date and time.

Sample:
1.2
     
dimensions
complex
on success
The unique dimension key and values of the baseline metric.

       
dimension_name
string
on success
The name of the dimension.

Sample:
dimension_name_example
       
dimension_value
string
on success
The value of the dimension.

Sample:
dimension_value_example
     
metric_name
string
on success
The name of the metric.

Sample:
metric_name_example
     
percentage_change
float
on success
The percentage change in the metric aggregated value compared to the baseline value.

Sample:
1.2
     
target_value
float
on success
The metric aggregated value at the target date and time.

Sample:
1.2
     
unit
string
on success
The unit of the value.

Sample:
unit_example
   
inventory
complex
on success
A list of the databases in the fleet, grouped by database type and subtype.

     
database_sub_type
string
on success
The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.

Sample:
CDB
     
database_type
string
on success
The type of Oracle Database installation.

Sample:
EXTERNAL_SIDB
     
deployment_type
string
on success
The infrastructure used to deploy the Oracle Database.

Sample:
ONPREMISE
     
inventory_count
integer
on success
The number of databases in the fleet.

Sample:
56


Authors

  • Oracle (@oracle)