Try SpotterFetches details about one or multiple AddmTasks 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 AddmTasks resources in Oracle Cloud Infrastructure
Lists the metadata for each ADDM task who's end snapshot time falls within the provided start and end time. Details include the name of the ADDM task, description, user, status and creation date time.
- name: List addm_tasks
oci_database_management_addm_tasks_facts:
# required
managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
time_start: 2013-10-20T19:20:30+01:00
time_end: 2013-10-20T19:20:30+01:00
# optional
sort_by: TASK_NAME
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:
- TASK_NAME
- TASK_ID
- DESCRIPTION
- DB_USER
- STATUS
- TIME_CREATED
- BEGIN_TIME
- END_TIME
description:
- The option to sort the list of ADDM tasks.
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
time_end:
description:
- The end of the time range to search for ADDM tasks as defined by date-time RFC3339
format.
required: true
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
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
time_start:
description:
- The beginning of the time range to search for ADDM tasks as defined by date-time
RFC3339 format.
required: true
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
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
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
addm_tasks:
contains:
begin_snapshot_id:
description:
- The ID number of the beginning AWR snapshot.
returned: on success
sample: 56
type: int
db_user:
description:
- The database user who owns the ADDM task.
returned: on success
sample: db_user_example
type: str
description:
description:
- The description of the ADDM task.
returned: on success
sample: description_example
type: str
end_snapshot_id:
description:
- The ID number of the ending AWR snapshot.
returned: on success
sample: 56
type: int
end_snapshot_time:
description:
- The timestamp of the ending AWR snapshot used in the ADDM task as defined
by date-time RFC3339 format.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
findings:
description:
- The number of ADDM findings.
returned: on success
sample: 56
type: int
how_created:
description:
- A description of how the task was created.
returned: on success
sample: AUTO
type: str
start_snapshot_time:
description:
- The timestamp of the beginning AWR snapshot used in the ADDM task as defined
by date-time RFC3339 format.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
status:
description:
- The status of the ADDM task.
returned: on success
sample: INITIAL
type: str
task_id:
description:
- The ID number of the ADDM task.
returned: on success
sample: 56
type: int
task_name:
description:
- The name of the ADDM task.
returned: on success
sample: task_name_example
type: str
time_created:
description:
- The creation date of the ADDM task.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of AddmTasks resources
returned: on success
sample:
- begin_snapshot_id: 56
db_user: db_user_example
description: description_example
end_snapshot_id: 56
end_snapshot_time: '2013-10-20T19:20:30+01:00'
findings: 56
how_created: AUTO
start_snapshot_time: '2013-10-20T19:20:30+01:00'
status: INITIAL
task_id: 56
task_name: task_name_example
time_created: '2013-10-20T19:20:30+01:00'
type: complex