Posh-SSH-master/en-US/Posh-SSH.psm1-Help.xml
|
<?xml version="1.0" encoding="utf-8" ?> <!-- Generated by: SAPIEN PowerShell Help Writer 2015 v1.0.9--> <!--Edited with: SAPIEN PowerShell Help Writer 2015 v1.0.9--> <helpItems xmlns="http://msh" schema="maml"> <!-- 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-PoshSSHModVersion</command:name> <maml:description> <maml:para>Gets the current installed version and the latest version of Posh-SSH.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>PoshSSHModVersion</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets the current installed version and the latest version of Posh-SSH.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-PoshSSHModVersion</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> </command:parameters> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>Get-PoshSSHModVersion InstalledVersion CurrentVersion ---------------- -------------- 1.7 1.6</dev:code> <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>Get-SFTPChildItem</command:name> <maml:description> <maml:para>Gets the items and child items in a specified path.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFTPChildItem</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets the items and child items in a specified path.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SFTPChildItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of directory whose content will be enumerated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFTPChildItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of directory whose content will be enumerated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">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"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of directory whose content will be enumerated.</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 (ByValue)" position="0"> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFTPChildItem -SessionId 0 FullName : /home/admin/. LastAccessTime : 3/17/2015 8:44:38 PM LastWriteTime : 3/12/2015 6:06:00 PM Length : 4096 UserId : 1000 FullName : /home/admin/.. LastAccessTime : 3/12/2015 12:42:46 PM LastWriteTime : 3/12/2015 11:45:06 AM Length : 18 UserId : 0 FullName : /home/admin/.bash_logout LastAccessTime : 3/15/2015 9:16:49 AM LastWriteTime : 6/10/2014 12:31:53 AM Length : 18 UserId : 1000 FullName : /home/admin/.bash_profile LastAccessTime : 3/16/2015 10:35:32 PM LastWriteTime : 6/10/2014 12:31:53 AM Length : 193 UserId : 1000 FullName : /home/admin/.bashrc LastAccessTime : 3/16/2015 10:35:32 PM LastWriteTime : 6/10/2014 12:31:53 AM Length : 231 UserId : 1000 FullName : /home/admin/.bash_history LastAccessTime : 3/16/2015 10:28:58 PM LastWriteTime : 3/16/2015 8:19:48 AM Length : 830 UserId : 1000 FullName : /home/admin/.ssh LastAccessTime : 3/12/2015 6:11:43 PM LastWriteTime : 3/12/2015 6:04:37 PM Length : 41 UserId : 1000 FullName : /home/admin/.viminfo LastAccessTime : 3/12/2015 6:06:00 PM LastWriteTime : 3/12/2015 6:06:00 PM Length : 577 UserId : 1000</dev:code> <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>Get-SFTPContent</command:name> <maml:description> <maml:para>Gets the content of the item at the specified location over SFTP.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFTPContent</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Gets the content of the item at the specified location over SFTP.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SFTPContent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to file to get content from.</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="2"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>How should the content be retured for the file being read. * Byte - returns a byte array. * MultiLine - Retuns a string array where each element represents a line in the file. * String - returns a string with all the contents of the 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>Encoding</maml:name> <maml:description> <maml:para>What type of encoding to use when content type is String or MultiLine.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFTPContent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to file to get content from.</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="2"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>How should the content be retured for the file being read. * Byte - returns a byte array. * MultiLine - Retuns a string array where each element represents a line in the file. * String - returns a string with all the contents of the 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>Encoding</maml:name> <maml:description> <maml:para>What type of encoding to use when content type is String or MultiLine.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">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"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to file to get content from.</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="2"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>How should the content be retured for the file being read. * Byte - returns a byte array. * MultiLine - Retuns a string array where each element represents a line in the file. * String - returns a string with all the contents of the 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="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Encoding</maml:name> <maml:description> <maml:para>What type of encoding to use when content type is String or MultiLine.</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 (ByValue)" position="0"> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <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:description> </command:inputType> </command:inputTypes> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Get-SFTPContent -SessionId 0 -Path /etc/system-release CentOS Linux release 7.0.1406 (Core)</dev:code> <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>Get-SFTPCurrentDirectory</command:name> <maml:description> <maml:para>Get the current location of a SFTP Session.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFTPCurrentDirectory</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get the current location of a SFTP Session specified by SessionId or SFTP Session Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SFTPCurrentDirectory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The SessionId number of an existing SFTP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:defaultValue/> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFTPCurrentDirectory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The SessionId number of an existing 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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> </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-SFTPDirectoryList</command:name> <maml:description> <maml:para>Get a List of Files for SFTP Session.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFTPDirectoryList</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get a collection of objection representing files on a given path on a SFTP Session.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SFTPDirectoryList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The SessionId number of an existing SFTP Session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Remote path to list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue/> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFTPDirectoryList</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Remote path to list.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue/> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The SessionId number of an existing 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="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Remote path to list.</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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> </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-SFTPLocation</command:name> <maml:description> <maml:para>Get the current working location for a SFTP connection.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFTPLocation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get the current working location for a SFTP connection.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SFTPLocation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFTPLocation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </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>SFTP Session Id of an exiting 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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> </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-SFTPPathAttribute</command:name> <maml:description> <maml:para>Get the attributes for a specified path in a SFTP session.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFTPPathAttribute</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get the attributes for a specified path in a SFTP session.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SFTPPathAttribute</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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 (ByValue)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to get information on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFTPPathAttribute</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to get information on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">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"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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 (ByValue)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path to get information on.</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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <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:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Renci.SshNet.Sftp.SftpFileAttributes</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>Get information on a specified path on a remote host. C:\PS></maml:para> </maml:introduction> <dev:code>Get-SFTPPathAttribute -SessionId 0 -Path "/tmp" LastAccessTime : 2/27/2015 6:38:43 PM LastWriteTime : 2/27/2015 7:01:01 PM Size : 512 UserId : 0 GroupId : 0 IsSocket : False IsSymbolicLink : False IsRegularFile : False IsBlockDevice : False IsDirectory : True IsCharacterDevice : False IsNamedPipe : False OwnerCanRead : True OwnerCanWrite : True OwnerCanExecute : True GroupCanRead : True GroupCanWrite : True GroupCanExecute : True OthersCanRead : True OthersCanWrite : True OthersCanExecute : True Extensions :</dev:code> <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>Get-SFTPSession</command:name> <maml:description> <maml:para>Get current SFTP Sessions that are available for interaction.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SFTPSession</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get current SFTP Sessions that are available for interaction.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SFTPSession</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32[]</command:parameterValue> <dev:defaultValue/> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases=""> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting session.</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:parameters> <maml:alertSet> <!-- Notes--> <maml:title/> <maml:alert> <maml:para>AUTHOR: Carlos Perez carlos_perez@darkoprator.com</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>Get all current SFTP sessions. C:\PS></maml:para> </maml:introduction> <dev:code>Get-SFTPSession SessionId Host Connected --------- ---- --------- 0 192.168.1.180 True</dev:code> <dev:remarks/> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/ http://www.darkoperator.com/</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Get-SSHSession</command:name> <maml:description> <maml:para>Get current SSH Session that are available for interaction.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SSHSession</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Get current SSH Session that are available for interaction.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SSHSession</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SessionId</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:parameters> <maml:alertSet> <!-- Notes--> <maml:title/> <maml:alert> <maml:para>AUTHOR: Carlos Perez carlos_perez@darkoprator.com</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>Get list of current sessions available. Get current SSH sessions. C:\PS></maml:para> </maml:introduction> <dev:code>Get-SSHSession SessionId Host Connected --------- ---- --------- 0 192.168.1.180 True</dev:code> <dev:remarks/> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/ http://www.darkoperator.com/</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Get-SSHTrustedHost</command:name> <maml:description> <maml:para>List Host and Fingerprint pairs that Posh-SSH trusts.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Get</command:verb> <command:noun>SSHTrustedHost</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>List Host and Fingerprint pairs that Posh-SSH trusts.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Get-SSHTrustedHost</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> </command:parameters> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>Get-SSHTrustedHost SSHHost Fingerprint ------- ----------- 192.168.1.143 a4:6e:80:33:3f:32:4:cb:be:e9:a0:80:1b:38:fd:3b 192.168.10.3 27:ca:f8:39:7e:ba:a:ff:a3:2d:ff:75:16:a6:bc:18 192.168.1.225 ea:8c:ec:93:1e:9d:ad:2e:41:bc:d0:b3:d8:a9:98:80</dev:code> <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>Invoke-SSHCommand</command:name> <maml:description> <maml:para>Executes a given command on a remote SSH host.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SSHCommand</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Executes a given command on a remote SSH hosst given credentials to the host or using an existing SSH Session.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Invoke-SSHCommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SSH Session Id of an exiting 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="false" position="1"> <maml:name>Command</maml:name> <maml:description> <maml:para>Command to execute in 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="2" aliases=""> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Time out in seconds to wait for the command to return a value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnsureConnection</maml:name> <maml:description> <maml:para>Ensures a connection is made by reconnecting before command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-SSHCommand</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SSHSession</maml:name> <maml:description> <maml:para>SSH Session object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SshSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Command</maml:name> <maml:description> <maml:para>Command to execute in 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="2" aliases=""> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Time out in seconds to wait for the command to return a value.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnsureConnection</maml:name> <maml:description> <maml:para>Ensures a connection is made by reconnecting before command.</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="false" position="1"> <maml:name>Command</maml:name> <maml:description> <maml:para>Command to execute in 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="false" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SSH Session Id of an exiting 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EnsureConnection</maml:name> <maml:description> <maml:para>Ensures a connection is made by reconnecting before command.</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="2" aliases=""> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Time out in seconds to wait for the command to return a value.</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="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SSHSession</maml:name> <maml:description> <maml:para>SSH Session object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SshSession[]</command:parameterValue> <dev:type> <maml:name>SshSession[]</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>SSH.SshSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!-- Notes--> <maml:title/> <maml:alert> <maml:para>AUTHOR: Carlos Perez carlos_perez@darkoprator.com</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>Executes the "uname -a" command against several sessions C:\PS></maml:para> </maml:introduction> <dev:code>Invoke-SSHCommand -Command "uname -a" -SessionId 0,2,3 Host : 192.168.1.163 Output : Linux debian6 2.6.32-5-amd64 #1 SMP Sun Sep 23 10:07:46 UTC 2012 x86_64 GNU/Linux ExitStatus : 0 Host : 192.168.1.155 Output : Linux ole6 2.6.39-300.17.1.el6uek.x86_64 #1 SMP Fri Oct 19 11:29:17 PDT 2012 x86_64 x86_64 x86_64 GNU/Linux ExitStatus : 0 Host : 192.168.1.234 Output : Linux ubuntusrv 3.2.0-29-generic #46-Ubuntu SMP Fri Jul 27 17:03:23 UTC 2012 x86_64 x86_64 x86_64 GNU/Linux ExitStatus : 0</dev:code> <dev:remarks/> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/ http://www.darkoperator.com/</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Invoke-SSHStreamExpectAction</command:name> <maml:description> <maml:para>Executes an action on a SSH ShellStream when output matches a desired string.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SSHStreamExpectAction</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Executes an action on a SSH ShellStream when output matches a desired string.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Invoke-SSHStreamExpectAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>ShellStream</maml:name> <maml:description> <maml:para>SSH Shell Stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ShellStream</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Command</maml:name> <maml:description> <maml:para>Initial command that will generate the output to be evaluated by the expect pattern.</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>ExpectString</maml:name> <maml:description> <maml:para>String on what to trigger the action on.</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>Action</maml:name> <maml:description> <maml:para>Command to execute once an expression is matched.</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="4"> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Number of seconds to wait for a match.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-SSHStreamExpectAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>ShellStream</maml:name> <maml:description> <maml:para>SSH Shell Stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ShellStream</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Command</maml:name> <maml:description> <maml:para>Initial command that will generate the output to be evaluated by the expect pattern.</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>ExpectRegex</maml:name> <maml:description> <maml:para>Regular expression on what to trigger the action on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Regex</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>Action</maml:name> <maml:description> <maml:para>Command to execute once an expression is matched.</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="4"> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Number of seconds to wait for a match.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="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, ByValue)" position="0"> <maml:name>ShellStream</maml:name> <maml:description> <maml:para>SSH Shell Stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ShellStream</command:parameterValue> <dev:type> <maml:name>ShellStream</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>Command</maml:name> <maml:description> <maml:para>Initial command that will generate the output to be evaluated by the expect pattern.</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="2"> <maml:name>ExpectString</maml:name> <maml:description> <maml:para>String on what to trigger the action on.</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>Action</maml:name> <maml:description> <maml:para>Command to execute once an expression is matched.</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="4"> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Number of seconds to wait for a match.</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="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>ExpectRegex</maml:name> <maml:description> <maml:para>Regular expression on what to trigger the action on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Regex</command:parameterValue> <dev:type> <maml:name>Regex</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>Renci.SshNet.ShellStream</maml:name> <maml:uri/> </dev:type> <maml:description> <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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Text.RegularExpressions.Regex</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> </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>Invoke-SSHStreamExpectSecureAction</command:name> <maml:description> <maml:para>Executes an action stored in a SecureString on a SSH ShellStream when output matches a desired string.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Invoke</command:verb> <command:noun>SSHStreamExpectSecureAction</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Executes an action stored in a secure string when an output is matched. By the expect action being in a secure string this function is best used when a password must be provided to a promp protecting it in memory. Examples uses would be for use in su or sudo commands.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Invoke-SSHStreamExpectSecureAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>ShellStream</maml:name> <maml:description> <maml:para>SSH Shell Stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ShellStream</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Command</maml:name> <maml:description> <maml:para>Initial command that will generate the output to be evaluated by the expect pattern.</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>ExpectString</maml:name> <maml:description> <maml:para>String on what to trigger the action on.</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>SecureAction</maml:name> <maml:description> <maml:para>SecureString representation of action once an expression is matched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Number of seconds to wait for a match.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-SSHStreamExpectSecureAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0"> <maml:name>ShellStream</maml:name> <maml:description> <maml:para>SSH Shell Stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ShellStream</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Command</maml:name> <maml:description> <maml:para>Initial command that will generate the output to be evaluated by the expect pattern.</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>ExpectRegex</maml:name> <maml:description> <maml:para>Regular expression on what to trigger the action on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Regex</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3"> <maml:name>SecureAction</maml:name> <maml:description> <maml:para>SecureString representation of action once an expression is matched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Number of seconds to wait for a match.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="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, ByValue)" position="0"> <maml:name>ShellStream</maml:name> <maml:description> <maml:para>SSH Shell Stream.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ShellStream</command:parameterValue> <dev:type> <maml:name>ShellStream</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>Command</maml:name> <maml:description> <maml:para>Initial command that will generate the output to be evaluated by the expect pattern.</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="2"> <maml:name>ExpectString</maml:name> <maml:description> <maml:para>String on what to trigger the action on.</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>SecureAction</maml:name> <maml:description> <maml:para>SecureString representation of action once an expression is matched.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4"> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Number of seconds to wait for a match.</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="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>ExpectRegex</maml:name> <maml:description> <maml:para>Regular expression on what to trigger the action on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Regex</command:parameterValue> <dev:type> <maml:name>Regex</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>Renci.SshNet.ShellStream</maml:name> <maml:uri/> </dev:type> <maml:description> <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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri/> </dev:type> <maml:description> <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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Text.RegularExpressions.Regex</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>Execute su command and pass protected password in a secure string to the SSH shell stream. C:\PS></maml:para> </maml:introduction> <dev:code>Invoke-SSHStreamExpectSecureAction -ShellStream $stream -Command 'su -' -ExpectString 'Passord:' -SecureAction (read-host -AsSecureString) -Verbose *********** VERBOSE: Executing command su -. VERBOSE: Waiting for match. VERBOSE: Executing action. VERBOSE: Action has been executed. True PS C:\> $stream.Read() Last login: Sat Mar 14 18:18:52 EDT 2015 on pts/0 Last failed login: Sun Mar 15 08:52:07 EDT 2015 on pts/0 There were 2 failed login attempts since the last successful login. [root@localhost ~]#</dev:code> <dev:remarks/> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>Invoke ifconfig command using sudo and provide the password for the account that is saved in a SecureString. C:\PS></maml:para> </maml:introduction> <dev:code>$sudoPassPropmp = [regex]':\s$' PS C:\> Invoke-SSHStreamExpectSecureAction -ShellStream $stream -Command 'sudo ifconfig' -ExpectRege x $sudoPassPropmp -SecureAction (read-host -AsSecureString) -Verbose *********** VERBOSE: Executing command sudo ifconfig. VERBOSE: Waiting for match. VERBOSE: Matching by RegEx. VERBOSE: Executing action. VERBOSE: Action has been executed. True PS C:\> $stream.Read() [sudo] password for admin: ens192: flags=4163<UP,BROADCAST,RUNNING,MULTICAST> mtu 1500 inet 192.168.1.180 netmask 255.255.240.0 broadcast 192.168.15.255 inet6 fe80::20c:29ff:feeb:34a0 prefixlen 64 scopeid 0x20<link> ether 00:0c:29:eb:34:a0 txqueuelen 1000 (Ethernet) RX packets 300644 bytes 175076049 (166.9 MiB) RX errors 0 dropped 0 overruns 0 frame 0 TX packets 139657 bytes 56363667 (53.7 MiB) TX errors 0 dropped 0 overruns 0 carrier 0 collisions 0 lo: flags=73<UP,LOOPBACK,RUNNING> mtu 65536 inet 127.0.0.1 netmask 255.0.0.0 inet6 ::1 prefixlen 128 scopeid 0x10<host> loop txqueuelen 0 (Local Loopback) RX packets 0 bytes 0 (0.0 B) RX errors 0 dropped 0 overruns 0 frame 0 TX packets 0 bytes 0 (0.0 B) TX errors 0 dropped 0 overruns 0 carrier 0 collisions 0 [admin@localhost ~]$</dev:code> <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-SFTPDirectory</command:name> <maml:description> <maml:para>Create Directory on Remote Server via SFTP.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFTPDirectory</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create Directory on Remote Server via SFTP specified by Index or SFTP Session Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SFTPDirectory</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="false" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path on remote host including directory name to be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue/> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFTPDirectory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path on remote host including directory name to be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue/> </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="false" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path on remote host including directory name to be created.</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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> </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-SFTPFileStream</command:name> <maml:description> <maml:para>Create a IO Stream over SFTP for a file on a remote host.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFTPFileStream</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create a IO Stream over SFTP for a file on a remote host.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SFTPFileStream</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SSH Session Id for an existing 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"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of file to create a stream for.</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>FileMode</maml:name> <maml:description> <maml:para>Specifies how the operating system should open a file. Options are: * Append - Opens the file if it exists and seeks to the end of the file, or creates a new file. * Create - Specifies that the operating system should create a new file. * CreateNew - Specifies that the operating system should create a new file * Open - Specifies that the operating system should open an existing file. * OpenOrCreate - pecifies that the operating system should open a file if it exists; otherwise, a new file should be created. * Truncate - Specifies that the operating system should open an existing file. When the file is opened, it should be truncated so that its size is zero bytes.</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>FileAccess</maml:name> <maml:description> <maml:para>Defines constants for read, write, or read/write access to a file. * Read - Read access to the file. Data can be read from the file. * ReadWrite - Read and write access to the file. Data can be written to and read from the file. * Write - Write access to the file. Data can be written to the file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFTPFileStream</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of file to create a stream for.</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>FileMode</maml:name> <maml:description> <maml:para>Specifies how the operating system should open a file. Options are: * Append - Opens the file if it exists and seeks to the end of the file, or creates a new file. * Create - Specifies that the operating system should create a new file. * CreateNew - Specifies that the operating system should create a new file * Open - Specifies that the operating system should open an existing file. * OpenOrCreate - pecifies that the operating system should open a file if it exists; otherwise, a new file should be created. * Truncate - Specifies that the operating system should open an existing file. When the file is opened, it should be truncated so that its size is zero bytes.</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>FileAccess</maml:name> <maml:description> <maml:para>Defines constants for read, write, or read/write access to a file. * Read - Read access to the file. Data can be read from the file. * ReadWrite - Read and write access to the file. Data can be written to and read from the file. * Write - Write access to the file. Data can be written to the file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">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"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SSH Session Id for an existing 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="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of file to create a stream for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>FileMode</maml:name> <maml:description> <maml:para>Specifies how the operating system should open a file. Options are: * Append - Opens the file if it exists and seeks to the end of the file, or creates a new file. * Create - Specifies that the operating system should create a new file. * CreateNew - Specifies that the operating system should create a new file * Open - Specifies that the operating system should open an existing file. * OpenOrCreate - pecifies that the operating system should open a file if it exists; otherwise, a new file should be created. * Truncate - Specifies that the operating system should open an existing file. When the file is opened, it should be truncated so that its size is zero bytes.</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>FileAccess</maml:name> <maml:description> <maml:para>Defines constants for read, write, or read/write access to a file. * Read - Read access to the file. Data can be read from the file. * ReadWrite - Read and write access to the file. Data can be written to and read from the file. * Write - Write access to the file. Data can be written to the 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <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:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Renci.SshNet.Sftp.SftpFileStream</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>$bashhistory = New-SFTPFileStream -SessionId 0 -Path /home/admin/.bash_history -FileMode Open -FileAccess Read PS C:\> $bashhistory CanRead : True CanSeek : True CanWrite : False CanTimeout : True Length : 830 Position : 0 IsAsync : False Name : /home/admin/.bash_history Handle : {0, 0, 0, 0} Timeout : 00:00:30 ReadTimeout : WriteTimeout : PS C:\> $streamreader = New-Object System.IO.StreamReader -ArgumentList $bashhistory PS C:\> while ($streamreader.Peek() -ge 0) {$streamreader.ReadLine()} ls exit ssh-keygen -t rsa mv ~/.ssh/id_rsa.pub ~/.ssh/authorized_keys chmod 600 ~/.ssh/authorized_keys vim /etc/ssh/sshd_config sudo vim /etc/ssh/sshd_config PS C:\></dev:code> <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-SFTPItem</command:name> <maml:description> <maml:para>Create a file or directory on remote host using SFTP.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFTPItem</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create a file or directory on remote host using SFTP.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SFTPItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SSH Session Id for an existing 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="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path on remote host to create the item.</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="2"> <maml:name>ItemType</maml:name> <maml:description> <maml:para>Type of item to create. Options are: * File * Directory</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFTPItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path on remote host to create the item.</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="2"> <maml:name>ItemType</maml:name> <maml:description> <maml:para>Type of item to create. Options are: * File * Directory</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">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"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SSH Session Id for an existing 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="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path on remote host to create the item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>ItemType</maml:name> <maml:description> <maml:para>Type of item to create. Options are: * File * Directory</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>New-SFTPItem -SessionId 0 -Path /tmp/help -ItemType Directory</dev:code> <dev:remarks> <maml:para>FullName : /tmp/help LastAccessTime : 3/17/2015 7:58:11 PM LastWriteTime : 3/17/2015 7:58:11 PM Length : 6 UserId : 1000 PS C:\> Get-SFTPPathAttribute 0 -Path /tmp/help LastAccessTime : 3/17/2015 7:58:11 PM LastWriteTime : 3/17/2015 7:58:11 PM Size : 6 UserId : 1000 GroupId : 1000 IsSocket : False IsSymbolicLink : False IsRegularFile : False IsBlockDevice : False IsDirectory : True IsCharacterDevice : False IsNamedPipe : False OwnerCanRead : True OwnerCanWrite : True OwnerCanExecute : True GroupCanRead : True GroupCanWrite : True GroupCanExecute : True OthersCanRead : True OthersCanWrite : False OthersCanExecute : True Extensions :</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-SFTPSymlink</command:name> <maml:description> <maml:para>Create a Symbolic Link on the remote host via SFTP.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SFTPSymlink</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Create a Symbolic Link on the remote host via SFTP.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SFTPSymlink</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SSH Session Id for an existing 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"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path on remote host to link 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>LinkPath</maml:name> <maml:description> <maml:para>Path on remote host to create as the symbolic link.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFTPSymlink</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path on remote host to link 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>LinkPath</maml:name> <maml:description> <maml:para>Path on remote host to create as the symbolic link.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">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"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SSH Session Id for an existing 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="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path on remote host to link 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="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2"> <maml:name>LinkPath</maml:name> <maml:description> <maml:para>Path on remote host to create as the symbolic link.</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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <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:description> </command:inputType> </command:inputTypes> </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-SSHShellStream</command:name> <maml:description> <maml:para>Creates a SSH shell stream for a given SSH Session.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SSHShellStream</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Creates a SSH shell stream for a given SSH Session.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SSHShellStream</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SSH Session Id for an existing session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TerminalName</maml:name> <maml:description> <maml:para>Name of the terminal.</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" aliases=""> <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>80</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Rows</maml:name> <maml:description> <maml:para>The rows.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>24</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Width</maml:name> <maml:description> <maml:para>The width.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>800</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Height</maml:name> <maml:description> <maml:para>The height.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>600</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>BufferSize</maml:name> <maml:description> <maml:para>Size of the buffer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SSHShellStream</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>SSHSession</maml:name> <maml:description> <maml:para>SSH Session Object for an existing session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SshSession</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TerminalName</maml:name> <maml:description> <maml:para>Name of the terminal.</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" aliases=""> <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>80</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Rows</maml:name> <maml:description> <maml:para>The rows.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>24</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Width</maml:name> <maml:description> <maml:para>The width.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>800</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Height</maml:name> <maml:description> <maml:para>The height.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>600</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>BufferSize</maml:name> <maml:description> <maml:para>Size of the buffer.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:defaultValue>1000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SSH Session Id for an existing 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="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>TerminalName</maml:name> <maml:description> <maml:para>Name of the terminal.</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" aliases=""> <maml:name>Columns</maml:name> <maml:description> <maml:para>The columns</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>80</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Rows</maml:name> <maml:description> <maml:para>The rows.</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>24</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Width</maml:name> <maml:description> <maml:para>The width.</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>800</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>Height</maml:name> <maml:description> <maml:para>The height.</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>600</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""> <maml:name>BufferSize</maml:name> <maml:description> <maml:para>Size of the buffer.</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>1000</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>SSHSession</maml:name> <maml:description> <maml:para>SSH Session Object for an existing session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SshSession</command:parameterValue> <dev:type> <maml:name>SshSession</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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SshSession</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Renci.SshNet.ShellStream</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>$SSHStream = New-SSHShellStream -Index 0 PS C:\> $SSHStream.WriteLine("uname -a") PS C:\> $SSHStream.read() Last login: Sat Mar 14 20:02:16 2015 from infidel01.darkoperator.com [admin@localhost ~]$ uname -a Linux localhost.localdomain 3.10.0-123.el7.x86_64 #1 SMP Mon Jun 30 12:09:22 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux [admin@localhost ~]$</dev:code> <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-SSHTrustedHost</command:name> <maml:description> <maml:para>Adds a new SSH Host and Fingerprint pait to the list of trusted SSH Hosts.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>New</command:verb> <command:noun>SSHTrustedHost</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Adds a new SSH Host and Fingerprint pait to the list of trusted SSH Hosts.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>New-SSHTrustedHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SSHHost</maml:name> <maml:description> <maml:para>IP Address of FQDN of host to add to trusted list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>FingerPrint</maml:name> <maml:description> <maml:para>SSH Server Fingerprint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</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>SSHHost</maml:name> <maml:description> <maml:para>IP Address of FQDN of host to add to trusted list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</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>FingerPrint</maml:name> <maml:description> <maml:para>SSH Server Fingerprint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> </command:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>New-SSHTrustedHost -SSHHost 192.168.10.20 -FingerPrint a4:6e:80:33:3f:31:4:cb:be:e9:a0:80:fb:38:fd:3b -Verbose VERBOSE: Adding to trusted SSH Host list 192.168.10.20 with a fingerprint of a4:6e:80:33:3f:31:4:cb:be:e9:a0:80:fb:38:fd:3b VERBOSE: SSH Host has been added.</dev:code> <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>Remove-SFTPDirectory</command:name> <maml:description> <maml:para/> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFTPDirectory</command:noun> <dev:version/> </command:details> <maml:description> <maml:para/> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SFTPDirectory</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="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SFTPDirectory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">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"> <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="false" position="0"> <maml:name>Path</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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> </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>Remove-SFTPFile</command:name> <maml:description> <maml:para>Deletes a file on a remote system via a SFTP Session.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFTPFile</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Deletes a file on a remote system via a SFTP Session specified by index or SFTP Session object.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SFTPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Session Id for an existing SFTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoteFile</maml:name> <maml:description> <maml:para>Full path of where to upload file on remote system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SFTPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>RemoteFile</maml:name> <maml:description> <maml:para>Full path of where to upload file on remote system.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">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=""> <maml:name>SessionId</maml:name> <maml:description> <maml:para>Session Id for an existing 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="false" position="1"> <maml:name>RemoteFile</maml:name> <maml:description> <maml:para>Full path of where to upload file on 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="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> </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>Remove-SFTPItem</command:name> <maml:description> <maml:para>Deletes the specified item on a SFTP session.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFTPItem</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Deletes the specified item on a SFTP session.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SFTPItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of item to be removed on remote host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SFTPItem</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of item to be removed on remote host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">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"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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="false" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of item to be removed on 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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> </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>Remove-SFTPSession</command:name> <maml:description> <maml:para>Close and Remove a SFTP Session</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SFTPSession</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Close and Remove a SFTP Session specified by Index or SFTP Session Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SFTPSession</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SFTPSession</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </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>SFTP Session Id of an exiting 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="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="false" 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>Close a SFTP Session PS C:\></maml:para> </maml:introduction> <dev:code>Remove-SFTPSession -SessionId 0 -Verbose VERBOSE: 0 VERBOSE: Removing session 0 True VERBOSE: Session 0 Removed</dev:code> <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>Remove-SSHSession</command:name> <maml:description> <maml:para>Removes and Closes an existing SSH Session.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SSHSession</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Removes and Closes an existing SSH Session. The session can be a SSH Session object or they can be specified by Session Id</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SSHSession</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 for an exiting SSH session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SSHSession</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>SSHSession</maml:name> <maml:description> <maml:para>SSH Session Object for an exiting session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SshSession[]</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 for an exiting SSH 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="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>SSHSession</maml:name> <maml:description> <maml:para>SSH Session Object for an exiting session.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SshSession[]</command:parameterValue> <dev:type> <maml:name>SshSession[]</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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SshSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <maml:alertSet> <!-- Notes--> <maml:title/> <maml:alert> <maml:para>AUTHOR: Carlos Perez carlos_perez@darkoprator.com</maml:para> </maml:alert> </maml:alertSet> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>Remove-SSHSession -SessionId 0 True</dev:code> <dev:remarks> <maml:para>Remove a SSH Session specified by SessionId</maml:para> </dev:remarks> </command:example> </command:examples> <maml:relatedLinks> <!-- Links--> <maml:navigationLink> <maml:linkText>Online version:</maml:linkText> <maml:uri>http://sshnet.codeplex.com/ http://www.darkoperator.com/</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!-- Command--> <command:details> <command:name>Remove-SSHTrustedHost</command:name> <maml:description> <maml:para>Removes a given SSH Host from the list of trusted hosts.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>SSHTrustedHost</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Removes a given SSH Host from the list of trusted hosts.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Remove-SSHTrustedHost</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SSHHost</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">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"> <maml:name>SSHHost</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:parameters> <command:inputTypes> <!-- Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>Remove-SSHTrustedHost -SSHHost 192.168.10.20 -Verbose VERBOSE: Removing SSH Host 192.168.10.20 from the list of trusted hosts. VERBOSE: SSH Host has been removed.</dev:code> <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>Rename-SFTPFile</command:name> <maml:description> <maml:para>Move or Rename remote file via a SFTP Session</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Rename</command:verb> <command:noun>SFTPFile</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Move or Rename remote file via a SFTP Session specified by index or SFTP Session object.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Rename-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>SFTP Session Id of an exiting 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="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to file to rename</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name for file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Rename-SFTPFile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>Exiting SFTP Session object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to file to rename</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name for file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">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"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to file to rename</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri/> </dev:type> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>NewName</maml:name> <maml:description> <maml:para>New name for 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/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0"> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>Exiting SFTP Session object.</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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>Rename file. C:\PS></maml:para> </maml:introduction> <dev:code>Rename-SFTPFile -SessionId 0 -Path /tmp/anaconda-ks.cfg -NewName anaconda-ks.cfg.old -Verbose VERBOSE: Renaming /tmp/anaconda-ks.cfg to anaconda-ks.cfg.old VERBOSE: File renamed</dev:code> <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-SFTPContent</command:name> <maml:description> <maml:para>Writes or replaces the content in an item with new content over SFTP.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFTPContent</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Writes or replaces the content in an item with new content over SFTP</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Set-SFTPContent</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"> <maml:name>Path</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>Value</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Encoding</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="false" position="named"> <maml:name>Append</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-SFTPContent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para/> </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>Value</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named"> <maml:name>Encoding</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="false" position="named"> <maml:name>Append</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="1"> <maml:name>Path</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="2"> <maml:name>Value</maml:name> <maml:description> <maml:para/> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</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>Encoding</maml:name> <maml:description> <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="false" position="named"> <maml:name>Append</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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri/> </dev:type> <maml:description> <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:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- Outputs--> <command:returnValue> <dev:type> <maml:name>Renci.SshNet.Sftp.SftpFile</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>PS C:\></maml:para> </maml:introduction> <dev:code>Set-SFTPContent -SessionId 0 -Path /tmp/example.txt -Value "My example message`n"</dev:code> <dev:remarks> <maml:para>FullName : /tmp/example.txt LastAccessTime : 3/16/2015 10:40:16 PM LastWriteTime : 3/16/2015 10:40:55 PM Length : 22 UserId : 1000 PS C:\> Get-SFTPContent -SessionId 0 -Path /tmp/example.txt My example message PS C:\> Set-SFTPContent -SessionId 0 -Path /tmp/example.txt -Value "New message`n" -Append FullName : /tmp/example.txt LastAccessTime : 3/16/2015 10:40:59 PM LastWriteTime : 3/16/2015 10:41:18 PM Length : 34 UserId : 1000 PS C:\> Get-SFTPContent -SessionId 0 -Path /tmp/example.txt My example message New message</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-SFTPCurrentDirectory</command:name> <maml:description> <maml:para>Change the current folder location of a SFTP Session</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFTPCurrentDirectory</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change the current folder location of a SFTP Session specified by Index or SFTP Session Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Set-SFTPCurrentDirectory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Remote path to set as the current working directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue/> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SFTPCurrentDirectory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Remote path to set as the current working directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue/> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases=""> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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="false" position="1" aliases=""> <maml:name>Path</maml:name> <maml:description> <maml:para>Remote path to set as the current working directory.</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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> </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-SFTPLocation</command:name> <maml:description> <maml:para>Change current location of the SFTP session.</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Set</command:verb> <command:noun>SFTPLocation</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Change current location of the SFTP session.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Set-SFTPLocation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Remote path to change current location of the SFTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SFTPLocation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Remote path to change current location of the SFTP session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">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"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Remote path to change current location of the 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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> </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>Test-SFTPPath</command:name> <maml:description> <maml:para>Test if a File or Directory exists on Remote Server via SFTP</maml:para> </maml:description> <maml:copyright> <maml:para/> </maml:copyright> <command:verb>Test</command:verb> <command:noun>SFTPPath</command:noun> <dev:version/> </command:details> <maml:description> <maml:para>Test if a File or Directory exists on Remote Server via SFTP specified by Index or SFTP Session Object.</maml:para> </maml:description> <command:syntax> <!-- Parameter Sets--> <command:syntaxItem> <maml:name>Test-SFTPPath</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="0"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path on remote host to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Test-SFTPPath</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting session.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SftpSession[]</command:parameterValue> <dev:defaultValue/> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path on remote host to test.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">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"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>SFTP Session Id of an exiting 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="false" position="1"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path on remote host to test.</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 (ByValue)" position="0" aliases=""> <maml:name>SFTPSession</maml:name> <maml:description> <maml:para>SFTP Session Object of an exiting 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:description> </command:inputType> <command:inputType> <dev:type> <maml:name>SSH.SftpSession[]</maml:name> <maml:uri/> </dev:type> <maml:description> <maml:para/> </maml:description> </command:inputType> </command:inputTypes> <command:examples> <!-- Examples--> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:para>Test if a folder temporaryfolder exists in the /tmp directory on server via a SFTP Session C:\PS></maml:para> </maml:introduction> <dev:code>Test-SFTPPath -SessionId 0 -Path "/tmp/temporaryfolder"</dev:code> <dev:remarks/> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:para>Test if a file myfile-1.0.0.ipa exists in the /apps directory on server via a SFTP Session C:\PS></maml:para> </maml:introduction> <dev:code>Test-SFTPPath -SessionId 0 -Path "/apps/myfile-1.0.0.ipa"</dev:code> <dev:remarks/> </command:example> </command:examples> </command:command> </helpItems> <!-- Generated by: SAPIEN PowerShell Help Writer 2015 v1.0.9--> <!--Edited with: SAPIEN PowerShell Help Writer 2015 v1.0.9--> |