Skip to main content
Element Software

EnableClusterSsh

Contributors netapp-pcarriga

You can use the EnableClusterSsh method to enable the SSH service on all nodes in the storage cluster.

Parameter

This method has the following input parameter:

Name Description Type Default value Required

duration

The amount of time that the SSH service will remain enabled.

string

None

Yes

Return values

This method has the following return values:

Name Description Type

result

A JSON object containing the status of the SSH service for the storage cluster, the time remaining until SSH is disabled, and the SSH service status for each node.

JSON object

Request example

Requests for this method are similar to the following example:

{
  "method": "EnableClusterSsh",
  "params": {
      "duration"  : "02:00:00.00"
  },
  "id" : 1
}

Response example

This method returns a response similar to the following example:

{
	"id": 1,
	"result" : {
    "enabled": true,
    "timeRemaining": "00:43:21",
    "nodes": [
    {
        "nodeID": 1,
        "enabled": true
    },
    {
        "nodeID": 2,
        "enabled": true
    },
    {
        "nodeID": 3,
        "enabled": false
    },
    {
        "nodeID": 4,
        "enabled": false
    } ]
			}
	}

New since version

10.3