oracle / oracle.oci / 2.38.0 / module / oci_database_management_sql_tuning_advisor_task_recommendation_facts Fetches details about one or multiple SqlTuningAdvisorTaskRecommendation 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_sql_tuning_advisor_task_recommendation_facts (2.38.0) — module
Install with ansible-galaxy collection install oracle.oci:==2.38.0
collections: - name: oracle.oci version: 2.38.0
Fetches details about one or multiple SqlTuningAdvisorTaskRecommendation resources in Oracle Cloud Infrastructure
Takes in a task id and object id and returns the recommendations/findings.
- name: List sql_tuning_advisor_task_recommendations oci_database_management_sql_tuning_advisor_task_recommendation_facts: # required managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx" sql_tuning_advisor_task_id: 56 sql_object_id: 56 execution_id: 56 # optional sort_by: RECOMMENDATION_TYPE sort_order: ASC
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 sort_by: choices: - RECOMMENDATION_TYPE - BENEFIT description: - The possible sortBy values of an object's recommendations. 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 sort_order: choices: - ASC - DESC description: - The option to sort information in ascending ('ASC') or descending ('DESC') order. Descending order is the default order. type: str execution_id: description: - The execution id for an execution of a SQL tuning task. This is not the L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). required: true type: int sql_object_id: description: - The SQL object id for the SQL tuning task. This is not the L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). required: true type: int 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: 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
sql_tuning_advisor_task_recommendations: contains: benefit: description: - The percentage benefit of this implementation. returned: on success sample: 3.4 type: float finding: description: - Summary of the issue found for the SQL statement. returned: on success sample: finding_example type: str implement_action_sql: description: - Action sql to be implemented based on the recommendation result. returned: on success sample: implement_action_sql_example type: str rationale: description: - Describes the reasoning behind the recommendation and how it relates to the finding. returned: on success sample: rationale_example type: str recommendation: description: - Particular recommendation for the finding. returned: on success sample: recommendation_example type: str recommendation_key: description: - Unique identifier of the recommendation in the scope of the task. returned: on success sample: 56 type: int recommendation_type: description: - Type of recommendation returned: on success sample: STATISTICS type: str sql_tuning_advisor_task_id: description: - Unique identifier of the task. It is not the L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). returned: on success sample: 56 type: int sql_tuning_advisor_task_object_id: description: - Key of the object to which these recommendations apply. It is not the L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). returned: on success sample: 56 type: int description: - List of SqlTuningAdvisorTaskRecommendation resources returned: on success sample: - benefit: 3.4 finding: finding_example implement_action_sql: implement_action_sql_example rationale: rationale_example recommendation: recommendation_example recommendation_key: 56 recommendation_type: STATISTICS sql_tuning_advisor_task_id: 56 sql_tuning_advisor_task_object_id: 56 type: complex