oracle.oci.oci_database_management_sql_tuning_advisor_task_facts – Fetches details about one or multiple SqlTuningAdvisorTask resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple SqlTuningAdvisorTask resources in Oracle Cloud Infrastructure

  • Lists the SQL Tuning Advisor tasks for the specified Managed Database.

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.
managed_database_id
string / required
The OCID of the Managed Database.
name
string
The optional query parameter to filter the SQL Tuning Advisor task list by name.
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.
sort_by
string
    Choices:
  • NAME
  • START_TIME
The option to sort the SQL Tuning Advisor task summary data.
sort_order
string
    Choices:
  • ASC
  • DESC
The option to sort information in ascending ('ASC') or descending ('DESC') order. Descending order is the default order.
status
string
    Choices:
  • INITIAL
  • EXECUTING
  • INTERRUPTED
  • COMPLETED
  • ERROR
The optional query parameter to filter the SQL Tuning Advisor task list by status.
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
time_greater_than_or_equal_to
string
The optional greater than or equal to query parameter to filter the timestamp.
time_less_than_or_equal_to
string
The optional less than or equal to query parameter to filter the timestamp.

Examples

- name: List sql_tuning_advisor_tasks
  oci_database_management_sql_tuning_advisor_task_facts:
    # required
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    status: INITIAL
    time_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_less_than_or_equal_to: 2013-10-20T19:20:30+01:00
    sort_by: NAME
    sort_order: ASC

Return Values

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

Key Returned Description
sql_tuning_advisor_tasks
complex
on success
List of SqlTuningAdvisorTask resources

Sample:
[{'days_to_expire': 56, 'description': 'description_example', 'instance_id': 56, 'name': 'name_example', 'owner': 'owner_example', 'recommendation_count': 56, 'sql_tuning_advisor_task_id': 56, 'task_status': 'COMPLETED', 'time_created': '2013-10-20T19:20:30+01:00', 'time_execution_ended': '2013-10-20T19:20:30+01:00', 'time_execution_started': '2013-10-20T19:20:30+01:00', 'total_sql_statements': 56}]
 
days_to_expire
integer
on success
The number of days left before the task expires. If the value equals -1, then the task has no expiration time (UNLIMITED).

Sample:
56
 
description
string
on success
The description of the SQL Tuning Advisor task.

Sample:
description_example
 
instance_id
integer
on success
The instance ID of the SQL Tuning Advisor task. This is not the OCID.

Sample:
56
 
name
string
on success
The name of the SQL Tuning Advisor task.

Sample:
name_example
 
owner
string
on success
The owner of the SQL Tuning Advisor task.

Sample:
owner_example
 
recommendation_count
integer
on success
The number of recommendations provided for the SQL Tuning Advisor task.

Sample:
56
 
sql_tuning_advisor_task_id
integer
on success
The unique identifier of the SQL Tuning Advisor task. This is not the OCID.

Sample:
56
 
task_status
string
on success
The status of the SQL Tuning Advisor task.

Sample:
COMPLETED
 
time_created
string
on success
The Creation date of the SQL Tuning Advisor task.

Sample:
2013-10-20T19:20:30+01:00
 
time_execution_ended
string
on success
The end time of the task execution.

Sample:
2013-10-20T19:20:30+01:00
 
time_execution_started
string
on success
The start time of the task execution.

Sample:
2013-10-20T19:20:30+01:00
 
total_sql_statements
integer
on success
The total number of SQL statements related to the SQL Tuning Advisor task.

Sample:
56


Authors

  • Oracle (@oracle)