oracle / oracle.oci / 4.21.0 / module / oci_database_management_database_fleet_health_metrics_facts Fetches details about a DatabaseFleetHealthMetrics resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_database_fleet_health_metrics_facts (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
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.
- 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
region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str cert_bundle: description: - 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. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str compare_type: choices: - HOUR - DAY - WEEK description: - The time window used for metrics comparison. type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str compare_target_time: description: - The target time for metrics comparison. required: true type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str compare_baseline_time: description: - The baseline time for metrics comparison. required: true type: str filter_by_metric_names: description: - 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. type: str filter_by_database_type: description: - The filter used to filter the databases in the fleet by a specific Oracle Database type. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str managed_database_group_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Managed Database Group. type: str filter_by_database_version: description: - The filter used to filter the databases in the fleet by a specific Oracle Database version. type: str filter_by_database_sub_type: description: - The filter used to filter the databases in the fleet by a specific Oracle Database subtype. type: str filter_by_database_deployment_type: description: - The filter used to filter the databases in the fleet by a specific Oracle Database deployment type. type: str realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
database_fleet_health_metrics: contains: compare_baseline_time: description: - 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. returned: on success sample: compare_baseline_time_example type: str compare_target_time: description: - 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. returned: on success sample: compare_target_time_example type: str compare_type: description: - The time window used for metrics comparison. returned: on success sample: HOUR type: str fleet_databases: contains: compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment where the Managed Database resides. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str database_container_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the parent Container Database, in the case of a Pluggable Database. returned: on success sample: ocid1.databasecontainer.oc1..xxxxxxEXAMPLExxxxxx type: str database_name: description: - The display name of the Managed Database. returned: on success sample: database_name_example type: str database_sub_type: description: - 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. returned: on success sample: CDB type: str database_type: description: - The type of Oracle Database installation. returned: on success sample: EXTERNAL_SIDB type: str database_version: description: - The Oracle Database version. returned: on success sample: database_version_example type: str db_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Managed Database. returned: on success sample: ocid1.db.oc1..xxxxxxEXAMPLExxxxxx type: str deployment_type: description: - The infrastructure used to deploy the Oracle Database. returned: on success sample: ONPREMISE type: str metrics: contains: baseline_value: description: - The baseline value of the metric. returned: on success sample: 1.2 type: float dimensions: contains: dimension_name: description: - The name of the dimension. returned: on success sample: dimension_name_example type: str dimension_value: description: - The value of the dimension. returned: on success sample: dimension_value_example type: str description: - The dimensions of the metric. returned: on success type: complex metric_name: description: - The name of the metric. returned: on success sample: metric_name_example type: str percentage_change: description: - The percentage change in the metric aggregated value compared to the baseline value. returned: on success sample: 1.2 type: float target_value: description: - The target value of the metric. returned: on success sample: 1.2 type: float timestamp: description: - The data point date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". returned: on success sample: '2013-10-20T19:20:30+01:00' type: str unit: description: - The unit of the value. returned: on success sample: unit_example type: str description: - A list of the database health metrics like CPU, Storage, and Memory. returned: on success type: complex workload_type: description: - The workload type of the Autonomous Database. returned: on success sample: OLTP type: str description: - A list of the databases present in the fleet and their usage metrics. returned: on success type: complex fleet_summary: contains: aggregated_metrics: contains: baseline_value: description: - The metric aggregated value at the baseline date and time. returned: on success sample: 1.2 type: float dimensions: contains: dimension_name: description: - The name of the dimension. returned: on success sample: dimension_name_example type: str dimension_value: description: - The value of the dimension. returned: on success sample: dimension_value_example type: str description: - The unique dimension key and values of the baseline metric. returned: on success type: complex metric_name: description: - The name of the metric. returned: on success sample: metric_name_example type: str percentage_change: description: - The percentage change in the metric aggregated value compared to the baseline value. returned: on success sample: 1.2 type: float target_value: description: - The metric aggregated value at the target date and time. returned: on success sample: 1.2 type: float unit: description: - The unit of the value. returned: on success sample: unit_example type: str description: - A list of databases present in the fleet and their usage metrics. returned: on success type: complex inventory: contains: database_sub_type: description: - 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. returned: on success sample: CDB type: str database_type: description: - The type of Oracle Database installation. returned: on success sample: EXTERNAL_SIDB type: str deployment_type: description: - The infrastructure used to deploy the Oracle Database. returned: on success sample: ONPREMISE type: str inventory_count: description: - The number of databases in the fleet. returned: on success sample: 56 type: int description: - A list of the databases in the fleet, grouped by database type and subtype. returned: on success type: complex description: - '' returned: on success type: complex description: - DatabaseFleetHealthMetrics resource returned: on success 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 type: complex