en-US/PoshSSH.dll-help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <<<<<<< HEAD <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-SCPFile</command:name> <command:verb>Get</command:verb> <command:noun>SCPFile</command:noun> <maml:description><maml:para>Download a File from a SSH Server using SCP </maml:para> </maml:description> </command:details> <maml:description><maml:para>Download a specified file from a SSH Server using SCP given its full path and name to give it locally. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-SCPFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SCP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SCP connection </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LocalFile</maml:name> <maml:Description><maml:para>Full path and file name to where to download the file on the local system. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>RemoteFile</maml:name> <maml:Description><maml:para>Full path to file on server that you wish 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>Dont show a progress bar during download of the file. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SCP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SCP connection </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LocalFile</maml:name> <maml:Description><maml:para>Full path and file name to where to download the file on the local system. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>RemoteFile</maml:name> <maml:Description><maml:para>Full path to file on server that you wish 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>Dont show a progress bar during download of the file. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.String[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Int32</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks><maml:para>{{ Add example description here }} </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-SCPFolder</command:name> <command:verb>Get</command:verb> <command:noun>SCPFolder</command:noun> <maml:description><maml:para>Download a folder from a SSH Server using SCP. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Download a specified folder from a SSH Server using SCP. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-SCPFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SCP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SCP connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LocalFolder</maml:name> <maml:Description><maml:para>Full path and folder name to where to download the folder on the local system. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>RemoteFolder</maml:name> <maml:Description><maml:para>Full path to folder on server that you wish 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>Dont show a progress bar during download of the file. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SCP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SCP connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LocalFolder</maml:name> <maml:Description><maml:para>Full path and folder name to where to download the folder on the local system. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>RemoteFolder</maml:name> <maml:Description><maml:para>Full path to folder on server that you wish 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>Dont show a progress bar during download of the file. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.String[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Int32</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks><maml:para>{{ Add example description here }} </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-SFTPFile</command:name> <command:verb>Get</command:verb> <command:noun>SFTPFile</command:noun> <maml:description><maml:para>Download a filefrom a SSH Server using SFTP. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Download a folder from a SSH server using SFTP against a current session. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-SFTPFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>SessionId</maml:name> <maml:Description><maml:para>Session Id number of an exiting SFTP Session. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"><maml:name>LocalPath</maml:name> <maml:Description><maml:para>Folder on the local machine where to download the file to. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>RemoteFile</maml:name> <maml:Description><maml:para>Full path on of file to download on the remote host. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Overwrite</maml:name> <maml:Description><maml:para>If file is already present locally overwrite it. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-SFTPFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>SFTPSession</maml:name> <maml:Description><maml:para>SFTP Session Object of a currently connected session. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:type><maml:name>SftpSession[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"><maml:name>LocalPath</maml:name> <maml:Description><maml:para>Folder on the local machine where to download the file to. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>RemoteFile</maml:name> <maml:Description><maml:para>Full path on of file to download on the remote host. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Overwrite</maml:name> <maml:Description><maml:para>If file is already present locally overwrite it. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>SessionId</maml:name> <maml:Description><maml:para>Session Id number of an exiting SFTP Session. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>RemoteFile</maml:name> <maml:Description><maml:para>Full path on of file to download on the remote host. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"><maml:name>LocalPath</maml:name> <maml:Description><maml:para>Folder on the local machine where to download the file to. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Overwrite</maml:name> <maml:Description><maml:para>If file is already present locally overwrite it. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>SFTPSession</maml:name> <maml:Description><maml:para>SFTP Session Object of a currently connected session. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:type><maml:name>SftpSession[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>@{Text=} </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>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.Int32[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>SSH.SftpSession[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks><maml:para>{{ Add example description here }} </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-SFTPSession</command:name> <command:verb>New</command:verb> <command:noun>SFTPSession</command:noun> <maml:description><maml:para>Creates an SSH Session against a SSH Server </maml:para> </maml:description> </command:details> <maml:description><maml:para>Creates an SFTP Session against a remote server. The command supports creating connection thru a Proxy and allows for authentication to the server using username and password. If a key file is specified the command will use the password in the credentials parameter as the paraphrase of the key. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-SFTPSession</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SFTP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SFTP connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeepAliveInterval</maml:name> <maml:Description><maml:para>Keep Alive interval in seconds for a connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SFTP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SFTP connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeepAliveInterval</maml:name> <maml:Description><maml:para>Keep Alive interval in seconds for a connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.String[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Int32</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------- Example 1 --------------</maml:title> <dev:code>PS C:\> New-SFTPSession -ComputerName 192.168.1.155 -Credential (Get-Credential) -Verbose</dev:code> <dev:remarks><maml:para>Create a new SFTP Session to a remote hosts using credentials. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-SSHSession</command:name> <command:verb>New</command:verb> <command:noun>SSHSession</command:noun> <maml:description><maml:para>Creates an SSH Session against a SSH Server </maml:para> </maml:description> </command:details> <maml:description><maml:para>Creates an SSH Session against a remote server. The command supports creating connection thru a Proxy and allows for authentication to the server using username and password. If a key file is specified the command will use the password in the credentials parameter as the paraphrase of the key. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-SSHSession</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SSH Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SSH connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeepAliveInterval</maml:name> <maml:Description><maml:para>Keep Alive interval in seconds for a connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>{{Fill OperationTimeout Description}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SSH Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SSH connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeepAliveInterval</maml:name> <maml:Description><maml:para>Keep Alive interval in seconds for a connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>{{Fill OperationTimeout Description}} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.String[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Int32</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>-------------- Example 1 --------------</maml:title> <dev:code>PS C:\> New-SSHSession -ComputerName 192.168.1.234 -Credential (Get-Credential) -Verbose</dev:code> <dev:remarks><maml:para>Create a new SSH Session to a server. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-SCPFile</command:name> <command:verb>Set</command:verb> <command:noun>SCPFile</command:noun> <maml:description><maml:para>Copies a file to a SSH server using SCP. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Copies a specified file to a SSH Server using SCP given its full path and name. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-SCPFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SCP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>LocalFile</maml:name> <maml:Description><maml:para>Full path and file name on the local system of the file to upload. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>RemotePath</maml:name> <maml:Description><maml:para>@{Text=} </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SCP connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host, </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>Dont show a progress bar during uploading of the file. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Set-SCPFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SCP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>LocalFile</maml:name> <maml:Description><maml:para>Full path and file name on the local system of the file to upload. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>RemotePath</maml:name> <maml:Description><maml:para>@{Text=} </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SCP connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host, </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>Dont show a progress bar during uploading of the file. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SCP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SCP connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>LocalFile</maml:name> <maml:Description><maml:para>Full path and file name on the local system of the file to upload. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"><maml:name>RemotePath</maml:name> <maml:Description><maml:para>@{Text=} </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host, </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>Throw a terminating error if the host key is not a trusted one. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>Dont show a progress bar during uploading of the file. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.String[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Int32</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks><maml:para>{{ Add example description here }} </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-SCPFolder</command:name> <command:verb>Set</command:verb> <command:noun>SCPFolder</command:noun> <maml:description><maml:para>Copies a folder to a SSH server using SCP. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Copies a specified folder to a SSH Server using SCP given its full path and name. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-SCPFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SCP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SCP connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LocalFolder</maml:name> <maml:Description><maml:para>Full path and folder name of local file to upload using SCP. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>RemoteFolder</maml:name> <maml:Description><maml:para>Full path and name of folder to copy as the local folder on the remote system. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>Dont show a progress bar during uploading of the file. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName, Computer, IPAddress, Host"><maml:name>ComputerName</maml:name> <maml:Description><maml:para>FQDN or IP Address of host to establish a SCP Session. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Port</maml:name> <maml:Description><maml:para>SSH TCP Port number to use for the SCP connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyServer</maml:name> <maml:Description><maml:para>Proxy server name or IP Address to use for connection. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyPort</maml:name> <maml:Description><maml:para>Port to connect to on proxy server to route connection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProxyType</maml:name> <maml:Description><maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5). </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LocalFolder</maml:name> <maml:Description><maml:para>Full path and folder name of local file to upload using SCP. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>RemoteFolder</maml:name> <maml:Description><maml:para>Full path and name of folder to copy as the local folder on the remote system. </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionTimeout</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AcceptKey</maml:name> <maml:Description><maml:para>Automatically accepts a new SSH fingerprint for a host. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ErrorOnUntrusted</maml:name> <maml:Description><maml:para>@{Text=} </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>NoProgress</maml:name> <maml:Description><maml:para>Dont show a progress bar during uploading of the file. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Do not perform any host key validation of the host. </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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>KeyFile</maml:name> <maml:Description><maml:para>OpenSSH format SSH private key 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.String[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Management.Automation.PSCredential</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Int32</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks><maml:para>{{ Add example description here }} </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/</maml:uri> </maml:navigationLink> </command: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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-SFTPFile</command:name> <command:verb>Set</command:verb> <command:noun>SFTPFile</command:noun> <maml:description><maml:para>Copy a local file to a remote host using an existing SFTP Session. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Copy a local file to a remote host using an existing SFTP Session. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-SFTPFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>SessionId</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"><maml:name>LocalFile</maml:name> <maml:Description><maml:para>@{Text=} </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>RemotePath</maml:name> <maml:Description><maml:para>@{Text=} </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Overwrite</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Set-SFTPFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>SFTPSession</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:type><maml:name>SftpSession[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"><maml:name>LocalFile</maml:name> <maml:Description><maml:para>@{Text=} </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>RemotePath</maml:name> <maml:Description><maml:para>@{Text=} </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Overwrite</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>SessionId</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type><maml:name>Int32[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>RemotePath</maml:name> <maml:Description><maml:para>@{Text=} </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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"><maml:name>LocalFile</maml:name> <maml:Description><maml:para>@{Text=} </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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Overwrite</maml:name> <maml:Description><maml:para>@{Text=} </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>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>SFTPSession</maml:name> <maml:Description><maml:para>@{Text=} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:type><maml:name>SftpSession[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>System.Int32[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>System.String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> <command:inputType><dev:type><maml:name>SSH.SftpSession[]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks><maml:para>{{ Add example description here }} </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> ======= <!--Edited with: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> <!--Generated by: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> <!-- Root Module: Posh-SSH Root Version: 2.0 Module: PoshSSH Version: 1.0.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"> <!--Command--> <command:details> <command:name>Get-SCPFile</command:name> <maml:description> <maml:para>Download a File from a SSH Server using SCP</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SCPFile</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Download a specified file from a SSH Server using SCP given its full path and name to give it locally.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-SCPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalFile</maml:name> <maml:description> <maml:para>Full path and file name to where to download the file on the local system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteFile</maml:name> <maml:description> <maml:para>Full path to file on server that you wish to download.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during download of the file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SCPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format SSH private key file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalFile</maml:name> <maml:description> <maml:para>Full path and file name to where to download the file on the local system.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteFile</maml:name> <maml:description> <maml:para>Full path to file on server that you wish to download.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during download of the file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SCPFile</maml:name> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="false" globbing="false" position="named"> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required</maml:para> </maml:description> <command:parameterValue required="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>LocalFile</maml:name> <maml:description> <maml:para>Full path and file name to where to download the file on the local system.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>RemoteFile</maml:name> <maml:description> <maml:para>Full path to file on server that you wish to download.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during download of the file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalFile</maml:name> <maml:description> <maml:para>Full path and file name to where to download the file on the local system.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteFile</maml:name> <maml:description> <maml:para>Full path to file on server that you wish to download.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during download of the file.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format 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/> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title/> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> </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"> <!--Command--> <command:details> <command:name>Get-SCPFolder</command:name> <maml:description> <maml:para>Download a folder from a SSH Server using SCP.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SCPFolder</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Download a specified folder from a SSH Server using SCP.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-SCPFolder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Full path and folder name to where to download the folder on the local system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteFolder</maml:name> <maml:description> <maml:para>Full path to folder on server that you wish to download</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during download of the file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SCPFolder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format SSH private key file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Full path and folder name to where to download the folder on the local system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteFolder</maml:name> <maml:description> <maml:para>Full path to folder on server that you wish to download</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during download of the file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Full path and folder name to where to download the folder on the local system.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteFolder</maml:name> <maml:description> <maml:para>Full path to folder on server that you wish 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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during download of the file.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format 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/> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title/> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> </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"> <!--Command--> <command:details> <command:name>Get-SFTPFile</command:name> <maml:description> <maml:para>Download a filefrom a SSH Server using SFTP.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFTPFile</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Download a folder from a SSH server using SFTP against a current session.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Get-SFTPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Session Id number of an exiting SFTP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Folder on the local machine where to download the file to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemoteFile</maml:name> <maml:description> <maml:para>Full path on of file to download on the remote host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>If file is already present locally overwrite it.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFTPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of a currently connected session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Folder on the local machine where to download the file to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemoteFile</maml:name> <maml:description> <maml:para>Full path on of file to download on the remote host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>If file is already present locally overwrite it.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Session Id number of an exiting SFTP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemoteFile</maml:name> <maml:description> <maml:para>Full path on of file to download on the remote host.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"> <maml:name>LocalPath</maml:name> <maml:description> <maml:para>Folder on the local machine where to download the file to.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>If file is already present locally overwrite it.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of a currently connected session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:type> <maml:name>SftpSession[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title/> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> </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"> <!--Command--> <command:details> <command:name>Set-SFTPFile</command:name> <maml:description> <maml:para>Copy a local file to a remote host using an existing SFTP Session.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFTPFile</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Copy a local file to a remote host using an existing SFTP Session.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-SFTPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"> <maml:name>LocalFile</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SFTPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"> <maml:name>LocalFile</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>RemotePath</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="PSPath"> <maml:name>LocalFile</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Overwrite</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:type> <maml:name>SftpSession[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title/> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> </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"> <!--Command--> <command:details> <command:name>New-SFTPSession</command:name> <maml:description> <maml:para>Creates an SSH Session against a SSH Server</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFTPSession</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates an SFTP Session against a remote server. The command supports creating connection thru a Proxy and allows for authentication to the server using username and password. If a key file is specified the command will use the password in the credentials parameter as the paraphrase of the key.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-SFTPSession</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SFTP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SFTP connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeepAliveInterval</maml:name> <maml:description> <maml:para>Keep Alive interval in seconds for a connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFTPSession</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SFTP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SFTP connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format SSH private key file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeepAliveInterval</maml:name> <maml:description> <maml:para>Keep Alive interval in seconds for a connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFTPSession</maml:name> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SFTP Session.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SFTP connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="false" globbing="true" position="named"> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>KeepAliveInterval</maml:name> <maml:description> <maml:para>Keep Alive interval in seconds for a connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SFTP Session.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SFTP connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeepAliveInterval</maml:name> <maml:description> <maml:para>Keep Alive interval in seconds for a connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format 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/> </command:parameter> <command:parameter required="true" globbing="true" pipelineInput="false" position="named" aliases=""> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title/> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>-------------- Example 1 --------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code>PS C:\> New-SFTPSession -ComputerName 192.168.1.155 -Credential (Get-Credential) -Verbose</dev:code> <dev:remarks> <maml:para>Create a new SFTP Session to a remote hosts using credentials.</maml:para> </dev:remarks> </command:example> </command:examples> </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"> <!--Command--> <command:details> <command:name>New-SSHSession</command:name> <maml:description> <maml:para>Creates an SSH Session against a SSH Server</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SSHSession</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates an SSH Session against a remote server. The command supports creating connection thru a Proxy and allows for authentication to the server using username and password. If a key file is specified the command will use the password in the credentials parameter as the paraphrase of the key.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>New-SSHSession</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SSH Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SSH connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeepAliveInterval</maml:name> <maml:description> <maml:para>Keep Alive interval in seconds for a connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SSHSession</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SSH Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SSH connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format SSH private key file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeepAliveInterval</maml:name> <maml:description> <maml:para>Keep Alive interval in seconds for a connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SSHSession</maml:name> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SSH Session.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="false" globbing="false" position="named" aliases=""> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SSH connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>KeepAliveInterval</maml:name> <maml:description> <maml:para>Keep Alive interval in seconds for a connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SSH Session.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SSH connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeepAliveInterval</maml:name> <maml:description> <maml:para>Keep Alive interval in seconds for a connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format 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/> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title/> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> <command:examples> <!--Examples--> <command:example> <maml:title>-------------- Example 1 --------------</maml:title> <maml:introduction> <maml:para/> </maml:introduction> <dev:code>PS C:\> New-SSHSession -ComputerName 192.168.1.234 -Credential (Get-Credential) -Verbose</dev:code> <dev:remarks> <maml:para>Create a new SSH Session to a server.</maml:para> </dev:remarks> </command:example> </command:examples> </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"> <!--Command--> <command:details> <command:name>Set-SCPFile</command:name> <maml:description> <maml:para>Copies a file to a SSH server using SCP.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SCPFile</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Copies a specified file to a SSH Server using SCP given its full path and name.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-SCPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>LocalFile</maml:name> <maml:description> <maml:para>Full path and file name on the local system of the file to upload.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host,</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during uploading of the file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SCPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>LocalFile</maml:name> <maml:description> <maml:para>Full path and file name on the local system of the file to upload.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format SSH private key file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host,</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during uploading of the file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SCPFile</maml:name> <command:parameter required="true" pipelineinput="false" globbing="true" position="named"> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during uploading of the file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host,</maml:para> </maml:description> <command:parameterValue required="false">Boolean</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>RemotePath</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>LocalFile</maml:name> <maml:description> <maml:para>Full path and file name on the local system of the file to upload.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key passphrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>LocalFile</maml:name> <maml:description> <maml:para>Full path and file name on the local system of the file to upload.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>RemotePath</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host,</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para>Throw a terminating error if the host key is not a trusted one.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during uploading of the file.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format 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/> </command:parameter> <command:parameter required="true" globbing="true" pipelineInput="false" position="named" aliases=""> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title/> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> </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"> <!--Command--> <command:details> <command:name>Set-SCPFolder</command:name> <maml:description> <maml:para>Copies a folder to a SSH server using SCP.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SCPFolder</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Copies a specified folder to a SSH Server using SCP given its full path and name.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem> <maml:name>Set-SCPFolder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Full path and folder name of local file to upload using SCP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteFolder</maml:name> <maml:description> <maml:para>Full path and name of folder to copy as the local folder on the remote system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during uploading of the file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SCPFolder</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format SSH private key file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Full path and folder name of local file to upload using SCP.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteFolder</maml:name> <maml:description> <maml:para>Full path and name of folder to copy as the local folder on the remote system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during uploading of the file.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SCPFolder</maml:name> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</maml:para> </maml:description> <command:parameterValue required="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</maml:para> </maml:description> <command:parameterValue required="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Full path and folder name of local file to upload using SCP.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>RemoteFolder</maml:name> <maml:description> <maml:para>Full path and name of folder to copy as the local folder on the remote system.</maml:para> </maml:description> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during uploading of the file.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" pipelineinput="True (ByPropertyName)" globbing="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</maml:para> </maml:description> <command:parameterValue required="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" pipelineinput="false" globbing="true" position="named"> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="HostName , Computer , IPAddress , Host"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>FQDN or IP Address of host to establish a SCP Session.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Credential</maml:name> <maml:description> <maml:para>SSH Credentials to use for connecting to a server. If a key file is used the password field is used for the Key pass phrase.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>SSH TCP Port number to use for the SCP connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyServer</maml:name> <maml:description> <maml:para>Proxy server name or IP Address to use for connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyPort</maml:name> <maml:description> <maml:para>Port to connect to on proxy server to route connection.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyCredential</maml:name> <maml:description> <maml:para>PowerShell Credential Object with the credentials for use to connect to proxy server if required.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ProxyType</maml:name> <maml:description> <maml:para>Type of Proxy being used (HTTP, Socks4 or Socks5).</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>LocalFolder</maml:name> <maml:description> <maml:para>Full path and folder name of local file to upload using SCP.</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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>RemoteFolder</maml:name> <maml:description> <maml:para>Full path and name of folder to copy as the local folder on the remote system.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>OperationTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ConnectionTimeout</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>AcceptKey</maml:name> <maml:description> <maml:para>Automatically accepts a new SSH fingerprint for a host.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>ErrorOnUntrusted</maml:name> <maml:description> <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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>NoProgress</maml:name> <maml:description> <maml:para>Dont show a progress bar during uploading of the file.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Do not perform any host key validation of the host.</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/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>KeyFile</maml:name> <maml:description> <maml:para>OpenSSH format 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/> </command:parameter> <command:parameter required="true" globbing="true" pipelineInput="false" position="named" aliases=""> <maml:name>KeyString</maml:name> <maml:description> <maml:para>OpenSSH key in a string array to be used for authentication.</maml:para> </maml:description> <command:parameterValue required="true">String[]</command:parameterValue> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!--Notes--> <maml:title/> <maml:alert> <maml:para/> </maml:alert> </maml:alertSet> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2016 v1.1.19--> </helpItems> >>>>>>> Release_v2 |