oracle.oci.oci_database_management_awr_db_param_change_facts – Fetches details about a AwrDbParamChange resource 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_database_management_awr_db_param_change_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about a AwrDbParamChange resource in Oracle Cloud Infrastructure
Summarizes the database parameter change history for one database parameter of the specified database in AWR. One change history record contains the previous value, the changed value, and the corresponding time range. If the database parameter value was changed multiple times within the time range, then multiple change history records are created for the same parameter. Note that this API only returns information on change history details for one database parameter. To get a list of all the database parameters whose values were changed during a specified time range, use the following API endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameters
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_db_id
string
/ required
|
The parameter to filter the database by internal ID. Note that the internal ID of the database can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
aliases: id |
|
begin_sn_id_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 . |
|
container_id
integer
|
The optional query parameter to filter the database container by an exact ID value. Note that the database container ID can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
|
|
end_sn_id_less_than_or_equal_to
integer
|
The optional less than or equal to query parameter to filter the snapshot ID.
|
|
inst_num
string
|
The optional single value query parameter to filter the database instance number.
|
|
managed_database_id
string
/ required
|
The OCID of the Managed Database.
|
|
name
string
/ required
|
The required single value query parameter to filter the entity 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 option to sort information in ascending ('ASC') or descending ('DESC') order. Descending order is the default order.
|
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.
|
|
time_less_than_or_equal_to
string
|
The optional less than or equal to query parameter to filter the timestamp.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific awr_db_param_change
oci_database_management_awr_db_param_change_facts:
# required
managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
awr_db_id: "ocid1.awrdb.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
# optional
inst_num: inst_num_example
begin_sn_id_greater_than_or_equal_to: 56
end_sn_id_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
container_id: 56
sort_by: IS_CHANGED
sort_order: ASC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
awr_db_param_change
complex
|
on success |
AwrDbParamChange resource
Sample:
{'instance_number': 56, 'is_default': True, 'previous_value': 'previous_value_example', 'snapshot_id': 56, 'time_begin': '2013-10-20T19:20:30+01:00', 'time_end': '2013-10-20T19:20:30+01:00', 'value': 'value_example', 'value_modified': 'value_modified_example'}
|
|
instance_number
integer
|
on success |
The database instance number.
Sample:
56
|
|
is_default
boolean
|
on success |
Indicates whether the parameter value in the end snapshot is the default.
Sample:
True
|
|
previous_value
string
|
on success |
The previous value of the database parameter.
Sample:
previous_value_example
|
|
snapshot_id
integer
|
on success |
The ID of the snapshot with the parameter value changed. The snapshot ID is not the OCID. It can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
Sample:
56
|
|
time_begin
string
|
on success |
The start time of the interval.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_end
string
|
on success |
The end time of the interval.
Sample:
2013-10-20T19:20:30+01:00
|
|
value
string
|
on success |
The current value of the database parameter.
Sample:
value_example
|
|
value_modified
string
|
on success |
Indicates whether the parameter has been modified after instance startup: - MODIFIED - Parameter has been modified with ALTER SESSION - SYSTEM_MOD - Parameter has been modified with ALTER SYSTEM (which causes all the currently logged in sessions' values to be modified) - FALSE - Parameter has not been modified after instance startup
Sample:
value_modified_example
|
Authors¶
Oracle (@oracle)