oracle.oci.oci_database_migration_job – Manage a Job resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

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
  • security_token
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.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
display_name
string
Name of the job.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
This parameter is updatable.
job_id
string
The OCID of the job
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
migration_id
string
The ID of the migration in which to list resources.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
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.
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.
state
string
    Choices:
  • present ←
  • absent
The state of the Job.
Use state=present to update an existing a Job.
Use state=absent to delete a Job.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Update job
  oci_database_migration_job:
    # required
    job_id: "ocid1.job.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update job using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_migration_job:
    # required
    display_name: display_name_example
    migration_id: "ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete job
  oci_database_migration_job:
    # required
    job_id: "ocid1.job.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete job using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_migration_job:
    # required
    display_name: display_name_example
    migration_id: "ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
job
complex
on success
Details of the Job resource acted upon by the current operation

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', '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'}]}
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
Name of the job.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the Migration Job.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the migration job.

Sample:
ACCEPTED
 
migration_id
string
on success
The OCID of the Migration that this job belongs to.

Sample:
ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx
 
progress
complex
on success

   
current_phase
string
on success
Current phase of the job.

Sample:
ODMS_VALIDATE_TGT
   
current_status
string
on success
Current status of the job.

Sample:
PENDING
   
phases
complex
on success
List of phase status for the job.
     
action
string
on success
The text describing the action required to fix the issue

Sample:
action_example
     
duration_in_ms
integer
on success
Duration of the phase in milliseconds

Sample:
56
     
extract
complex
on success
Summary of phase status results.
       
message
string
on success
Message in entry.

Sample:
message_example
       
type
string
on success
Type of extract.

Sample:
ERROR
     
is_advisor_report_available
boolean
on success
True if a Pre-Migration Advisor report is available for this phase. False or null if no report is available.

Sample:
True
     
issue
string
on success
The text describing the root cause of the reported issue

Sample:
issue_example
     
log_location
complex
on success

       
bucket_name
string
on success
Name of the bucket containing the log file.

Sample:
bucket_name_example
       
namespace
string
on success
Object Storage namespace.

Sample:
namespace_example
       
object_name
string
on success
Log object name.

Sample:
object_name_example
     
name
string
on success
Phase name

Sample:
ODMS_VALIDATE_TGT
     
progress
integer
on success
Percent progress of job phase.

Sample:
56
     
status
string
on success
Phase status

Sample:
PENDING
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
The time the Migration Job was created. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the Migration Job was last updated. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
The job type.

Sample:
EVALUATION
 
unsupported_objects
complex
on success
Database objects not supported.
   
object_name
string
on success
Name of the object (regular expression is allowed)

Sample:
object_name_example
   
owner
string
on success
Owner of the object (regular expression is allowed)

Sample:
owner_example
   
type
string
on success
Type of unsupported object

Sample:
GOLDEN_GATE


Authors

  • Oracle (@oracle)