| API Description | API Path |
|---|---|
Perform steps required to finalize the infra.Perform steps that are required to finalize the infra such as remove the temporary security groups, remove other objects created temporarily for the migration. |
POST /api/v1/migration?action=finalize_infra
|
Get Migration Data Info.Get information about the requested Migration Data file. |
GET /api/v1/migration/data
|
Download migration dataDownload the data needed for migration. The call returns after Download is completed. |
GET /api/v1/migration/data/download
|
Upload migration dataUpload the data needed for migration. The call returns after upload is completed. |
POST /api/v1/migration/data/upload
|
Get the list of discovered switches (DVS, VSS)Get the list of discovered switches (DVS, VSS) for the selected VC. |
GET /api/v1/migration/discovered-switches
|
NSX-V feedback detailsGet feedback details of NSX-V to be migrated. |
GET /api/v1/migration/feedback-requests
|
Accept default action for feedbacksPick default resolution for all feedback items. |
POST /api/v1/migration/feedback-response?action=accept-recommended
|
Migration feedback responseProvide response for feedback queries needed for migration. |
PUT /api/v1/migration/feedback-response
|
Feedback request summaryGet feedback summary of NSX-V to be migrated. |
GET /api/v1/migration/feedback-summary
|
NSX-V feedback detailsGet feedback details of NSX-V to be migrated, grouped by feedback type. |
GET /api/v1/migration/grouped-feedback-requests
|
Get migration stats for logical constructs phaseGet migration stats for logical constructs phase. This API can be polled for getting runtime progress of the migration from source to target. |
GET /api/v1/migration/logical-constructs/stats
|
Get the list of migrated switches (DVS, VSS)Get the list of migrated switches (DVS, VSS) for the selected VC. |
GET /api/v1/migration/migrated-switches
|
Return information of all migration unit groupsReturn information of all migration unit groups in the migration plan. If request parameter summary is set to true, then only count of migration units will be returned, migration units list will be empty. If request parameter component type is specified, then all migration unit groups for that component will be returned. |
GET /api/v1/migration/migration-unit-groups
|
Create a groupCreate a group of migration units. |
POST /api/v1/migration/migration-unit-groups
|
Get migration status for migration unit groupsGet migration status for migration unit groups |
GET /api/v1/migration/migration-unit-groups-status
|
Delete the migration unit groupDelete the specified group. NOTE - A group can be deleted only if it is empty. If user tries to delete a group containing one or more migration units, the operation will fail and an error will be returned. |
DELETE /api/v1/migration/migration-unit-groups/<group-id>
|
Return migration unit group informationReturns information about a specific migration unit group in the migration plan. If request parameter summary is set to true, then only count of migration units will be returned, migration units list will be empty. |
GET /api/v1/migration/migration-unit-groups/<group-id>
|
Add migration units to specified migration unit groupAdd migration units to specified migration unit group. The migration units will be added at the end of the migration unit list. |
POST /api/v1/migration/migration-unit-groups/<group-id>?action=add_migration_units
|
Reorder migration unit groupReorder an migration unit group by placing it before/after the specified migration unit group. |
POST /api/v1/migration/migration-unit-groups/<group-id>?action=reorder
|
Update the migration unit groupUpdate the specified migration unit group. Removal of migration units from the group using this is not allowed. An error will be returned in that case. |
PUT /api/v1/migration/migration-unit-groups/<group-id>
|
Reorder an migration unit within the migration unit groupReorder an migration unit within the migration unit group by placing it before/after the specified migration unit |
POST /api/v1/migration/migration-unit-groups/<group-id>/migration-unit/<migration-unit-id>?action=reorder
|
Get migration status for groupGet migration status for migration units in the specified group. User can specify whether to show only the migration units with errors. |
GET /api/v1/migration/migration-unit-groups/<group-id>/status
|
Return aggregate information of all migration unit groupsReturn information of all migration unit groups in the migration plan. If request parameter summary is set to true, then only count of migration units will be returned, migration units list will be empty. If request parameter component type is specified, then all migration unit groups for that component will be returned. |
GET /api/v1/migration/migration-unit-groups/aggregate-info
|
Get migration unitsGet migration units |
GET /api/v1/migration/migration-units
|
Get migration units statsGet migration units stats |
GET /api/v1/migration/migration-units-stats
|
Get a specific migration unitGet a specific migration unit |
GET /api/v1/migration/migration-units/<migration-unit-id>
|
Get migration units aggregate-infoGet migration units aggregate-info |
GET /api/v1/migration/migration-units/aggregate-info
|
Get list of nodes across all typesGet list of nodes. If request parameter component type is specified, then all nodes for that component will be returned. If request parameter component version is specified, then all nodes at that version will be returned. |
GET /api/v1/migration/nodes
|
Get summary of nodesGet summary of nodes, which includes node count for each type and component version. |
GET /api/v1/migration/nodes-summary
|
Mark completion of a migration cycleThis 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 migrationStart the migration. Migration will start as per the migration plan. |
POST /api/v1/migration/plan?action=start
|
Pause migrationPause 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 migrationResets all migration steps done so far, so that migration can be restarted with new setup details. |
POST /api/v1/migration/plan?action=abort
|
Continue migrationContinue the migration. Resumes the migration from the point where it was paused. |
POST /api/v1/migration/plan?action=continue
|
Reset migration plan to default planReset 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 migrationRoll 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 componentGet the migration plan settings for the component. |
GET /api/v1/migration/plan/<component_type>/settings
|
Update migration plan settings for the componentUpdate the migration plan settings for the component. |
PUT /api/v1/migration/plan/<component_type>/settings
|
NSX-V setup detailsGet setup details of NSX-V to be migrated. |
GET /api/v1/migration/setup
|
NSX-V setup detailsProvide setup details of NSX-V to be migrated. |
PUT /api/v1/migration/setup
|
Get migration status summaryGet migration status summary |
GET /api/v1/migration/status-summary
|
Get migration summaryGet migration summary |
GET /api/v1/migration/summary
|
Get the switch set as current scope for migrationThe user is returned the switch (DVS/VSS) set as current scope of migration. |
GET /api/v1/migration/switch
|
Set the switch as current scope for migrationThe user specifies a DVS / VSS as the current scope of migration. |
PUT /api/v1/migration/switch
|
Perform steps required before migrating a VM group.For each VM group, the following three high level steps are performed in sequence. 1. Call pre VM group migrate API. 2. Migrate (by vmotion,in place, etc.,) VMs in the VM group. This step will be done by user independent of MC. 3. Call post VM group migrate API with the same VM group id used in the pre VM group migrate API. This API specifically deals with pre VM group migrate API. When pre VM group migrate API is invoked for a VM group id, MC performs following actions. - Checks segmentation realization state. - Creates segment ports. - Creates temporary security groups. |
POST /api/v1/migration/vmgroup?action=pre_migrate
|
Perform steps required after migrating a VM group.For each VM group, the following three high level steps are performed in sequence. 1. Call pre VM group migrate API. 2. Migrate (by vmotion,in place, etc.,) VMs in the VM group. This step will be done by user independent of MC. 3. Call post VM group migrate API with the same VM group id used in the pre VM group migrate API. This API specifically deals with post VM group migrate API. When post VM group migrate API is invoked for a VM group id, MC performs following actions. - Add security tags on the VMs migrated. For the VMs mentioned in the failed VM instance uuids, this operation is skipped. |
POST /api/v1/migration/vmgroup?action=post_migrate
|