Try SpotterFetches details about one or multiple SqlTuningAdvisorTask resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple SqlTuningAdvisorTask resources in Oracle Cloud Infrastructure
Lists the SQL Tuning Advisor tasks for the specified Managed Database.
- 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
name:
description:
- The optional query parameter to filter the SQL Tuning Advisor task list by name.
type: str
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
status:
choices:
- INITIAL
- EXECUTING
- INTERRUPTED
- COMPLETED
- ERROR
description:
- The optional query parameter to filter the SQL Tuning Advisor task list by status.
type: str
sort_by:
choices:
- NAME
- START_TIME
description:
- The option to sort the SQL Tuning Advisor task summary data.
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
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
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
time_less_than_or_equal_to:
description:
- The optional less than or equal to query parameter to filter the timestamp.
type: str
time_greater_than_or_equal_to:
description:
- The optional greater than or equal to query parameter to filter the timestamp.
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
sql_tuning_advisor_tasks:
contains:
days_to_expire:
description:
- The number of days left before the task expires. If the value equals -1, then
the task has no expiration time (UNLIMITED).
returned: on success
sample: 56
type: int
description:
description:
- The description of the SQL Tuning Advisor task.
returned: on success
sample: description_example
type: str
instance_id:
description:
- The instance 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
recommendation_count:
description:
- The number of recommendations provided for the SQL Tuning Advisor task.
returned: on success
sample: 56
type: int
sql_tuning_advisor_task_id:
description:
- The unique identifier 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
task_status:
description:
- The status of the SQL Tuning Advisor task.
returned: on success
sample: COMPLETED
type: str
time_created:
description:
- The Creation date of the SQL Tuning Advisor task.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_execution_ended:
description:
- The end time of the task execution.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_execution_started:
description:
- The start time of the task execution.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
total_sql_statements:
description:
- The total number of SQL statements related to the SQL Tuning Advisor task.
returned: on success
sample: 56
type: int
description:
- List of SqlTuningAdvisorTask resources
returned: on success
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
type: complex