Restart, start or stop the NSX Control Plane Agent service

Request:

Method:

POST

URI Path(s):

/api/v1/transport-nodes/{transport-node-id}/node/services/nsx-control-plane-agent?action=restart
/api/v1/transport-nodes/{transport-node-id}/node/services/nsx-control-plane-agent?action=start
/api/v1/transport-nodes/{transport-node-id}/node/services/nsx-control-plane-agent?action=stop

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

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

Required Permissions:

crud

Feature:

system_administration

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

Restart, start or stop the NSX Control Plane Agent service

Request:

Successful Response:

NodeServiceStatusProperties (schema)

Required Permissions:

Feature:

Additional Errors: