oracle / oracle.oci / 4.43.0 / module / oci_database_management_optimizer_statistics_collection_aggregations_facts Fetches details about one or multiple OptimizerStatisticsCollectionAggregations 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_optimizer_statistics_collection_aggregations_facts (4.43.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.43.0
collections: - name: oracle.oci version: 4.43.0
Fetches details about one or multiple OptimizerStatisticsCollectionAggregations resources in Oracle Cloud Infrastructure
Gets a list of the optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database. You must specify a value for GroupByQueryParam to determine whether the data should be grouped by task status or task object status. Optionally, you can specify a date-time range (of seven days) to obtain collection aggregations within the specified time range. If the date-time range is not specified, then the operations in the last seven days are listed. You can further filter the results by providing the optional type of TaskTypeQueryParam. If the task type not provided, then both Auto and Manual tasks are considered for aggregation.
- name: List optimizer_statistics_collection_aggregations oci_database_management_optimizer_statistics_collection_aggregations_facts: # required managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx" group_type: TASK_STATUS # optional start_time_greater_than_or_equal_to: start_time_greater_than_or_equal_to_example end_time_less_than_or_equal_to: end_time_less_than_or_equal_to_example task_type: ALL
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 - 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 task_type: choices: - ALL - MANUAL - AUTO description: - The filter types of the optimizer statistics tasks. type: str group_type: choices: - TASK_STATUS - TASK_OBJECTS_STATUS description: - The optimizer statistics tasks grouped by type. 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 end_time_less_than_or_equal_to: description: - The end time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". type: str start_time_greater_than_or_equal_to: description: - The start time of the time range to retrieve the optimizer statistics of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". 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
optimizer_statistics_collection_aggregations: contains: completed: description: - The number of tasks or objects for which statistics gathering is completed. returned: on success sample: 56 type: int failed: description: - The number of tasks or objects for which statistics gathering failed. returned: on success sample: 56 type: int group_by: description: - The optimizer statistics tasks grouped by type. returned: on success sample: TASK_STATUS type: str in_progress: description: - The number of tasks or objects for which statistics gathering is in progress. returned: on success sample: 56 type: int pending: description: - The number of tasks or objects for which statistics are yet to be gathered. returned: on success sample: 56 type: int skipped: description: - The number of tasks or objects for which statistics gathering was skipped. returned: on success sample: 56 type: int time_end: description: - Indicates the end of the hour as the statistics are aggregated per hour. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_start: description: - Indicates the start of the hour as the statistics are aggregated per hour. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str timed_out: description: - The number of tasks or objects for which statistics gathering timed out. returned: on success sample: 56 type: int total: description: - 'The total number of tasks or objects for which statistics collection is finished. This number is the sum of all the tasks or objects with various statuses: pending, inProgress, completed, failed, skipped, timedOut, and unknown.' returned: on success sample: 56 type: int unknown: description: - The number of tasks or objects for which the status of statistics gathering is unknown. returned: on success sample: 56 type: int description: - List of OptimizerStatisticsCollectionAggregations resources returned: on success sample: - completed: 56 failed: 56 group_by: TASK_STATUS in_progress: 56 pending: 56 skipped: 56 time_end: '2013-10-20T19:20:30+01:00' time_start: '2013-10-20T19:20:30+01:00' timed_out: 56 total: 56 unknown: 56 type: complex