NSX-T Data Center REST API

Restart, start or stop the NSX upgrade agent service

Request:

Method:
POST
URI Path(s):
/api/v1/transport-nodes/{transport-node-id}/node/services/nsx-upgrade-agent?action=restart
/api/v1/transport-nodes/{transport-node-id}/node/services/nsx-upgrade-agent?action=start
/api/v1/transport-nodes/{transport-node-id}/node/services/nsx-upgrade-agent?action=stop
/api/v1/cluster/{cluster-node-id}/node/services/nsx-upgrade-agent?action=restart
/api/v1/cluster/{cluster-node-id}/node/services/nsx-upgrade-agent?action=start
/api/v1/cluster/{cluster-node-id}/node/services/nsx-upgrade-agent?action=stop
/api/v1/node/services/nsx-upgrade-agent?action=restart
/api/v1/node/services/nsx-upgrade-agent?action=start
/api/v1/node/services/nsx-upgrade-agent?action=stop
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

POST https://<nsx-mgr>/api/v1/node/services/nsx-upgrade-agent?action=restart

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeServiceStatusProperties+

Example Response:

{ "_schema": "NodeServiceStatusProperties", "_self": "/node/services/nsx-upgrade-agent", "monitor_pid": 1, "monitor_runtime_state": "running", "pids": [ 17892 ], "runtime_state": "running" }

Required Permissions:

crud

Feature:

system_administration

Additional Errors: