SSHClient Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorksSSH_SSHClient

Procedural Interface

 ipworksssh_sshclient_open();
 ipworksssh_sshclient_close($res);
 ipworksssh_sshclient_register_callback($res, $id, $function);
 ipworksssh_sshclient_get_last_error($res);
 ipworksssh_sshclient_get_last_error_code($res);
 ipworksssh_sshclient_set($res, $id, $index, $value);
 ipworksssh_sshclient_get($res, $id, $index);
 ipworksssh_sshclient_do_closechannel($res, $channelid);
 ipworksssh_sshclient_do_config($res, $configurationstring);
 ipworksssh_sshclient_do_decodepacket($res, $encodedpacket);
 ipworksssh_sshclient_do_doevents($res);
 ipworksssh_sshclient_do_encodepacket($res, $packet);
 ipworksssh_sshclient_do_exchangekeys($res);
 ipworksssh_sshclient_do_getsshparam($res, $payload, $field);
 ipworksssh_sshclient_do_getsshparambytes($res, $payload, $field);
 ipworksssh_sshclient_do_openchannel($res, $channeltype);
 ipworksssh_sshclient_do_opentcpipchannel($res, $desthost, $destport, $srchost, $srcport);
 ipworksssh_sshclient_do_openterminal($res, $channelid, $terminaltype, $width, $height, $usepixels, $modes);
 ipworksssh_sshclient_do_sendchanneldata($res, $channelid, $data);
 ipworksssh_sshclient_do_sendsshpacket($res, $channelid, $packettype, $payload);
 ipworksssh_sshclient_do_setsshparam($res, $payload, $fieldtype, $fieldvalue);
 ipworksssh_sshclient_do_sshlogoff($res);
 ipworksssh_sshclient_do_sshlogon($res, $sshhost, $sshport);
 ipworksssh_sshclient_do_startservice($res, $channelid, $service, $parameter);

Remarks

The SSHClient class can be used to perform any number of tasks secured by the Secure Shell (SSH) protocol. First set SSHHost, SSHUser and either SSHPassword or the SSHCert* properties , 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 class.

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.