Cloud Migrations Functions

Package: DBMS_CLOUD_OCI_CM_MIGRATION

CANCEL_WORK_REQUEST Function

Cancels work request with the given ID.

Syntax

FUNCTION cancel_work_request (
  work_request_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_cancel_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MIGRATION_COMPARTMENT Function

Moves a migration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_migration_compartment (
  migration_id varchar2,
  change_migration_compartment_details dbms_cloud_oci_cloud_migrations_change_migration_compartment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_change_migration_compartment_response_t;

Parameters

Parameter	Description
`migration_id`	(required) Unique migration identifier
`change_migration_compartment_details`	(required) The information to be updated.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_MIGRATION_PLAN_COMPARTMENT Function

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_migration_plan_compartment (
  migration_plan_id varchar2,
  change_migration_plan_compartment_details dbms_cloud_oci_cloud_migrations_change_migration_plan_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_change_migration_plan_compartment_response_t;

Parameters

Parameter	Description
`migration_plan_id`	(required) Unique migration plan identifier
`change_migration_plan_compartment_details`	(required) Details for the compartment move.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_REPLICATION_SCHEDULE_COMPARTMENT Function

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_replication_schedule_compartment (
  replication_schedule_id varchar2,
  change_replication_schedule_compartment_details dbms_cloud_oci_cloud_migrations_change_replication_schedule_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_change_replication_schedule_compartment_response_t;

Parameters

Parameter	Description
`replication_schedule_id`	(required) Unique replication schedule identifier in path
`change_replication_schedule_compartment_details`	(required) Details for the compartment move.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MIGRATION Function

Creates a migration.

Syntax

FUNCTION create_migration (
  create_migration_details dbms_cloud_oci_cloud_migrations_create_migration_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_create_migration_response_t;

Parameters

Parameter	Description
`create_migration_details`	(required) Details for the new migration.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MIGRATION_ASSET Function

Creates a migration asset.

Syntax

FUNCTION create_migration_asset (
  create_migration_asset_details dbms_cloud_oci_cloud_migrations_create_migration_asset_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_create_migration_asset_response_t;

Parameters

Parameter	Description
`create_migration_asset_details`	(required) Details for the new migration asset.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_MIGRATION_PLAN Function

Creates a migration plan.

Syntax

FUNCTION create_migration_plan (
  create_migration_plan_details dbms_cloud_oci_cloud_migrations_create_migration_plan_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_create_migration_plan_response_t;

Parameters

Parameter	Description
`create_migration_plan_details`	(required) Details for the new migration plan.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_REPLICATION_SCHEDULE Function

Creates a replication schedule.

Syntax

FUNCTION create_replication_schedule (
  create_replication_schedule_details dbms_cloud_oci_cloud_migrations_create_replication_schedule_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_create_replication_schedule_response_t;

Parameters

Parameter	Description
`create_replication_schedule_details`	(required) Details for the new replication schedule.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_TARGET_ASSET Function

Creates a target asset.

Syntax

FUNCTION create_target_asset (
  create_target_asset_details dbms_cloud_oci_cloud_migrations_create_target_asset_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_create_target_asset_response_t;

Parameters

Parameter	Description
`create_target_asset_details`	(required) Details for the new target asset.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MIGRATION Function

Deletes a migration resource by identifier.

Syntax

FUNCTION delete_migration (
  migration_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_delete_migration_response_t;

Parameters

Parameter	Description
`migration_id`	(required) Unique migration identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MIGRATION_ASSET Function

Deletes a migration asset resource by an identifier.

Syntax

FUNCTION delete_migration_asset (
  migration_asset_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_delete_migration_asset_response_t;

Parameters

Parameter	Description
`migration_asset_id`	(required) Unique migration asset identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_MIGRATION_PLAN Function

Deletes a migration plan resource by an identifier.

Syntax

FUNCTION delete_migration_plan (
  migration_plan_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_delete_migration_plan_response_t;

Parameters

Parameter	Description
`migration_plan_id`	(required) Unique migration plan identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_REPLICATION_SCHEDULE Function

Deletes a replication schedule resource by identifier.

Syntax

FUNCTION delete_replication_schedule (
  replication_schedule_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_delete_replication_schedule_response_t;

Parameters

Parameter	Description
`replication_schedule_id`	(required) Unique replication schedule identifier in path
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_TARGET_ASSET Function

Deletes a target asset resource by identifier.

Syntax

FUNCTION delete_target_asset (
  target_asset_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_delete_target_asset_response_t;

Parameters

Parameter	Description
`target_asset_id`	(required) Unique target asset identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

EXECUTE_MIGRATION_PLAN Function

Executes the migration plan with the migration plan ID.

Syntax

FUNCTION execute_migration_plan (
  migration_plan_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_execute_migration_plan_response_t;

Parameters

Parameter	Description
`migration_plan_id`	(required) Unique migration plan identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

EXPORT_MIGRATION_PLAN Function

Exports the migration plan to a csv file.

Syntax

FUNCTION export_migration_plan (
  migration_plan_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_export_migration_plan_response_t;

Parameters

Parameter	Description
`migration_plan_id`	(required) Unique migration plan identifier
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MIGRATION Function

Gets a migration by identifier.

Syntax

FUNCTION get_migration (
  migration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_get_migration_response_t;

Parameters

Parameter	Description
`migration_id`	(required) Unique migration identifier
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MIGRATION_ASSET Function

Gets a migration asset by identifier.

Syntax

FUNCTION get_migration_asset (
  migration_asset_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_get_migration_asset_response_t;

Parameters

Parameter	Description
`migration_asset_id`	(required) Unique migration asset identifier
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MIGRATION_PLAN Function

Gets a migration plan by identifier.

Syntax

FUNCTION get_migration_plan (
  migration_plan_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_get_migration_plan_response_t;

Parameters

Parameter	Description
`migration_plan_id`	(required) Unique migration plan identifier
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REPLICATION_PROGRESS Function

Gets the progress percentage of a migration asset's replication process.

Syntax

FUNCTION get_replication_progress (
  migration_asset_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_get_replication_progress_response_t;

Parameters

Parameter	Description
`migration_asset_id`	(required) Unique migration asset identifier
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REPLICATION_SCHEDULE Function

Gets a replication schedule by identifier.

Syntax

FUNCTION get_replication_schedule (
  replication_schedule_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_get_replication_schedule_response_t;

Parameters

Parameter	Description
`replication_schedule_id`	(required) Unique replication schedule identifier in path
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TARGET_ASSET Function

Gets a target asset by identifier.

Syntax

FUNCTION get_target_asset (
  target_asset_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_get_target_asset_response_t;

Parameters

Parameter	Description
`target_asset_id`	(required) Unique target asset identifier
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Gets the status of the work request with the given ID.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

IMPORT_MIGRATION_PLAN Function

Imports a migration plan from a csv file.

Syntax

FUNCTION import_migration_plan (
  migration_plan_id varchar2,
  import_migration_plan_details blob,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_import_migration_plan_response_t;

Parameters

Parameter	Description
`migration_plan_id`	(required) Unique migration plan identifier
`import_migration_plan_details`	(required) The csv file to be uploaded.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_AVAILABLE_SHAPES Function

List of shapes by parameters.

Syntax

FUNCTION list_available_shapes (
  migration_plan_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  dvh_host_id varchar2 DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  reserved_capacity_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_list_available_shapes_response_t;

Parameters

Parameter	Description
`migration_plan_id`	(required) Unique migration plan identifier
`compartment_id`	(optional) The ID of the compartment in which to list resources.
`dvh_host_id`	(optional) The ID of the Dvh in which to list resources.
`availability_domain`	(optional) The availability domain in which to list resources.
`reserved_capacity_id`	(optional) The reserved capacity ID for which to list resources.
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending. Allowed values are: 'timeCreated', 'displayName'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MIGRATION_ASSETS Function

Returns a list of migration assets.

Syntax

FUNCTION list_migration_assets (
  migration_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  migration_asset_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_list_migration_assets_response_t;

Parameters

Parameter	Description
`migration_id`	(optional) Unique migration identifier
`display_name`	(optional) A filter to return only resources that match the entire given display name.
`migration_asset_id`	(optional) Unique migration asset identifier
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response.
`lifecycle_state`	(optional) The current state of the migration asset.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MIGRATION_PLANS Function

Returns a list of migration plans.

Syntax

FUNCTION list_migration_plans (
  compartment_id varchar2 DEFAULT NULL,
  migration_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  migration_plan_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_list_migration_plans_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The ID of the compartment in which to list resources.
`migration_id`	(optional) Unique migration identifier
`display_name`	(optional) A filter to return only resources that match the entire given display name.
`migration_plan_id`	(optional) Unique migration plan identifier
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response.
`lifecycle_state`	(optional) The current state of the migration plan.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MIGRATIONS Function

Returns a list of migrations.

Syntax

FUNCTION list_migrations (
  compartment_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  migration_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_list_migrations_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The ID of the compartment in which to list resources.
`lifecycle_state`	(optional) A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.
`display_name`	(optional) A filter to return only resources that match the entire given display name.
`migration_id`	(optional) Unique migration identifier
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REPLICATION_SCHEDULES Function

Returns a list of replication schedules.

Syntax

FUNCTION list_replication_schedules (
  compartment_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  replication_schedule_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_list_replication_schedules_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The ID of the compartment in which to list resources.
`lifecycle_state`	(optional) The current state of the replication schedule.
`display_name`	(optional) A filter to return only resources that match the entire given display name.
`replication_schedule_id`	(optional) Unique replication schedule identifier in query
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TARGET_ASSETS Function

Returns a list of target assets.

Syntax

FUNCTION list_target_assets (
  migration_plan_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  target_asset_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_list_target_assets_response_t;

Parameters

Parameter	Description
`migration_plan_id`	(optional) Unique migration plan identifier
`display_name`	(optional) A filter to return only resources that match the entire given display name.
`target_asset_id`	(optional) Unique target asset identifier
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response.
`lifecycle_state`	(optional) The current state of the target asset.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order can be provided. The default order for 'timeCreated' is descending. The default order for 'displayName' is ascending. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Returns a paginated list of errors for a given work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order for 'timeAccepted' is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Returns a paginated list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response.
`limit`	(optional) The maximum number of items to return.
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order for 'timeAccepted' is descending. Allowed values are: 'timeAccepted'
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

List of work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2 DEFAULT NULL,
  work_request_id varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  operation_type varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The ID of the compartment in which to list resources.
`work_request_id`	(optional) The ID of the asynchronous work request.
`status`	(optional) A filter to return only resources where the resource's lifecycle state matches the given operation status. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'WAITING', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED', 'NEEDS_ATTENTION'
`operation_type`	(optional) A filter to return only resources where the resource's lifecycle state matches the given operation type. Allowed values are: 'CREATE_MIGRATION', 'UPDATE_MIGRATION', 'REFRESH_MIGRATION', 'DELETE_MIGRATION', 'MOVE_MIGRATION', 'START_ASSET_REPLICATION', 'START_MIGRATION_REPLICATION', 'CREATE_REPLICATION_SCHEDULE', 'UPDATE_REPLICATION_SCHEDULE', 'DELETE_REPLICATION_SCHEDULE', 'MOVE_REPLICATION_SCHEDULE', 'CREATE_MIGRATION_PLAN', 'UPDATE_MIGRATION_PLAN', 'DELETE_MIGRATION_PLAN', 'MOVE_MIGRATION_PLAN', 'REFRESH_MIGRATION_PLAN', 'EXECUTE_MIGRATION_PLAN', 'REFRESH_MIGRATION_ASSET', 'CREATE_MIGRATION_ASSET', 'DELETE_MIGRATION_ASSET', 'CREATE_TARGET_ASSET', 'UPDATE_TARGET_ASSET', 'DELETE_TARGET_ASSET'
`resource_id`	(optional) The ID of the resource affected by the work request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of the previous response.
`limit`	(optional) The maximum number of items to return.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order for 'timeAccepted' is descending. Allowed values are: 'timeAccepted'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REFRESH_MIGRATION Function

Refreshes migration based on the migration ID.

Syntax

FUNCTION refresh_migration (
  migration_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_refresh_migration_response_t;

Parameters

Parameter	Description
`migration_id`	(required) Unique migration identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REFRESH_MIGRATION_ASSET Function

Refreshes the migration asset with the migration asset ID.

Syntax

FUNCTION refresh_migration_asset (
  migration_asset_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_refresh_migration_asset_response_t;

Parameters

Parameter	Description
`migration_asset_id`	(required) Unique migration asset identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REFRESH_MIGRATION_PLAN Function

Refreshes the migration plan with the migration plan ID.

Syntax

FUNCTION refresh_migration_plan (
  migration_plan_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_refresh_migration_plan_response_t;

Parameters

Parameter	Description
`migration_plan_id`	(required) Unique migration plan identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

START_ASSET_REPLICATION Function

Starts replication for the asset with the migration asset ID.

Syntax

FUNCTION start_asset_replication (
  migration_asset_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_start_asset_replication_response_t;

Parameters

Parameter	Description
`migration_asset_id`	(required) Unique migration asset identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

START_MIGRATION_REPLICATION Function

Starts replication for a migration or for some asset.

Syntax

FUNCTION start_migration_replication (
  migration_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_start_migration_replication_response_t;

Parameters

Parameter	Description
`migration_id`	(required) Unique migration identifier
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MIGRATION Function

Updates the migration.

Syntax

FUNCTION update_migration (
  migration_id varchar2,
  update_migration_details dbms_cloud_oci_cloud_migrations_update_migration_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_update_migration_response_t;

Parameters

Parameter	Description
`migration_id`	(required) Unique migration identifier
`update_migration_details`	(required) The information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MIGRATION_ASSET Function

Updates the migration asset.

Syntax

FUNCTION update_migration_asset (
  migration_asset_id varchar2,
  update_migration_asset_details dbms_cloud_oci_cloud_migrations_update_migration_asset_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_update_migration_asset_response_t;

Parameters

Parameter	Description
`migration_asset_id`	(required) Unique migration asset identifier
`update_migration_asset_details`	(required) The information to be updated.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_MIGRATION_PLAN Function

Updates the migration plan.

Syntax

FUNCTION update_migration_plan (
  migration_plan_id varchar2,
  update_migration_plan_details dbms_cloud_oci_cloud_migrations_update_migration_plan_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_update_migration_plan_response_t;

Parameters

Parameter	Description
`migration_plan_id`	(required) Unique migration plan identifier
`update_migration_plan_details`	(required) The information to be updated.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_REPLICATION_SCHEDULE Function

Updates the replication schedule.

Syntax

FUNCTION update_replication_schedule (
  replication_schedule_id varchar2,
  update_replication_schedule_details dbms_cloud_oci_cloud_migrations_update_replication_schedule_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_update_replication_schedule_response_t;

Parameters

Parameter	Description
`replication_schedule_id`	(required) Unique replication schedule identifier in path
`update_replication_schedule_details`	(required) The information to be updated.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TARGET_ASSET Function

Updates the target asset.

Syntax

FUNCTION update_target_asset (
  target_asset_id varchar2,
  update_target_asset_details dbms_cloud_oci_cloud_migrations_update_target_asset_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cm_migration_update_target_asset_response_t;

Parameters

Parameter	Description
`target_asset_id`	(required) Unique target asset identifier
`update_target_asset_details`	(required) The information to be updated.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before that due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://cloudmigration.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CANCEL_WORK_REQUEST Function 🔗

CHANGE_MIGRATION_COMPARTMENT Function 🔗

CHANGE_MIGRATION_PLAN_COMPARTMENT Function 🔗

CHANGE_REPLICATION_SCHEDULE_COMPARTMENT Function 🔗

CREATE_MIGRATION Function 🔗

CREATE_MIGRATION_ASSET Function 🔗

CREATE_MIGRATION_PLAN Function 🔗

CREATE_REPLICATION_SCHEDULE Function 🔗

CREATE_TARGET_ASSET Function 🔗

DELETE_MIGRATION Function 🔗

DELETE_MIGRATION_ASSET Function 🔗

DELETE_MIGRATION_PLAN Function 🔗

DELETE_REPLICATION_SCHEDULE Function 🔗

DELETE_TARGET_ASSET Function 🔗

EXECUTE_MIGRATION_PLAN Function 🔗

EXPORT_MIGRATION_PLAN Function 🔗

GET_MIGRATION Function 🔗

GET_MIGRATION_ASSET Function 🔗

GET_MIGRATION_PLAN Function 🔗

GET_REPLICATION_PROGRESS Function 🔗

GET_REPLICATION_SCHEDULE Function 🔗

GET_TARGET_ASSET Function 🔗

GET_WORK_REQUEST Function 🔗

IMPORT_MIGRATION_PLAN Function 🔗

LIST_AVAILABLE_SHAPES Function 🔗

LIST_MIGRATION_ASSETS Function 🔗

LIST_MIGRATION_PLANS Function 🔗

LIST_MIGRATIONS Function 🔗

LIST_REPLICATION_SCHEDULES Function 🔗

LIST_TARGET_ASSETS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

REFRESH_MIGRATION Function 🔗

REFRESH_MIGRATION_ASSET Function 🔗

REFRESH_MIGRATION_PLAN Function 🔗

START_ASSET_REPLICATION Function 🔗

START_MIGRATION_REPLICATION Function 🔗

UPDATE_MIGRATION Function 🔗

UPDATE_MIGRATION_ASSET Function 🔗

UPDATE_MIGRATION_PLAN Function 🔗

UPDATE_REPLICATION_SCHEDULE Function 🔗

UPDATE_TARGET_ASSET Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CANCEL_WORK_REQUEST Function

CHANGE_MIGRATION_COMPARTMENT Function

CHANGE_MIGRATION_PLAN_COMPARTMENT Function

CHANGE_REPLICATION_SCHEDULE_COMPARTMENT Function

CREATE_MIGRATION Function

CREATE_MIGRATION_ASSET Function

CREATE_MIGRATION_PLAN Function

CREATE_REPLICATION_SCHEDULE Function

CREATE_TARGET_ASSET Function

DELETE_MIGRATION Function

DELETE_MIGRATION_ASSET Function

DELETE_MIGRATION_PLAN Function

DELETE_REPLICATION_SCHEDULE Function

DELETE_TARGET_ASSET Function

EXECUTE_MIGRATION_PLAN Function

EXPORT_MIGRATION_PLAN Function

GET_MIGRATION Function

GET_MIGRATION_ASSET Function

GET_MIGRATION_PLAN Function

GET_REPLICATION_PROGRESS Function

GET_REPLICATION_SCHEDULE Function

GET_TARGET_ASSET Function

GET_WORK_REQUEST Function

IMPORT_MIGRATION_PLAN Function

LIST_AVAILABLE_SHAPES Function

LIST_MIGRATION_ASSETS Function

LIST_MIGRATION_PLANS Function

LIST_MIGRATIONS Function

LIST_REPLICATION_SCHEDULES Function

LIST_TARGET_ASSETS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

REFRESH_MIGRATION Function

REFRESH_MIGRATION_ASSET Function

REFRESH_MIGRATION_PLAN Function

START_ASSET_REPLICATION Function

START_MIGRATION_REPLICATION Function

UPDATE_MIGRATION Function

UPDATE_MIGRATION_ASSET Function

UPDATE_MIGRATION_PLAN Function

UPDATE_REPLICATION_SCHEDULE Function

UPDATE_TARGET_ASSET Function