Get the Exit Status of a Remote SSH Command

See more SSH Examples

Demonstrates the Chilkat Ssh.GetChannelExitStatus method, which returns the remote process exit status for a channel. The only argument is the channel number. Call it only after ChannelReceivedExitStatus returns true.

var
success: Integer;
ssh: TChilkatSsh;
sshPort: Integer;
password: WideString;
channelNum: Integer;
exitStatus: Integer;

begin
success := 0;

//  Demonstrates the Ssh.GetChannelExitStatus method, which returns the remote process exit
//  status for a channel.  The only argument is the channel number.  Call it only after
//  ChannelReceivedExitStatus returns 1.

ssh := TChilkatSsh.Create(Self);

sshPort := 22;
success := ssh.Connect('ssh.example.com',sshPort);
if (success = 0) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
password := 'mySshPassword';

success := ssh.AuthenticatePw('mySshLogin',password);
if (success = 0) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;

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

success := ssh.SendReqExec(channelNum,'grep -q root /etc/passwd');
if (success = 0) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;

//  IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
//  it, this call waits forever if the server never sends channel close.
ssh.ReadTimeoutMs := 15000;

success := ssh.ChannelReceiveToClose(channelNum);
if (success = 0) then
  begin
    Memo1.Lines.Add(ssh.LastErrorText);
    Exit;
  end;

//  Retrieve the exit status immediately, before calling unrelated SSH methods or releasing the
//  channel, because the completed channel record can be discarded.
if (ssh.ChannelReceivedExitStatus(channelNum)) then
  begin
    exitStatus := ssh.GetChannelExitStatus(channelNum);
    Memo1.Lines.Add('Exit status: ' + IntToStr(exitStatus));

    //  By convention, 0 means the remote command succeeded.
    if (exitStatus = 0) then
      begin
        Memo1.Lines.Add('The remote command succeeded.');
      end
    else
      begin
        Memo1.Lines.Add('The remote command reported a failure.');
      end;
  end;

ssh.Disconnect();