oracle / oracle.oci / 4.2.0 / module / oci_database_management_historic_addm_result_actions Perform actions on a HistoricAddmResult resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_historic_addm_result_actions (4.2.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.2.0
collections: - name: oracle.oci version: 4.2.0
Perform actions on a HistoricAddmResult resource in Oracle Cloud Infrastructure
For I(action=run_historic_addm), creates and executes a historic ADDM task using the specified AWR snapshot IDs. If an existing ADDM task uses the provided awr snapshot IDs, the existing task will be returned.
- name: Perform action run_historic_addm on historic_addm_result oci_database_management_historic_addm_result_actions: # required managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx" start_snapshot_id: 56 end_snapshot_id: 56 action: run_historic_addm
action: choices: - run_historic_addm description: - The action to perform on the HistoricAddmResult. required: true type: str 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 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 auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal 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 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 end_snapshot_id: description: - The ID of the ending AWR snapshot. required: true 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 start_snapshot_id: description: - The ID number of the beginning AWR snapshot. required: true type: int 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: aliases: - 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
historic_addm_result: 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 historic 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 is_newly_created: description: - Specifies whether the ADDM task returned had already existed or was newly created by the api call. returned: on success sample: true type: bool 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 of the historic ADDM task. returned: on success sample: 56 type: int task_name: description: - The name of the historic 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: - Details of the HistoricAddmResult resource acted upon by the current operation 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 is_newly_created: true 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