Check Whether an SSH Exit Status Was Received

See more SSH Examples

Demonstrates the Chilkat Ssh.ChannelReceivedExitStatus method, which reports whether the server supplied an exit-status value for a channel. The only argument is the channel number. When it returns true, call GetChannelExitStatus to read the value.

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

async function chilkatExample() {
  // Demonstrates the Ssh.ChannelReceivedExitStatus method, which reports whether the server
  // supplied an exit-status value for a channel.  The only argument is the channel number.  When
  // it returns true, call GetChannelExitStatus to read the value.

  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, 'test -f /etc/hosts');
  } 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;
  }

  // The server is not required to send an exit status for every channel type or command.
  if (ssh.channelReceivedExitStatus(channelNum)) {
    const exitStatus = ssh.getChannelExitStatus(channelNum);
    console.log(`Exit status: ${exitStatus}`);
  } else {
    console.log('The server did not provide an exit status.');
  }

  ssh.disconnect();
}