hub.ssh_tunnel.support.enabled.set

Hub type: H2, H2_secure, G150
Connection type: UI

Create ssh support tunnel to controller. Used to access remote controller via ssh.

Edit

Field	Type	Required	Description
enabled	bool	+	Open or close ssh support tunnel.
endTime	string	–	Time when ssh tunnel should be closed. If this field is not defined then current time + 2 weeks. Format: “YYYY-MM-DDThh:mm:ss”

Edit

empty result

Edit

Code	Message	Data	Reason
-32602	Value is not in valid range	rpc.params.range.invalid.endTime	endTime already expired
-32602	Wrong params, endTime	rpc.params.invalid.endTime

Edit

Request
Response

Edit

				
					{
    "method": "hub.ssh_tunnel.support.enabled.set",
    "id": "_ID_",
    "params": {
        "enabled": true,
        "endTime": "2021-01-15T20:00:00"
    }
}

Edit

				
					{
    "error": null,
    "id": "_ID_",
    "method": "hub.ssh_tunnel.support.enabled.set",
    "result": {},
}