SSH Exec (Execute Command Line)

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

Download Chilkat 32-bit SSH / SFTP ActiveX (.msi)

Download All 32-bit Chilkat ActiveX Components (.zip)

Download All 64-bit Chilkat ActiveX Components (.zip)

LOCAL loSsh
LOCAL lnSuccess
LOCAL lcHostname
LOCAL lnPort
LOCAL lnChannelNum
LOCAL lcCmd1
LOCAL lcCmd2
LOCAL lcCmd3
LOCAL lcCmd4
LOCAL lcCmd5
LOCAL lcCmd6
LOCAL n
LOCAL lnPollTimeoutMs
LOCAL lcCmdOutput

*  Important: It is helpful to send the contents of the
*  ssh.LastErrorText property when requesting support.

loSsh = CreateObject('Chilkat.Ssh')

*  Any string automatically begins a fully-functional 30-day trial.

lnSuccess = loSsh.UnlockComponent("Anything for 30-day trial")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Connect to an SSH server:

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

lnSuccess = loSsh.Connect(lcHostname,lnPort)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

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

*  Authenticate using login/password:
lnSuccess = loSsh.AuthenticatePw("myLogin","myPassword")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

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

lnChannelNum = loSsh.OpenSessionChannel()
IF (lnChannelNum < 0) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
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"
lnSuccess = loSsh.SendReqExec(lnChannelNum,"ls")
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Read whatever output may already be available on the
*  SSH connection.  ChannelReadAndPoll returns the number of bytes
*  that are available in the channel's internal buffer that
*  are ready to be "picked up" by calling GetReceivedText
*  or GetReceivedData.
*  A return value of -1 indicates failure.
*  A return value of -2 indicates a failure via timeout.

*  The ChannelReadAndPoll method waits
*  for data to arrive on the connection usingi the IdleTimeoutMs
*  property setting.  Once the first data arrives, it continues
*  reading but instead uses the pollTimeoutMs passed in the 2nd argument:
*  A return value of -2 indicates a timeout where no data is received.

lnPollTimeoutMs = 2000
n = loSsh.ChannelReadAndPoll(lnChannelNum,lnPollTimeoutMs)
IF (n < 0) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Close the channel:
lnSuccess = loSsh.ChannelSendClose(lnChannelNum)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Perhaps we did not receive all of the commands output.
*  To make sure,  call ChannelReceiveToClose to accumulate any remaining
*  output until the server's corresponding "channel close" is received.
lnSuccess = loSsh.ChannelReceiveToClose(lnChannelNum)
IF (lnSuccess <> 1) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

*  Let's pickup the accumulated output of the command:

lcCmdOutput = loSsh.GetReceivedText(lnChannelNum,"ansi")
IF (lcCmdOutput = NULL ) THEN
    =MESSAGEBOX(loSsh.LastErrorText)
    QUIT
ENDIF

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

*  Disconnect
loSsh.Disconnect()