oracle.oci.oci_application_migration_source – Manage a Source resource 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_application_migration_source.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Source resource in Oracle Cloud Infrastructure

  • For state=present, creates a source in the specified compartment. In Application Migration, a source refers to the environment from which the application is being migrated. For more information, see Manage Sources.

  • All Oracle Cloud Infrastructure resources, including sources, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

  • After you send your request, a source is created in the specified compartment. The new source’s lifecycle state will temporarily be <code>CREATING</code>. Application Migration connects to the source environment with the authentication credentials that you have provided. If the connection is established, the status of the source changes to <code>ACTIVE</code> and Application Migration fetches the list of applications that are available for migration in the source environment.

  • To track the progress of the operation, you can monitor the status of the Create Source work request by using the <code>`GetWorkRequest <https://docs.cloud.oracle.com/en-us/iaas/api/#/en/applicationmigration/20191031/WorkRequest/GetWorkRequest>`_</code> REST API operation on the work request or by viewing the status of the work request in the console.

  • Ensure that the state of the source has changed to <code>ACTIVE</code>, before you retrieve the list of applications from the source environment using the <code>`ListSourceApplications <https://docs.cloud.oracle.com/en- us/iaas/api/#/en/applicationmigration/20191031/SourceApplicationSummary/ListSourceApplications>`_</code> REST API call.

  • This resource has the following action operations in the oracle.oci.oci_application_migration_source_actions module: change_compartment.

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.
authorization_details
dictionary
This parameter is updatable.
access_token
string
AccessToken to access the app endpoint.
Required when type is 'OCIC_IDCS'
client_app_url
string
AuthClient app url resource that the accesstoken is for.
Required when type is 'OCIC_IDCS'
password
string
Password for this user.
Required when type is one of ['OCIC', 'INTERNAL_COMPUTE', 'OCC']
type
string / required
    Choices:
  • OCC
  • INTERNAL_COMPUTE
  • OCIC_IDCS
  • OCIC
Type of the source environment from which you are migrating applications to Oracle Cloud Infrastructure.
username
string
User with Compute Operations role in Oracle Cloud@Customer.
Required when type is one of ['OCIC', 'INTERNAL_COMPUTE', 'OCC']
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 that contains the source.
Required for create using state=present.
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.
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. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
description
string
Description of the source. This helps you to identify the appropriate source environment when you have multiple sources defined.
This parameter is updatable.
display_name
string
Name of the source. This helps you to identify the appropriate source environment when you have multiple sources defined.
Required for create, 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
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
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.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
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.
source_details
dictionary
Required for create using state=present.
This parameter is updatable.
account_name
string
The identity domain ID of your traditional Oracle Cloud Infrastructure - Classic account.
Required when type is 'INTERNAL_COMPUTE'
bucket
string
the bucket wherein the export archive exists in object storage
Required when type is 'IMPORT'
compute_account
string
If you are using an Oracle Cloud@Customer account with Identity Cloud Service (IDCS), enter the service instance ID. For example, if Compute-567890123 is the account name of your Oracle Cloud@Customer Compute service entitlement, then enter 567890123.
Required when type is one of ['OCIC', 'OCC']
manifest
dictionary
Required when type is 'IMPORT'
export_details
dictionary
application specific details as parsed from various sources of the application that was exported
Applicable when type is 'IMPORT'
export_type
string
the type of application that the export tool was executed against to generate this manifest
Applicable when type is 'IMPORT'
md5
string
the MD5 hash of the export artifact archive that was produced by the export tool and should be used with this manifest
Applicable when type is 'IMPORT'
signature
string
a sha1 hash of all the fields of this manifest (excluding the signature)
Applicable when type is 'IMPORT'
timestamp
string
when this manifest was generated
Applicable when type is 'IMPORT'
version
string
the version of the export tool that was used to generate the manifest
Applicable when type is 'IMPORT'
namespace
string
the object storage namespace where the bucket and uploaded object resides
Required when type is 'IMPORT'
object_name
string
the name of the archive as it exists in object storage
Required when type is 'IMPORT'
region
string
The Oracle Cloud Infrastructure - Classic region from which you want to migrate your applications. For example, uscom-east-1 or uscom- central-1.
Required when type is 'OCIC'
type
string / required
    Choices:
  • IMPORT
  • OCC
  • INTERNAL_COMPUTE
  • OCIC
The type of source environment.
source_id
string
The OCID of the source.
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
state
string
    Choices:
  • present ←
  • absent
The state of the Source.
Use state=present to create or update a Source.
Use state=absent to delete a Source.
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: Create source
  oci_application_migration_source:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    source_details:
      # required
      manifest:
        # optional
        version: version_example
        export_type: export_type_example
        export_details: null
        timestamp: timestamp_example
        md5: md5_example
        signature: signature_example
      namespace: namespace_example
      bucket: bucket_example
      object_name: object_name_example
      type: IMPORT

    # optional
    display_name: display_name_example
    description: description_example
    authorization_details:
      # required
      type: OCC
      username: username_example
      password: example-password
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update source
  oci_application_migration_source:
    # required
    source_id: "ocid1.source.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    source_details:
      # required
      manifest:
        # optional
        version: version_example
        export_type: export_type_example
        export_details: null
        timestamp: timestamp_example
        md5: md5_example
        signature: signature_example
      namespace: namespace_example
      bucket: bucket_example
      object_name: object_name_example
      type: IMPORT
    authorization_details:
      # required
      type: OCC
      username: username_example
      password: example-password
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update source using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_application_migration_source:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    description: description_example
    source_details:
      # required
      manifest:
        # optional
        version: version_example
        export_type: export_type_example
        export_details: null
        timestamp: timestamp_example
        md5: md5_example
        signature: signature_example
      namespace: namespace_example
      bucket: bucket_example
      object_name: object_name_example
      type: IMPORT
    authorization_details:
      # required
      type: OCC
      username: username_example
      password: example-password
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete source
  oci_application_migration_source:
    # required
    source_id: "ocid1.source.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete source using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_application_migration_source:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

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

Key Returned Description
source
complex
on success
Details of the Source resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'source_details': {'account_name': 'account_name_example', 'bucket': 'bucket_example', 'compute_account': 'compute_account_example', 'manifest': {'export_details': {}, 'export_type': 'export_type_example', 'md5': 'md5_example', 'signature': 'signature_example', 'timestamp': '2013-10-20T19:20:30+01:00', 'version': 'version_example'}, 'namespace': 'namespace_example', 'object_name': 'object_name_example', 'region': 'us-phoenix-1', 'type': 'OCIC'}, 'time_created': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
The OCID of the compartment that contains the source.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
Description of the source. This helps you to identify the appropriate source environment when you have multiple sources defined.

Sample:
description_example
 
display_name
string
on success
Name of the source. This helps you to identify the appropriate source environment when you have multiple sources defined.

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 source.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
Details about the current lifecycle state of the source.

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

Sample:
CREATING
 
source_details
complex
on success

   
account_name
string
on success
The identity domain ID of your traditional Oracle Cloud Infrastructure - Classic account.

Sample:
account_name_example
   
bucket
string
on success
the bucket wherein the export archive exists in object storage

Sample:
bucket_example
   
compute_account
string
on success
If you are using an Oracle Cloud@Customer account with Identity Cloud Service (IDCS), enter the service instance ID. For example, if Compute-567890123 is the account name of your Oracle Cloud@Customer Compute service entitlement, then enter 567890123.

Sample:
compute_account_example
   
manifest
complex
on success

     
export_details
dictionary
on success
application specific details as parsed from various sources of the application that was exported

     
export_type
string
on success
the type of application that the export tool was executed against to generate this manifest

Sample:
export_type_example
     
md5
string
on success
the MD5 hash of the export artifact archive that was produced by the export tool and should be used with this manifest

Sample:
md5_example
     
signature
string
on success
a sha1 hash of all the fields of this manifest (excluding the signature)

Sample:
signature_example
     
timestamp
string
on success
when this manifest was generated

Sample:
2013-10-20T19:20:30+01:00
     
version
string
on success
the version of the export tool that was used to generate the manifest

Sample:
version_example
   
namespace
string
on success
the object storage namespace where the bucket and uploaded object resides

Sample:
namespace_example
   
object_name
string
on success
the name of the archive as it exists in object storage

Sample:
object_name_example
   
region
string
on success
The Oracle Cloud Infrastructure - Classic region from which you want to migrate your applications. For example, uscom-east-1 or uscom-central-1.

Sample:
us-phoenix-1
   
type
string
on success
The type of source environment.

Sample:
OCIC
 
time_created
string
on success
The date and time at which the source was created, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)