(PowerShell) SSH ReceiveUntilMatchN

Demonstrates how to call the SSH ChannelReceiveUntilMatchN method.

Chilkat .NET Downloads Chilkat .NET Assemblies

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

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

$ssh = New-Object Chilkat.Ssh

# For the sake of the example, pretend the remote shell prompt
# will be any of the following:
$saPrompts = New-Object Chilkat.StringArray

$saPrompts.Append("~$")
$saPrompts.Append("mars#")
$saPrompts.Append("jupiter%")
$saPrompts.Append("chilkat$")
$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 -ne $true) {
    $($ssh.LastErrorText)
    exit
}

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

# Authenticate using login/password:
$success = $ssh.AuthenticatePw("myLogin","myPassword")
if ($success -ne $true) {
    $($ssh.LastErrorText)
    exit
}

# Open a session channel.  (It is possible to have multiple
# session channels open simultaneously.)
$channelNum = $ssh.OpenSessionChannel()
if ($channelNum -lt 0) {
    $($ssh.LastErrorText)
    exit
}

$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 -ne $true) {
    $($ssh.LastErrorText)
    exit
}

# Start a shell on the channel:
$success = $ssh.SendReqShell($channelNum)
if ($success -ne $true) {
    $($ssh.LastErrorText)
    exit
}

#  Run the 1st command in the remote shell, which will be to
#  "cd" to a subdirectory.
$success = $ssh.ChannelSendString($channelNum,"cd workspace`n","utf-8")
if ($success -ne $true) {
    $($ssh.LastErrorText)
    exit
}

# Retrieve the output to the next prompt:
$caseSensitiveMatch = $true
$success = $ssh.ChannelReceiveUntilMatchN($channelNum,$saPrompts,"utf-8",$caseSensitiveMatch)
if ($success -ne $true) {
    $($ssh.LastErrorText)
    exit
}

#  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 -ne $true) {
    $($ssh.LastErrorText)
    exit
}

$($cmdOutput)

#  Run the 2nd command in the remote shell, which will be
#  to "ls" the directory.
$success = $ssh.ChannelSendString($channelNum,"ls`n","utf-8")
if ($success -ne $true) {
    $($ssh.LastErrorText)
    exit
}

# Retrieve and display the output.
$success = $ssh.ChannelReceiveUntilMatchN($channelNum,$saPrompts,"utf-8",$caseSensitiveMatch)
if ($success -ne $true) {
    $($ssh.LastErrorText)
    exit
}

$cmdOutput = $ssh.GetReceivedText($channelNum,"utf-8")
if ($ssh.LastMethodSuccess -ne $true) {
    $($ssh.LastErrorText)
    exit
}

$($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`n","utf-8")
if ($success -ne $true) {
    $($ssh.LastErrorText)
    exit
}

# 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 -ne $true) {
    $($ssh.LastErrorText)
    exit
}

# 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 -lt 0) {
    $($ssh.LastErrorText)
    exit
}

# Close the channel:
$success = $ssh.ChannelSendClose($channelNum)
if ($success -ne $true) {
    $($ssh.LastErrorText)
    exit
}

# 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 -ne $true) {
    $($ssh.LastErrorText)
    exit
}

$cmdOutput = $ssh.GetReceivedText($channelNum,"utf-8")
if ($ssh.LastMethodSuccess -ne $true) {
    $($ssh.LastErrorText)
    exit
}

$($cmdOutput)

# Disconnect
$ssh.Disconnect()