PowerShell

SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files. PowerShell

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

$success = $false

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

# Important: It is helpful to send the contents of the
# sftp.LastErrorText property when requesting support.

$sftp = New-Object Chilkat.SFtp

# Set some timeouts, in milliseconds:
$sftp.ConnectTimeoutMs = 5000
$sftp.IdleTimeoutMs = 10000

# Connect to the SSH server.  
# The standard SSH port = 22
# The hostname may be a hostname or IP address.
$hostname = "www.my-sftp-server.com"
$port = 22
$success = $sftp.Connect($hostname,$port)
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

# Authenticate with the SSH server.  Chilkat SFTP supports
# both password-based authenication as well as public-key
# authentication.  This example uses password authenication.
$success = $sftp.AuthenticatePw("myLogin","myPassword")
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

# After authenticating, the SFTP subsystem must be initialized:
$success = $sftp.InitializeSftp()
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

# Open a directory on the server...
# Paths starting with a slash are "absolute", and are relative 
# to the root of the file system. Names starting with any other 
# character are relative to the user's default directory (home directory).
# A path component of ".." refers to the parent directory, 
# and "." refers to the current directory. 
$handle = $sftp.OpenDir(".")
if ($sftp.LastMethodSuccess -eq $false) {
    $($sftp.LastErrorText)
    exit
}

# Download the directory listing:

$dirListing = New-Object Chilkat.SFtpDir
$success = $sftp.ReadDirListing($handle,$dirListing)
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

# Close the handle for the directory listing.
$success = $sftp.CloseHandle($handle)
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

# Iterate over the files.
$fileObj = New-Object Chilkat.SFtpFile
$i = 0
$n = $dirListing.NumFilesAndDirs
while ($i -lt $n) {

    $success = $dirListing.FileAt($i,$fileObj)
    if ($success -eq $false) {
        $($dirListing.LastErrorText)
        exit
    }

    $($fileObj.Filename)
    $($fileObj.FileType)
    $("Size in bytes: " + $fileObj.Size32)
    $("----")

    $i = $i + 1
}

$("Success.")