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.

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

$success = $false

#  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.

$ssh = New-Object Chilkat.Ssh

$sshPort = 22
$success = $ssh.Connect("ssh.example.com",$sshPort)
if ($success -eq $false) {
    $($ssh.LastErrorText)
    exit
}

#  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.
$password = "mySshPassword"

$success = $ssh.AuthenticatePw("mySshLogin",$password)
if ($success -eq $false) {
    $($ssh.LastErrorText)
    exit
}

#  Open a session channel.  A negative return value indicates failure.
$channelNum = $ssh.OpenSessionChannel()
if ($channelNum -lt 0) {
    $($ssh.LastErrorText)
    exit
}

#  Request execution of a command.  A $true return means the server accepted the request; it
#  does not mean the command itself succeeded.
$success = $ssh.SendReqExec($channelNum,"ls -l /tmp")
if ($success -eq $false) {
    $($ssh.LastErrorText)
    exit
}

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

$output = $ssh.GetReceivedText($channelNum,"utf-8")
if ($ssh.LastMethodSuccess -eq $false) {
    $($ssh.LastErrorText)
    exit
}

$($output)

$ssh.Disconnect()