Functions/Open-WinSCPSession.ps1
|
<#
.SYNOPSIS This is the main interface class of the WinSCP assembly. .DESCRIPTION Creates a new WINSCP.Session Object with setting specified in the WinSCP.SessionOptions object. Assign this Object to a Variable to easily manipulate actions later. .INPUTS WinSCP.SessionOptions. .OUTPUTS WinSCP.Session. .PARAMETER SessionOptions Defines information to allow an automatic connection and authentication of the session. .PARAMETER DebugLogPath Path to store assembly debug log to. Default null means, no debug log file is created. See also SessionLogPath. The property has to be set before calling Open. .PARAMETER SessionLogPath Path to store session log file to. Default null means, no session log file is created. .PARAMETER ReconnectTime Sets time limit in seconds to try reconnecting broken sessions. Default is 120 seconds. Use TimeSpan.MaxValue to remove any limit. .PARAMETER Timeout Maximal interval between two consecutive outputs from WinSCP console session, before TimeoutException is thrown. The default is one minute. It�s not recommended to change the value. .EXAMPLE PS C:\> $session = Open-WinSCPSession -SessionOptions (New-WinSCPSessionOptions -Hostname myftphost.org -Username ftpuser -password "FtpUserPword" -Protocol Ftp) PS C:\> $session ExecutablePath : AdditionalExecutableArguments : DefaultConfiguration : True DisableVersionCheck : False IniFilePath : ReconnectTime : 10675199.02:48:05.4775807 DebugLogPath : SessionLogPath : XmlLogPath : C:\Users\user\AppData\Local\Temp\wscp0708.03114C7C.tmp Timeout : 00:01:00 Output : {winscp> option batch on, batch on , winscp> option confirm off, confirm off ...} Opened : True UnderlyingSystemType : WinSCP.Session .EXAMPLE PS C:\> $session = New-WinSCPSessionOptions -Hostname myftphost.org -Username ftpuser -password "FtpUserPword" -Protocol Ftp | Open-WinSCPSession PS C:\> $session ExecutablePath : AdditionalExecutableArguments : DefaultConfiguration : True DisableVersionCheck : False IniFilePath : ReconnectTime : 10675199.02:48:05.4775807 DebugLogPath : SessionLogPath : XmlLogPath : C:\Users\user\AppData\Local\Temp\wscp0708.03114C7C.tmp Timeout : 00:01:00 Output : {winscp> option batch on, batch on , winscp> option confirm off, confirm off ...} Opened : True UnderlyingSystemType : WinSCP.Session .NOTES If the WinSCPSession is piped into another WinSCP command, the connection will be disposed upon completion of that command. Be sure to store the WinSCPSession into a vairable, else there will be no handle to use with it. .INPUTS WinSCP.SessionOptions. .OUTPUTS WinSCP.Session. .LINK http://dotps1.github.io/WinSCP .LINK http://winscp.net/eng/docs/library_session #> Function Open-WinSCPSession { [CmdletBinding()] [OutputType([WinSCP.Session])] Param ( [Parameter(Mandatory = $true, ValueFromPipeLine = $true)] [WinSCP.SessionOptions] $SessionOptions, [Parameter()] [String] $DebugLogPath, [Parameter()] [String] $SessionLogPath, [Parameter()] [TimeSpan] $ReconnectTime, [Parameter()] [TimeSpan] $Timeout ) $session = New-Object -TypeName WinSCP.Session foreach ($key in $PSBoundParameters.Keys | ?{ $_ -ne 'SessionOptions' }) { try { $session.$($key) = $PSBoundParameters.$($key) } catch [System.Exception] { throw $_ } } try { $session.Open($SessionOptions) return $session } catch [System.Exception] { throw $_ } } |