(Lianja) SSH Exec (Execute Command Line)

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loSsh = createobject("CkSsh")

// Connect to an SSH server:

// Hostname may be an IP address or hostname:
lcHostname = "192.168.1.108"
lnPort = 22

llSuccess = loSsh.Connect(lcHostname,lnPort)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

// Wait a max of 5 seconds when reading responses..
loSsh.IdleTimeoutMs = 5000

// Authenticate using login/password:
llSuccess = loSsh.AuthenticatePw("myLogin","myPassword")
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

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

lnChannelNum = loSsh.OpenSessionChannel()
if (lnChannelNum < 0) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

// 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:
lcCmd1 = "dir"

// Do a nameserver lookup:
lcCmd2 = "nslookup chilkatsoft.com"

// List a specific directory.  Given that the shell is CMD.EXE, backslashes must
// be used:
lcCmd3 = "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:
lcCmd4 = '"cd \\temp&&dir"'

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

// Get a directory listing:
lcCmd5 = "ls -l /tmp"

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

// Request a directory listing on the remote server:
// If your server is Windows, change the string from "ls" to "dir"
llSuccess = loSsh.SendReqExec(lnChannelNum,"ls")
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

// Call ChannelReceiveToClose to read 
// output until the server's corresponding "channel close" is received.
llSuccess = loSsh.ChannelReceiveToClose(lnChannelNum)
if (llSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

// Let's pickup the accumulated output of the command:
lcCmdOutput = loSsh.GetReceivedText(lnChannelNum,"ansi")
if (loSsh.LastMethodSuccess <> .T.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

// Display the remote shell's command output:
? lcCmdOutput

// Disconnect
loSsh.Disconnect()


release loSsh