Overview

These public interfaces are used in the SSH components. They are provided for implementing advanced functionality in your scripts. In order for you to use these interfaces in your project, you have to reference CozyRoc.SSISPlus.dll library.


ISshClientConnection

SSH Connection Manager component is based on Tamir Gal's SharpSsh secure communications library. When SSIS ConnectionManager.AcquireConnection method is called, it returns object implementing ISshClientConnection interface. This is the interface used for configuration and connection to secure SSH-enabled server.

When called, connects to remote server, returning Channel object. This method has one parameter, which can be one of the options listed in the following table.

Value Result Channel
session ChannelSession
shell ChannelShell
exec ChannelExec
x11 ChannelX11
direct-tcpip ChannelDirectTCPIP
forwarded-tcpip ChannelForwardedTCPIP
sftp Starting from SSIS+ 1.3 the returned object implements IFtpClient interface and it is the recommended way for interacting with the remote server. You can still get access to the low-level backend object by casting the returned object to ChannelSftp.
subsystem ChannelSubsystem

Closes connection to remote server.

Returns true if there is open connection to remote server.

Initiates secure tunnel between machines. This is also known as port-forwarding. These are the method parameters:

  • local (string) - local entry IP address and port. Separate address and port with colon (:).
  • remote (string) - remote IP address and port. Separate address and port with colon (:).

Stops a secure tunnel. These are the method parameters:

  • local (string) - local entry IP address and port. Separate address and port with colon (:).

Properties

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 password to access the SSH server.

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

Specify verbose log file name for investigating SSH connection issues.

Specify file transfers mode. This property has the options listed in the following table.

Value Description
True Use binary file transfer mode (default).
False Use ASCII file transfer mode.

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

Value Description
0 Proxy not specified
1 Use tunnel (HTTP) proxy type.
2 Use SOCKS4 proxy type.
3 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 documentation