PowerShell

Clear the FTP Session Log

Demonstrates the Chilkat Ftp2.ClearSessionLog method, which clears the in-memory FTP protocol log collected while KeepSessionLog is enabled. It takes no arguments.

Background: With session logging on, the SessionLog accumulates the full FTP command/reply conversation, which is invaluable for diagnosing a failed transfer. Over a long-lived session it grows unbounded, so clearing it frees memory — and, more usefully, lets you capture the log for one specific operation in isolation by clearing just before and reading just after.

Chilkat PowerShell Downloads

Download Chilkat for PowerShell

PowerShell

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

$success = $false

#  Demonstrates the Ftp2.ClearSessionLog method, which clears the in-memory FTP protocol log.  It
#  takes no arguments and is a void method.

$ftp = New-Object Chilkat.Ftp2

$ftp.Hostname = "ftp.example.com"
$ftp.Username = "myFtpLogin"

#  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.
$ftp.Password = "myPassword"

$success = $ftp.Connect()
if ($success -eq $false) {
    $($ftp.LastErrorText)
    exit
}

#  The SessionLog accumulates the FTP protocol conversation when KeepSessionLog is enabled, which
#  is useful for debugging.
$ftp.KeepSessionLog = $true

#  ... perform some operations ...

#  Clear the log, for example before starting a new logical operation whose log you want to
#  capture in isolation.
$ftp.ClearSessionLog()
$("Session log cleared.")

$success = $ftp.Disconnect()
if ($success -eq $false) {
    $($ftp.LastErrorText)
    exit
}