Cmdlets for SFTP

Build 21.0.7930

Getting Started

Connecting to SFTP

Establishing a Connection shows how to authenticate to SFTP and configure any necessary connection properties. You can also configure cmdlet capabilities through the available Connection properties, from data modeling to firewall traversal. The Advanced Settings section shows how to set up more advanced configurations and troubleshoot connection errors.

Connecting from PowerShell

The CData Cmdlets PowerShell Module for SFTP provides a familiar way to interact with SFTP from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with SFTP using standard PowerShell objects; you can chain the cmdlets to each other or other cmdlets in pipelines. The cmdlets also support PowerShell debug streams.

Data Manipulation with Cmdlets

See Establishing a Connection to learn how to get started with the Connect-SFTP cmdlet. You can then pass the SFTPConnection object returned to other cmdlets for accessing data:

  • Select-SFTP
  • Add-SFTP
  • Update-SFTP
  • Remove-SFTP

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-SFTP cmdlet.

Accessing Debug Output from Streams

See Capturing Errors and Logging to obtain the debug output through PowerShell streams.

PowerShell Version Support

The standard cmdlets are supported in PowerShell 2, 3, 4, and 5.

SFTP Version Support

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930