IPWorks SSH 2020 Node.js Edition

Questions / Feedback?

SSHLogon Method

Logon to the SSHHost using the current SSHUser and SSHPassword .

Syntax

sshclient.SSHLogon(SSHHost, SSHPort, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Logon to the SSH server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.

Example (Logging On)


SSHClient.SSHUser = "username"
SSHClient.SSHPassword = "password"
SSHClient.SSHLogon("sshHost", sshPort)

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 Node.js Edition - Version 20.0 [Build 8501]