Update ssh service properties

Update ssh service properties. If the start_on_boot property is updated to true, existing ssh sessions if any are stopped and the ssh service is restarted.

Request:

Method:

PUT

URI Path(s):

/api/v1/cluster/<cluster-node-id>/node/services/ssh
/api/v1/transport-nodes/<transport-node-id>/node/services/ssh
/api/v1/node/services/ssh

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

NodeSshServiceProperties+

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
service_name	Service name	string	Required
service_properties	SSH Service properties	SshServiceProperties

Example Request:

PUT https://<nsx-mgr>/api/v1/node/services/ssh { "service_name": "ssh", "service_properties": { "start_on_boot": false, "root_login": true } }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

NodeSshServiceProperties+

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
service_name	Service name	string	Required
service_properties	SSH Service properties	SshServiceProperties

Example Response:

{ "_schema": "NodeSshServiceProperties", "_self": "/node/services/ssh", "service_name": "ssh", "service_properties": { "start_on_boot": false, "root_login": true } }

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