oracle.oci.oci_database_management_job_facts – Fetches details about one or multiple Job resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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

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

  • If job_id is specified, the details of a single Job 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 jobs.
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_id
string
The identifier of the job.
Required to get a specific job.

aliases: id
lifecycle_state
string
    Choices:
  • ACTIVE
  • INACTIVE
The lifecycle state of the job.
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.
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
  oci_database_management_job_facts:
    # required
    job_id: "ocid1.job.oc1..xxxxxxEXAMPLExxxxxx"

- name: List jobs
  oci_database_management_job_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    managed_database_group_id: "ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx"
    managed_database_id: "ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    lifecycle_state: ACTIVE
    sort_by: TIMECREATED
    sort_order: ASC

Return Values

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

Key Returned Description
jobs
complex
on success
List of Job resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'database_sub_type': 'CDB', 'description': 'description_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'job_type': 'SQL', 'lifecycle_state': 'ACTIVE', 'managed_database_group_id': 'ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx', 'managed_database_id': 'ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx', 'managed_databases_details': [{'database_sub_type': 'CDB', 'database_type': 'EXTERNAL_SIDB', 'deployment_type': 'ONPREMISE', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_cluster': True, 'name': 'name_example', 'workload_type': 'OLTP'}], 'name': 'name_example', 'operation_type': 'EXECUTE_SQL', 'result_location': {'bucket_name': 'bucket_name_example', 'namespace_name': 'namespace_name_example', 'type': 'OBJECT_STORAGE'}, 'role': 'NORMAL', 'schedule_details': {'end_time': 'end_time_example', 'interval_type': 'DAILY', 'interval_value': 'interval_value_example', 'start_time': 'start_time_example'}, 'schedule_type': 'IMMEDIATE', 'sql_text': 'sql_text_example', 'sql_type': 'QUERY', 'submission_error_message': 'submission_error_message_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'timeout': 'timeout_example', 'user_name': 'user_name_example'}]
 
compartment_id
string
on success
The OCID of the compartment in which the job resides.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
database_sub_type
string
on success
The subtype of the Oracle Database where the job has to be executed. Applicable only when managedDatabaseGroupId is provided.

Sample:
CDB
 
description
string
on success
The description of the job.

Sample:
description_example
 
id
string
on success
The OCID of the job.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
job_type
string
on success
The type of job.

Sample:
SQL
 
lifecycle_state
string
on success
The lifecycle state of the job.

Sample:
ACTIVE
 
managed_database_group_id
string
on success
The OCID of the Managed Database Group where the job has to be executed.

Sample:
ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx
 
managed_database_id
string
on success
The OCID of the Managed Database where the job has to be executed.

Sample:
ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx
 
managed_databases_details
complex
on success
The details of the Managed Databases where the job has to be executed.
Returned for get operation

   
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
   
id
string
on success
The OCID of the Managed Database.

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

Sample:
True
   
name
string
on success
The name of the Managed Database.

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

Sample:
OLTP
 
name
string
on success
The display name of the job.

Sample:
name_example
 
operation_type
string
on success
The SQL operation type.
Returned for get operation

Sample:
EXECUTE_SQL
 
result_location
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
   
type
string
on success
The type of the job execution result location.

Sample:
OBJECT_STORAGE
 
role
string
on success
The role of the database user. Indicates whether the database user is a normal user or sysdba.
Returned for get operation

Sample:
NORMAL
 
schedule_details
complex
on success

   
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
 
schedule_type
string
on success
The schedule type of the job.

Sample:
IMMEDIATE
 
sql_text
string
on success
The SQL text to be executed in the job. This is a mandatory field for the EXECUTE_SQL operationType.
Returned for get operation

Sample:
sql_text_example
 
sql_type
string
on success
The type of SQL. This is a mandatory field for the EXECUTE_SQL operationType.
Returned for get operation

Sample:
QUERY
 
submission_error_message
string
on success
The error message that is returned if the job submission fails. Null is returned in all other scenarios.

Sample:
submission_error_message_example
 
time_created
string
on success
The date and time when the job was created.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time when the job was last updated.

Sample:
2013-10-20T19:20:30+01:00
 
timeout
string
on success
The job timeout duration, which is expressed like "1h 10m 15s".

Sample:
timeout_example
 
user_name
string
on success
The database user name used to execute the SQL job. If the job is being executed on a Managed Database Group, then the user name should exist on all the databases in the group with the same password.
Returned for get operation

Sample:
user_name_example


Authors

  • Oracle (@oracle)