oracle.oci.oci_opsi_awr_database_parameter_facts – Fetches details about one or multiple AwrDatabaseParameter resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_awr_database_parameter_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple AwrDatabaseParameter resources in Oracle Cloud Infrastructure
Summarizes the database parameter history for the specified database in AWR. This includes the list of database parameters, with information on whether the parameter values were modified within the query time range. Note that each database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include:
Queryparam (valueChanged =”Y”) - Each parameter whose value was changed during the time range, “isChanged : true” in response for the DB params. Queryparam (valueChanged =”N”) - Each parameter whose value was unchanged during the time range, “isChanged : false” in response for the DB params. Queryparam (valueChanged =”Y” and valueModified = “SYSTEM_MOD”) - Each parameter whose value was changed at the system level during the time range, “isChanged : true” & “valueModified : SYSTEM_MOD” in response for the DB params. Queryparam (valueChanged =”N” and valueDefault = “FALSE”) - Each parameter whose value was unchanged during the time range, however, the value is not the default value, “isChanged : true” & “isDefault : false” in response for the DB params.
Note that this API does not return information on the number of times each database parameter has been changed within the time range. To get the database parameter value change history for a specific parameter, use the following API endpoint: /awrHubs/{awrHubId}/awrDbParameterChanges?awrSourceDatabaseIdentifier={awrSourceDbId}
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. |
awr_hub_id
string
/ required
|
Unique Awr Hub identifier
|
|
awr_source_database_identifier
string
/ required
|
The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases
|
|
begin_snapshot_identifier_greater_than_or_equal_to
integer
|
The optional greater than or equal to filter on the snapshot ID.
|
|
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 . |
|
end_snapshot_identifier_less_than_or_equal_to
integer
|
The optional less than or equal to query parameter to filter the snapshot Identifier.
|
|
instance_number
string
|
The optional single value query parameter to filter by database instance number.
|
|
name
list
/ elements=string
|
The optional multiple value query parameter to filter the entity name.
|
|
name_contains
string
|
The optional contains query parameter to filter the entity name by any part of the name.
|
|
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
|
|
The option to sort the AWR database parameter change history data.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`).
|
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. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
|
|
time_less_than_or_equal_to
string
|
The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z
|
|
value_changed
string
|
|
The optional query parameter to filter database parameters whose values were changed.
|
value_default
string
|
|
The optional query parameter to filter the database parameters that had the default value in the last snapshot.
|
value_modified
string
|
|
The optional query parameter to filter the database parameters that had a modified value in the last snapshot.
|
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 awr_database_parameters
oci_opsi_awr_database_parameter_facts:
# required
awr_hub_id: "ocid1.awrhub.oc1..xxxxxxEXAMPLExxxxxx"
awr_source_database_identifier: awr_source_database_identifier_example
# optional
instance_number: instance_number_example
begin_snapshot_identifier_greater_than_or_equal_to: 56
end_snapshot_identifier_less_than_or_equal_to: 56
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
name: [ "name_example" ]
name_contains: name_contains_example
value_changed: Y
value_default: TRUE
value_modified: MODIFIED
sort_by: IS_CHANGED
sort_order: ASC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)