(Tcl) SSH Exec (Execute Command Line)

Shows how to execute a command on an SSH server and retrieve the command output.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set ssh [new_CkSsh]

# Connect to an SSH server:

# Hostname may be an IP address or hostname:
set hostname "192.168.1.108"
set port 22

set success [CkSsh_Connect $ssh $hostname $port]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Wait a max of 5 seconds when reading responses..
CkSsh_put_IdleTimeoutMs $ssh 5000

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

# Open a session channel.  (It is possible to have multiple
# session channels open simultaneously.)

set channelNum [CkSsh_OpenSessionChannel $ssh]
if {$channelNum < 0} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# The SendReqExec method starts a command on the remote
# server.   The syntax of the command string depends on the
# default shell used on the remote server to run the command.
# On Windows systems it is CMD.EXE.  On UNIX/Linux
# systems the user's default shell is typically defined in /etc/password.

# Here are some examples of command lines for <b>Windows SSH servers</b>:

# Get a directory listing:
set cmd1 "dir"

# Do a nameserver lookup:
set cmd2 "nslookup chilkatsoft.com"

# List a specific directory.  Given that the shell is CMD.EXE, backslashes must
# be used:
set cmd3 "dir \\temp"

# Execute a sequence of commands.  The syntax for CMD.EXE may be found
# here: http://technet.microsoft.com/en-us/library/bb490880.aspx.  Notice how the commands
# are separated by "&&" and the entire command must be enclosed in quotes:
set cmd4 "\"cd \\temp&&dir\""

# Here are two examples of command lines for <b>Linux/UNIX SSH servers</b>:

# Get a directory listing:
set cmd5 "ls -l /tmp"

# Run a series of commands (syntax may depend on your default shell):
set cmd6 "cd /etc; ls -la"

# Request a directory listing on the remote server:
# If your server is Windows, change the string from "ls" to "dir"
set success [CkSsh_SendReqExec $ssh $channelNum "ls"]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Call ChannelReceiveToClose to read 
# output until the server's corresponding "channel close" is received.
set success [CkSsh_ChannelReceiveToClose $ssh $channelNum]
if {$success != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Let's pickup the accumulated output of the command:
set cmdOutput [CkSsh_getReceivedText $ssh $channelNum "ansi"]
if {[CkSsh_get_LastMethodSuccess $ssh] != 1} then {
    puts [CkSsh_lastErrorText $ssh]
    delete_CkSsh $ssh
    exit
}

# Display the remote shell's command output:
puts "$cmdOutput"

# Disconnect
CkSsh_Disconnect $ssh

delete_CkSsh $ssh