JavaScript

Get the Type of an Active SSH Channel

Demonstrates the Chilkat Ssh.GetChannelType method, which returns the type of the channel at a zero-based enumeration index. The only argument is the index — an enumeration position, not a channel number. Values include session, x11, forwarded-tcpip, and direct-tcpip.

Background: Paired with GetChannelNumber, this turns the channel collection into a readable inventory of what a connection is currently doing — which channels are running commands (session) versus tunneling TCP traffic (direct-tcpip). That is valuable for diagnostics and for application code that manages several channel kinds at once. An out-of-range index causes the string-returning method to report failure.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

//  Demonstrates the Ssh.GetChannelType method, which returns the type of the channel at a
//  zero-based enumeration index.  The only argument is the index, which is an enumeration
//  position and not a channel number.  Values include "session" and "direct-tcpip".

var ssh = new CkSsh();

var sshPort = 22;
success = ssh.Connect("ssh.example.com",sshPort);
if (success == false) {
    console.log(ssh.LastErrorText);
    return;
}

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
var password = "mySshPassword";

success = ssh.AuthenticatePw("mySshLogin",password);
if (success == false) {
    console.log(ssh.LastErrorText);
    return;
}

var channelNum = ssh.OpenSessionChannel();
if (channelNum < 0) {
    console.log(ssh.LastErrorText);
    return;
}

//  Enumerate the active channels and report each one's number and type.
var n = ssh.NumOpenChannels;
var i;
for (i = 0; i <= n - 1; i++) {
    var chNum = ssh.GetChannelNumber(i);
    var chType = ssh.GetChannelType(i);
    if (ssh.LastMethodSuccess == false) {
        console.log(ssh.LastErrorText);
        return;
    }

    console.log("Channel " + chNum + " is of type " + chType);
}

ssh.Disconnect();