(Delphi DLL) SSH Exec (Execute Command Line)

Shows how to execute a command on an SSH server and retrieve the command output.

Chilkat for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Ssh;

...

procedure TForm1.Button1Click(Sender: TObject);
var
ssh: HCkSsh;
hostname: PWideChar;
port: Integer;
success: Boolean;
channelNum: Integer;
cmd1: PWideChar;
cmd2: PWideChar;
cmd3: PWideChar;
cmd4: PWideChar;
cmd5: PWideChar;
cmd6: PWideChar;
cmdOutput: PWideChar;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

ssh := CkSsh_Create();

// Connect to an SSH server:

// Hostname may be an IP address or hostname:
hostname := '192.168.1.108';
port := 22;

success := CkSsh_Connect(ssh,hostname,port);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Wait a max of 5 seconds when reading responses..
CkSsh_putIdleTimeoutMs(ssh,5000);

// Authenticate using login/password:
success := CkSsh_AuthenticatePw(ssh,'myLogin','myPassword');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Open a session channel.  (It is possible to have multiple
// session channels open simultaneously.)

channelNum := CkSsh_OpenSessionChannel(ssh);
if (channelNum < 0) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// The SendReqExec method starts a command on the remote
// server.   The syntax of the command string depends on the
// default shell used on the remote server to run the command.
// On Windows systems it is CMD.EXE.  On UNIX/Linux
// systems the user's default shell is typically defined in /etc/password.

// Here are some examples of command lines for <b>Windows SSH servers</b>:

// Get a directory listing:
cmd1 := 'dir';

// Do a nameserver lookup:
cmd2 := 'nslookup chilkatsoft.com';

// List a specific directory.  Given that the shell is CMD.EXE, backslashes must
// be used:
cmd3 := 'dir \\temp';

// Execute a sequence of commands.  The syntax for CMD.EXE may be found
// here: http://technet.microsoft.com/en-us/library/bb490880.aspx.  Notice how the commands
// are separated by "&&" and the entire command must be enclosed in quotes:
cmd4 := '"cd \\temp&&dir"';

// Here are two examples of command lines for <b>Linux/UNIX SSH servers</b>:

// Get a directory listing:
cmd5 := 'ls -l /tmp';

// Run a series of commands (syntax may depend on your default shell):
cmd6 := 'cd /etc; ls -la';

// Request a directory listing on the remote server:
// If your server is Windows, change the string from "ls" to "dir"
success := CkSsh_SendReqExec(ssh,channelNum,'ls');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Call ChannelReceiveToClose to read 
// output until the server's corresponding "channel close" is received.
success := CkSsh_ChannelReceiveToClose(ssh,channelNum);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Let's pickup the accumulated output of the command:
cmdOutput := CkSsh__getReceivedText(ssh,channelNum,'ansi');
if (CkSsh_getLastMethodSuccess(ssh) <> True) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

// Display the remote shell's command output:
Memo1.Lines.Add(cmdOutput);

// Disconnect
CkSsh_Disconnect(ssh);

CkSsh_Dispose(ssh);

end;