Restart, start or stop the ssh service

Request:

Method:

POST

URI Path(s):

/api/v1/transport-nodes/{transport-node-id}/node/services/ssh?action=start
/api/v1/transport-nodes/{transport-node-id}/node/services/ssh?action=stop
/api/v1/transport-nodes/{transport-node-id}/node/services/ssh?action=restart
/api/v1/cluster/{cluster-node-id}/node/services/ssh?action=start
/api/v1/cluster/{cluster-node-id}/node/services/ssh?action=stop
/api/v1/cluster/{cluster-node-id}/node/services/ssh?action=restart
/api/v1/node/services/ssh?action=start
/api/v1/node/services/ssh?action=stop
/api/v1/node/services/ssh?action=restart

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

POST https://<nsx-mgr>/api/v1/node/services/ssh?action=start

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/ssh", "pids": [ 15930 ], "runtime_state": "running" }

Restart, start or stop the ssh service

Request:

Example Request:

Successful Response:

NodeServiceStatusProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: