SecureBlackbox 2020 Node.js Edition

Questions / Feedback?

Subsystem Property

Specifies the subsystem to request from the server.

Syntax

 sshclient.getSubsystem([callback])
 sshclient.setSubsystem( subsystem, [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 getSubsystem([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 setSubsystem([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

Subsystem is a special form of an SSH channel. It is typically used to transfer third-party protocol data, with SFTP being the most widely known.

You can tell class to set up a subsystem connection (rather than a shell or command) by assigning the subsystem name to this property.

Data Type

String

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