SecureBlackbox 2020 Node.js Edition

Questions / Feedback?

Connect Method

Establishes connection to an SSH server.

Syntax

sshclient.connect(address, port, [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

Use this method to connect to the SSH server by providing its Address and Port.

Before connecting to the server you might want to set up your credentials using Username and Password properties. You might also need to configure the server key validation routine. You can do this by subscribing to KnownKeyReceived and UnknownKeyReceived events and implementing the event handlers as required.

Adjust AsyncMode before connecting to switch the component to either synchronous or asynchronous mode. In synchronous mode, all the calls to the component, such as Connect or SendBytes, are executed within the context of the caller thread, and block until the action completes. In asynchronous mode, the component runs the SSH session in a background thread, which makes all such calls return immediately. Find out more about the modes in the AsyncMode topic.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Node.js Edition - Version 20.0 [Build 8165]