Run a Command on an SSH Session Channel

See more SSH Examples

Demonstrates the Chilkat Ssh.SendReqExec method, which requests execution of a command on a session channel. The first argument is the channel number and the second is the command line. This example runs a command, reads the output until the channel closes, and prints it.

Dim success As Long
success = 0

'  Demonstrates the Ssh.SendReqExec method, which requests execution of a command on a session
'  channel.  The 1st argument is the channel number and the 2nd is the command line.

Dim ssh As New ChilkatSsh

Dim sshPort As Long
sshPort = 22
success = ssh.Connect("ssh.example.com",sshPort)
If (success = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
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 = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  Open a session channel.  A negative return value indicates failure.
Dim channelNum As Long
channelNum = ssh.OpenSessionChannel()
If (channelNum < 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  Request execution of a command.  A 1 return means the server accepted the request; it
'  does not mean the command itself succeeded.
success = ssh.SendReqExec(channelNum,"ls -l /tmp")
If (success = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
'  it, this call waits forever if the server never sends channel close.
ssh.ReadTimeoutMs = 15000

'  Read the command output until the server closes the channel.
success = ssh.ChannelReceiveToClose(channelNum)
If (success = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

Dim output As String
output = ssh.GetReceivedText(channelNum,"utf-8")
If (ssh.LastMethodSuccess = 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

Debug.Print output

ssh.Disconnect