oracle.oci.oci_application_migration_migration – Manage a Migration resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.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_migration
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Migration resource in Oracle Cloud Infrastructure
For state=present, creates a migration. A migration represents the end-to-end workflow of moving an application from a source environment to Oracle Cloud Infrastructure. Each migration moves a single application to Oracle Cloud Infrastructure. For more information, see Manage Migrations.
When you create a migration, provide the required information to let Application Migration access the source environment. Application Migration uses this information to access the application in the source environment and discover application artifacts.
All Oracle Cloud Infrastructure resources, including migrations, 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. For more information, see Resource Identifiers.
After you send your request, a migration is created in the compartment that contains the source. The new migration’s lifecycle state will temporarily be <code>CREATING</code> and the state of the migration will be <code>DISCOVERING_APPLICATION</code>. During this phase, Application Migration sets the template for the <code>serviceConfig</code> and <code>applicationConfig</code> fields of the migration. When this operation is complete, the state of the migration changes to <code>MISSING_CONFIG_VALUES</code>. Next, you’ll need to update the migration to provide configuration values. Before updating the migration, ensure that its state has changed to <code>MISSING_CONFIG_VALUES</code>.
To track the progress of this operation, you can monitor the status of the Create Migration and Discover Application work requests 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.
This resource has the following action operations in the oracle.oci.oci_application_migration_migration_actions module: change_compartment, migrate_application.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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 ). |
|||
application_config
dictionary
|
Configuration required to migrate the application. In addition to the key and value, additional fields are provided to describe type type and purpose of each field. Only the value for each key is required when passing configuration to the CreateMigration operation.
This parameter is updatable.
|
|||
description
string
|
Help text to guide the user in setting the configuration value.
|
|||
group
string
|
The name of the group to which this field belongs, if any.
|
|||
is_mutable
boolean
|
|
Indicates whether or not the field may be modified (defaults to `true`).
|
||
is_required
boolean
|
|
Indicates whether or not the field is required (defaults to `true`).
|
||
name
string
|
The name of the configuration field.
|
|||
resource_list
list
/ elements=dictionary
|
A list of resources associated with a specific configuration object.
|
|||
group
string
|
The name of the group to which this field belongs to.
|
|||
name
string
|
The display name of the resource field.
|
|||
type
string
/ required
|
The type of the resource field.
|
|||
value
string
/ required
|
The value of the field.
|
|||
type
string
|
The type of the configuration field.
|
|||
value
string
|
The value of the field.
|
|||
application_name
string
|
Name of the application that you want to migrate from the source environment.
Required for create using state=present.
|
|||
auth_purpose
string
|
|
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
|
|
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 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 application that you are migrating.
This parameter is updatable.
|
|||
discovery_details
dictionary
|
Required for create using state=present.
This parameter is updatable.
|
|||
service_instance_password
string
|
Password for this user.
Required when type is one of ['OAC', 'PCS', 'OIC', 'ICS']
|
|||
service_instance_user
string
|
Application administrator username to access the Oracle Integration Classic instance in the source environment.
Required when type is one of ['OAC', 'PCS', 'OIC', 'ICS']
|
|||
type
string
/ required
|
|
The type of application that you want to migrate.
|
||
weblogic_password
string
|
The password of the WebLogic administrator for the Oracle Java Cloud Service application in the source environment.
Required when type is one of ['SOACS', 'JCS']
|
|||
weblogic_user
string
|
WebLogic administrator username for the Oracle Java Cloud Service application in the source environment.
Required when type is one of ['SOACS', 'JCS']
|
|||
display_name
string
|
User-friendly name of the application. This will be the name of the migrated application in Oracle Cloud Infrastructure.
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
|
|
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.
|
|||
is_selective_migration
boolean
|
|
If set to `true`, Application Migration migrates the application resources selectively depending on the source.
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.
|
|||
migration_id
string
|
The OCID of the migration.
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 |
|||
pre_created_target_database_type
string
|
|
The pre-existing database type to be used in this migration. Currently, Application migration only supports Oracle Cloud Infrastructure databases and this option is currently available only for `JAVA_CLOUD_SERVICE` and `WEBLOGIC_CLOUD_SERVICE` target instance types.
|
||
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. |
|||
service_config
dictionary
|
Configuration required to migrate the application. In addition to the key and value, additional fields are provided to describe type type and purpose of each field. Only the value for each key is required when passing configuration to the CreateMigration operation.
This parameter is updatable.
|
|||
description
string
|
Help text to guide the user in setting the configuration value.
|
|||
group
string
|
The name of the group to which this field belongs, if any.
|
|||
is_mutable
boolean
|
|
Indicates whether or not the field may be modified (defaults to `true`).
|
||
is_required
boolean
|
|
Indicates whether or not the field is required (defaults to `true`).
|
||
name
string
|
The name of the configuration field.
|
|||
resource_list
list
/ elements=dictionary
|
A list of resources associated with a specific configuration object.
|
|||
group
string
|
The name of the group to which this field belongs to.
|
|||
name
string
|
The display name of the resource field.
|
|||
type
string
/ required
|
The type of the resource field.
|
|||
value
string
/ required
|
The value of the field.
|
|||
type
string
|
The type of the configuration field.
|
|||
value
string
|
The value of the field.
|
|||
source_id
string
|
The OCID of the source.
Required for create using state=present.
|
|||
state
string
|
|
The state of the Migration.
Use state=present to create or update a Migration.
Use state=absent to delete a Migration.
|
||
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
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create migration
oci_application_migration_migration:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
source_id: "ocid1.source.oc1..xxxxxxEXAMPLExxxxxx"
application_name: application_name_example
discovery_details:
# required
service_instance_user: service_instance_user_example
service_instance_password: example-password
type: OIC
# optional
pre_created_target_database_type: DATABASE_SYSTEM
display_name: display_name_example
description: description_example
is_selective_migration: true
service_config:
# optional
name: name_example
group: group_example
type: type_example
value: value_example
description: description_example
resource_list:
- # required
type: type_example
value: value_example
# optional
name: name_example
group: group_example
is_required: true
is_mutable: true
application_config:
# optional
name: name_example
group: group_example
type: type_example
value: value_example
description: description_example
resource_list:
- # required
type: type_example
value: value_example
# optional
name: name_example
group: group_example
is_required: true
is_mutable: true
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update migration
oci_application_migration_migration:
# required
migration_id: "ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
description: description_example
discovery_details:
# required
service_instance_user: service_instance_user_example
service_instance_password: example-password
type: OIC
is_selective_migration: true
service_config:
# optional
name: name_example
group: group_example
type: type_example
value: value_example
description: description_example
resource_list:
- # required
type: type_example
value: value_example
# optional
name: name_example
group: group_example
is_required: true
is_mutable: true
application_config:
# optional
name: name_example
group: group_example
type: type_example
value: value_example
description: description_example
resource_list:
- # required
type: type_example
value: value_example
# optional
name: name_example
group: group_example
is_required: true
is_mutable: true
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update migration using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_application_migration_migration:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
description: description_example
discovery_details:
# required
service_instance_user: service_instance_user_example
service_instance_password: example-password
type: OIC
is_selective_migration: true
service_config:
# optional
name: name_example
group: group_example
type: type_example
value: value_example
description: description_example
resource_list:
- # required
type: type_example
value: value_example
# optional
name: name_example
group: group_example
is_required: true
is_mutable: true
application_config:
# optional
name: name_example
group: group_example
type: type_example
value: value_example
description: description_example
resource_list:
- # required
type: type_example
value: value_example
# optional
name: name_example
group: group_example
is_required: true
is_mutable: true
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete migration
oci_application_migration_migration:
# required
migration_id: "ocid1.migration.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete migration using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_application_migration_migration:
# 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 | |||
---|---|---|---|---|---|
migration
complex
|
on success |
Details of the Migration resource acted upon by the current operation
Sample:
{'application_config': {'description': 'description_example', 'group': 'group_example', 'is_mutable': True, 'is_required': True, 'name': 'name_example', 'resource_list': [{'group': 'group_example', 'name': 'name_example', 'type': 'type_example', 'value': 'value_example'}], 'type': 'type_example', 'value': 'value_example'}, 'application_name': 'application_name_example', 'application_type': 'JCS', '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', 'is_selective_migration': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'migration_state': 'DISCOVERING_APPLICATION', 'pre_created_target_database_type': 'DATABASE_SYSTEM', 'service_config': {'description': 'description_example', 'group': 'group_example', 'is_mutable': True, 'is_required': True, 'name': 'name_example', 'resource_list': [{'group': 'group_example', 'name': 'name_example', 'type': 'type_example', 'value': 'value_example'}], 'type': 'type_example', 'value': 'value_example'}, 'source_id': 'ocid1.source.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00'}
|
|||
application_config
complex
|
on success |
Configuration required to migrate the application. In addition to the key and value, additional fields are provided to describe type type and purpose of each field. Only the value for each key is required when passing configuration to the CreateMigration operation.
|
|||
description
string
|
on success |
Help text to guide the user in setting the configuration value.
Sample:
description_example
|
|||
group
string
|
on success |
The name of the group to which this field belongs, if any.
Sample:
group_example
|
|||
is_mutable
boolean
|
on success |
Indicates whether or not the field may be modified (defaults to `true`).
Sample:
True
|
|||
is_required
boolean
|
on success |
Indicates whether or not the field is required (defaults to `true`).
Sample:
True
|
|||
name
string
|
on success |
The name of the configuration field.
Sample:
name_example
|
|||
resource_list
complex
|
on success |
A list of resources associated with a specific configuration object.
|
|||
group
string
|
on success |
The name of the group to which this field belongs to.
Sample:
group_example
|
|||
name
string
|
on success |
The display name of the resource field.
Sample:
name_example
|
|||
type
string
|
on success |
The type of the resource field.
Sample:
type_example
|
|||
value
string
|
on success |
The value of the field.
Sample:
value_example
|
|||
type
string
|
on success |
The type of the configuration field.
Sample:
type_example
|
|||
value
string
|
on success |
The value of the field.
Sample:
value_example
|
|||
application_name
string
|
on success |
Name of the application which is being migrated. This is the name of the application in the source environment.
Sample:
application_name_example
|
|||
application_type
string
|
on success |
The type of application being migrated.
Sample:
JCS
|
|||
compartment_id
string
|
on success |
The OCID of the compartment that contains the migration.
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 migration.
Sample:
description_example
|
|||
display_name
string
|
on success |
User-friendly name of the migration.
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.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||
is_selective_migration
boolean
|
on success |
If set to `true`, Application Migration migrates only the application resources that you specify. If set to `false`, Application Migration migrates the entire application. When you migrate the entire application, all the application resources are migrated to the target environment. You can selectively migrate resources only for the Oracle Integration Cloud and Oracle Integration Cloud Service applications.
Sample:
True
|
|||
lifecycle_details
string
|
on success |
Details about the current lifecycle state of the migration.
Sample:
lifecycle_details_example
|
|||
lifecycle_state
string
|
on success |
The current state of the migration.
Sample:
CREATING
|
|||
migration_state
string
|
on success |
The current state of the overall migration process.
Sample:
DISCOVERING_APPLICATION
|
|||
pre_created_target_database_type
string
|
on success |
The pre-existing database type to be used in this migration. Currently, Application migration only supports Oracle Cloud Infrastructure databases and this option is currently available only for `JAVA_CLOUD_SERVICE` and `WEBLOGIC_CLOUD_SERVICE` target instance types.
Sample:
DATABASE_SYSTEM
|
|||
service_config
complex
|
on success |
Configuration required to migrate the application. In addition to the key and value, additional fields are provided to describe type type and purpose of each field. Only the value for each key is required when passing configuration to the CreateMigration operation.
|
|||
description
string
|
on success |
Help text to guide the user in setting the configuration value.
Sample:
description_example
|
|||
group
string
|
on success |
The name of the group to which this field belongs, if any.
Sample:
group_example
|
|||
is_mutable
boolean
|
on success |
Indicates whether or not the field may be modified (defaults to `true`).
Sample:
True
|
|||
is_required
boolean
|
on success |
Indicates whether or not the field is required (defaults to `true`).
Sample:
True
|
|||
name
string
|
on success |
The name of the configuration field.
Sample:
name_example
|
|||
resource_list
complex
|
on success |
A list of resources associated with a specific configuration object.
|
|||
group
string
|
on success |
The name of the group to which this field belongs to.
Sample:
group_example
|
|||
name
string
|
on success |
The display name of the resource field.
Sample:
name_example
|
|||
type
string
|
on success |
The type of the resource field.
Sample:
type_example
|
|||
value
string
|
on success |
The value of the field.
Sample:
value_example
|
|||
type
string
|
on success |
The type of the configuration field.
Sample:
type_example
|
|||
value
string
|
on success |
The value of the field.
Sample:
value_example
|
|||
source_id
string
|
on success |
The OCID of the source with which this migration is associated.
Sample:
ocid1.source.oc1..xxxxxxEXAMPLExxxxxx
|
|||
time_created
string
|
on success |
The date and time at which the migration was created, in the format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)