oracle.oci.oci_database_management_optimizer_statistics_collection_aggregations_facts – Fetches details about one or multiple OptimizerStatisticsCollectionAggregations resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.14.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_optimizer_statistics_collection_aggregations_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • 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.

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.
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_less_than_or_equal_to
string
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'".
group_type
string / required
    Choices:
  • TASK_STATUS
  • TASK_OBJECTS_STATUS
The optimizer statistics tasks grouped by type.
managed_database_id
string / required
The OCID of the Managed Database.
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_greater_than_or_equal_to
string
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'".
task_type
string
    Choices:
  • ALL
  • MANUAL
  • AUTO
The filter types of the optimizer statistics tasks.
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: 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

Return Values

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

Key Returned Description
optimizer_statistics_collection_aggregations
complex
on success
List of OptimizerStatisticsCollectionAggregations resources

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}]
 
completed
integer
on success
The number of tasks or objects for which statistics gathering is completed.

Sample:
56
 
failed
integer
on success
The number of tasks or objects for which statistics gathering failed.

Sample:
56
 
group_by
string
on success
The optimizer statistics tasks grouped by type.

Sample:
TASK_STATUS
 
in_progress
integer
on success
The number of tasks or objects for which statistics gathering is in progress.

Sample:
56
 
pending
integer
on success
The number of tasks or objects for which statistics are yet to be gathered.

Sample:
56
 
skipped
integer
on success
The number of tasks or objects for which statistics gathering was skipped.

Sample:
56
 
time_end
string
on success
Indicates the end of the hour as the statistics are aggregated per hour.

Sample:
2013-10-20T19:20:30+01:00
 
time_start
string
on success
Indicates the start of the hour as the statistics are aggregated per hour.

Sample:
2013-10-20T19:20:30+01:00
 
timed_out
integer
on success
The number of tasks or objects for which statistics gathering timed out.

Sample:
56
 
total
integer
on success
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.

Sample:
56
 
unknown
integer
on success
The number of tasks or objects for which the status of statistics gathering is unknown.

Sample:
56


Authors

  • Oracle (@oracle)