en-US/WinSCP-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.36--> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.36--> <!-- Module: WinSCP Version: 5.11.0.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>ConvertTo-WinSCPEscapedString</command:name> <maml:description> <maml:para>Converts special characters in file path to make it unambiguous file mask/wildcard.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>ConvertTo</command:verb> <command:noun>WinSCPEscapedString</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Converts special characters in file path to make it unambiguous file mask/wildcard.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>ConvertTo-WinSCPEscapedString</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>FileMask</maml:name> <maml:description> <maml:para>File path to convert.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>FileMask</maml:name> <maml:description> <maml:para>File path to convert.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> ConvertTo-WinSCPEscapedString -FileMask "./WhosFileIsThis?.txt" ./WhosFileIsThis[?].txt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $sessionOption = New-WinSCPSessionOption -HostName $env:COMPUTERNAME -Protocol Ftp PS C:\> New-WinSCPSession -SessionOption $sessionOption Opened Timeout HostName ------ ------- -------- True 00:01:00 ftp.dotps1.github.io PS C:\> $escapedString = ConvertTo-WinSCPEscapedString -FileMask "./WhosFileIsThis?.txt" PS C:\> Get-WinSCPItem -Path $escapedString Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 4/25/2017 11:30:02 AM 349 WhosFileIsThis?.txt PS C:\> Remove-WinSCPSession</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/ConvertTo-WinSCPEscapedString</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_escapefilemask</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-WinSCPChildItem</command:name> <maml:description> <maml:para>Gets the items and child items in one or more specified locations.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WinSCPChildItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets the items and child items in one or more specified locations.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-WinSCPChildItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to root remote directory to start enumeration in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Windows wildcard to filter files. To select all files, use null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Recurse into subdirectories.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Depth</maml:name> <maml:description> <maml:para>The amount of directories to recurse.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets only the names of the items in the locations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Directory</maml:name> <maml:description> <maml:para>Select directory objects only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>File</maml:name> <maml:description> <maml:para>Select file objects only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to root remote directory to start enumeration in.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Windows wildcard to filter files. To select all files, use null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Recurse into subdirectories.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Depth</maml:name> <maml:description> <maml:para>The amount of directories to recurse.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Gets only the names of the items in the locations.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Directory</maml:name> <maml:description> <maml:para>Select directory objects only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>File</maml:name> <maml:description> <maml:para>Select file objects only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Array</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Using Directory and File switches together.</maml:title> <maml:alert> <maml:para>If both -Directory and -File switches are used, return nothing. This mimics the functionality of Get-ChildItem.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Get-WinSCPChildItem Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 6/30/2017 8:50:37 AM ftpDir1 --------- 6/30/2017 8:50:44 AM ftpDir2 --------- 6/30/2017 8:50:52 AM 0 ftpDoc1.txt --------- 6/30/2017 8:50:52 AM 0 ftpDoc2.txt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $sessionOption = New-WinSCPSessionOption -HostName $env:COMPUTERNAME -Protocol Ftp PS C:\> New-WinSCPSession -SessionOption $sessionOption Opened Timeout HostName ------ ------- -------- True 00:01:00 ftp.dotps1.github.io PS C:\> Get-WinChildItem -File Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 6/30/2017 8:50:52 AM 0 ftpDoc1.txt --------- 6/30/2017 8:50:52 AM 0 ftpDoc2.txt PS C:\> Remove-WinSCPSession</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Get-WinSCPChildItem</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_enumerateremotefiles</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-WinSCPItem</command:name> <maml:description> <maml:para>Gets the item at the specified location.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WinSCPItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets the item at the specified location.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-WinSCPItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to remote file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to remote file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filter</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.RemoteFileInfo</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Get-WinSCPItem -Path "ftpDir1" Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 6/30/2017 8:50:37 AM ftpDir1</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $sessionOption = New-WinSCPSessionOption -HostName $env:COMPUTERNAME -Protocol Ftp PS C:\> New-WinSCPSession -SessionOption $sessionOption Opened Timeout HostName ------ ------- -------- True 00:01:00 ftp.dotps1.github.io PS C:\> Get-WinSCPItem -Path "ftpDir1" Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 6/30/2017 8:50:37 AM ftpDir1 PS C:\> Remove-WinSCPSession</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Get-WinSCPItem</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_getfileinfo</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-WinSCPItemChecksum</command:name> <maml:description> <maml:para>Calculates a checksum of a remote file.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WinSCPItemChecksum</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Calculates a checksum of a remote file.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-WinSCPItemChecksum</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>A full path to a remote file to calculate a checksum for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Algorithm</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Algorithm</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>A full path to a remote file to calculate a checksum for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Array</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Get-WinSCPItemChecksum</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_calculatefilechecksum</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-WinSCPSession</command:name> <maml:description> <maml:para>Gets a WinSCP.Session object.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WinSCPSession</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets a WinSCP.Session object.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-WinSCPSession</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.Session</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>WinSCPSession PSDefaultParameterValue.</maml:title> <maml:alert> <maml:para>When creating/opeing a WinSCP.Session with the New-WinSCPSession cmdlet, the WinSCPSession PSDefaultParameterValue is set in all other commands in this module. This command is useful to retreive that object if necessary.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Get-WinSCPSession Opened Timeout HostName ------ ------- -------- True 00:01:00 ftp.dotps1.github.io</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Get-WinSCPSession</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-WinSCPSshHostKeyFingerprint</command:name> <maml:description> <maml:para>Scans a fingerprint of SSH server public key (host key) or FTPS/WebDAVS TLS certificate.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>WinSCPSshHostKeyFingerprint</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Scans a fingerprint of SSH server public key (host key) or FTPS/WebDAVS TLS certificate.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-WinSCPSshHostKeyFingerprint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>SessionOption</maml:name> <maml:description> <maml:para>Defines a server to scan the fingerprint of. The Protocol property must be Protocol.Sftp or Protocol.Scp, or Protocol.Ftp with FtpSecure being FtpSecure.Implicit or FtpSecure.Explicit, or Protocol.Webdav with WebdavSecure being true. Other than that only the HostName needs to be set. The PortNumber, Timeout and few raw session settings can be set, if necessary. The other properties are ignored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SessionOptions[]</command:parameterValue> <dev:type> <maml:name>SessionOptions[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>SessionOption</maml:name> <maml:description> <maml:para>Defines a server to scan the fingerprint of. The Protocol property must be Protocol.Sftp or Protocol.Scp, or Protocol.Ftp with FtpSecure being FtpSecure.Implicit or FtpSecure.Explicit, or Protocol.Webdav with WebdavSecure being true. Other than that only the HostName needs to be set. The PortNumber, Timeout and few raw session settings can be set, if necessary. The other properties are ignored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SessionOptions[]</command:parameterValue> <dev:type> <maml:name>SessionOptions[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.SessionOptions[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $sessionOption = New-WinSCPSessionOption -HostName ftp.dotps1.github.io PS C:\> Get-WinSCPSshHostKeyFingerprint -SessionOption $sessionOption ssh-dss 2048 01:aa:23:bb:45:cc:67:dd:89:ee:01:ff:23:aa:45:bb</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $sessionOption = New-WinSCPSessionOption -HostName ftp.dotps1.github.io PS C:\> $sshHostKeyFingerprint = Get-WinSCPSshHostKeyFingerprint -SessionOption $sessionOption PS C:\> $sessionOption.SshHostKeyFingerprint = $sshHostKeyFingerprint PS C:\> New-WinSCPSession -SessionOption $sessionOption Opened Timeout HostName ------ ------- -------- True 00:01:00 ftp.dotps1.github.io PS C:\> Remove-WinSCPSession</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Get-WinSCPSshServerPublicKeyFingerprint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_scanfingerprint</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Invoke-WinSCPCommand</command:name> <maml:description> <maml:para>Executes command on the remote server.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>WinSCPCommand</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Executes command on the remote server.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Invoke-WinSCPCommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Command</maml:name> <maml:description> <maml:para>Command to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Command</maml:name> <maml:description> <maml:para>Command to execute.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.CommandExecutionResult</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Invoke-WinSCPCommand</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_executecommand</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Move-WinSCPItem</command:name> <maml:description> <maml:para>Moves remote file to another remote directory and/or renames remote file.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Move</command:verb> <command:noun>WinSCPItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Moves remote file to another remote directory and/or renames remote file.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Move-WinSCPItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to remote file to move/rename.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Full path to new location and name to move/rename the file to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrite destination if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Gets the RemoteFileInfo object from the new path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to remote file to move/rename.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Destination</maml:name> <maml:description> <maml:para>Full path to new location and name to move/rename the file to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrite destination if it exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Gets the RemoteFileInfo object from the new path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <!--Notes--> <maml:title>Destination Formating</maml:title> <maml:alert> <maml:para>The name must be included or the target page has to end with a slash.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Move-WinSCPItem -Path "ftpDoc1.txt" -Destination "ftpDir1/"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $sessionOption = New-WinSCPSessionOption -HostName $env:COMPUTERNAME -Protocol Ftp PS C:\> New-WinSCPSession -SessionOption $sessionOption Opened Timeout HostName ------ ------- -------- True 00:01:00 ftp.dotps1.github.io PS C:\> Move-WinSCPItem -Path "ftpDir1/ftpDoc1.txt" -Destination "/" -PassThru Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 6/30/2017 8:50:52 AM 0 ftpDoc1.txt PS C:\> Remove-WinSCPSession</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Move-WinSCPItem</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_movefile</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-WinSCPItem</command:name> <maml:description> <maml:para>Creates a new item on a remote host.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>WinSCPItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates a new item on a remote host.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-WinSCPItem</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The full path to the new item. If the Name parameter is used, it will be appened to this value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new item. If this parameter is not used, the item will be named the last segment in the Path parameter value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ItemType</maml:name> <maml:description> <maml:para>The type of item to create, file or directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>File</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>An initial value to put in the item.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrite the item if it already exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TransferOptions</maml:name> <maml:description> <maml:para>Defines options for file transfers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferOptions</command:parameterValue> <dev:type> <maml:name>TransferOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The full path to the new item. If the Name parameter is used, it will be appened to this value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new item. If this parameter is not used, the item will be named the last segment in the Path parameter value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ItemType</maml:name> <maml:description> <maml:para>The type of item to create, file or directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>File</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Value</maml:name> <maml:description> <maml:para>An initial value to put in the item.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Overwrite the item if it already exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TransferOptions</maml:name> <maml:description> <maml:para>Defines options for file transfers.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferOptions</command:parameterValue> <dev:type> <maml:name>TransferOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session System.String[] System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.RemoteFileInfo</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPItem -Path NewWinSCPItem.txt Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 6/30/2017 1:41:47 PM 0 NewWinSCPItem.txt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $sessionOption = New-WinSCPSessionOption -HostName $env:COMPUTERNAME -Protocol Ftp PS C:\> New-WinSCPSession -SessionOption $sessionOption Opened Timeout HostName ------ ------- -------- True 00:01:00 ftp.dotps1.github.io PS C:\> New-WinSCPItem -Path NewWinSCPItem.txt -Value "Hello World!" Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 6/30/2017 2:05:35 PM 12 NewWinSCPItem.txt PS C:\> Remove-WinSCPSession</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/New-WinSCPItem</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-WinSCPItemPermission</command:name> <maml:description> <maml:para>Represents *nix-style remote file permissions.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>WinSCPItemPermission</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Represents *nix-style remote file permissions.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-WinSCPItemPermission</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Numeric</maml:name> <maml:description> <maml:para>Permissions as a number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Octal</maml:name> <maml:description> <maml:para>Permissions in octal format, e.g. "644". Octal format has 3 or 4 (when any special permissions are set) digits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Text</maml:name> <maml:description> <maml:para>Permissions as a text in format "rwxrwxrwx".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupExecute</maml:name> <maml:description> <maml:para>Execute permission for group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupRead</maml:name> <maml:description> <maml:para>Read permission for group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupWrite</maml:name> <maml:description> <maml:para>Write permission for group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OtherExecute</maml:name> <maml:description> <maml:para>Execute permission for others.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OtherRead</maml:name> <maml:description> <maml:para>Read permission for others.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OtherWrite</maml:name> <maml:description> <maml:para>Write permission for others.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetGid</maml:name> <maml:description> <maml:para>Grants the user, who executes the file, permissions of file group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetUid</maml:name> <maml:description> <maml:para>Grants the user, who executes the file, permissions of file owner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Sticky</maml:name> <maml:description> <maml:para>Sticky bit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserExecute</maml:name> <maml:description> <maml:para>Execute permission for owner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserRead</maml:name> <maml:description> <maml:para>Read permission for owner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserWrite</maml:name> <maml:description> <maml:para>Write permission for owner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupExecute</maml:name> <maml:description> <maml:para>Execute permission for group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupRead</maml:name> <maml:description> <maml:para>Read permission for group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GroupWrite</maml:name> <maml:description> <maml:para>Write permission for group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Numeric</maml:name> <maml:description> <maml:para>Permissions as a number.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Octal</maml:name> <maml:description> <maml:para>Permissions in octal format, e.g. "644". Octal format has 3 or 4 (when any special permissions are set) digits.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OtherExecute</maml:name> <maml:description> <maml:para>Execute permission for others.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OtherRead</maml:name> <maml:description> <maml:para>Read permission for others.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OtherWrite</maml:name> <maml:description> <maml:para>Write permission for others.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetGid</maml:name> <maml:description> <maml:para>Grants the user, who executes the file, permissions of file group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SetUid</maml:name> <maml:description> <maml:para>Grants the user, who executes the file, permissions of file owner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Sticky</maml:name> <maml:description> <maml:para>Sticky bit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>Text</maml:name> <maml:description> <maml:para>Permissions as a text in format "rwxrwxrwx".</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserExecute</maml:name> <maml:description> <maml:para>Execute permission for owner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserRead</maml:name> <maml:description> <maml:para>Read permission for owner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>UserWrite</maml:name> <maml:description> <maml:para>Write permission for owner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.FilePermissions</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPItemPermission Numeric : 0 Text : --------- Octal : 000 OtherExecute : False OtherWrite : False OtherRead : False GroupExecute : False GroupWrite : False GroupRead : False UserExecute : False UserWrite : False UserRead : False Sticky : False SetGid : False SetUid : False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPItemPermission -OtherExecute -GroupExecute Numeric : 9 Text : -----x--x Octal : 011 OtherExecute : True OtherWrite : False OtherRead : False GroupExecute : True GroupWrite : False GroupRead : False UserExecute : False UserWrite : False UserRead : False Sticky : False SetGid : False SetUid : False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/New-WinSCPItemPermission</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_filepermissions</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-WinSCPSession</command:name> <maml:description> <maml:para>This is the main interface class of the WinSCP assembly.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>WinSCPSession</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This is the main interface class of the WinSCP assembly. It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-WinSCPSession</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>SessionOption</maml:name> <maml:description> <maml:para>Defines information to allow an automatic connection and authentication of the session. Returned from the New-WinSCPSessionOption command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SessionOptions</command:parameterValue> <dev:type> <maml:name>SessionOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalExecutableArguments</maml:name> <maml:description> <maml:para>Additional command-line arguments to be passed to winscp.com. In general, this should be left with default null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DebugLogLevel</maml:name> <maml:description> <maml:para>Logging level of debug log to. The default value is 0. The maximal logging level is 2.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DebugLogPath</maml:name> <maml:description> <maml:para>Path to store assembly debug log to. Default null means, no debug log file is created. See also SessionLogPath.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecutableProcessCredential</maml:name> <maml:description> <maml:para>If the .NET process is running in an impersonated environment, you need to provide credentials of the impersonated account, so that the winscp.exe process can be started with the same privileges.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReconnectTime</maml:name> <maml:description> <maml:para>Sets time limit in seconds to try reconnecting broken sessions. Default is 120 seconds. Use TimeSpan.MaxValue to remove any limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionLogPath</maml:name> <maml:description> <maml:para>Path to store session log file to. Default null means, no session log file is created. See also DebugLogPath.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>SessionOption</maml:name> <maml:description> <maml:para>Defines information to allow an automatic connection and authentication of the session. Returned from the New-WinSCPSessionOption command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SessionOptions</command:parameterValue> <dev:type> <maml:name>SessionOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AdditionalExecutableArguments</maml:name> <maml:description> <maml:para>Additional command-line arguments to be passed to winscp.com. In general, this should be left with default null.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DebugLogLevel</maml:name> <maml:description> <maml:para>Logging level of debug log to. The default value is 0. The maximal logging level is 2.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DebugLogPath</maml:name> <maml:description> <maml:para>Path to store assembly debug log to. Default null means, no debug log file is created. See also SessionLogPath.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExecutableProcessCredential</maml:name> <maml:description> <maml:para>If the .NET process is running in an impersonated environment, you need to provide credentials of the impersonated account, so that the winscp.exe process can be started with the same privileges.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ReconnectTime</maml:name> <maml:description> <maml:para>Sets time limit in seconds to try reconnecting broken sessions. Default is 120 seconds. Use TimeSpan.MaxValue to remove any limit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionLogPath</maml:name> <maml:description> <maml:para>Path to store session log file to. Default null means, no session log file is created. See also DebugLogPath.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>null</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.SessionOptions</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.Session</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPSession -SessionOption (New-WinSCPSessionOption -HostName ftp.dotps1.github.io -Protocol Ftp) Opened Timeout HostName ------ ------- -------- True 00:01:00 ftp.dotps1.github.io</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> $credential = Get-Credential PS C:\> $sshHostKeyFingerprint = "ssh-dss 2048 01:aa:23:bb:45:cc:67:dd:89:ee:01:ff:23:aa:45:bb" PS C:\> $sessionOption = New-WinSCPSessionOption -HostName ftp.dotps1.github.io -SshHostKeyFingerprint $sshHostKeyFingerprint -Credential $credential PS C:\> New-WinSCPSession -SessionOption $sessionOption Opened Timeout HostName ------ ------- -------- True 00:01:00 ftp.dotps1.github.io</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/New-WinSCPSession</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_open</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-WinSCPSessionOption</command:name> <maml:description> <maml:para>Defines information to allow an automatic connection and authentication of the session. Is used with the Session.Open and Session.ScanFingerprint methods.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>WinSCPSessionOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Defines information to allow an automatic connection and authentication of the session. Is used with the New-WinSCPSession and Get-WinSCPSshHostKeyFingerprint methods.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-WinSCPSessionOption</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Represents a set of security credentials, such as a user name and a password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FtpMode</maml:name> <maml:description> <maml:para>Possible values are FtpMode.Passive (default) and FtpMode.Active.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">FtpMode</command:parameterValue> <dev:type> <maml:name>FtpMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FtpSecure</maml:name> <maml:description> <maml:para>Possible values are FtpSecure.None (default), FtpSecure.Implicit and FtpSecure.Explicit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">FtpSecure</command:parameterValue> <dev:type> <maml:name>FtpSecure</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Name of the host to connect to. Mandatory property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>Port number to connect to. Keep default 0 to use the default port for the protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PrivateKeyPassphrase</maml:name> <maml:description> <maml:para>Passphrase for encrypted private keys and client certificates.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>Protocol to use for the session. Possible values are Protocol.Sftp (default), Protocol.Scp, Protocol.Ftp and Protocol.Webdav.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Protocol</command:parameterValue> <dev:type> <maml:name>Protocol</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Sftp</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <maml:name>SshHostKeyFingerprint</maml:name> <maml:description> <maml:para>Fingerprint of SSH server host key (or several alternative fingerprints separated by semicolon). It makes WinSCP automatically accept host key with the fingerprint. Mandatory for SFTP/SCP protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>SshPrivateKeyPath</maml:name> <maml:description> <maml:para>Full path to SSH private key file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>TlsClientCertificatePath</maml:name> <maml:description> <maml:para>Full path to TLS/SSL client certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="10"> <maml:name>TlsHostCertificateFingerprint</maml:name> <maml:description> <maml:para>Fingerprint of FTPS/WebDAVS server TLS/SSL certificate to be automatically accepted (useful for certificates signed by untrusted authority).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="11"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Server response timeout. Defaults to 15 seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="12"> <maml:name>WebdavRoot</maml:name> <maml:description> <maml:para>WebDAV root path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="13"> <maml:name>RawSetting</maml:name> <maml:description> <maml:para>Allows configuring any site settings using raw format as in an INI file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GiveUpSecurityAndAcceptAnySshHostKey</maml:name> <maml:description> <maml:para>Give up security and accept any SSH host key. To be used in exceptional situations only, when security is not required. When set, log files will include warning about insecure connection. To maintain security, use SshHostKeyFingerprint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GiveUpSecurityAndAcceptAnyTlsHostCertificate</maml:name> <maml:description> <maml:para>Give up security and accept any FTPS/WebDAVS server TLS/SSL certificate. To be used in exceptional situations only, when security is not required. When set, log files will include warning about insecure connection. To maintain security, use TlsHostCertificateFingerprint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WebdavSecure</maml:name> <maml:description> <maml:para>Use WebDAVS (WebDAV over TLS/SSL), instead of WebDAV.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Represents a set of security credentials, such as a user name and a password.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FtpMode</maml:name> <maml:description> <maml:para>Possible values are FtpMode.Passive (default) and FtpMode.Active.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">FtpMode</command:parameterValue> <dev:type> <maml:name>FtpMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>FtpSecure</maml:name> <maml:description> <maml:para>Possible values are FtpSecure.None (default), FtpSecure.Implicit and FtpSecure.Explicit.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">FtpSecure</command:parameterValue> <dev:type> <maml:name>FtpSecure</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GiveUpSecurityAndAcceptAnySshHostKey</maml:name> <maml:description> <maml:para>Give up security and accept any SSH host key. To be used in exceptional situations only, when security is not required. When set, log files will include warning about insecure connection. To maintain security, use SshHostKeyFingerprint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>GiveUpSecurityAndAcceptAnyTlsHostCertificate</maml:name> <maml:description> <maml:para>Give up security and accept any FTPS/WebDAVS server TLS/SSL certificate. To be used in exceptional situations only, when security is not required. When set, log files will include warning about insecure connection. To maintain security, use TlsHostCertificateFingerprint.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>HostName</maml:name> <maml:description> <maml:para>Name of the host to connect to. Mandatory property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>PortNumber</maml:name> <maml:description> <maml:para>Port number to connect to. Keep default 0 to use the default port for the protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>PrivateKeyPassphrase</maml:name> <maml:description> <maml:para>Passphrase for encrypted private keys and client certificates.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>Protocol</maml:name> <maml:description> <maml:para>Protocol to use for the session. Possible values are Protocol.Sftp (default), Protocol.Scp, Protocol.Ftp and Protocol.Webdav.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Protocol</command:parameterValue> <dev:type> <maml:name>Protocol</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Sftp</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="7"> <maml:name>SshHostKeyFingerprint</maml:name> <maml:description> <maml:para>Fingerprint of SSH server host key (or several alternative fingerprints separated by semicolon). It makes WinSCP automatically accept host key with the fingerprint. Mandatory for SFTP/SCP protocol.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8"> <maml:name>SshPrivateKeyPath</maml:name> <maml:description> <maml:para>Full path to SSH private key file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9"> <maml:name>TlsClientCertificatePath</maml:name> <maml:description> <maml:para>Full path to TLS/SSL client certificate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="10"> <maml:name>TlsHostCertificateFingerprint</maml:name> <maml:description> <maml:para>Fingerprint of FTPS/WebDAVS server TLS/SSL certificate to be automatically accepted (useful for certificates signed by untrusted authority).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="11"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>Server response timeout. Defaults to 15 seconds.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TimeSpan</command:parameterValue> <dev:type> <maml:name>TimeSpan</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WebdavSecure</maml:name> <maml:description> <maml:para>Use WebDAVS (WebDAV over TLS/SSL), instead of WebDAV.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="12"> <maml:name>WebdavRoot</maml:name> <maml:description> <maml:para>WebDAV root path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="13"> <maml:name>RawSetting</maml:name> <maml:description> <maml:para>Allows configuring any site settings using raw format as in an INI file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.SessionOptions</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPSessionOption -HostName ftp.dotps1.github.io Protocol : Sftp HostName : ftp.dotps1.github.io PortNumber : 0 UserName : anonymous Password : SecurePassword : System.Security.SecureString NewPassword : SecureNewPassword : Timeout : 00:00:15 TimeoutInMilliseconds : 15000 PrivateKeyPassphrase : SshHostKeyFingerprint : GiveUpSecurityAndAcceptAnySshHostKey : False SshPrivateKeyPath : SshPrivateKeyPassphrase : FtpMode : Passive FtpSecure : None WebdavSecure : False WebdavRoot : TlsHostCertificateFingerprint : GiveUpSecurityAndAcceptAnyTlsHostCertificate : False TlsClientCertificatePath :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPSessionOption -HostName ftp.dotps1.github.io -Protocol Sftp -SshHostKeyFingerPrint "ssh-dss 2048 01:aa:23:bb:45:cc:67:dd:89:ee:01:ff:23:aa:45:bb" -Credential (Get-Credential) Protocol : Sftp HostName : ftp.dotps1.github.io PortNumber : 0 UserName : dotps1 Password : SecurePassword : System.Security.SecureString NewPassword : SecureNewPassword : Timeout : 00:00:15 TimeoutInMilliseconds : 15000 PrivateKeyPassphrase : SshHostKeyFingerprint : ssh-dss 2048 01:aa:23:bb:45:cc:67:dd:89:ee:01:ff:23:aa:45:bb GiveUpSecurityAndAcceptAnySshHostKey : False SshPrivateKeyPath : SshPrivateKeyPassphrase : FtpMode : Passive FtpSecure : None WebdavSecure : False WebdavRoot : TlsHostCertificateFingerprint : GiveUpSecurityAndAcceptAnyTlsHostCertificate : False TlsClientCertificatePath :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/New-WinSCPSessionOption</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_sessionoptions</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-WinSCPTransferOption</command:name> <maml:description> <maml:para>Defines options for file transfers.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>WinSCPTransferOption</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Defines options for file transfers.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-WinSCPTransferOption</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FileMask</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FilePermissions</maml:name> <maml:description> <maml:para>Permissions to applied to a remote file (used for uploads only). Use default null to keep default permissions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">FilePermissions</command:parameterValue> <dev:type> <maml:name>FilePermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OverwriteMode</maml:name> <maml:description> <maml:para>Behavior when overwriting existing files. Possible values are: OverwriteMode.Overwrite (default) to overwrite the existing files. OverwriteMode.Resume to assume that the existing and smaller file is a remnant of an interrupted transfer and resumes the transfer. SFTP and FTP protocols only. OverwriteMode.Append to append the source file to the end of existing target file. SFTP protocol only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OverwriteMode</command:parameterValue> <dev:type> <maml:name>OverwriteMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PreserveTimestamp</maml:name> <maml:description> <maml:para>Preserve timestamp (set last write time of destination file to that of source file). Defaults to true. When used with Session.SynchronizeDirectories, timestamp is always preserved, disregarding property value, unless criteria parameter is SynchronizationCriteria.None or SynchronizationCriteria.Size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>TransferResumeSupport</maml:name> <maml:description> <maml:para>Configures automatic resume/transfer to temporary filename.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferResumeSupport</command:parameterValue> <dev:type> <maml:name>TransferResumeSupport</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SpeedLimit</maml:name> <maml:description> <maml:para>Limit transfer speed (in KB/s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>TransferMode</maml:name> <maml:description> <maml:para>Possible values are TransferMode.Binary (default), TransferMode.Ascii and TransferMode.Automatic (based on file extension).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferMode</command:parameterValue> <dev:type> <maml:name>TransferMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>FileMask</maml:name> <maml:description> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>FilePermissions</maml:name> <maml:description> <maml:para>Permissions to applied to a remote file (used for uploads only). Use default null to keep default permissions.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">FilePermissions</command:parameterValue> <dev:type> <maml:name>FilePermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>OverwriteMode</maml:name> <maml:description> <maml:para>Behavior when overwriting existing files. Possible values are: OverwriteMode.Overwrite (default) to overwrite the existing files. OverwriteMode.Resume to assume that the existing and smaller file is a remnant of an interrupted transfer and resumes the transfer. SFTP and FTP protocols only. OverwriteMode.Append to append the source file to the end of existing target file. SFTP protocol only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">OverwriteMode</command:parameterValue> <dev:type> <maml:name>OverwriteMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>PreserveTimestamp</maml:name> <maml:description> <maml:para>Preserve timestamp (set last write time of destination file to that of source file). Defaults to true. When used with Session.SynchronizeDirectories, timestamp is always preserved, disregarding property value, unless criteria parameter is SynchronizationCriteria.None or SynchronizationCriteria.Size.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>TransferResumeSupport</maml:name> <maml:description> <maml:para>Configures automatic resume/transfer to temporary filename.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferResumeSupport</command:parameterValue> <dev:type> <maml:name>TransferResumeSupport</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>SpeedLimit</maml:name> <maml:description> <maml:para>Limit transfer speed (in KB/s).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6"> <maml:name>TransferMode</maml:name> <maml:description> <maml:para>Possible values are TransferMode.Binary (default), TransferMode.Ascii and TransferMode.Automatic (based on file extension).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferMode</command:parameterValue> <dev:type> <maml:name>TransferMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.TransferOptions</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPTransferOption PreserveTimestamp : True FilePermissions : TransferMode : Binary FileMask : ResumeSupport : default SpeedLimit : 0 OverwriteMode : Overwrite</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPTransferOption -PreserveTimestamp:$false -FilePermissions (New-WinSCPItemPermission -OtherExecute) PreserveTimestamp : False FilePermissions : --------x TransferMode : Binary FileMask : ResumeSupport : default SpeedLimit : 0 OverwriteMode : Overwrite</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/New-WinSCPTransferOption</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_transferoptions</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-WinSCPTransferResumeSupport</command:name> <maml:description> <maml:para>Configures automatic resume/transfer to temporary filename.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>WinSCPTransferResumeSupport</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Configures automatic resume/transfer to temporary filename.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-WinSCPTransferResumeSupport</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>TransferResumeSupportState</maml:name> <maml:description> <maml:para>Sets what files will be transferred with resume support/to temporary filename. Use TransferResumeSupportState.Default for built-in default (currently all files above 100 KB), TransferResumeSupportState.On for all files, TransferResumeSupportState.Off for no file (turn off) or TransferResumeSupportState.Smart for all files above threshold (see Threshold).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferResumeSupportState</command:parameterValue> <dev:type> <maml:name>TransferResumeSupportState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Threshold</maml:name> <maml:description> <maml:para>Threshold (in KB) for TransferResumeSupportState.Smart mode. Setting the Threshold automatically sets the State to the TransferResumeSupportState.Smart.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>TransferResumeSupportState</maml:name> <maml:description> <maml:para>Sets what files will be transferred with resume support/to temporary filename. Use TransferResumeSupportState.Default for built-in default (currently all files above 100 KB), TransferResumeSupportState.On for all files, TransferResumeSupportState.Off for no file (turn off) or TransferResumeSupportState.Smart for all files above threshold (see Threshold).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferResumeSupportState</command:parameterValue> <dev:type> <maml:name>TransferResumeSupportState</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Threshold</maml:name> <maml:description> <maml:para>Threshold (in KB) for TransferResumeSupportState.Smart mode. Setting the Threshold automatically sets the State to the TransferResumeSupportState.Smart.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.TransferResumeSupport</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPTransferResumeSupport State Threshold ----- --------- Default</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/New-WinSCPTransferResumeSupport</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_transferresumesupport</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Receive-WinSCPItem</command:name> <maml:description> <maml:para>Downloads one or more files from remote directory to local directory.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Receive</command:verb> <command:noun>WinSCPItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Downloads one or more files from remote directory to local directory.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Receive-WinSCPItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Path"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para>Full path to remote directory followed by slash and wildcard to select files or subdirectories to download.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="Destination"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Full path to download the file to. When downloading multiple files, the filename in the path should be replaced with operation mask or omitted (path ends with backslash).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TransferOptions</maml:name> <maml:description> <maml:para>Transfer options. Defaults to null, what is equivalent to New-WinSCPTransferOption.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferOptions</command:parameterValue> <dev:type> <maml:name>TransferOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>When set to true, deletes source remote file(s) after transfer. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Path"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para>Full path to remote directory followed by slash and wildcard to select files or subdirectories to download.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="Destination"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Full path to download the file to. When downloading multiple files, the filename in the path should be replaced with operation mask or omitted (path ends with backslash).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>When set to true, deletes source remote file(s) after transfer. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TransferOptions</maml:name> <maml:description> <maml:para>Transfer options. Defaults to null, what is equivalent to New-WinSCPTransferOption.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferOptions</command:parameterValue> <dev:type> <maml:name>TransferOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.TransferOperationResult</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Receive-WinSCPItem -RemotePath ftpDoc1.txt Destination: C:\ IsSuccess FileName --------- -------- True ftpDoc1.txt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPItem -Path NewWinSCPItem.txt -ItemType File -Value "Hello World!" Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 7/5/2017 10:54:45 AM 12 NewWinSCPItem.txt PS C:\> Receive-WinSCPItem -RemotePath NewWinSCPItem.txt -LocalPath C:\Users\dotps1\Desktop -Remove Destination: C:\Users\dotps1\Desktop IsSuccess FileName --------- -------- True NewWinSCPItem.txt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Receive-WinSCPItem</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_getfiles</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-WinSCPItem</command:name> <maml:description> <maml:para>Removes one or more remote files.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>WinSCPItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes one or more remote files.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-WinSCPItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to remote directory followed by slash and wildcard to select files or subdirectories to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to remote directory followed by slash and wildcard to select files or subdirectories to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Remove-WinSCPItem -Path NewWinSCPItem.txt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Remove-WinSCPItem</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_removefiles</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-WinSCPSession</command:name> <maml:description> <maml:para>Closes and disposes the WinSCP.Session object.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>WinSCPSession</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Closes and disposes the WinSCP.Session object.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-WinSCPSession</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Remove-WinSCPSession</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Remove-WinSCPSession</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_close</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Rename-WinSCPItem</command:name> <maml:description> <maml:para></maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>WinSCPItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Rename-WinSCPItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The full path to the item to e renamed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name for the item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Output the WinSCP.RemoteFileInfo object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>The full path to the item to e renamed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name for the item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Output the WinSCP.RemoteFileInfo object.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Rename-WinSCPItem -Path NewWinSCPItem.txt -NewName RenameWinSCPItem.txt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-WinSCPItem -Path NewWinSCPItem.txt -ItemType File Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 7/5/2017 12:14:55 PM 0 NewWinSCPItem.txt PS C:\> Rename-WinSCPItem -Path NewWinSCPItem.txt -NewName RenameWinSCPItem.txt -PassThru Directory: ./ Mode LastWriteTime Length Name ---- ------------- ------ ---- --------- 7/5/2017 2:26:09 PM 0 RenameWinSCPItem.txt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Rename-WinSCPItem</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_movefile</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Send-WinSCPItem</command:name> <maml:description> <maml:para>Uploads one or more files from local directory to remote directory.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Send</command:verb> <command:noun>WinSCPItem</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Uploads one or more files from local directory to remote directory.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Send-WinSCPItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Path"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Full path to local file or directory to upload. Filename in the path can be replaced with Windows wildcard to select multiple files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="Destination"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para>Full path to upload the file to. When uploading multiple files, the filename in the path should be replaced with operation mask or omitted (path ends with slash).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TransferOptions</maml:name> <maml:description> <maml:para>Transfer options. Defaults to null, what is equivalent to New-WinSCPTransferOption.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferOptions</command:parameterValue> <dev:type> <maml:name>TransferOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>When set to true, deletes source local file(s) after transfer. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Path"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Full path to local file or directory to upload. Filename in the path can be replaced with Windows wildcard to select multiple files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="Destination"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para>Full path to upload the file to. When uploading multiple files, the filename in the path should be replaced with operation mask or omitted (path ends with slash).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>When set to true, deletes source local file(s) after transfer. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>TransferOptions</maml:name> <maml:description> <maml:para>Transfer options. Defaults to null, what is equivalent to New-WinSCPTransferOption.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferOptions</command:parameterValue> <dev:type> <maml:name>TransferOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.TransferOperationResult</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Send-WinSCPItem -LocalPath ftpDoc3.txt Destination: \ IsSuccess FileName --------- -------- True ftpDoc3.txt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> New-Item -Name NewItem.txt -ItemType File -Value "Hello World!" Directory: C:\ Mode LastWriteTime Length Name ---- ------------- ------ ---- -a---- 7/5/2017 2:48 PM 12 NewItem.txt PS C:\ Send-WinSCPItem -LocalPath NewItem.txt -Remove Destination: \ IsSuccess FileName --------- -------- True NewItem.txt</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Send-WinSCPItem</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_putfiles</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Start-WinSCPConsole</command:name> <maml:description> <maml:para>Starts an ineratice WinSCP Console.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Start</command:verb> <command:noun>WinSCPConsole</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Starts an ineratice WinSCP Console.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Start-WinSCPConsole</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Start-WinSCPConsole</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Start-WinSCPConsole</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/commandline#scripting</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Sync-WinSCPPath</command:name> <maml:description> <maml:para>Synchronizes directories.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Sync</command:verb> <command:noun>WinSCPPath</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Synchronizes directories.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Sync-WinSCPPath</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Synchronization mode. Possible values are SynchronizationMode.Local, SynchronizationMode.Remote and SynchronizationMode.Both.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SynchronizationMode</command:parameterValue> <dev:type> <maml:name>SynchronizationMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Full path to local directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para>Full path to remote directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Criteria</maml:name> <maml:description> <maml:para>Comparison criteria. Possible values are SynchronizationCriteria.None, SynchronizationCriteria.Time (default), SynchronizationCriteria.Size and SynchronizationCriteria.Either. For SynchronizationMode.Both SynchronizationCriteria.Time can be used only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SynchronizationCriteria</command:parameterValue> <dev:type> <maml:name>SynchronizationCriteria</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>TransferOptions</maml:name> <maml:description> <maml:para>Transfer options. Defaults to null, what is equivalent to New-WinSCPTransferOption.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferOptions</command:parameterValue> <dev:type> <maml:name>TransferOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>When set to true, deletes obsolete files. Cannot be used for SynchronizationMode.Both.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mirror</maml:name> <maml:description> <maml:para>When set to true, synchronizes in mirror mode (synchronizes also older files). Cannot be used for SynchronizationMode.Both. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Synchronization mode. Possible values are SynchronizationMode.Local, SynchronizationMode.Remote and SynchronizationMode.Both.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SynchronizationMode</command:parameterValue> <dev:type> <maml:name>SynchronizationMode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Full path to local directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para>Full path to remote directory.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Remove</maml:name> <maml:description> <maml:para>When set to true, deletes obsolete files. Cannot be used for SynchronizationMode.Both.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Mirror</maml:name> <maml:description> <maml:para>When set to true, synchronizes in mirror mode (synchronizes also older files). Cannot be used for SynchronizationMode.Both. Defaults to false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Criteria</maml:name> <maml:description> <maml:para>Comparison criteria. Possible values are SynchronizationCriteria.None, SynchronizationCriteria.Time (default), SynchronizationCriteria.Size and SynchronizationCriteria.Either. For SynchronizationMode.Both SynchronizationCriteria.Time can be used only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SynchronizationCriteria</command:parameterValue> <dev:type> <maml:name>SynchronizationCriteria</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5"> <maml:name>TransferOptions</maml:name> <maml:description> <maml:para>Transfer options. Defaults to null, what is equivalent to New-WinSCPTransferOption.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">TransferOptions</command:parameterValue> <dev:type> <maml:name>TransferOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>WinSCP.SynchronizationResult</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Sync-WinSCPPath -Mode Local Uploads : {} Downloads : {/ftpDoc1.txt, /ftpDoc2.txt} Removals : {} Failures : {} IsSuccess : True</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>EXAMPLE 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Sync-WinSCPPath -Mode Both -Criteria Time Uploads : {C:\Users\us165614\Desktop\local\localDoc1.txt, C:\Users\us165614\Desktop\local\localDoc2.txt} Downloads : {/ftpDoc1.txt, /ftpDoc2.txt} Removals : {} Failures : {} IsSuccess : True</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Sync-WinSCPPath</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_synchronizedirectories</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Test-WinSCPPath</command:name> <maml:description> <maml:para>Checks for existence of remote file or directory.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Test</command:verb> <command:noun>WinSCPPath</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Checks for existence of remote file or directory.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Test-WinSCPPath</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to remote file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>WinSCPSession</maml:name> <maml:description> <maml:para>It represents a session and provides methods for manipulating remote files over SFTP, SCP or FTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Session</command:parameterValue> <dev:type> <maml:name>Session</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to remote file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>WinSCP.Session System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Test-WinSCPPath -Path / True</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!--Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>https://github.com/dotps1/WinSCP/wiki/Test-WinSCPPath</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>WinSCP reference:</maml:linkText> <maml:uri>https://winscp.net/eng/docs/library_session_fileexists</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.36--> </helpItems> |