SSH Tasks

Properties   Configuration Settings  

The SSH Task enables your SSIS Package to execute remote commands over SSH.


The SSH Task uses the SSH "exec" subsystem to remotely execute commands from your SSIS Package.

SSH Send Task

The SSH Send Task provides an ultra light-weight remote command execution client for your SSIS Package. You must first set an SSHHost. If the SSH server requires authentication, you should set the necessary SSHUser, and either SSHPassword or SSHCert depending on the SSHAuthMode you wish to use. Once the SSH server information is set, you must enter the Command you wish to execute.

Whenever called from the SSIS Package, the task will execute the given command. If the Stdin property has any data, that data will supplied to the executing command's standard input.

Once the command has finished executing, the task will write the output from the command's standard out pipe to the variable pointed to by the CommandStdOut property. It will also write the command's exit code to the variable pointed to by the CommandExitStatus property, and any data from the standard err pipe to the variable pointed to by the CommandErrorMessage property.

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.

CommandThe command to be sent to the remote host.
CommandErrorMessageThe error message, if any, returned by the server after command execution.
CommandExitStatusThe exit code for the executed command for the current message.
CommandStdErrThe standard error output of the executed Command .
CommandStdOutThe standard output of the executed Command .
FailOnErrorControls how the task treats error codes returned by command execution.
FirewallA set of properties related to firewall access.
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.
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.
StdinA string of data that will be supplied to the executing command's standard input.
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.

KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
LogoffWhether or not to logoff from the server after execution.
LogSSHPacketsIf True, detailed SSH packet logging is performed.
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]