Try SpotterFetches details about a PdbMetrics resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches 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.
- 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
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
end_time:
description:
- 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'".
required: true
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
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
start_time:
description:
- 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'".
required: true
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
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
managed_database_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the Managed Database.
required: true
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
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
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
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
pdb_metrics:
contains:
database_usage_metrics:
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 summary of PDBs and their resource usage metrics such as CPU, User I/O,
and Storage, within a specific CDB.
returned: on success
type: complex
description:
- PdbMetrics resource
returned: on success
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
type: complex