SecureBlackbox Lite 2020 Node.js Edition

Questions / Feedback?

ConnectAndExec Method

Connects to an SSH server and executes a command in one go.

Syntax

sshclient.connectAndExec(address, port, command, wantStdout, wantStdErr, [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, buffer){ }

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

'buffer' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Use this method to connect to an SSH server at Address and Port and execute a command. The method returns the output of the executed command.

This method is a handy shortcut for running non-interactive commands. It encapsulates calls to Connect, Receive, Disconnect internally to save you time and space.

Please note that ConnectAndExec always runs synchronously, thus ignoring the AsyncMode setting.

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