Functions/Get-WinSCPFileChecksum.ps1
|
<#
.SYNOPSIS Calculates a checksum of a remote file. .DESCRIPTION Use IANA Algorithm to retrive the checksum of a remote file. .INPUTS WinSCP.Session. .PARAMETER WinSCPSession A valid open WinSCP.Session, returned from Open-WinSCPSession. .PARAMETER Algorithm A name of a checksum algorithm to use. Use IANA name of algorithm or use a name of any proprietary algorithm the server supports (with SFTP protocol only). Commonly supported algorithms are sha-1 and md5. .PARAMETER Path A full path to a remote file to calculate a checksum for. .EXAMPLE PS C:\> Get-WinSCPFileChecksum -Algorithm 'sha-1' -Path './rDir/file.txt .NOTES .LINK http://dotps1.github.io/WinSCP .LINK http://winscp.net/eng/docs/library_session_calculatefilechecksum #> Function Get-WinSCPFileChecksum { [CmdletBinding()] [OutputType()] Param ( [Parameter(Mandatory = $true, ValueFromPipeLine = $true)] [ValidateScript({ if($_.Open){ return $true }else{ throw 'The WinSCP Session is not in an Open state.' } })] [Alias('Session')] [WinSCP.Session] $WinSCPSession, [Parameter(Mandatory = $true)] [String] $Algorithm, [Parameter(Mandatory = $true)] [String[]] $Path ) Begin { $sessionValueFromPipeLine = $PSBoundParameters.ContainsKey('WinSCPSession') } Process { try { return ($WinSCPSession.CalculateFileChecksum($Algorithm, $Path)) } catch [System.Exception] { throw $_ } } End { if (-not ($sessionValueFromPipeLine)) { Close-WinSCPSession -WinSCPSession $WinSCPSession } } } |