Try SpotterFetches details about one or multiple AwrDbSnapshot resources 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 one or multiple AwrDbSnapshot resources in Oracle Cloud Infrastructure
Lists AWR snapshots for the specified database in the AWR.
- name: List awr_db_snapshots
oci_database_management_awr_db_snapshot_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
sort_by: TIME_BEGIN
sort_order: ASC
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:
- TIME_BEGIN
- SNAPSHOT_ID
description:
- The option to sort the AWR snapshot summary 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:
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_snapshots:
contains:
awr_db_id:
description:
- 'Internal ID of the database. The internal ID of the database 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'
returned: on success
sample: ocid1.awrdb.oc1..xxxxxxEXAMPLExxxxxx
type: str
error_count:
description:
- The total number of errors.
returned: on success
sample: 56
type: int
instance_number:
description:
- The database instance number.
returned: on success
sample: 56
type: int
snapshot_id:
description:
- 'The ID of the snapshot. 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 snapshot.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_db_startup:
description:
- The timestamp of the database startup.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_end:
description:
- The end time of the snapshot.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of AwrDbSnapshot resources
returned: on success
sample:
- awr_db_id: ocid1.awrdb.oc1..xxxxxxEXAMPLExxxxxx
error_count: 56
instance_number: 56
snapshot_id: 56
time_begin: '2013-10-20T19:20:30+01:00'
time_db_startup: '2013-10-20T19:20:30+01:00'
time_end: '2013-10-20T19:20:30+01:00'
type: complex