Xbase++

SSH Commands to a Sophos Router Device Console

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.

Background: Menu-driven appliances require the client to navigate the interface exactly as a human would — read the menu, send the keystroke that selects an entry, then wait for the next prompt. Because the prompt changes as you move between menu levels, the pattern you match on must change too, which is why this example matches the menu text first and console> afterward.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSsh
LOCAL nPort
LOCAL cPassword
LOCAL nChannelNum
LOCAL nCaseSensitive
LOCAL cCmdOutput

nSuccess := 0

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

oSsh := CreateObject("Chilkat.Ssh")

nPort := 22
nSuccess := oSsh:Connect("172.16.16.16", nPort)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  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.
cPassword := "mySshPassword"

nSuccess := oSsh:AuthenticatePw("mySshLogin", cPassword)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

nChannelNum := oSsh:QuickShell()
IF (nChannelNum < 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  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.
oSsh:ReadTimeoutMs := 15000

nCaseSensitive := 1

//  The router presents a numbered main menu ending with "Select Menu Number [0-7]: ".
nSuccess := oSsh:ChannelReceiveUntilMatch(nChannelNum, "Select Menu Number", "utf-8", nCaseSensitive)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

cCmdOutput := oSsh:GetReceivedText(nChannelNum, "utf-8")
IF (oSsh:LastMethodSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

? cCmdOutput

//  Choose menu item 4 (Device Console), exactly as if typing it in a terminal.
nSuccess := oSsh:ChannelSendString(nChannelNum, "4" + Chr(10), "utf-8")
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  The device console prompt is "console>".
nSuccess := oSsh:ChannelReceiveUntilMatch(nChannelNum, "console>", "utf-8", nCaseSensitive)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

cCmdOutput := oSsh:GetReceivedText(nChannelNum, "utf-8")
IF (oSsh:LastMethodSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

? cCmdOutput

//  Send a console command and read its output up to the next prompt.
nSuccess := oSsh:ChannelSendString(nChannelNum, "dnslookup host google.com" + Chr(10), "utf-8")
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

nSuccess := oSsh:ChannelReceiveUntilMatch(nChannelNum, "console>", "utf-8", nCaseSensitive)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

cCmdOutput := oSsh:GetReceivedText(nChannelNum, "utf-8")
IF (oSsh:LastMethodSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

? cCmdOutput

//  Additional commands follow the same pattern.
nSuccess := oSsh:ChannelSendString(nChannelNum, "dnslookup host microsoft.com" + Chr(10), "utf-8")
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

nSuccess := oSsh:ChannelReceiveUntilMatch(nChannelNum, "console>", "utf-8", nCaseSensitive)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

cCmdOutput := oSsh:GetReceivedText(nChannelNum, "utf-8")
IF (oSsh:LastMethodSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

? cCmdOutput

oSsh:Disconnect()

oSsh:destroy()