NSX-T Data Center REST API

Associated URIs:

API Description API Path

List migrated resources


List migrated resources.This API is applicable for mp2Policy migration mode only.
GET /api/v1/migration/migrated-resources

This api is used to get mp policy promotion history. The history contains details about date and time of different promotion operations like INITIATED, CANCELLED, SUCCESS.


This api is used to get migration history.
GET /api/v1/migration/mp-policy-promotion/history

This api is used to get mp policy promotion state.


This api is used to get promotion state.
GET /api/v1/migration/mp-policy-promotion/state

This will trigger the migration from mp to policy.


This will trigger the migration from mp to policy
POST /api/v1/migration/mp-to-policy

Cancel migration


This will cancel the on-going promotion and system will be restored to original state
as before promotion.
POST /api/v1/migration/mp-to-policy/cancel

To get MP2Policy promotion feedback.


To get MP2Policy promotion feedback.
This gives all the validation errors or failures during PRECHECK / APPLY phase.
GET /api/v1/migration/mp-to-policy/feedback

To get MP2Policy promotion stats.


To get MP2Policy promotion stats.
This gives detailed information about promotion progess per resource type
like what's the promotion status, how many resources has been promoted etc.
GET /api/v1/migration/mp-to-policy/stats

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

Update migration-state of federation site


This API updates the migration-state of host groups which are part of
provided federation site/s.
POST /api/v1/migration/plan?action=update_site_migration_state

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

Get migration-state of all the federation sites.


This API returns the migration-state of all the federation sites.
GET /api/v1/migration/plan/site-migration-state