oracle.oci.oci_database_management_pdb_metrics_facts – Fetches details about a PdbMetrics 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_database_management_pdb_metrics_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a PdbMetrics resource in Oracle Cloud Infrastructure

  • Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each PDB within a specific CDB. If comparmentId is specified, then the metrics for each PDB (within the CDB) in the specified compartment are retrieved. If compartmentId is not specified, then the metrics for all the PDBs within the CDB are retrieved.

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_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.
end_time
string / required
The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".
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_id
string / required
The OCID of the Managed Database.

aliases: id
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.
start_time
string / required
The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".
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 pdb_metrics
  oci_database_management_pdb_metrics_facts:
    # required
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
    start_time: start_time_example
    end_time: end_time_example

    # optional
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    compare_type: HOUR
    filter_by_metric_names: filter_by_metric_names_example

Return Values

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

Key Returned Description
pdb_metrics
complex
on success
PdbMetrics resource

Sample:
{'database_usage_metrics': [{'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'}]}
 
database_usage_metrics
complex
on success
A summary of PDBs and their resource usage metrics such as CPU, User I/O, and Storage, within a specific CDB.

   
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


Authors

  • Oracle (@oracle)