SCP Tasks
Properties Configuration Settings
The SCP Component 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.
| 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. |
| 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.
| 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. |
| 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. |
| 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.
| FilePermissions | Specifies the permissions of a file to be set after a successful upload. |
| KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
| 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. |
| RecursiveMode | If set to true the component will recursively upload or download files. |
| ServerResponseWindow | The time to wait for a server response in milliseconds. |
| SSHAcceptServerHostKeyFingerPrint | Instructs the component to accept the server's host key with this fingerprint. |
| SSHEncryptionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
| SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
| SSHMacAlgorithms | Specifies the supported Mac algorithms. |
| SSHPublicKeyAlgorithms | Specifies the supported public key algorithms. |
| 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. |