hub.ssh_tunnel.create

Hub Type: H2, H2_secure, G150

Connection Type: UI

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

Edit

Field	Type	Required	Description
serverAddress	string	+	Server that will accept ssh tunnel from controller
serverPort	int	–	Server’s ssh port that will accept ssh tunnel from controller (defaults to 8822)
serverUser	string	+	Username that will be used to authenticate on server
serverPass	string	+	Password that will be used to authenticate on server
tunnelPort	int	+	Free server port which will accept ssh tunnel connection from clients
time	int	–	Tunnel open time in minutes. Max value 60 minutes (defaults to 60 minutes). Tunnel will be closed either after timeout if there are no connections, or after last connection closed.

Edit

empty response

Edit

Code	Message	Data
-32600	Bad request,	rpc.params.notfound.
-32500	Error message from ssh	hub.ssh_tunnel.failed

Edit

Request
Response

Edit

				
					{
    "method": "hub.ssh_tunnel.create",
    "id": "_ID_",
    "params": {
        "serverAddress": "server.address.com",
        "serverUser": "server_user",
        "serverPass": "server_password",
        "tunnelPort": 33333,
        "time": 60
    }
}

Edit

				
					{
    "error": null,
    "id": "_ID_",
    "result": {}
}