Get-SFTP Cmdlet

Parameters Output Objects Configuration Settings

The Get-SFTP cmdlet is used to download files and retrieve directory listings from SFTP servers.

Syntax

Get-SFTP [parameters]

Remarks

This cmdlet implements a standard SFTP client to transfer files from an SSH server's SFTP subsystem.

To use the cmdlet to download a file, you must specify the Server, User, and Password. The file to download from is given by RemoteFile, and the file to download to is specified by LocalFile.

Directory listings may be retrieved by setting List to the remote path of which you wish to receive a directory listing. Results of a directory listing will be returned in one or more EntryInfo objects.

This cmdlet handles listing directories and downloading files. To upload files please see the SEND-SFTP cmdlet.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

# Download a file from an SFTP server 
get-sftp -server ftp_server -cred $cred -remotefile text.txt -localfile "C:\text.txt"
 
# Connect using SSH with public key authentication and download all .txt files
$certPass = Read-Host "Enter Cert Password" -AsSecureString
get-sftp -user test -server SFTPServer -AuthMode PublicKey -CertStoreType PEMKey -CertStore file.pem -CertPassword $certPass -CertSubject * -Path Folder1 -RemoteFile *.txt

Connection Handling

This cmdlet supports persistent connections through the Connection parameter. To establish a new SFTP connection, use the Connect-SFTP cmdlet. To close the connection, use the Disconnect-SFTP cmdlet.

Parameter List

The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.


Connection	An already established connection.
LogFile	The location of a file to which debug information is written.
AfterConnect	A set of FTP commands to be executed immediately after connecting to the Server .
AfterDownload	A set of FTP commands to be executed immediately after each file downloaded.
AuthMode	The type of authentication used by the cmdlet.
BeforeDownload	A set of FTP commands to be executed immediately before each file is downloaded.
CertPassword	The password to the certificate store.
CertStore	The name of the certificate store for the client certificate.
CertStoreType	The type of certificate store for the client certificate.
CertSubject	The subject of the certificate used for client authentication.
CompressionAlgorithms	A comma-separated list containing all allowable compression algorithms.
Config	Specifies one or more configuration settings.
Credential	The PSCredential object to use for user/password authentication.
EncryptionAlgorithms	A comma-separated list containing all allowable compression algorithms.
FirewallHost	Name or IP address of firewall.
FirewallPassword	A password if authentication is to be used when connecting through the firewall.
FirewallPort	The port of the firewall to which to connect.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
Force	Forces the cmdlet to accept the default behavior instead of querying the user.
List	Get a directory listing for the path and file mask specified.
LocalFile	The local file to download to.
LocalIP	The IP address of the local interface to use.
LogFile	The location of a file to which debug information is written.
Overwrite	Indicates whether the LocalFile may be overwritten.
Password	The password to use for authentication.
PasswordPrompt	The shell prompt used for keyboard-interactive authentication.
Port	The TCP port in the remote host to which to connect.
RemoteFile	The name of the remote file to download.
Server	The address of the Server.
SSHAccept	The hex-encoded fingerprint of the host to trust explicitly.
Timeout	The maximum time allowed for the operation.
User	The username to use for authentication.

Output Objects

The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.


EntryInfo	This object contains details about a file returned from the FTP Server .
FTPFile	This object is created after a file has finished transferring.

Configuration Settings

The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.


AllowBackslashInName	Whether backslashes are allowed in folder and file names.
DisableRealPath	Controls whether or not the SSH_FXP_REALPATH request is sent.
FiletimeFormat	Specifies the format to use when returning filetime strings.
FileMaskDelimiter	Specifies a delimiter to use for setting multiple file masks in the RemoteFile property.
IgnoreFileMaskCasing	Controls whether or not the file mask is case sensitive.
LocalEOL	When TransferMode is set, this specifies the line ending for the local system.
ServerEOL	When TransferMode is set, this specifies the line ending for the remote system.
MaskSensitive	Masks passwords in logs.
MaxFileData	Specifies the maximum payload size of an SFTP packet.
ProtocolVersion	The highest allowable SFTP version to use.
PreserveFileTime	Preserves the file's timestamps during transfer.
TransferMode	The transfer mode (ASCII or Binary).
ReadLink	This settings returns the target of a specified symbolic link.
RealTimeUpload	Enables real time uploading.
RealTimeUploadAgeLimit	The age limit in seconds when using RealTimeUpload.
SimultaneousTransferLimit	The maximum number of simultaneous file transfers.
TransferredDataLimit	Specifies the maximum number of bytes to download from the remote file.
ClientSSHVersionString	The SSH version string used by the cmdlet.
SSHVersionPattern	The pattern used to match the remote host's version string.
SSHFingerprintHashAlgorithm	The algorithm used to calculate the fingerprint.
SignedSSHCert	The CA signed client public key used when authenticating.
SSHAcceptServerCAKey	The CA public key that signed the server's host key.
SSHAcceptAnyServerHostKey	If set the cmdlet will accept any key presented by the server.
SSHAcceptServerHostKeyFingerPrint	The fingerprint of the server key to accept.
SSHKeyExchangeAlgorithms	Specifies the supported key exchange algorithms.
SSHMacAlgorithms	Specifies the supported Mac algorithms.
SSHPublicKeyAlgorithms	Specifies the supported public key algorithms.
SSHKeepAliveInterval	The interval between keep alive packets.
SSHKeepAliveCountMax	The maximum number of keep alive packets to send without a response.
SSHKeyRenegotiate	Causes the component to renegotiate the SSH keys.
KeyRenegotiationThreshold	Sets the threshold for the SSH Key Renegotiation.
SSHPubKeyAuthSigAlgorithms	Specifies the signature algorithm when attempting public key authentication.
KerberosRealm	The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosDelegation	If true, asks for credentials with delegation enabled during authentication.
KerberosSPN	The Kerberos Service Principal Name of the SSH host.
LogSSHPackets	If true, detailed SSH packet logging is performed.
MaxPacketSize	The maximum packet size of the channel, in bytes.
MaxWindowSize	The maximum window size allowed for the channel, in bytes.
PasswordPrompt	The text of the password prompt used in keyboard-interactive authentication.
PreferredDHGroupBits	The size (in bits) of the preferred modulus (p) to request from the server.
RecordLength	The length of received data records.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the cmdlet whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the cmdlet binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
UseBackgroundThread	Whether threads created by the cmdlet are background threads.
UseInternalSecurityAPI	Tells the cmdlet whether or not to use the system security libraries or an internal implementation.