Xojo Plugin

Request an SSH Subsystem

Demonstrates the Chilkat Ssh.SendReqSubsystem method, which requests a predefined subsystem on a session channel. The first argument is the channel number and the second is the subsystem name. This example requests the sftp subsystem.

Background: A subsystem is a named service the server exposes over a channel instead of a shell command — sftp is the familiar example, and netconf is common on network devices. After acceptance, the channel carries that protocol's data, exchanged with the ordinary channel send and receive methods. If the server rejects the subsystem, the channel normally stays open and can be reused for another request.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the Ssh.SendReqSubsystem method, which requests a predefined subsystem on a
//  session channel.  The 1st argument is the channel number and the 2nd is the subsystem name.

Dim ssh As New Chilkat.Ssh

Dim sshPort As Int32
sshPort = 22
success = ssh.Connect("ssh.example.com",sshPort)
If (success = False) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

//  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.
Dim password As String
password = "mySshPassword"

success = ssh.AuthenticatePw("mySshLogin",password)
If (success = False) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

//  Open a session channel.  A negative return value indicates failure.
Dim channelNum As Int32
channelNum = ssh.OpenSessionChannel()
If (channelNum < 0) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

//  Request the "sftp" subsystem.  A 1 return means the server accepted the request;
//  subsequent protocol data is exchanged with the normal channel send and receive methods.
success = ssh.SendReqSubsystem(channelNum,"sftp")
If (success = False) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

System.DebugLog("Subsystem request accepted.")

ssh.Disconnect