Try SpotterFetches details about one or multiple Job 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 Job resources in Oracle Cloud Infrastructure
List all the names of the Migration jobs associated to the specified migration site.
If I(job_id) is specified, the details of a single Job will be returned.
- name: Get a specific job
oci_database_migration_job_facts:
# required
job_id: "ocid1.job.oc1..xxxxxxEXAMPLExxxxxx"
- name: List jobs
oci_database_migration_job_facts:
# required
migration_id: "ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
sort_by: timeCreated
sort_order: ASC
lifecycle_state: ACCEPTED
job_id:
aliases:
- id
description:
- The OCID of the job
- Required to get a specific 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
- displayName
description:
- The field to sort by. Only one sort order may be provided. Default order for timeCreated
is descending. Default order for displayName is ascending. If no value is specified
timeCreated is default.
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
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either 'asc' or 'desc'.
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
display_name:
aliases:
- name
description:
- A filter to return only resources that match the entire display name given.
type: str
migration_id:
description:
- The ID of the migration in which to list resources.
- Required to list multiple jobs.
type: str
lifecycle_state:
choices:
- ACCEPTED
- IN_PROGRESS
- UNKNOWN
- TERMINATED
- FAILED
- SUCCEEDED
- WAITING
- CANCELING
- CANCELED
description:
- The lifecycle state of the Migration Job.
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
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
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
jobs:
contains:
defined_tags:
description:
- 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- Name of the job.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- 'Simple key-value pair that is applied without any predefined name, type or
scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The OCID of the Migration Job.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_details:
description:
- A message describing the current state in more detail. For example, can be
used to provide actionable information for a resource in Failed state.
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of the migration job.
returned: on success
sample: ACCEPTED
type: str
migration_id:
description:
- The OCID of the Migration that this job belongs to.
returned: on success
sample: ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx
type: str
progress:
contains:
current_phase:
description:
- Current phase of the job.
returned: on success
sample: ODMS_VALIDATE_TGT
type: str
current_status:
description:
- Current status of the job.
returned: on success
sample: PENDING
type: str
job_progress:
description:
- Job progress percentage (0 - 100)
returned: on success
sample: 56
type: int
phases:
contains:
action:
description:
- The text describing the action required to fix the issue
returned: on success
sample: action_example
type: str
duration_in_ms:
description:
- Duration of the phase in milliseconds
returned: on success
sample: 56
type: int
extract:
contains:
message:
description:
- Message in entry.
returned: on success
sample: message_example
type: str
type:
description:
- Type of extract.
returned: on success
sample: ERROR
type: str
description:
- Summary of phase status results.
returned: on success
type: complex
is_advisor_report_available:
description:
- True if a Pre-Migration Advisor report is available for this phase.
False or null if no report is available.
returned: on success
sample: true
type: bool
issue:
description:
- The text describing the root cause of the reported issue
returned: on success
sample: issue_example
type: str
log_location:
contains:
bucket_name:
description:
- Name of the bucket containing the log file.
returned: on success
sample: bucket_name_example
type: str
namespace:
description:
- Object Storage namespace.
returned: on success
sample: namespace_example
type: str
object_name:
description:
- Log object name.
returned: on success
sample: object_name_example
type: str
description:
- ''
returned: on success
type: complex
name:
description:
- Phase name
returned: on success
sample: ODMS_VALIDATE_TGT
type: str
progress:
description:
- Percent progress of job phase.
returned: on success
sample: 56
type: int
status:
description:
- Phase status
returned: on success
sample: PENDING
type: str
description:
- List of phase status for the job.
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
system_tags:
description:
- 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`'
returned: on success
sample: {}
type: dict
time_created:
description:
- The time the Migration Job was created. An RFC3339 formatted datetime string
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The time the Migration Job was last updated. An RFC3339 formatted datetime
string
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
type:
description:
- The job type.
returned: on success
sample: EVALUATION
type: str
unsupported_objects:
contains:
object_name:
description:
- Name of the object (regular expression is allowed)
returned: on success
sample: object_name_example
type: str
owner:
description:
- Owner of the object (regular expression is allowed)
returned: on success
sample: owner_example
type: str
type:
description:
- Type of unsupported object
returned: on success
sample: GOLDEN_GATE
type: str
description:
- Database objects not supported.
- Returned for get operation
returned: on success
type: complex
description:
- List of Job resources
returned: on success
sample:
- defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
lifecycle_details: lifecycle_details_example
lifecycle_state: ACCEPTED
migration_id: ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx
progress:
current_phase: ODMS_VALIDATE_TGT
current_status: PENDING
job_progress: 56
phases:
- action: action_example
duration_in_ms: 56
extract:
- message: message_example
type: ERROR
is_advisor_report_available: true
issue: issue_example
log_location:
bucket_name: bucket_name_example
namespace: namespace_example
object_name: object_name_example
name: ODMS_VALIDATE_TGT
progress: 56
status: PENDING
system_tags: {}
time_created: '2013-10-20T19:20:30+01:00'
time_updated: '2013-10-20T19:20:30+01:00'
type: EVALUATION
unsupported_objects:
- object_name: object_name_example
owner: owner_example
type: GOLDEN_GATE
type: complex