SCP Tasks

Properties   Configuration Settings  

The SCP Task adds SSH-secured file transfer capabilities to your SSIS Package.

Remarks

The SCP Task adds a SCP client to your SSIS Package that enables it with SSH-secured file download and upload functionality.

SCP Receive Task

The SCP 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 SCP server every PollingInterval and download the file(s) specified by FileMask. All files that match the FileMask will be downloaded and submitted to the SSIS Package as individual messages.

SCP Send Task

The SCP 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 SCP server whenever it has a message to send. The task will attempt to upload to the specified RemotePath.

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.

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.
OtherDefines a set of configuration settings to be used by the task.
OverwriteWhether or not the component 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.

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.
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.
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.

FilePermissionsSpecifies the permissions of a file to be set after a successful upload.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
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.
RecursiveModeIf set to true the task will recursively upload or download files.
ServerResponseWindowThe time to wait for a server response in milliseconds.
SSHAcceptServerHostKeyFingerPrintInstructs the task to accept the server's host key with this fingerprint.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms.
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]