(Excel) SSH ReceiveUntilMatchN

Demonstrates how to call the SSH ChannelReceiveUntilMatchN method.

Download Excel Class Modules Chilkat Excel Class Modules

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim ssh As Chilkat.Ssh
Set ssh = Chilkat.NewSsh

' For the sake of the example, pretend the remote shell prompt
' will be any of the following:
Dim saPrompts As Chilkat.StringArray
Set saPrompts = Chilkat.NewStringArray

Dim success As Boolean
success = saPrompts.Append("~$")
success = saPrompts.Append("mars#")
success = saPrompts.Append("jupiter%")
success = saPrompts.Append("chilkat$")
success = saPrompts.Append("admin>")

' Connect to an SSH server:
' Hostname may be an IP address or hostname:

hostname = "www.some-ssh-server.com"

port = 22

success = ssh.Connect(hostname,port)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Wait a max of 10 seconds when reading responses..
ssh.IdleTimeoutMs = 10000

' Authenticate using login/password:
success = ssh.AuthenticatePw("myLogin","myPassword")
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Open a session channel.  (It is possible to have multiple
' session channels open simultaneously.)

channelNum = ssh.OpenSessionChannel()
If (channelNum < 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If


termType = "dumb"

widthInChars = 120

heightInChars = 40
' Use 0 for pixWidth and pixHeight when the dimensions
' are set in number-of-chars.

pixWidth = 0

pixHeight = 0
success = ssh.SendReqPty(channelNum,termType,widthInChars,heightInChars,pixWidth,pixHeight)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Start a shell on the channel:
success = ssh.SendReqShell(channelNum)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  Run the 1st command in the remote shell, which will be to
'  "cd" to a subdirectory.
success = ssh.ChannelSendString(channelNum,"cd workspace" & vbLf,"utf-8")
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Retrieve the output to the next prompt:

caseSensitiveMatch = True
success = ssh.ChannelReceiveUntilMatchN(channelNum,saPrompts,"utf-8",caseSensitiveMatch)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

'  Display what we've received so far.  This clears
'  the internal receive buffer, which is important.
'  After we send the command, we'll be reading until
'  the next command prompt.  If the command prompt
'  is already in the internal receive buffer, it'll think it's
'  already finished...
cmdOutput = ssh.GetReceivedText(channelNum,"utf-8")
If (ssh.LastMethodSuccess <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

Debug.Print cmdOutput

'  Run the 2nd command in the remote shell, which will be
'  to "ls" the directory.
success = ssh.ChannelSendString(channelNum,"ls" & vbLf,"utf-8")
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Retrieve and display the output.
success = ssh.ChannelReceiveUntilMatchN(channelNum,saPrompts,"utf-8",caseSensitiveMatch)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

cmdOutput = ssh.GetReceivedText(channelNum,"utf-8")
If (ssh.LastMethodSuccess <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

Debug.Print cmdOutput

'  Start the final command in the remote shell.  This example
'  will send a "ls -l" command to retrieve the long format directory listing.
success = ssh.ChannelSendString(channelNum,"ls -l" & vbLf,"utf-8")
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Send an EOF.  This tells the server that no more data will 
' be sent on this channel.  The channel remains open, and
' the SSH client may still receive output on this channel.
success = ssh.ChannelSendEof(channelNum)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Read whatever output may already be available on the
' SSH connection.  ChannelReadAndPoll returns the number of bytes
' that are available in the channel's internal buffer that
' are ready to be "picked up" by calling GetReceivedText
' or GetReceivedData.
' A return value of -1 indicates failure.
' A return value of -2 indicates a failure via timeout.

' The ChannelReadAndPoll method waits
' for data to arrive on the connection usingi the IdleTimeoutMs
' property setting.  Once the first data arrives, it continues
' reading but instead uses the pollTimeoutMs passed in the 2nd argument:
' A return value of -2 indicates a timeout where no data is received.

pollTimeoutMs = 2000

n = ssh.ChannelReadAndPoll(channelNum,pollTimeoutMs)
If (n < 0) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Close the channel:
success = ssh.ChannelSendClose(channelNum)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Perhaps we did not receive all of the commands output.
' To make sure,  call ChannelReceiveToClose to accumulate any remaining
' output until the server's corresponding "channel close" is received.
success = ssh.ChannelReceiveToClose(channelNum)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

cmdOutput = ssh.GetReceivedText(channelNum,"utf-8")
If (ssh.LastMethodSuccess <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

Debug.Print cmdOutput

' Disconnect
ssh.Disconnect