oracle / oracle.oci / 4.21.0 / module / oci_database_management_job_execution_facts Fetches details about one or multiple JobExecution resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_management_job_execution_facts (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
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 I(job_execution_id) is specified, the details of a single JobExecution will be returned.
- 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"
name: description: - A filter to return only resources that match the entire name. type: str job_id: description: - The identifier of the job. 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 status: description: - The status of the job execution. type: str sort_by: choices: - TIMECREATED - NAME description: - 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. 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 job_run_id: description: - The identifier of the job run. type: str sort_order: choices: - ASC - DESC description: - The option to sort information in ascending ('ASC') or descending ('DESC') order. Ascending 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 compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. - Required to list multiple job_executions. type: str job_execution_id: aliases: - id description: - The identifier of the job execution. - Required to get a specific job_execution. 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. 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 managed_database_group_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Managed Database Group. 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
job_executions: contains: compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the parent job resides. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str database_sub_type: description: - The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database. returned: on success sample: CDB type: str database_type: description: - The type of Oracle Database installation. returned: on success sample: EXTERNAL_SIDB type: str deployment_type: description: - A list of the supported infrastructure that can be used to deploy the database. returned: on success sample: ONPREMISE type: str error_message: description: - 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 returned: on success sample: error_message_example type: str id: description: - The identifier of the job execution. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_cluster: description: - Indicates whether the Oracle Database is part of a cluster. returned: on success sample: true type: bool job_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the parent job. returned: on success sample: ocid1.job.oc1..xxxxxxEXAMPLExxxxxx type: str job_name: description: - The name of the parent job. returned: on success sample: job_name_example type: str job_run_id: description: - The identifier of the associated job run. - Returned for get operation returned: on success sample: ocid1.jobrun.oc1..xxxxxxEXAMPLExxxxxx type: str managed_database_group_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Managed Database Group where the parent job has to be executed. returned: on success sample: ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx type: str managed_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Managed Database associated with the job execution. returned: on success sample: ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx type: str managed_database_name: description: - The name of the Managed Database associated with the job execution. returned: on success sample: managed_database_name_example type: str name: description: - The name of the job execution. returned: on success sample: name_example type: str result_details: contains: bucket_name: description: - The name of the bucket used for job execution result storage. returned: on success sample: bucket_name_example type: str namespace_name: description: - The Object Storage namespace used for job execution result storage. returned: on success sample: namespace_name_example type: str object_name: description: - The name of the object containing the job execution result. returned: on success sample: object_name_example type: str row_count: description: - The number of rows returned in the result for the Query SqlType. returned: on success sample: 56 type: int type: description: - The type of job execution result. returned: on success sample: OBJECT_STORAGE type: str description: - '' - Returned for get operation returned: on success type: complex schedule_details: contains: end_time: description: - The end time of the scheduled job in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". returned: on success sample: end_time_example type: str interval_type: description: - The interval type for a recurring scheduled job. For a non-recurring (one time) job, NEVER must be specified as the interval type. returned: on success sample: DAILY type: str interval_value: description: - The value for the interval period for a recurring scheduled job. returned: on success sample: interval_value_example type: str start_time: description: - The start time of the scheduled job in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". returned: on success sample: start_time_example type: str description: - '' - Returned for get operation returned: on success type: complex sql_text: description: - The SQL text executed as part of the job. - Returned for get operation returned: on success sample: sql_text_example type: str status: description: - The status of the job execution. returned: on success sample: SUCCEEDED type: str time_completed: description: - The date and time when the job execution completed. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_created: description: - The date and time when the job execution was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str user_name: description: - The database user name used to execute the SQL job. - Returned for get operation returned: on success sample: user_name_example type: str workload_type: description: - The workload type of the Autonomous Database. returned: on success sample: OLTP type: str description: - List of JobExecution resources returned: on success 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 type: complex