Start a Remote Shell with QuickShell

See more SSH Examples

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.

load ./chilkat.dll

set success 0

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

set ssh [new_CkSsh]

set sshPort 22
set success [CkSsh_Connect $ssh "ssh.example.com" $sshPort]
if {$success == 0} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

#  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.
set password "mySshPassword"

set success [CkSsh_AuthenticatePw $ssh "mySshLogin" $password]
if {$success == 0} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

#  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.
set channelNum [CkSsh_QuickShell $ssh]
if {$channelNum < 0} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

#  QuickShell returns as soon as the shell request is accepted -- it does not wait for or
#  consume the initial login text or prompt.
set success [CkSsh_ChannelSendString $ssh $channelNum "uname -a; echo DONE_MARKER\n" "utf-8"]
if {$success == 0} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

#  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.
CkSsh_put_ReadTimeoutMs $ssh 15000

set caseSensitive 0
set success [CkSsh_ChannelReceiveUntilMatch $ssh $channelNum "DONE_MARKER" "utf-8" $caseSensitive]
if {$success == 0} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

set output [CkSsh_getReceivedText $ssh $channelNum "utf-8"]
if {[CkSsh_get_LastMethodSuccess $ssh] == 0} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

puts "$output"

CkSsh_Disconnect $ssh

delete_CkSsh $ssh