Try SpotterFetches details about a AwrDbParamChange resource 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 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
- 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
name:
description:
- The required single value query parameter to filter the entity name.
required: true
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
sort_by:
choices:
- IS_CHANGED
- NAME
description:
- The option to sort the AWR database parameter change history 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
inst_num:
description:
- The optional single value query parameter to filter the database instance number.
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
awr_db_id:
aliases:
- id
description:
- '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'
required: true
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
container_id:
description:
- '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'
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
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
end_sn_id_less_than_or_equal_to:
description:
- The optional less than or equal to query parameter to filter the snapshot ID.
type: int
begin_sn_id_greater_than_or_equal_to:
description:
- The optional greater than or equal to filter on the snapshot ID.
type: int
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
awr_db_param_change:
contains:
instance_number:
description:
- The database instance number.
returned: on success
sample: 56
type: int
is_default:
description:
- Indicates whether the parameter value in the end snapshot is the default.
returned: on success
sample: true
type: bool
previous_value:
description:
- The previous value of the database parameter.
returned: on success
sample: previous_value_example
type: str
snapshot_id:
description:
- 'The ID of the snapshot with the parameter value changed. The snapshot ID
is not the L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
It can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots'
returned: on success
sample: 56
type: int
time_begin:
description:
- The start time of the interval.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_end:
description:
- The end time of the interval.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
value:
description:
- The current value of the database parameter.
returned: on success
sample: value_example
type: str
value_modified:
description:
- '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'
returned: on success
sample: value_modified_example
type: str
description:
- AwrDbParamChange resource
returned: on success
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
type: complex