Xojo Plugin

Send Text on an SSH Channel

Demonstrates the Chilkat Ssh.ChannelSendString method, which encodes text using a charset and sends the resulting bytes on a channel. The arguments are the channel number, the text, and the charset. No line ending or terminator is added automatically.

Background: This is how you type into a remote shell programmatically. The most common mistake is forgetting the newline — the remote shell will not act on a command until it receives one, so the terminator must be part of the text you send. An empty string is valid and sends zero bytes. The charset governs how the text becomes bytes on the wire.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the Ssh.ChannelSendString method, which encodes text with a charset and sends
//  the bytes on a channel.  The 1st argument is the channel number, the 2nd is the text, and the
//  3rd is the charset.  No line ending is added automatically.

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

Dim channelNum As Int32
channelNum = ssh.OpenSessionChannel()
If (channelNum < 0) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

//  Start a shell WITHOUT requesting a PTY.  Without a PTY the shell sees it is connected to a
//  raw data pipe and enters non-interactive mode: it suppresses the command prompt, does not
//  echo typed commands back, and skips interactive login scripts.  The output is therefore
//  clean and easily parseable -- but because no prompt is ever sent, code must not wait for
//  one.  Instead, have each command print a predictable marker, or wait for EOF / channel close.
success = ssh.SendReqShell(channelNum)
If (success = False) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

//  Send a command.  The trailing newline must be included because no terminator is added.
success = ssh.ChannelSendString(channelNum,"ls -l /tmp" + EndOfLine.Unix,"utf-8")
If (success = False) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

//  Read the shell's response.
Dim pollTimeoutMs As Int32
pollTimeoutMs = 2000
Dim result As Int32
result = ssh.ChannelReadAndPoll(channelNum,pollTimeoutMs)
If (result = -1) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

Dim output As String
output = ssh.GetReceivedText(channelNum,"utf-8")
If (ssh.LastMethodSuccess = False) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

System.DebugLog(output)

ssh.Disconnect