SSH API

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.

Connect method

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

Close method

Closes connection to remote server.

IsConnected method

Returns true if there is open connection to remote server.

ServerHost property (string)

Specify the name or IP address of the SSH server.

ServerPort property (int)

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

ServerUser property (string)

Specify user name to access the SSH server.

ServerPassword property (string)

Specify password to access the SSH server.

ServerTimeout property (int)

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

ProxyType property (int)

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.

ProxyHost property (string)

Specify the name or IP address of the proxy server.

ProxyPort property (int)

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

ProxyUser property (string)

Specify user name to access the proxy server.

ProxyPassword property (string)

Specify password to access the proxy server.