oracle.oci.oci_opsi_addm_db_recommendation_aggregation_facts – Fetches details about one or multiple AddmDbRecommendationAggregation resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.1.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_opsi_addm_db_recommendation_aggregation_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple AddmDbRecommendationAggregation resources in Oracle Cloud Infrastructure
Summarizes ADDM recommendations for the specified databases.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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. |
category_name
string
|
Optional value filter to match the finding category exactly.
|
|
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.
|
|
compartment_id
string
/ required
|
The OCID of the compartment.
|
|
compartment_id_in_subtree
boolean
|
|
A flag to search all resources within a given compartment and all sub-compartments.
|
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 . |
|
database_id
list
/ elements=string
|
Optional list of database OCIDs of the associated DBaaS entity.
|
|
defined_tag_equals
list
/ elements=string
|
A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
|
|
defined_tag_exists
list
/ elements=string
|
A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
|
|
finding_identifier
string
|
Unique finding ID
|
|
freeform_tag_equals
list
/ elements=string
|
A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
|
|
freeform_tag_exists
list
/ elements=string
|
A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND".
|
|
id
list
/ elements=string
|
Optional list of database insight resource OCIDs.
|
|
instance_number
string
|
The optional single value query parameter to filter by database instance number.
|
|
name
string
|
Optional filter to return only resources whose name exactly matches the substring given. The match is case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.
|
|
name_contains
string
|
Optional filter to return only resources whose name contains the substring given. The match is not case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION.
|
|
owner_or_name_contains
string
|
Optional filter to return only resources whose owner or name contains the substring given. The match is not case sensitive. Only considered when categoryName is SCHEMA_OBJECT.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
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
|
|
Field name for sorting the recommendation data
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
|
sql_identifier
string
|
Optional filter to return only resources whose sql id matches the value given. Only considered when categoryName is SQL_TUNING.
|
|
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_interval_end
string
|
Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd.
|
|
time_interval_start
string
|
Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: List addm_db_recommendation_aggregations
oci_opsi_addm_db_recommendation_aggregation_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
database_id: [ "ocid1.database.oc1..xxxxxxEXAMPLExxxxxx" ]
id: [ "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx" ]
instance_number: instance_number_example
time_interval_start: 2013-10-20T19:20:30+01:00
time_interval_end: 2013-10-20T19:20:30+01:00
category_name: category_name_example
finding_identifier: finding_identifier_example
sql_identifier: sql_identifier_example
owner_or_name_contains: owner_or_name_contains_example
name_contains: name_contains_example
name: name_example
sort_order: ASC
sort_by: maxBenefitPercent
defined_tag_equals: [ "defined_tag_equals_example" ]
freeform_tag_equals: [ "freeform_tag_equals_example" ]
defined_tag_exists: [ "defined_tag_exists_example" ]
freeform_tag_exists: [ "freeform_tag_exists_example" ]
compartment_id_in_subtree: true
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
addm_db_recommendation_aggregations
complex
|
on success |
List of AddmDbRecommendationAggregation resources
Sample:
[{'frequency_count': 56, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'implement_actions': [], 'max_benefit_avg_active_sessions': 1.2, 'max_benefit_percent': 1.2, 'message': 'message_example', 'overall_benefit_percent': 1.2, 'rationale': 'rationale_example', 'related_object': {'is_sql_text_truncated': True, 'name': 'name_example', 'object_id': 56, 'object_name': 'object_name_example', 'object_type': 'object_type_example', 'owner': 'owner_example', 'sql_command': 'sql_command_example', 'sql_id': 'ocid1.sql.oc1..xxxxxxEXAMPLExxxxxx', 'sql_text': 'sql_text_example', 'sub_object_name': 'sub_object_name_example', 'type': 'SCHEMA_OBJECT'}, 'requires_db_restart': 'requires_db_restart_example', 'type': 'type_example'}]
|
||
frequency_count
integer
|
on success |
Number of occurrences for this recommendation
Sample:
56
|
||
id
string
|
on success |
The OCID of the Database insight.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
implement_actions
list
/ elements=string
|
on success |
Actions that can be performed to implement the recommendation (such as 'ALTER PARAMETER', 'RUN SQL TUNING ADVISOR')
|
||
max_benefit_avg_active_sessions
float
|
on success |
Maximum estimated benefit in terms of average active sessions
Sample:
1.2
|
||
max_benefit_percent
float
|
on success |
Maximum estimated benefit in terms of percentage of total activity
Sample:
1.2
|
||
message
string
|
on success |
Recommendation message
Sample:
message_example
|
||
overall_benefit_percent
float
|
on success |
Overall estimated benefit in terms of percentage of total activity
Sample:
1.2
|
||
rationale
string
|
on success |
Recommendation message
Sample:
rationale_example
|
||
related_object
complex
|
on success |
|
||
is_sql_text_truncated
boolean
|
on success |
SQL identifier
Sample:
True
|
||
name
string
|
on success |
Name of database parameter
Sample:
name_example
|
||
object_id
integer
|
on success |
Object id (from RDBMS)
Sample:
56
|
||
object_name
string
|
on success |
Name of object
Sample:
object_name_example
|
||
object_type
string
|
on success |
Type of the object (such as TABLE, INDEX)
Sample:
object_type_example
|
||
owner
string
|
on success |
Owner of object
Sample:
owner_example
|
||
sql_command
string
|
on success |
SQL command name (such as SELECT, INSERT)
Sample:
sql_command_example
|
||
sql_id
string
|
on success |
SQL identifier
Sample:
ocid1.sql.oc1..xxxxxxEXAMPLExxxxxx
|
||
sql_text
string
|
on success |
First 3800 characters of the SQL text
Sample:
sql_text_example
|
||
sub_object_name
string
|
on success |
Subobject name; for example, partition name
Sample:
sub_object_name_example
|
||
type
string
|
on success |
Type of related object
Sample:
SCHEMA_OBJECT
|
||
requires_db_restart
string
|
on success |
Indicates implementation of the recommended action requires a database restart in order for it to take effect. Possible values "Y", "N" and null.
Sample:
requires_db_restart_example
|
||
type
string
|
on success |
Type of recommendation
Sample:
type_example
|
Authors¶
Oracle (@oracle)