Overview

SSH Connection Manager is SSIS Connection Manager for establishing SSH connections. Use the API to build components based on SSH Connection Manager.


Setup

Use the SSH Connection Manager dialog to specify properties for connecting to an SSH-enabled server. The configuration dialog has server and proxy settings.

Server Parameters

Specify the name or IP address of the SSH server.

Specify the port number on the SSH server to use for the connection. The default value of this property is 22.

Specify user name to access the SSH server.

Specify authentication type. This property has the options listed in the following table.

Value Description
By Password User is authenticated with password. Selecting this value displays the dynamic option Password.
By Key File User is authenticated with private key file, unlocked with passphrase. Selecting this value displays the dynamic options Key File, Passphrase.

Specify password to access the SSH server. Specify arbitrary value for anonymous account.

Select private key file to access the SSH server.

Specify passphrase to unlock the private key file.

Specify the number of seconds before timing out session connect. The default value of this property is 60 seconds.

Specify if all clients should use the same connection. This property has the options listed in the following table.

Value Description
True All clients use same connection.
False Every client use different connection (default).
Test Connection

Confirm connection manager configuration by clicking Test Connection.


Advanced Parameters 1.5

Specify verbose log file name for investigating SSH connection issues.

Specify to use binary mode for file transfers.

Specify SSH backend engine in use. This property has the options listed in the following table.

Value Description
1 Use legacy SSH backend engine.
2 Use new 1.5 SSH backend engine (default).
This property is not visible in the connection manager dialog.

Proxy Parameters

Specify proxy type. This property has the options listed in the following table.

Value Description
None Proxy not specified
Tunnel Use tunnel (HTTP) proxy type.
SOCKS4 Use SOCKS4 proxy type.
SOCKS5 Use SOCKS5 proxy type.

Specify the name or IP address of the proxy server.

Specify the port number on the proxy server to use for the connection. The default value of this property is 80.

Specify user name to access the proxy server.

Specify password to access the proxy server.


Related scripts


FAQ

  • The Execute method on the task returned error code 0x80004003 (Object reference not set to an instance of an object.). The Execute method must succeed, and indicate the result using an "out" parameter.
    ... and also:
    Failed to decrypt protected XML node "ServerPassword" with error 0x8009000B "Key not valid for use in specified state.". You may not be authorized to access this information. This error occurs when there is a cryptographic error. Verify that the correct key is available.

    The default package protection level: EncryptSensitiveWithUserKey, doesn't work very well with SQL Agent Jobs.

    If you decide to setup package encryption with EncryptAllWithPassword or EncryptSensitiveWithPassword you have to make sure you provide the password to the command line for DTEXEC application. More information how to setup DTEXEC in SQL Server Job Agent is available here and information about DTEXEC command line options is available here

    You may also find useful the following articles:

    An SSIS package does not run when you call the SSIS package from a SQL Server Agent job step

    SSIS and SQL Server Agent

    How to run a SQL Server 2005 Integration Services package as a SQL Server Agent job step

  • Error: 0xC0014005 at : The connection type "SSH" specified for connection manager "SSH Connection Manager 1" is not recognized as a valid connection manager type. This error is returned when an attempt is made to create a connection manager for an unknown connection type. Check the spelling in the connection type name.
    Starting from SSIS+ 1.3 SR-2, this error is resolved. Use the 64bit installation.

    By default SSIS+ is installed under the 32bit - Program Files (x86) folder. You have two options:

    • Set Run64BitRuntime project property to False to force SSIS to execute with the 32bit runtime.
    • or ... find CozyRoc.SSISPlus.dll library and manually copy it to the following 64bit folders:
      • Microsoft SQL Server\90\DTS\Connections
      • Microsoft SQL Server\90\DTS\Tasks
      • Microsoft SQL Server\90\DTS\PipelineComponents
      • Microsoft SQL Server\90\SDK\Assemblies
  • PuttyGen doesn't generate proper DSA keys, which can work with the SSH Connection Manager. You may use ssh-keygen application, which generates keys recognized by SSH Connection Manager. The application is part of the OpenSSH package. Use the following command to generate 1024 bit DSA keys:

    ssh-keygen.exe -b 1024 -t dsa

  • You may have firewall/proxy issue. Make sure you can successfully telnet your server. You should get back text starting with "SSH-2.0".

  • The SSH Connection Manager doesn't support directly Putty Private Key (PPK) Files. You have to export your key in OpenSSH format. You can do this in PuttyGen application:

    • Open your .PPK file in PuttyGen.
    • Select Conversions -> Export OpenSSH key

Related documentation