SFTP Tasks
Properties Configuration Settings
The SFTP Component adds SSH-secured file transfer capabilities to your SSIS Package.
Remarks
The SFTP Task adds a complete SFTP client to your SSIS Package that enables it with SSH-secured file download and upload functionality.
SFTP Receive Task
The SFTP Receive Task requires that a single property be set: SSHHost. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.
The task will connect to the SFTP server every PollingInterval and list the directory specified by RemotePath. All files that match the FileMask will be downloaded and submitted to the SSIS Package as individual SSIS ADO tables. In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode.
SFTP Send Task
The SFTP Send Task requires both an SSHHost and a RemoteFile. You may also set an SSHPort if the server is not running on the default SSH port. In order to authenticate with the SSH server, you will need to specify an SSHUser, and either SSHPassword or SSHCert depending upon the SSHAuthMode to be used.
The task will connect to the SFTP server whenever it has a message to send. The task will attempt to upload to the specified RemotePath. If Overwrite is set to True, the task will delete or overwrite remote files as necessary to complete the operation.
In order to prevent parallel processing by another application before your upload is complete, you may need to set a temporary upload directory via RemoteTempPath. If the temporary directory is set, the file will first be uploaded to the specified temporary directory, and will be moved to the final destination path once the upload has completed.
Receiver Property List
The following is the full list of the properties of the receiver task with short descriptions. Click on the links for further details.
| AfterConnect | A set of FTP-style commands to be executed immediately after connecting to the SSHHost . |
| AfterGet | A set of FTP-style commands to be executed after the download. |
| BeforeGet | A set of FTP-style commands to be executed before the download. |
| Delete | Controls if the remote file is deleted after download. |
| DirList | String denoting the name of the variable which contains the last directory listing entries. |
| FileMask | Indicates the type of files to download from the SSH server. |
| Firewall | A set of properties related to firewall access. |
| LocalDirectory | The directory on the local machine where files are downloaded. |
| LogFile | The file to write logging information to at runtime. |
| LogMode | What information gets logged during component execution. |
| Operation | The operation which will be executed by the FTP task. |
| Other | Defines a set of configuration settings to be used by the component. |
| Overwrite | Whether or not the component should overwrite files during transfer. |
| PersistentConnection | Instructs the component whether to keep the connection to the server open. |
| RemotePath | The current path on the SSH server. |
| RuntimeLicense | Specifies the component runtime license key. |
| SSHAcceptServerHostKey | Instructs the component to accept the server host key that matches the supplied key. |
| SSHAcceptServerHostKeyAcceptAny | Tells the component to accept any server certificate. |
| SSHAuthMode | The type of authentication used by the component. |
| SSHCert | The certificate to use for client authentication during the SSH handshake. |
| SSHCompressionAlgorithms | A comma-separated list of compression algorithms allowed for this connection. |
| SSHHost | The address of the SSH host. |
| SSHPassword | The password for SSH password-based authentication. |
| SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
| SSHUser | The username for SSH authentication. |
| Timeout | A timeout for the component. |
Sender Property List
The following is the full list of the properties of the sender task with short descriptions. Click on the links for further details.
| AfterConnect | A set of FTP-style commands to be executed immediately after connecting to the SSHHost . |
| AfterPut | A set of FTP-style commands to be executed after the upload. |
| Append | Whether or not the component should append data to the RemoteFile . |
| BeforePut | A set of FTP-style commands to be executed before the upload. |
| Firewall | A set of properties related to firewall access. |
| LocalFile | The path to a local file for upload. |
| LogFile | The file to write logging information to at runtime. |
| LogMode | What information gets logged during component execution. |
| Other | Defines a set of configuration settings to be used by the component. |
| Overwrite | Whether or not the component should overwrite files during transfer. |
| PersistentConnection | Instructs the component whether to keep the connection to the server open. |
| RemoteFile | The name of the destination file on the SSH server for uploading. |
| RemotePath | The current path on the SSH server. |
| RemoteTempPath | A temporary directory on the server to store files before moving them to RemotePath . |
| RuntimeLicense | Specifies the component runtime license key. |
| SSHAcceptServerHostKey | Instructs the component to accept the server host key that matches the supplied key. |
| SSHAcceptServerHostKeyAcceptAny | Tells the component to accept any server certificate. |
| SSHAuthMode | The type of authentication used by the component. |
| SSHCert | The certificate to use for client authentication during the SSH handshake. |
| SSHCompressionAlgorithms | A comma-separated list of compression algorithms allowed for this connection. |
| SSHHost | The address of the SSH host. |
| SSHPassword | The password for SSH password-based authentication. |
| SSHPort | The port on the SSH server where the SSH service is running; by default, 22. |
| SSHUser | The username for SSH authentication. |
| Timeout | A timeout for the component. |
Configuration Settings
The following is a list of configuration settings for the task with short descriptions. Click on the links for further details.
| DisableRealPath | Controls whether or not the SSH_FXP_REALPATH request is sent. |
| DownloadCacheFile | When set, only new files will be downloaded from the server. |
| DownloadCacheFileDuration | The number of minutes that a file name will remain in the download cache. |
| EnableFileDetailsComparison | Whether the receive component should consider metadata differences when deciding whether to download a file again. |
| ExcludeMask | Instructs the component to exclude some files when downloading. |
| FileMaskDelimiter | Specifies a delimiter to use for setting multiple file masks. |
| FilePermissions | Specifies the permissions of a file to be set after a successful upload. |
| IgnoreFileMaskCasing | Instructs the component to ignore casing of when FileMask is set. |
| KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
| ListDirBeforeDownload | Determines if the directory is listed on download. |
| LocalEOL | When TransferMode is set, this specifies the line ending for the local system. |
| LocalFile | The name of the LocalFile to which the remote file will be saved. |
| Logoff | Whether or not to logoff from the server after execution. |
| LogSSHPackets | If True, detailed SSH packet logging is performed. |
| MaxFileData | Specifies the maximum payload size of an SFTP packet. |
| MaxFilesPerPollingInterval | The maximum number of files that will be downloaded from the server during a single poll. |
| PreserveFileTime | Preserves the file's timestamps during transfer. |
| ProtocolVersion | The highest allowable SFTP version to use. |
| RecursiveDownload | When true, all files and folders in the RemotePath are downloaded recursively. |
| RecursiveUpload | When true, all files and folders in the folder specified in LocalFile are uploaded recursively. |
| RenameMode | The condition under which RenameTo is used. |
| RenameTo | A filename to which RemoteFile will be renamed. |
| ServerEOL | When TransferMode is set, this specifies the line ending for the remote system. |
| SortCriteria | Determines sort order before downloading files. |
| SSHAcceptServerHostKeyFingerPrint | Instructs the component to accept the server's host key with this fingerprint. |
| SSHEncryptionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
| SSHFingerprintHashAlgorithm | The algorithm used to calculate the fingerprint. |
| SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
| SSHMacAlgorithms | Specifies the supported Mac algorithms. |
| SSHPublicKeyAlgorithms | Specifies the supported public key algorithms. |
| TemporaryDownloadExtension | An extension to be appended during download. |
| TemporaryUploadExtension | An extension to be appended during upload. |
| TransferMode | The transfer mode (ASCII or Binary). |
| WaitForServerDisconnect | Causes the component to wait for the server to close the connection. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |