(PowerShell) SCP Download File

Demonstrates how to download a file using the SCP protocol (Secure Copy Protocol over SSH).

Chilkat .NET Downloads Chilkat .NET Assemblies

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

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

$ssh = New-Object Chilkat.Ssh

# Hostname may be an IP address or hostname:
$hostname = "www.some-ssh-server.com"
$port = 22

# Connect to an SSH server:
$success = $ssh.Connect($hostname,$port)
if ($success -ne $true) {
    $($ssh.LastErrorText)
    exit
}

# Wait a max of 5 seconds when reading responses..
$ssh.IdleTimeoutMs = 5000

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

# Once the SSH object is connected and authenticated, we use it
# in our SCP object.
$scp = New-Object Chilkat.Scp

$success = $scp.UseSsh($ssh)
if ($success -ne $true) {
    $($scp.LastErrorText)
    exit
}

$remotePath = "test.txt"
$localPath = "/home/bob/test.txt"
$success = $scp.DownloadFile($remotePath,$localPath)
if ($success -ne $true) {
    $($scp.LastErrorText)
    exit
}

$("SCP download file success.")

# Disconnect
$ssh.Disconnect()