Try SpotterFetches details about a AwrDbParam 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 AwrDbParam resource 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:
- Each parameter whose value was changed during the time range: (valueChanged ="Y") - Each parameter whose value was unchanged during the time range: (valueChanged ="N") - Each parameter whose value was changed at the system level during the time range: (valueChanged ="Y" and valueModified = "SYSTEM_MOD") - Each parameter whose value was unchanged during the time range, however, the value is not the default value: (valueChanged ="N" and valueDefault = "FALSE")
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: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameterChanges
- name: Get a specific awr_db_param
oci_database_management_awr_db_param_facts:
# required
managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
awr_db_id: "ocid1.awrdb.oc1..xxxxxxEXAMPLExxxxxx"
# 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
name: [ "name_example" ]
name_contains: name_contains_example
value_changed: Y
value_default: TRUE
value_modified: MODIFIED
sort_by: IS_CHANGED
sort_order: ASC
name:
description:
- The optional multiple value query parameter to filter the entity name.
elements: str
type: list
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
name_contains:
description:
- The optional contains query parameter to filter the entity name by any part of the
name.
type: str
value_changed:
choices:
- Y
- N
description:
- The optional query parameter to filter database parameters whose values were changed.
type: str
value_default:
choices:
- 'TRUE'
- 'FALSE'
description:
- The optional query parameter to filter the database parameters that had the default
value in the last snapshot.
type: str
value_modified:
choices:
- MODIFIED
- SYSTEM_MOD
- 'FALSE'
description:
- The optional query parameter to filter the database parameters that had a modified
value in the last snapshot.
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
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:
contains:
begin_value:
description:
- The parameter value when the period began.
returned: on success
sample: begin_value_example
type: str
end_value:
description:
- The parameter value when the period ended.
returned: on success
sample: end_value_example
type: str
instance_number:
description:
- The database instance number.
returned: on success
sample: 56
type: int
is_changed:
description:
- Indicates whether the parameter value changed within the period.
returned: on success
sample: true
type: bool
is_default:
description:
- Indicates whether the parameter value in the end snapshot is the default.
returned: on success
sample: true
type: bool
name:
description:
- The name of the parameter.
returned: on success
sample: name_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:
- AwrDbParam resource
returned: on success
sample:
begin_value: begin_value_example
end_value: end_value_example
instance_number: 56
is_changed: true
is_default: true
name: name_example
value_modified: value_modified_example
type: complex