System Administration > Lifecycle Management > Migration > Plan

Associated URIs:

API Description API Path

Mark completion of a migration cycle


This API marks the completion of one execution of migration workflow. This API resets internal
execution state and hence needs to be invoked before starting subsequent workflow run.
POST /api/v1/migration/plan?action=finish

Start migration


Start the migration. Migration will start as per the migration plan.
POST /api/v1/migration/plan?action=start

Pause migration


Pause the migration. Migration will be paused after migration of all
the nodes currently in progress is completed either successfully
or with failure. User can make changes in the migration plan when
the migration is paused.
POST /api/v1/migration/plan?action=pause

Abort migration


Resets all migration steps done so far, so that migration can be restarted
with new setup details.
POST /api/v1/migration/plan?action=abort

Continue migration


Continue the migration. Resumes the migration from the point where
it was paused.
POST /api/v1/migration/plan?action=continue

Reset migration plan to default plan


Reset the migration plan to default plan. User has an option to change
the default plan. But if after making changes, user wants to go
back to the default plan, this is the way to do so.
POST /api/v1/migration/plan?action=reset

Rollbabck migration


Roll back the migration. Changes applied to target NSX will be reverted.
Use the migration status API to monitor progress of roll back.
POST /api/v1/migration/plan?action=rollback

Get migration plan settings for the component


Get the migration plan settings for the component.
GET /api/v1/migration/plan/<component_type>/settings

Update migration plan settings for the component


Update the migration plan settings for the component.
PUT /api/v1/migration/plan/<component_type>/settings