SFTP Tasks

Properties   Configuration Settings  

The SFTP Task 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.

AfterConnectA set of FTP-style commands to be executed immediately after connecting to the SSHHost .
AfterGetA set of FTP-style commands to be executed after the download.
BeforeGetA set of FTP-style commands to be executed before the download.
DeleteControls if the remote file is deleted after download.
DirListString denoting the name of the variable which contains the last directory listing entries.
FileMaskIndicates the type of files to download from the SSH server.
FirewallA set of properties related to firewall access.
LocalDirectoryThe directory on the local machine where files are downloaded.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during task execution.
OperationThe operation which will be executed by the FTP task.
OtherDefines a set of configuration settings to be used by the task.
OverwriteWhether or not the task should overwrite files during transfer.
PersistentConnectionInstructs the task whether to keep the connection to the server open.
RemotePathThe current path on the SSH server.
RuntimeLicenseSpecifies the task runtime license key.
SSHAcceptServerHostKeyInstructs the task to accept the server host key that matches the supplied key.
SSHAcceptServerHostKeyAcceptAnyTells the task to accept any server certificate.
SSHAuthModeThe type of authentication used by the task.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
TimeoutA timeout for the task.

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.

AfterConnectA set of FTP-style commands to be executed immediately after connecting to the SSHHost .
AfterPutA set of FTP-style commands to be executed after the upload.
AppendWhether or not the task should append data to the RemoteFile .
BeforePutA set of FTP-style commands to be executed before the upload.
FirewallA set of properties related to firewall access.
LocalFileThe path to a local file for upload.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during task execution.
OtherDefines a set of configuration settings to be used by the task.
OverwriteWhether or not the task should overwrite files during transfer.
PersistentConnectionInstructs the task whether to keep the connection to the server open.
RemoteFileThe name of the destination file on the SSH server for uploading.
RemotePathThe current path on the SSH server.
RemoteTempPathA temporary directory on the server to store files before moving them to RemotePath .
RuntimeLicenseSpecifies the task runtime license key.
SSHAcceptServerHostKeyInstructs the task to accept the server host key that matches the supplied key.
SSHAcceptServerHostKeyAcceptAnyTells the task to accept any server certificate.
SSHAuthModeThe type of authentication used by the task.
SSHCertThe certificate to use for client authentication during the SSH handshake.
SSHCompressionAlgorithmsA comma-separated list of compression algorithms allowed for this connection.
SSHHostThe address of the SSH host.
SSHPasswordThe password for SSH password-based authentication.
SSHPortThe port on the SSH server where the SSH service is running; by default, 22.
SSHUserThe username for SSH authentication.
TimeoutA timeout for the task.

Configuration Settings


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

DisableRealPathControls whether or not the SSH_FXP_REALPATH request is sent.
DownloadCacheFileWhen set, only new files will be downloaded from the server.
DownloadCacheFileDurationThe number of minutes that a file name will remain in the download cache.
EnableFileDetailsComparisonWhether the receive task should consider metadata differences when deciding whether to download a file again.
ExcludeMaskInstructs the task to exclude some files when downloading.
FileMaskDelimiterSpecifies a delimiter to use for setting multiple file masks.
FilePermissionsSpecifies the permissions of a file to be set after a successful upload.
IgnoreFileMaskCasingInstructs the task to ignore casing of when FileMask is set.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
ListDirBeforeDownloadDetermines if the directory is listed on download.
LocalEOLWhen TransferMode is set, this specifies the line ending for the local system.
LocalFileThe name of the LocalFile to which the remote file will be saved.
LogoffWhether or not to logoff from the server after execution.
LogSSHPacketsIf True, detailed SSH packet logging is performed.
MaxFileDataSpecifies the maximum payload size of an SFTP packet.
MaxFilesPerPollingIntervalThe maximum number of files that will be downloaded from the server during a single poll.
PreserveFileTimePreserves the file's timestamps during transfer.
ProtocolVersionThe highest allowable SFTP version to use.
RecursiveDownloadWhen true, all files and folders in the RemotePath are downloaded recursively.
RecursiveUploadWhen true, all files and folders in the folder specified in LocalFile are uploaded recursively.
RenameModeThe condition under which RenameTo is used.
RenameToA filename to which RemoteFile will be renamed.
ServerEOLWhen TransferMode is set, this specifies the line ending for the remote system.
SortCriteriaDetermines sort order before downloading files.
SSHAcceptServerHostKeyFingerPrintInstructs the task to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHFingerprintHashAlgorithmThe algorithm used to calculate the fingerprint.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms.
TemporaryDownloadExtensionAn extension to be appended during download.
TemporaryUploadExtensionAn extension to be appended during upload.
TransferModeThe transfer mode (ASCII or Binary).
WaitForServerDisconnectCauses the component to wait for the server to close the connection.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the task whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Tasks for SSIS - Version 20.0 [Build 7877]