oracle / oracle.oci / 4.21.0 / module / oci_database_management_availability_metric_facts Fetches details about one or multiple AvailabilityMetric resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_availability_metric_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 one or multiple AvailabilityMetric resources in Oracle Cloud Infrastructure
Gets the availability metrics related to managed database for the Oracle database specified by managedDatabaseId.
- name: List availability_metrics oci_database_management_availability_metric_facts: # required managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx" start_time: start_time_example end_time: end_time_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 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 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: 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 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
availability_metrics: contains: header: contains: dimensions: description: - The qualifiers provided in the definition of the returned metric. returned: on success sample: {} type: dict duration_in_seconds: description: - The duration of the returned aggregated data in seconds. returned: on success sample: 56 type: int mean: description: - The mean value of the metric. returned: on success sample: 1.2 type: float metadata: description: - The additional information about the metric. - 'Example: `"unit": "bytes"`' returned: on success sample: {} type: dict metric_name: description: - The name of the metric. returned: on success sample: metric_name_example type: str start_timestamp_in_epoch_seconds: description: - The start time associated with the value of the metric. returned: on success sample: 56 type: int description: - '' returned: on success type: complex metrics: contains: dimensions: description: - The qualifiers provided in the definition of the returned metric. returned: on success sample: {} type: dict duration_in_seconds: description: - The duration of the returned aggregated data in seconds. returned: on success sample: 56 type: int mean: description: - The mean value of the metric. returned: on success sample: 1.2 type: float metadata: description: - The additional information about the metric. - 'Example: `"unit": "bytes"`' returned: on success sample: {} type: dict metric_name: description: - The name of the metric. returned: on success sample: metric_name_example type: str start_timestamp_in_epoch_seconds: description: - The start time associated with the value of the metric. returned: on success sample: 56 type: int description: - The list of metrics returned for the specified request. Each of the metrics has a `metricName` and additional properties like `metadata`, `dimensions`. If a property is not set, then use the value from `header`. - 'Suppose `m` be an item in the `metrics` array: - If `m.metricName` is not set, use `header.metricName` instead - If `m.durationInSeconds` is not set, use `header.durationInSeconds` instead - If `m.dimensions` is not set, use `header.dimensions` instead - If `m.metadata` is not set, use `header.metadata` instead' returned: on success type: complex range_end_time_in_epoch_seconds: description: - The end of the time range (exclusive) of the returned metric data. returned: on success sample: 56 type: int range_start_time_in_epoch_seconds: description: - The beginning of the time range (inclusive) of the returned metric data. returned: on success sample: 56 type: int description: - List of AvailabilityMetric resources returned: on success sample: - header: dimensions: {} duration_in_seconds: 56 mean: 1.2 metadata: {} metric_name: metric_name_example start_timestamp_in_epoch_seconds: 56 metrics: - dimensions: {} duration_in_seconds: 56 mean: 1.2 metadata: {} metric_name: metric_name_example start_timestamp_in_epoch_seconds: 56 range_end_time_in_epoch_seconds: 56 range_start_time_in_epoch_seconds: 56 type: complex