Execute upgrade task

Execute upgrade task.

Request:

Method:

POST

URI Path(s):

/api/v1/node/upgrade/performtask
/api/v1/transport-nodes/<transport-node-id>/node/upgrade/performtask
/api/v1/cluster/<cluster-node-id>/node/upgrade/performtask

Request Headers:

n/a

Query Parameters:

UpgradeTaskActionParameters+

Name	Description	Type	Notes
action	Upgrade task The upgrade task to perform.	string	Pattern: "^[^/]+$"

Request Body:

UpgradeTaskProperties+

Name	Description	Type	Notes
bundle_name	Name of Bundle	string	Required
parameters	Bundle arguments	object	Readonly
step	Step name	string

Example Request:

POST https://<nsx-mgr>/api/v1/node/upgrade/performtask?action=execute { "bundle_name" : "VMware-NSX-unified-appliance-2.1.0.0.0.6921065", "step": "list_commands", "parameters": { "parameter_key1": "parameter_value1", } }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

UpgradeTaskProperties+

Name	Description	Type	Notes
bundle_name	Name of Bundle	string	Required
parameters	Bundle arguments	object	Readonly
step	Step name	string

Required Permissions:

crud

Feature:

system_administration

Additional Errors:

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