AutoIt

Start a Remote Shell with QuickShell

Demonstrates the Chilkat Ssh.QuickShell method, which starts a remote shell using the simplified sequence OpenSessionChannel → SendReqPty → SendReqShell. It takes no arguments and returns the shell channel number, or -1 on failure. The default PTY size is 80 columns by 24 rows.

Background: Note that QuickShell does allocate a PTY, so unlike a bare SendReqShell the remote shell runs interactively: it prints a command prompt, echoes the commands you send, and runs interactive login scripts. That is convenient for terminal-style work but means the output contains prompts and echoed input that scripted parsing must tolerate. The method returns as soon as the shell request is accepted — it does not consume the initial login text or prompt, so read and discard that before relying on command output.

Chilkat AutoIt Downloads

Download Chilkat for AutoIt

AutoIt

Local $bSuccess = False

;  Demonstrates the Ssh.QuickShell method, which starts a remote shell using the simplified
;  sequence OpenSessionChannel, SendReqPty, and SendReqShell.  It takes no arguments and returns
;  the shell channel number, or -1 on failure.  The default PTY size is 80 columns by 24 rows.

$oSsh = ObjCreate("Chilkat.Ssh")

Local $iSshPort = 22
$bSuccess = $oSsh.Connect("ssh.example.com",$iSshPort)
If ($bSuccess = False) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
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.
Local $sPassword = "mySshPassword"

$bSuccess = $oSsh.AuthenticatePw("mySshLogin",$sPassword)
If ($bSuccess = False) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
EndIf

;  Start the shell.  Note that QuickShell allocates a PTY, so the remote shell runs
;  interactively: it prints a command prompt and echoes the commands that are sent to it.
Local $iChannelNum = $oSsh.QuickShell()
If ($iChannelNum < 0) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
EndIf

;  QuickShell returns as soon as the shell request is accepted -- it does not wait for or
;  consume the initial login text or prompt.
$bSuccess = $oSsh.ChannelSendString($iChannelNum,"uname -a; echo DONE_MARKER" & @LF,"utf-8")
If ($bSuccess = False) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
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

Local $bCaseSensitive = False
$bSuccess = $oSsh.ChannelReceiveUntilMatch($iChannelNum,"DONE_MARKER","utf-8",$bCaseSensitive)
If ($bSuccess = False) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
EndIf

Local $sOutput = $oSsh.GetReceivedText($iChannelNum,"utf-8")
If ($oSsh.LastMethodSuccess = False) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($sOutput & @CRLF)

$oSsh.Disconnect