PowerShell

Open a Custom SSH Channel Type

Demonstrates the Chilkat Ssh.OpenCustomChannel method, which requests a channel whose application-defined type is supplied as the only argument. It returns the channel number, or -1 if the server rejects the channel. The server must implement that channel type.

Background: The SSH protocol allows vendor- and application-specific channel types beyond the standard session and direct-tcpip kinds; by convention these carry an @domain suffix to avoid name collisions. This method is the escape hatch for talking to a server that implements such a type. On rejection, inspect ChannelOpenFailCode to learn why.

Chilkat PowerShell Downloads

Download Chilkat for PowerShell

PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

#  Demonstrates the Ssh.OpenCustomChannel method, which requests a custom SSH channel whose
#  application-defined type is supplied as the only argument.  It returns the channel number,
#  or -1 if the server rejects the channel.  The server must implement that channel type.

$ssh = New-Object Chilkat.Ssh

$sshPort = 22
$success = $ssh.Connect("ssh.example.com",$sshPort)
if ($success -eq $false) {
    $($ssh.LastErrorText)
    exit
}

#  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.
$password = "mySshPassword"

$success = $ssh.AuthenticatePw("mySshLogin",$password)
if ($success -eq $false) {
    $($ssh.LastErrorText)
    exit
}

#  Request an application-defined channel type.  The server must support it.
$channelType = "my-custom-channel@example.com"
$channelNum = $ssh.OpenCustomChannel($channelType)
if ($channelNum -lt 0) {
    $($ssh.LastErrorText)
    exit
}

$("Opened custom channel: " + $channelNum)

#  The channel is used with the normal channel send, receive, EOF, CLOSE, and release methods.

$ssh.Disconnect()