NSX-T Data Center REST API

Start workflow.

Start workflow.

Request:

Method:

POST

URI Path(s):

/api/v1/migration/overlay-adoption/vcenters/{vcenter-id}/workflow/action/start

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

StartWorkflowInput+

StartWorkflowInput (schema)

Name	Description	Type	Notes
workflow_spec	Workflow spec Workflow spec.	WorkflowSpec (Abstract type: pass one of the following concrete types) CollectConfigWorkflowSpec DisconnectBridgeWorkflowSpec ExtendDvpgWorkflowSpec MigrateGatewayWorkflowSpec MigrateVmsWorkflowSpec
workflow_type	Workflow type Workflow type.	WorkflowType	Required

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DvpgAndSegmentWorkflowResource+

DvpgAndSegmentWorkflowResource (schema)

Name	Description	Type	Notes
dvpg_id	DVPG ID DVPG ID.	string	Required
segment_path	Segment path Segment path.	string	Required
type	Must be set to the value DvpgAndSegmentWorkflowResource	WorkflowResourceType	Required

DvpgWorkflowResource+

DvpgWorkflowResource (schema)

Name	Description	Type	Notes
dvpg_id	DVPG Id DVPG Id.	string	Required
type	Must be set to the value DvpgWorkflowResource	WorkflowResourceType	Required

SegmentAndBridgeProfileWorkflowResource+

SegmentAndBridgeProfileWorkflowResource (schema)

Name	Description	Type	Notes
bridge_profile_path	Bridge profile path Bridge profile path.	string	Required
segment_path	Segment path Segment path.	string	Required
type	Must be set to the value SegmentAndBridgeProfileWorkflowResource	WorkflowResourceType	Required

SegmentWorkflowResource+

SegmentWorkflowResource (schema)

Name	Description	Type	Notes
segment_path	Segment path Segment path.	string	Required
type	Must be set to the value SegmentWorkflowResource	WorkflowResourceType	Required

VcWorkflowResource+

VcWorkflowResource (schema)

Name	Description	Type	Notes
type	Must be set to the value VcWorkflowResource	WorkflowResourceType	Required
vcenter_id	vCenter ID vCenter ID.	string	Required

VmGroupWorkflowResource+

VmGroupWorkflowResource (schema)

Name	Description	Type	Notes
type	Must be set to the value VmGroupWorkflowResource	WorkflowResourceType	Required
vm_group_id	VM group ID VM group ID.	string	Required

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