Sstrutt: Initial creation - content from PowerShell Examples page

2012-04-18T13:30:15Z

Initial creation - content from PowerShell Examples page

New page

= Operations =
Bear in mind that different FTP servers will respond in differing ways - see [[#Gotchas|Gotchas]]
== Directory Listing ==
<source lang="powershell">
$site = "ftp://ftp-srv/logfiles"
$user = "Anonymous"
$pass = "Hello"

Write-Host "Get FTP site dir listing..." -nonewline

# Do directory listing
$FTPreq = [System.Net.FtpWebRequest]::Create($site)
$FTPreq.Timeout = 30000 # msec (default is infinite)
$FTPreq.ReadWriteTimeout = 10000 # msec (default is 300,000 - 5 mins)
$FTPreq.KeepAlive = $false # (default is enabled)
$FTPreq.Credentials = New-Object System.Net.NetworkCredential($user,$pass)
$FTPreq.Method = [System.Net.WebRequestMethods+FTP]::ListDirectory

try
{
$FTPres = $FTPreq.GetResponse()
}
catch
{
Write-Host "FAILED: $_"
Exit
}

Write-Host $FTPres.StatusCode -nonewline
Write-Host $FTPres.StatusDescription

$list = Receive-Stream $FTPres.GetResponseStream()
$FTPres.Close()
</source>

== Get ==
<source lang="powershell">
$site = "ftp://ftp-srv/logfiles"
$file = "activity1.log"
$user = "Anonymous"
$pass = "Hello"

Write-Host "Download $file " -nonewline

$FTPreq = [System.Net.FtpWebRequest]::Create("$site\$file")
$FTPreq.Timeout = 15000 # msec (defult is infinite)
$FTPreq.ReadWriteTimeout = 10000 # msec (defult is 300,000 - 5 mins)
$FTPreq.KeepAlive = $false # (default is enabled)
$FTPreq.Credentials = New-Object System.Net.NetworkCredential($user,$pass)
$FTPreq.UseBinary = $true
$FTPreq.Method = [System.Net.WebRequestMethods+FTP]::DownloadFile

try
{
$FTPres = $FTPreq.GetResponse()
}
catch
{
Write-Host "FAILED: $_"
Exit
}
$dest = "$DestDir\$file"

Write-Host $FTPres.StatusDescription "Write to $DestDir\$file"
$FTPstream = $FTPres.GetResponseStream()
try
{
$dest = New-Object IO.FileStream ("$DestDir\$file",[IO.FileMode]::Create)
}
catch
Write-Host "FAILED: $_"
$FTPstream.Close()
$FTPres.Close()
Exit
}

[byte[]]$buffer = New-Object byte[] 1024
$read = 0
do
{
$read=$FTPstream.Read($buffer,0,1024)
$dest.Write($buffer,0,$read)
}
while ($read -ne 0)
{
$dest.Close()
}
$FTPstream.Close()
$FTPres.Close()
</source>

= Gotchas =
* '''KeepAlive's''' - Its generally safer to disable keep alives, this causes the FTP session to be dropped after each request. This is less efficient, but leads to more reliable results. If requests don't get completed properly the .NET API gets into a stuck state whereby new FTP requests appear to time-out (though no request actually goes to the FTP server.
* '''Inconsistent Results''' - Results from IIS and non-IIS FTP servers can look different, for example a directory listing on an IIS FTP server results in a basic/raw text result, where as from a non-IIS FTP server this results in HTML rendered text

= Further Reading =
* [http://msdn.microsoft.com/en-us/library/system.net.ftpwebrequest.aspx MSDN FtpWebRequest Class]
* Examples I've worked from
** http://rcovelo.blogspot.com/2008/10/powershell-very-simple-ftp-client.html
** http://stackoverflow.com/questions/265339/whats-the-best-way-to-automate-secure-ftp-in-powershell
** http://powershell.com/cs/media/p/804.aspx

[[Category:PowerShell]]
[[Category:FTP]]

FTP (PowerShell) - Revision history

Sstrutt: Initial creation - content from PowerShell Examples page