Send-SFTP Cmdlet

Parameters   Output Objects   Configuration Settings  

The Send-SFTP component can be used to upload files to SFTP servers.

Syntax

Send-SFTP [parameters]

Remarks

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

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

This cmdlet only handles uploading files. To download files or retrieve directory listings, please see the GET-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.

# Upload a file
send-sftp -server myserver -credential $cred -localfile C:\test.txt -remotefile test.txt

# Connect using SSH with public key authentication and upload a file
$certPass = Read-Host "Enter Cert Password" -AsSecureString
send-sftp -server myserver -user test -AuthMode PublicKey -CertStoreType PEMKey -CertStore file.pem -CertPassword $certPass -CertSubject * -localfile C:\test.txt -remotefile test.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.