SecureBlackbox Lite 2020 Node.js Edition

Questions / Feedback?

Commands Property

Specifies the list of commands to execute.

Syntax

 sshclient.getCommands([callback])
 sshclient.setCommands( commands, [callback])

Default Value

""

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 the getCommands([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setCommands([callback]) 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 property to provide a list of commands to execute remotely. Separate different commands with EOL characters.

When this property is set, the component works in the command mode, meaning each command is executed in its own virtual terminal session. No shell connection is established.

If no commands are provided via this property, the component will establish a shell session.

Data Type

String

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