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.

import { Ssh } from '@chilkat/react-native'

async function chilkatExample() {
  // 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 true.

  const ssh = new Ssh();

  const sshPort = 22;
  try {
    await ssh.connectAsync('ssh.example.com', sshPort);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  // 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.
  const password = 'mySshPassword';

  try {
    await ssh.authenticatePwAsync('mySshLogin', password);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  const channelNum = await ssh.openSessionChannelAsync();
  if (channelNum < 0) {
    console.log(ssh.lastErrorText);
    return;
  }

  try {
    await ssh.sendReqExecAsync(channelNum, 'grep -q root /etc/passwd');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  // 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;

  try {
    await ssh.channelReceiveToCloseAsync(channelNum);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  // 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)) {
    const exitStatus = ssh.getChannelExitStatus(channelNum);
    console.log(`Exit status: ${exitStatus}`);

    // By convention, 0 means the remote command succeeded.
    if (exitStatus === 0) {
      console.log('The remote command succeeded.');
    } else {
      console.log('The remote command reported a failure.');
    }
  }

  ssh.disconnect();
}