Restart, start or stop the NSX upgrade agent service

Request:

Method:

POST

URI Path(s):

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+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
health	Service health in addition to runtime_state	string	Readonly Enum: STABLE, DEGRADED
monitor_pid	Service monitor process id	integer	Readonly
monitor_runtime_state	Service monitor runtime state	string	Readonly Enum: running, stopped
pids	Service process ids	array of integer	Readonly
reason	Reason for service degradation	string	Readonly
runtime_state	Service runtime state	string	Readonly Enum: running, stopped

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:

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

Restart, start or stop the NSX upgrade agent service

Request:

Example Request:

Successful Response:

NodeServiceStatusProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: