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.

bool success = false;

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

Chilkat.Ssh ssh = new Chilkat.Ssh();

int port = 22;
success = ssh.Connect("172.16.16.16",port);
if (success == false) {
    Debug.WriteLine(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.
string password = "mySshPassword";

success = ssh.AuthenticatePw("mySshLogin",password);
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

int channelNum = ssh.QuickShell();
if (channelNum < 0) {
    Debug.WriteLine(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;

bool caseSensitive = true;

//  The router presents a numbered main menu ending with "Select Menu Number [0-7]: ".
success = ssh.ChannelReceiveUntilMatch(channelNum,"Select Menu Number","utf-8",caseSensitive);
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

string cmdOutput = ssh.GetReceivedText(channelNum,"utf-8");
if (ssh.LastMethodSuccess == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

Debug.WriteLine(cmdOutput);

//  Choose menu item 4 (Device Console), exactly as if typing it in a terminal.
success = ssh.ChannelSendString(channelNum,"4\n","utf-8");
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

//  The device console prompt is "console>".
success = ssh.ChannelReceiveUntilMatch(channelNum,"console>","utf-8",caseSensitive);
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

cmdOutput = ssh.GetReceivedText(channelNum,"utf-8");
if (ssh.LastMethodSuccess == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

Debug.WriteLine(cmdOutput);

//  Send a console command and read its output up to the next prompt.
success = ssh.ChannelSendString(channelNum,"dnslookup host google.com\n","utf-8");
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

success = ssh.ChannelReceiveUntilMatch(channelNum,"console>","utf-8",caseSensitive);
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

cmdOutput = ssh.GetReceivedText(channelNum,"utf-8");
if (ssh.LastMethodSuccess == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

Debug.WriteLine(cmdOutput);

//  Additional commands follow the same pattern.
success = ssh.ChannelSendString(channelNum,"dnslookup host microsoft.com\n","utf-8");
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

success = ssh.ChannelReceiveUntilMatch(channelNum,"console>","utf-8",caseSensitive);
if (success == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

cmdOutput = ssh.GetReceivedText(channelNum,"utf-8");
if (ssh.LastMethodSuccess == false) {
    Debug.WriteLine(ssh.LastErrorText);
    return;
}

Debug.WriteLine(cmdOutput);

ssh.Disconnect();