oracle.oci.oci_database_management_awr_db_param_facts – Fetches details about a AwrDbParam resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.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_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches 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

Requirements

The below requirements are needed on the host that executes this module.

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
    Choices:
  • service_principal
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
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
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
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.
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
    Choices:
  • IS_CHANGED
  • NAME
The option to sort the AWR database parameter change history data.
sort_order
string
    Choices:
  • ASC
  • DESC
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.
value_changed
string
    Choices:
  • Y
  • N
The optional query parameter to filter database parameters whose values were changed.
value_default
string
    Choices:
  • TRUE
  • FALSE
The optional query parameter to filter the database parameters that had the default value in the last snapshot.
value_modified
string
    Choices:
  • MODIFIED
  • SYSTEM_MOD
  • FALSE
The optional query parameter to filter the database parameters that had a modified value in the last snapshot.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
awr_db_param
complex
on success
AwrDbParam resource

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'}
 
begin_value
string
on success
The parameter value when the period began.

Sample:
begin_value_example
 
end_value
string
on success
The parameter value when the period ended.

Sample:
end_value_example
 
instance_number
integer
on success
The database instance number.

Sample:
56
 
is_changed
boolean
on success
Indicates whether the parameter value changed within the period.

Sample:
True
 
is_default
boolean
on success
Indicates whether the parameter value in the end snapshot is the default.

Sample:
True
 
name
string
on success
The name of the parameter.

Sample:
name_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)