oracle / oracle.oci / 4.21.0 / module / oci_database_management_sql_tuning_advisor_task_summary_report_facts Fetches details about a SqlTuningAdvisorTaskSummaryReport resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_sql_tuning_advisor_task_summary_report_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 a SqlTuningAdvisorTaskSummaryReport resource in Oracle Cloud Infrastructure
Gets the summary report for the specified SQL Tuning Advisor task.
- name: Get a specific sql_tuning_advisor_task_summary_report oci_database_management_sql_tuning_advisor_task_summary_report_facts: # required managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx" sql_tuning_advisor_task_id: 56 # optional search_period: LAST_24HR 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 begin_exec_id_greater_than_or_equal_to: 56 end_exec_id_less_than_or_equal_to: 56
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 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 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 search_period: choices: - LAST_24HR - LAST_7DAY - LAST_31DAY - SINCE_LAST - ALL description: - How far back the API will search for begin and end exec id. Unused if neither exec ids nor time filter query params are supplied. This is applicable only for Auto SQL Tuning tasks. 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 sql_tuning_advisor_task_id: aliases: - id description: - The SQL tuning task identifier. This is not the L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). required: true type: int time_less_than_or_equal_to: description: - The optional less than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks. type: str time_greater_than_or_equal_to: description: - The optional greater than or equal to query parameter to filter the timestamp. This is applicable only for Auto SQL Tuning tasks. type: str end_exec_id_less_than_or_equal_to: description: - The optional less than or equal to query parameter to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks. type: int begin_exec_id_greater_than_or_equal_to: description: - The optional greater than or equal to filter on the execution ID related to a specific SQL Tuning Advisor task. This is applicable only for Auto SQL Tuning tasks. type: int 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
sql_tuning_advisor_task_summary_report: contains: index_findings: contains: index_columns: description: - Columns of the index. returned: on success sample: [] type: list index_hash_value: description: - Numerical representation of the index. returned: on success sample: 56 type: int index_name: description: - Name of the index. returned: on success sample: index_name_example type: str reference_count: description: - The number of times the index is referenced within the SQL Tuning advisor task findings. returned: on success sample: 56 type: int schema: description: - Schema related to the index. returned: on success sample: schema_example type: str table_name: description: - Table's name related to the index. returned: on success sample: table_name_example type: str description: - The list of object findings related to indexes. returned: on success type: complex object_stat_findings: contains: object_hash_value: description: - Numerical representation of the object. returned: on success sample: 56 type: int object_name: description: - Name of the object. returned: on success sample: object_name_example type: str object_type: description: - Type of the object. returned: on success sample: object_type_example type: str problem_type: description: - Type of statistics problem related to the object. returned: on success sample: MISSING type: str reference_count: description: - The number of the times the object is referenced within the SQL Tuning advisor task findings. returned: on success sample: 56 type: int schema: description: - Schema of the object. returned: on success sample: schema_example type: str description: - The list of object findings related to statistics. returned: on success type: complex statistics: contains: finding_benefits: contains: db_time_after_implemented: description: - The actual database time of the SQL statements for which SQL Tuning Advisor recommendations are implemented. returned: on success sample: 56 type: int db_time_after_recommended: description: - The estimated database time of the above SQL statements, if SQL Tuning Advisor recommendations are implemented. returned: on success sample: 56 type: int db_time_before_implemented: description: - The actual database time of the above SQL statements, before SQL Tuning Advisor recommendations are implemented. returned: on success sample: 56 type: int db_time_before_recommended: description: - The actual database time of the SQL statements for which SQL Tuning Advisor recommendations are not implemented. returned: on success sample: 56 type: int description: - '' returned: on success type: complex finding_counts: contains: alternate_plan: description: - The number of distinct SQL statements with alternative plan recommendations. returned: on success sample: 56 type: int implemented_sql_profile: description: - The number of distinct SQL statements with implemented SQL profiles. returned: on success sample: 56 type: int index: description: - The number of distinct SQL statements with index recommendations. returned: on success sample: 56 type: int recommended_sql_profile: description: - The number of distinct SQL statements with recommended SQL profiles. returned: on success sample: 56 type: int restructure: description: - The number of distinct SQL statements with restructured SQL recommendations. returned: on success sample: 56 type: int statistics: description: - The number of distinct SQL statements with stale or missing optimizer statistics recommendations. returned: on success sample: 56 type: int description: - '' returned: on success type: complex statement_counts: contains: distinct_sql: description: - The number of distinct SQL statements. returned: on success sample: 56 type: int error_count: description: - The number of distinct SQL statements with errors. returned: on success sample: 56 type: int finding_count: description: - The number of distinct SQL statements with findings. returned: on success sample: 56 type: int total_sql: description: - The total number of SQL statements. returned: on success sample: 56 type: int description: - '' returned: on success type: complex description: - '' returned: on success type: complex task_info: contains: description: description: - The description of the SQL Tuning Advisor task. This is not defined for Auto SQL Tuning tasks. returned: on success sample: description_example type: str id: description: - The ID of the SQL Tuning Advisor task. This is not the L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). returned: on success sample: 56 type: int name: description: - The name of the SQL Tuning Advisor task. returned: on success sample: name_example type: str owner: description: - The owner of the SQL Tuning Advisor task. returned: on success sample: owner_example type: str running_time: description: - The total running time in seconds. This is not defined for Auto SQL Tuning tasks. returned: on success sample: 56 type: int status: description: - The status of the SQL Tuning Advisor task. This is not defined for Auto SQL Tuning tasks. returned: on success sample: COMPLETED type: str time_ended: description: - The end time of the task execution. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_started: description: - The start time of the task execution. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - '' returned: on success type: complex description: - SqlTuningAdvisorTaskSummaryReport resource returned: on success sample: index_findings: - index_columns: [] index_hash_value: 56 index_name: index_name_example reference_count: 56 schema: schema_example table_name: table_name_example object_stat_findings: - object_hash_value: 56 object_name: object_name_example object_type: object_type_example problem_type: MISSING reference_count: 56 schema: schema_example statistics: finding_benefits: db_time_after_implemented: 56 db_time_after_recommended: 56 db_time_before_implemented: 56 db_time_before_recommended: 56 finding_counts: alternate_plan: 56 implemented_sql_profile: 56 index: 56 recommended_sql_profile: 56 restructure: 56 statistics: 56 statement_counts: distinct_sql: 56 error_count: 56 finding_count: 56 total_sql: 56 task_info: description: description_example id: 56 name: name_example owner: owner_example running_time: 56 status: COMPLETED time_ended: '2013-10-20T19:20:30+01:00' time_started: '2013-10-20T19:20:30+01:00' type: complex