oracle.oci.oci_database_management_awr_db_facts – Fetches details about one or multiple AwrDb resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple AwrDb resources in Oracle Cloud Infrastructure
Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.
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. |
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 . |
|
managed_database_id
string
/ required
|
The OCID of the Managed Database.
|
|
name
string
|
The optional 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 summary 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: List awr_dbs
oci_database_management_awr_db_facts:
# required
managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
# optional
name: name_example
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
sort_by: END_INTERVAL_TIME
sort_order: ASC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
awr_dbs
complex
|
on success |
List of AwrDb resources
Sample:
[{'awr_db_id': 'ocid1.awrdb.oc1..xxxxxxEXAMPLExxxxxx', 'container_id': 56, 'db_name': 'db_name_example', 'db_version': 'db_version_example', 'first_snapshot_id': 56, 'instance_list': [], 'latest_snapshot_id': 56, 'snapshot_count': 56, 'snapshot_interval_in_min': 56, 'snapshot_timezone': 'snapshot_timezone_example', 'time_db_startup': '2013-10-20T19:20:30+01:00', 'time_first_snapshot_begin': '2013-10-20T19:20:30+01:00', 'time_latest_snapshot_end': '2013-10-20T19:20:30+01:00'}]
|
|
awr_db_id
string
|
on success |
The internal ID of the database. The internal ID of the database is not the OCID. It can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs
Sample:
ocid1.awrdb.oc1..xxxxxxEXAMPLExxxxxx
|
|
container_id
integer
|
on success |
ID of the database container. The database container ID is not the OCID. It can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
Sample:
56
|
|
db_name
string
|
on success |
The name of the database.
Sample:
db_name_example
|
|
db_version
string
|
on success |
The version of the database.
Sample:
db_version_example
|
|
first_snapshot_id
integer
|
on success |
The ID of the earliest snapshot. The snapshot ID is not the OCID. It can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
Sample:
56
|
|
instance_list
list
/ elements=string
|
on success |
The database instance numbers.
|
|
latest_snapshot_id
integer
|
on success |
The ID of the latest snapshot. The snapshot ID is not the OCID. It can be retrieved from the following endpoint: /managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
Sample:
56
|
|
snapshot_count
integer
|
on success |
The total number of snapshots.
Sample:
56
|
|
snapshot_interval_in_min
integer
|
on success |
The interval time between snapshots (in minutes).
Sample:
56
|
|
snapshot_timezone
string
|
on success |
The time zone of the snapshot.
Sample:
snapshot_timezone_example
|
|
time_db_startup
string
|
on success |
The timestamp of the database startup.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_first_snapshot_begin
string
|
on success |
The start time of the earliest snapshot.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_latest_snapshot_end
string
|
on success |
The end time of the latest snapshot.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)