Functions/Get-WinSCPChildItem.ps1
|
<#
.SYNOPSIS Shows the contents of a remote directory. .DESCRIPTION Displays the contents within a remote directory, including other directories and files. .INPUTS WinSCP.Session. System.String. .OUTPUTS System.Array. .PARAMETER WinSCPSession A valid open WinSCP.Session, returned from New-WinSCPSession. .PARAMETER Path Specifies a path to one or more locations. Wildcards are permitted. The default location is the home directory of the user making the connection. .PARAMETER Filter Filter to be applied to returned objects. .PARAMETER Recurse Return items from all subdirectories. .EXAMPLE PS C:\> New-WinSCPSession -Credential (New-Object -TypeName System.Managemnet.Automation.PSCredential -ArgumentList $env:USERNAME, (New-Object -TypeName System.Security.SecureString)) -HostName $env:COMPUTERNAME -Protocol Ftp | Get-WinSCPChildItem -Path '/rDir/' Directory: /rDir FileType LastWriteTime Length Name -------- ------------- ------ ---- D 1/1/2015 12:00:00 AM 0 rSubDir - 1/1/2015 12:00:00 AM 0 rTextFile.txt .EXAMPLE PS C:\> $credential = Get-Credential PS C:\> $session = New-WinSCPSession -Credential $credential -Hostname 'myftphost.org' -SshHostKeyFingerprint 'ssh-rsa 1024 xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx' PS C:\> Get-WinSCPChildItem -WinSCPSession $session -Path '/rDir/' -Recurse Directory: /rDir FileType LastWriteTime Length Name -------- ------------- ------ ---- D 1/1/2015 12:00:00 AM 0 rSubDir - 1/1/2015 12:00:00 AM 0 rTextFile.txt Directory: /rDir/rSubDir FileType LastWriteTime Length Name -------- ------------- ------ ---- - 1/1/2015 12:00:00 AM 0 rSubDirTextFile.txt .NOTES If the WinSCPSession is piped into this command, the connection will be closed and the object will be disposed upon completion of the command. .LINK http://dotps1.github.io/WinSCP .LINK http://winscp.net/eng/docs/library_session_listdirectory #> Function Get-WinSCPChildItem { [OutputType([Array])] Param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true)] [ValidateScript({ if ($_.Opened) { return $true } else { throw 'The WinSCP Session is not in an Open state.' } })] [WinSCP.Session] $WinSCPSession, [Parameter(ValueFromPipelineByPropertyName = $true)] [ValidateScript({ -not ([String]::IsNullOrWhiteSpace($_)) })] [String[]] $Path = '/', [Parameter()] [ValidateScript({ -not ([String]::IsNullOrWhiteSpace($_)) })] [String] $Filter = '*', [Parameter()] [Switch] $Recurse ) Begin { $sessionValueFromPipeLine = $PSBoundParameters.ContainsKey('WinSCPSession') } Process { foreach ($p in (Format-WinSCPPathString -Path $($Path))) { if (-not (Test-WinSCPPath -WinSCPSession $WinSCPSession -Path $p)) { Write-Error -Message "Cannot find path: $p because it does not exist." continue } try { $items = foreach ($file in ($WinSCPSession.ListDirectory($p).Files | Where-Object { $_.Name -ne '..' })) { $WinSCPSession.GetFileInfo((Format-WinSCPPathString -Path (Join-Path -Path $p -ChildPath $file))) } $items | Where-Object { $_.Name -like $Filter } if ($Recurse.IsPresent) { foreach ($directory in ($items | Where-Object { $_.IsDirectory }).Name) { Get-WinSCPChildItem -WinSCPSession $WinSCPSession -Path (Format-WinSCPPathString -Path (Join-Path -Path $p -ChildPath $directory)) -Recurse -Filter $Filter } } } catch { Write-Error -Message $_.ToString() } } } End { if (-not ($sessionValueFromPipeLine)) { Remove-WinSCPSession -WinSCPSession $WinSCPSession } } } |