IP*Works! SSH sshclient Component : sshclient OCX, sshclient .NET Component, sshclient Class, sshclient Bean, sshclient Object

login

Red Carpet Subscriptions

IP*Works! Products

Internet Business

QuickBooks Integrator

E-Payment Integrator

Vital/TSYS Integrator

Paymentech Integrator

Enterprise Adapters

SQL Server SSIS Tasks

Windows Workflow

SharePoint Extensions

Verified By Visa

3-D Secure MPI

Testimonials

"YOUR IP*WORKS! VB CONTROLS ARE THE BEST!!!!! MANY MANY COMPLIMENTS FOR YOUR FANTASTIC TOOL!!!!"

-- M Bollini

[more...]

Available in: SSH

SSHClient Component [IP*Works! SSH V8]

Properties Methods Events Configuration Settings

The SSHClient component implements a fully functional, open-ended SSH client.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The SSHClient component can be used to perform any number of tasks secured by the Secure Shell (SSH) protocol. First set SSHHost, SSHUser and either SSHPassword or SSHCert, then call SSHLogon to establish a secure connection.

To open channels, use OpenChannel. To open a channel to tunnel data to a remote machine, call OpenTcpIpChannel. The Channels property contains a list of all of the channels open for the current instance of the component.

Once a "session" channel has been opened, you can call StartService to initialize a service on that channel. If you are using a "shell" service, you can call OpenTerminal to establish a pseudo-terminal for formatting the data output from the shell.

Data received from the server will be fired through SSHChannelData events. Any requests received can be processed through the SSHChannelRequest event.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


Channels	A collection of currently open channels.
Connected	Triggers a connection or disconnection.
Firewall	A set of properties related to firewall access.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where IPPort binds.
SSHAcceptServerHostKey	Instructs the component to accept the server host key that matches the supplied key.
SSHAuthMode	The authentication method to be used the component when performing an SSHLogon .
SSHCert	A certificate to be used for authenticating the SSHUser .
SSHCompressionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHHost	The address of the SSH host.
SSHKeyExchangeAlgorithms	A comma-separated list containing all allowable key exchange algorithms.
SSHMacAlgorithms	A comma-separated list containing all allowable message authentication algorithms.
SSHPassword	The password for SSH password-based authentication.
SSHPort	The port on the SSH server where the SSH service is running; by default, 22.
SSHPublicKeyAlgorithms	A comma-separated list containing all allowable public key authentication algorithms.
SSHUser	The username for SSH authentication.
Timeout	A timeout for the component.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


Config	Sets or retrieves a configuration setting.
DoEvents	Processes events from the internal message queue.
ExchangeKeys	Causes the component to exchange a new set of session keys with the SSHHost .
OpenChannel	Opens a new SSHChannel .
OpenTcpIpChannel	Opens a special TCP/IP tunneling SSHChannel .
OpenTerminal	Creates a pseudo-terminal to be used to help display data for a channel.
SSHLogoff	Logoff from the SSH server.
SSHLogon	Logon to the SSHHost using the current SSHUser and SSHPassword .
StartService	Requests the given service on a target channel.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
Disconnected	Fired when a connection is closed.
Error	Information about errors during data delivery.
SSHChannelData	Fired when the SSHHost sends channel data to the client.
SSHChannelRequest	Fired when the SSHHost sends a channel request to the client.
SSHServerAuthentication	Fired after the server presents its public key to the client.
SSHStatus	Shows the progress of the secure connection.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.


SSHAcceptAnyServerHostKey	If set the component will accept any key presented by the server
AuthModeList	A comma-delimited list of modes to be used during multi-factor authentication.
SSHAcceptServerHostKeyFingerPrint	The fingerprint of the server key to accept
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
TcpNoDelay	Whether or not to delay when sending packets
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).

|

About

|

Privacy Policy

|

Terms of Use

|