NSX-T Data Center REST API

Add vCenter to scope of migration

Add vCenter to scope of migration. Migration operations can be performed on vCenter only if it is added to
scope of migration. At any given point of time, only one vCenter can be present in the migration scope list,
which means migration operations can be performed only on one vCenter at a time. Invoking this API with a new
valid vCenter ID will remove previous one from the migration scope and add the new one to migration scope. For a
vCenter to be added to scope of migration, it has to satisfy following conditions.
1. vCenter should have been registered as a compute manager with NSX.
2. User should have provided vCenter username and password details via UI or API in the overlay adoption tool.

Request:

Method:

PUT

URI Path(s):

/api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/add_to_migration_scope

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

Vcenter+

Vcenter (schema)

Name	Description	Type	Notes
id	vCenter ID ID of the vCenter compute manager in NSX.	string	Required Readonly
ip	vCenter ip address or fqdn Ip address or fqdn of vCenter compute manager in NSX.	string	Readonly
is_vcenter_password_empty	Flag to indicate whether vCenter password is empty Flag to indicate whether vCenter password stored in overlay adoption migration tool is empty. This value can become empty if the migration co-ordinator service is re-started. In this case, vCenter username/password details will need to be provided again to the overlay adoption migration tool.	boolean	Required Readonly
name	vCenter name vCenter name.	string	Readonly
port	vCenter port vCenter port that will be used to fetch details.	string	Readonly
username	vCenter username Username for connecting to vCenter.	string	Readonly

Required Permissions:

crud

Feature:

utilities_upgrade

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable