SendSSHPacket Method

Used to send an encoded SSH packet to a connected client.

Syntax

sshclient.sendSSHPacket(channelId, packetType, payload_Buffer, [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

This method can be used to send a previously built SSH payload to a connected client. ConnectionId identifies the connection that will receive the packet. To send a packet to specific channel, you may specify that channel's ChannelId instead.

PacketType identifies what kind of packet is to be sent. Payload should contain the payload of the packet, which can be built by successive calls to SetSSHParam.

When SendSSHPacket is called, the SSHDaemon will finish building the packet, encrypt it for transport, and send it to the target connected client.