NSX-T Data Center REST API

Update migration plan settings for the component

Update the migration plan settings for the component.

Request:

Method:

PUT

URI Path(s):

/api/v1/migration/plan/<component_type>/settings

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

MigrationPlanSettings+

MigrationPlanSettings (schema)

Name	Description	Type	Notes
parallel	Migration Method to specify whether the migration is to be performed serially or in parallel	boolean	Default: "True"
pause_after_each_group	Flag to indicate whether to pause the migration after migration of each group is completed	boolean	Default: "False"
pause_on_error	Flag to indicate whether to pause the migration plan execution when an error occurs	boolean	Default: "False"

Example Request:

PUT https://<nsx-mgr>/api/v1/migration/plan/HOST/settings { "parallel" : "false", "pause_on_error" : "true", "pause_after_each_group" : "false" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

MigrationPlanSettings+

MigrationPlanSettings (schema)

Name	Description	Type	Notes
parallel	Migration Method to specify whether the migration is to be performed serially or in parallel	boolean	Default: "True"
pause_after_each_group	Flag to indicate whether to pause the migration after migration of each group is completed	boolean	Default: "False"
pause_on_error	Flag to indicate whether to pause the migration plan execution when an error occurs	boolean	Default: "False"

Example Response:

{ "parallel" : "false", "pause_on_error" : "true", "pause_after_each_group" : "false" }

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