Try SpotterFetches details about one or multiple JobRun 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 JobRun resources in Oracle Cloud Infrastructure
Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided. If none of these parameters is provided, all the job runs in the compartment are listed. Job runs can also be filtered based on name and runStatus parameters.
If I(job_run_id) is specified, the details of a single JobRun will be returned.
- name: Get a specific job_run
oci_database_management_job_run_facts:
# required
job_run_id: "ocid1.jobrun.oc1..xxxxxxEXAMPLExxxxxx"
- name: List job_runs
oci_database_management_job_run_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"
run_status: run_status_example
name: name_example
sort_by: TIMECREATED
sort_order: ASC
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
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
- 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
job_run_id:
aliases:
- id
description:
- The identifier of the job run.
- Required to get a specific job_run.
type: str
run_status:
description:
- The status 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_runs.
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_runs:
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
id:
description:
- The identifier of the job run.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
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
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 Managed Database where the parent job has to be executed.
returned: on success
sample: ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx
type: str
name:
description:
- The name of the job run.
returned: on success
sample: name_example
type: str
run_status:
description:
- The status of the job run.
returned: on success
sample: COMPLETED
type: str
time_submitted:
description:
- The date and time when the job run was submitted.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The date and time when the job run was last updated.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of JobRun resources
returned: on success
sample:
- compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
job_id: ocid1.job.oc1..xxxxxxEXAMPLExxxxxx
job_name: job_name_example
managed_database_group_id: ocid1.manageddatabasegroup.oc1..xxxxxxEXAMPLExxxxxx
managed_database_id: ocid1.manageddatabase.oc1..xxxxxxEXAMPLExxxxxx
name: name_example
run_status: COMPLETED
time_submitted: '2013-10-20T19:20:30+01:00'
time_updated: '2013-10-20T19:20:30+01:00'
type: complex