SSH Commands to a Sophos Router Device Console

See more SSH Examples

Demonstrates establishing an SSH session with a Sophos XG router and sending commands in its device console session. The router presents a numbered main menu; the example selects the Device Console entry and then runs commands at the resulting console> prompt.

Note: QuickShell allocates a PTY, which is what a network device console expects. The device presents an interactive prompt, and each command's output is read up to the next prompt.

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

async function chilkatExample() {
  // This example requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  // Demonstrates establishing an SSH session with a Sophos XG router and sending commands in its
  // device console session.
  // 
  // Note: QuickShell allocates a PTY, which is what a device console expects.  Navigating the
  // device's menus is a matter of reading up to each prompt and sending the expected keystrokes.

  const ssh = new Ssh();

  const port = 22;
  try {
    await ssh.connectAsync('172.16.16.16', port);
  } 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.quickShellAsync();
  if (channelNum < 0) {
    console.log(ssh.lastErrorText);
    return;
  }

  // IMPORTANT: Set a read timeout before receiving until a match.  ReadTimeoutMs defaults to 0,
  // which means no limit -- without it, this call waits forever if the received data never
  // contains a match.
  ssh.readTimeoutMs = 15000;

  const caseSensitive = true;

  // The router presents a numbered main menu ending with "Select Menu Number [0-7]: ".
  try {
    await ssh.channelReceiveUntilMatchAsync(channelNum, 'Select Menu Number', 'utf-8', caseSensitive);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  let cmdOutput: string;
  try {
    cmdOutput = ssh.getReceivedText(channelNum, 'utf-8');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  console.log(cmdOutput);

  // Choose menu item 4 (Device Console), exactly as if typing it in a terminal.
  try {
    await ssh.channelSendStringAsync(channelNum, '4\n', 'utf-8');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  // The device console prompt is "console>".
  try {
    await ssh.channelReceiveUntilMatchAsync(channelNum, 'console>', 'utf-8', caseSensitive);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  try {
    cmdOutput = ssh.getReceivedText(channelNum, 'utf-8');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  console.log(cmdOutput);

  // Send a console command and read its output up to the next prompt.
  try {
    await ssh.channelSendStringAsync(channelNum, 'dnslookup host google.com\n', 'utf-8');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  try {
    await ssh.channelReceiveUntilMatchAsync(channelNum, 'console>', 'utf-8', caseSensitive);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  try {
    cmdOutput = ssh.getReceivedText(channelNum, 'utf-8');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  console.log(cmdOutput);

  // Additional commands follow the same pattern.
  try {
    await ssh.channelSendStringAsync(channelNum, 'dnslookup host microsoft.com\n', 'utf-8');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  try {
    await ssh.channelReceiveUntilMatchAsync(channelNum, 'console>', 'utf-8', caseSensitive);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  try {
    cmdOutput = ssh.getReceivedText(channelNum, 'utf-8');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  console.log(cmdOutput);

  ssh.disconnect();
}