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.
|Command||The command to be sent to the remote host.|
|CommandErrorMessage||The error message, if any, returned by the server after command execution.|
|CommandExitStatus||The exit code for the executed command for the current message.|
|CommandStdErr||The standard error output of the executed Command .|
|CommandStdOut||The standard output of the executed Command .|
|FailOnError||Controls how the task treats error codes returned by command execution.|
|Firewall||A set of properties related to firewall access.|
|LogFile||The file to write logging information to at runtime.|
|LogMode||What information gets logged during task execution.|
|Other||Defines a set of configuration settings to be used by the task.|
|PersistentConnection||Instructs the task whether to keep the connection to the server open.|
|RuntimeLicense||Specifies the task runtime license key.|
|SSHAcceptServerHostKey||Instructs the task to accept the server host key that matches the supplied key.|
|SSHAcceptServerHostKeyAcceptAny||Tells the task to accept any server certificate.|
|SSHAuthMode||The type of authentication used by the task.|
|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.|
|Stdin||A string of data that will be supplied to the executing command's standard input.|
|Timeout||A timeout for the task.|
The following is a list of configuration settings for the task with short descriptions. Click on the links for further details.
|KeyRenegotiationThreshold||Sets the threshold for the SSH Key Renegotiation.|
|Logoff||Whether or not to logoff from the server after execution.|
|LogSSHPackets||If True, detailed SSH packet logging is performed.|
|SSHAcceptServerHostKeyFingerPrint||Instructs the task 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 task whether or not to use the system security libraries or an internal implementation.|