SolarNetwork SSH

Class: SshSession

domain~ SshSession

A SolarSSH session object.

new SshSession(created, sessionId, nodeId, sshHost, sshPort, reverseSshPort [, startInstructionId] [, stopInstructionId])

Constructor.

Parameters:
Name Type Argument Description
created Date

the creation date
sessionId string

the unique session ID
nodeId number

the node ID
sshHost string

the SSH host name
sshPort number

the SSH port
reverseSshPort number

the reverse SSH port
startInstructionId number <optional>

the StartRemoteSsh instruction ID
stopInstructionId number <optional>

the StopRemoteSsh instruction ID

Methods

<static> fromJsonEncoding(json)

Parse a JSON string into a module:domain~SshSession instance.

The JSON must be encoded the same way module:domain~SshSession#toJsonEncoding does.

Parameters:
Name Type Description
json string | Object

the JSON to parse, or a parsed JSON object
Returns:

the session instance

Type
module:domain~SshSession

toJsonEncoding()

Get this object as a standard JSON encoded string value.

Returns:

the JSON encoded string

Type
string