(Tcl) SSH Quick/Simple Shell Session

See more SSH Examples

Demonstrates the simplified way to run multiple commands in a shell session on an SSH server.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set ssh [new_CkSsh]

set port 22
set success [CkSsh_Connect $ssh "the-ssh-server.com" $port]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Authenticate using login/password:
set success [CkSsh_AuthenticatePw $ssh "theSshLogin" "theSshPassword"]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Start a shell session.
# (The QuickShell method was added in Chilkat v9.5.0.65)
set channelNum [CkSsh_QuickShell $ssh]
if {$channelNum < 0} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Construct a StringBuilder with multiple commands, one per line.
# Note: The line-endings are potentially important.  Some SSH servers may
# require either LF or CRLF line endings.  (Unix/Linux/OSX servers typically
# use bare-LF line endings.  Windows servers likely use CRLF line endings.)
set sbCommands [new_CkStringBuilder]

CkStringBuilder_Append $sbCommands "echo hello world\n"
CkStringBuilder_Append $sbCommands "date\n"
CkStringBuilder_Append $sbCommands "df\n"

# For our last command, we're going to echo a marker string that
# we'll use in ChannelReceiveUntilMatch below.
# The use of single quotes around 'IS' is a trick so that the output
# of the command is "THIS IS THE END OF THE SCRIPT", but the terminal echo
# includes the single quotes.  This allows us to read until we see the actual
# output of the last command.
CkStringBuilder_Append $sbCommands "echo THIS 'IS' THE END OF THE SCRIPT\n"

# Send the commands..
set success [CkSsh_ChannelSendString $ssh $channelNum [CkStringBuilder_getAsString $sbCommands] "ansi"]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    delete_CkStringBuilder $sbCommands
    exit
}

# Send an EOF to indicate no more commands will be sent.
# For brevity, we're not checking the return values of each method call.
# Your code should check the success/failure of each call.
set success [CkSsh_ChannelSendEof $ssh $channelNum]

# Receive output up to our marker.
set success [CkSsh_ChannelReceiveUntilMatch $ssh $channelNum "THIS IS THE END OF THE SCRIPT" "ansi" 1]

# Close the channel.
# It is important to close the channel only after receiving the desired output.
set success [CkSsh_ChannelSendClose $ssh $channelNum]

# Get any remaining output..
set success [CkSsh_ChannelReceiveToClose $ssh $channelNum]

# Get the complete output for all the commands in the session.
puts "--- output ----"
puts [CkSsh_getReceivedText $ssh $channelNum ansi]

# Here's our actual sample output:

# 	Last login: Thu Dec 22 20:19:09 2016 from chilkat13
# 
# 	echo hello world
# 	date
# 	df
# 	echo THIS 'IS' THE END OF THE SCRIPT
# 	chilkatosx:~ chilkat$ echo hello world
# 	hello world
# 	chilkatosx:~ chilkat$ date
# 	Thu Dec 22 20:30:48 CST 2016
# 	chilkatosx:~ chilkat$ df
# 	Filesystem    512-blocks      Used  Available Capacity  iused     ifree %iused  Mounted on
# 	/dev/disk2    2176716032 265768928 1910435104    13% 33285114 238804388   12%   /
# 	devfs                383       383          0   100%      664         0  100%   /dev
# 	map -hosts             0         0          0   100%        0         0  100%   /net
# 	map auto_home          0         0          0   100%        0         0  100%   /home
# 	/dev/disk3s2      374668    374668          0   100%    93665         0  100%   /Volumes/Google Chrome
# 	chilkatosx:~ chilkat$ echo THIS 'IS' THE END OF THE SCRIPT
# 	THIS IS THE END OF THE SCRIPT
# 	chilkatosx:~ chilkat$ 

delete_CkSsh $ssh
delete_CkStringBuilder $sbCommands