oracle.oci.oci_database_management_job_execution_facts – Fetches details about one or multiple JobExecution resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple JobExecution resources in Oracle Cloud Infrastructure

  • Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, jobRunId, managedDatabaseId or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job executions in the compartment are listed. Job executions can also be filtered based on the name and status parameters.

  • If job_execution_id is specified, the details of a single JobExecution will be returned.

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.
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.
compartment_id
string
The OCID of the compartment.
Required to list multiple job_executions.
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.
job_execution_id
string
The identifier of the job execution.
Required to get a specific job_execution.

aliases: id
job_id
string
The identifier of the job.
job_run_id
string
The identifier of the job run.
managed_database_group_id
string
The OCID of the Managed Database Group.
managed_database_id
string
The OCID of the Managed Database.
name
string
A filter to return only resources that match the entire 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:
  • TIMECREATED
  • NAME
The field to sort information by. Only one sortOrder can be used. The default sort order for 'TIMECREATED' is descending and the default sort order for 'NAME' is ascending. The 'NAME' sort order is case-sensitive.
sort_order
string
    Choices:
  • ASC
  • DESC
The option to sort information in ascending ('ASC') or descending ('DESC') order. Ascending order is the default order.
status
string
The status of the job execution.
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

Examples

- name: Get a specific job_execution
  oci_database_management_job_execution_facts:
    # required
    job_execution_id: "ocid1.jobexecution.oc1..xxxxxxEXAMPLExxxxxx"

- name: List job_executions
  oci_database_management_job_execution_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    job_id: "ocid1.job.oc1..xxxxxxEXAMPLExxxxxx"
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
    managed_database_group_id: "ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx"
    status: status_example
    name: name_example
    sort_by: TIMECREATED
    sort_order: ASC
    job_run_id: "ocid1.jobrun.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
job_executions
complex
on success
List of JobExecution resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_sub_type': 'CDB', 'database_type': 'EXTERNAL_SIDB', 'deployment_type': 'ONPREMISE', 'error_message': 'error_message_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_cluster': True, 'job_id': 'ocid1.job.oc1..xxxxxxEXAMPLExxxxxx', 'job_name': 'job_name_example', 'job_run_id': 'ocid1.jobrun.oc1..xxxxxxEXAMPLExxxxxx', 'managed_database_group_id': 'ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx', 'managed_database_id': 'ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx', 'managed_database_name': 'managed_database_name_example', 'name': 'name_example', 'result_details': {'bucket_name': 'bucket_name_example', 'namespace_name': 'namespace_name_example', 'object_name': 'object_name_example', 'row_count': 56, 'type': 'OBJECT_STORAGE'}, 'schedule_details': {'end_time': 'end_time_example', 'interval_type': 'DAILY', 'interval_value': 'interval_value_example', 'start_time': 'start_time_example'}, 'sql_text': 'sql_text_example', 'status': 'SUCCEEDED', 'time_completed': '2013-10-20T19:20:30+01:00', 'time_created': '2013-10-20T19:20:30+01:00', 'user_name': 'user_name_example', 'workload_type': 'OLTP'}]
 
compartment_id
string
on success
The OCID of the compartment in which the parent job resides.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
database_sub_type
string
on success
The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database.

Sample:
CDB
 
database_type
string
on success
The type of Oracle Database installation.

Sample:
EXTERNAL_SIDB
 
deployment_type
string
on success
A list of the supported infrastructure that can be used to deploy the database.

Sample:
ONPREMISE
 
error_message
string
on success
The error message that is returned if the job execution fails. Null is returned if the job is still running or if the job execution is successful.
Returned for get operation

Sample:
error_message_example
 
id
string
on success
The identifier of the job execution.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_cluster
boolean
on success
Indicates whether the Oracle Database is part of a cluster.

Sample:
True
 
job_id
string
on success
The OCID of the parent job.

Sample:
ocid1.job.oc1..xxxxxxEXAMPLExxxxxx
 
job_name
string
on success
The name of the parent job.

Sample:
job_name_example
 
job_run_id
string
on success
The identifier of the associated job run.
Returned for get operation

Sample:
ocid1.jobrun.oc1..xxxxxxEXAMPLExxxxxx
 
managed_database_group_id
string
on success
The OCID of the Managed Database Group where the parent job has to be executed.

Sample:
ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx
 
managed_database_id
string
on success
The OCID of the Managed Database associated with the job execution.

Sample:
ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx
 
managed_database_name
string
on success
The name of the Managed Database associated with the job execution.

Sample:
managed_database_name_example
 
name
string
on success
The name of the job execution.

Sample:
name_example
 
result_details
complex
on success
Returned for get operation

   
bucket_name
string
on success
The name of the bucket used for job execution result storage.

Sample:
bucket_name_example
   
namespace_name
string
on success
The Object Storage namespace used for job execution result storage.

Sample:
namespace_name_example
   
object_name
string
on success
The name of the object containing the job execution result.

Sample:
object_name_example
   
row_count
integer
on success
The number of rows returned in the result for the Query SqlType.

Sample:
56
   
type
string
on success
The type of job execution result.

Sample:
OBJECT_STORAGE
 
schedule_details
complex
on success
Returned for get operation

   
end_time
string
on success
The end time of the scheduled job in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

Sample:
end_time_example
   
interval_type
string
on success
The interval type for a recurring scheduled job. For a non-recurring (one time) job, NEVER must be specified as the interval type.

Sample:
DAILY
   
interval_value
string
on success
The value for the interval period for a recurring scheduled job.

Sample:
interval_value_example
   
start_time
string
on success
The start time of the scheduled job in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

Sample:
start_time_example
 
sql_text
string
on success
The SQL text executed as part of the job.
Returned for get operation

Sample:
sql_text_example
 
status
string
on success
The status of the job execution.

Sample:
SUCCEEDED
 
time_completed
string
on success
The date and time when the job execution completed.

Sample:
2013-10-20T19:20:30+01:00
 
time_created
string
on success
The date and time when the job execution was created.

Sample:
2013-10-20T19:20:30+01:00
 
user_name
string
on success
The database user name used to execute the SQL job.
Returned for get operation

Sample:
user_name_example
 
workload_type
string
on success
The workload type of the Autonomous Database.

Sample:
OLTP


Authors

  • Oracle (@oracle)